From 1bb8eb8270f2f281f2a262e31f7484ff4801f920 Mon Sep 17 00:00:00 2001
From: "Jakob (Koby) Shimony"
Date: Tue, 2 Feb 2021 22:52:13 +0100
Subject: [PATCH] Initial Commit
---
.openapi-generator/VERSION | 2 +-
.travis.yml | 3 +-
README.md | 28 +-
docs/AddLoyaltyPointsEffectProps.md | 1 +
docs/Application.md | 14 +
docs/ApplicationAPIKey.md | 2 +
docs/ApplicationEvent.md | 1 +
docs/Binding.md | 1 +
docs/Campaign.md | 5 +
docs/CartItem.md | 1 -
docs/Change.md | 1 +
docs/CreateApplicationAPIKey.md | 2 +
docs/CustomerProfileIntegrationRequestV2.md | 5 +-
docs/DeductLoyaltyPointsEffectProps.md | 1 +
docs/Effect.md | 1 +
docs/EffectEntity.md | 1 +
docs/InlineResponse20020.md | 4 +-
docs/InlineResponse20021.md | 2 +-
docs/InlineResponse20022.md | 2 +-
docs/InlineResponse20023.md | 2 +-
docs/InlineResponse20024.md | 2 +-
docs/InlineResponse20025.md | 2 +-
docs/InlineResponse20026.md | 2 +-
docs/InlineResponse20027.md | 5 +-
docs/InlineResponse20028.md | 5 +-
docs/InlineResponse20029.md | 2 +-
docs/IntegrationApi.md | 50 +-
docs/IntegrationRequest.md | 4 +-
docs/IntegrationStateV2.md | 1 +
docs/LimitConfig.md | 17 -
docs/LoyaltyProgramBalance.md | 6 +-
docs/LoyaltyProgramLedgers.md | 1 +
docs/LoyaltySubLedger.md | 2 +-
docs/ManagementApi.md | 753 +++++--
docs/ModelImport.md | 11 +-
docs/NewApplication.md | 14 +
docs/NewApplicationAPIKey.md | 2 +
docs/NewCoupons.md | 4 +-
docs/NewCouponsForMultipleRecipients.md | 16 +
docs/ProfileAudiencesChanges.md | 10 +
docs/RejectCouponEffectProps.md | 3 +
docs/RejectReferralEffectProps.md | 3 +
docs/RollbackAddedLoyaltyPointsEffectProps.md | 13 +
...ollbackDeductedLoyaltyPointsEffectProps.md | 15 +
docs/RollbackReferralEffectProps.md | 9 +
docs/RuleFailureReason.md | 20 +
docs/UpdateApplication.md | 14 +
package.json | 2 +-
src/ApiClient.js | 7 +-
src/api/IntegrationApi.js | 106 +-
src/api/ManagementApi.js | 1953 ++++++++++-------
src/index.js | 65 +-
src/model/APIError.js | 2 +-
src/model/AcceptCouponEffectProps.js | 2 +-
src/model/AcceptReferralEffectProps.js | 2 +-
src/model/AccessLogEntry.js | 2 +-
src/model/Account.js | 2 +-
src/model/AccountAdditionalCost.js | 2 +-
src/model/AccountAnalytics.js | 2 +-
src/model/AccountEntity.js | 2 +-
src/model/AccountLimits.js | 2 +-
src/model/AddFreeItemEffectProps.js | 2 +-
src/model/AddLoyaltyPointsEffectProps.js | 19 +-
src/model/AdditionalCost.js | 2 +-
src/model/Application.js | 38 +-
src/model/ApplicationAPIKey.js | 10 +-
src/model/ApplicationApiHealth.js | 2 +-
src/model/ApplicationCustomer.js | 2 +-
src/model/ApplicationCustomerEntity.js | 2 +-
src/model/ApplicationCustomerSearch.js | 2 +-
src/model/ApplicationEntity.js | 2 +-
src/model/ApplicationEvent.js | 12 +-
src/model/ApplicationSession.js | 2 +-
src/model/ApplicationSessionEntity.js | 2 +-
src/model/Attribute.js | 2 +-
src/model/AttributesMandatory.js | 2 +-
src/model/AttributesSettings.js | 2 +-
src/model/Audience.js | 2 +-
src/model/AudienceMembership.js | 2 +-
src/model/BaseSamlConnection.js | 2 +-
src/model/Binding.js | 11 +-
src/model/Campaign.js | 47 +-
src/model/CampaignAnalytics.js | 2 +-
src/model/CampaignCopy.js | 2 +-
src/model/CampaignEntity.js | 2 +-
src/model/CampaignGroup.js | 2 +-
src/model/CampaignGroupEntity.js | 2 +-
src/model/CampaignSearch.js | 2 +-
src/model/CampaignSet.js | 2 +-
src/model/CampaignSetBranchNode.js | 2 +-
src/model/CampaignSetLeafNode.js | 2 +-
src/model/CampaignSetNode.js | 2 +-
src/model/CartItem.js | 11 +-
src/model/Change.js | 11 +-
src/model/ChangeProfilePassword.js | 2 +-
src/model/CodeGeneratorSettings.js | 2 +-
src/model/Coupon.js | 2 +-
src/model/CouponConstraints.js | 2 +-
src/model/CouponCreatedEffectProps.js | 2 +-
src/model/CouponRejectionReason.js | 2 +-
src/model/CouponReservations.js | 2 +-
src/model/CouponSearch.js | 2 +-
src/model/CouponValue.js | 2 +-
src/model/CreateApplicationAPIKey.js | 10 +-
src/model/CustomerActivityReport.js | 2 +-
src/model/CustomerAnalytics.js | 2 +-
src/model/CustomerInventory.js | 2 +-
src/model/CustomerProfile.js | 2 +-
src/model/CustomerProfileAudienceRequest.js | 2 +-
.../CustomerProfileAudienceRequestItem.js | 2 +-
.../CustomerProfileIntegrationRequestV2.js | 21 +-
src/model/CustomerProfileSearchQuery.js | 2 +-
src/model/CustomerSession.js | 2 +-
src/model/CustomerSessionV2.js | 2 +-
src/model/DeductLoyaltyPointsEffectProps.js | 19 +-
src/model/Effect.js | 11 +-
src/model/EffectEntity.js | 11 +-
src/model/EmailEntity.js | 2 +-
src/model/Entity.js | 2 +-
src/model/EntityWithTalangVisibleID.js | 2 +-
src/model/Environment.js | 2 +-
src/model/ErrorEffectProps.js | 2 +-
src/model/ErrorResponse.js | 2 +-
src/model/ErrorSource.js | 2 +-
src/model/Event.js | 2 +-
src/model/EventType.js | 2 +-
src/model/FeatureFlag.js | 2 +-
src/model/FeatureFlags.js | 2 +-
src/model/FeaturesFeed.js | 2 +-
src/model/FeedNotification.js | 2 +-
src/model/FuncArgDef.js | 2 +-
src/model/FunctionDef.js | 2 +-
src/model/InlineResponse200.js | 2 +-
src/model/InlineResponse2001.js | 2 +-
src/model/InlineResponse20010.js | 2 +-
src/model/InlineResponse20011.js | 2 +-
src/model/InlineResponse20012.js | 2 +-
src/model/InlineResponse20013.js | 2 +-
src/model/InlineResponse20014.js | 2 +-
src/model/InlineResponse20015.js | 2 +-
src/model/InlineResponse20016.js | 2 +-
src/model/InlineResponse20017.js | 2 +-
src/model/InlineResponse20018.js | 2 +-
src/model/InlineResponse20019.js | 2 +-
src/model/InlineResponse2002.js | 2 +-
src/model/InlineResponse20020.js | 18 +-
src/model/InlineResponse20021.js | 10 +-
src/model/InlineResponse20022.js | 10 +-
src/model/InlineResponse20023.js | 10 +-
src/model/InlineResponse20024.js | 10 +-
src/model/InlineResponse20025.js | 10 +-
src/model/InlineResponse20026.js | 10 +-
src/model/InlineResponse20027.js | 26 +-
src/model/InlineResponse20028.js | 26 +-
src/model/InlineResponse20029.js | 10 +-
src/model/InlineResponse2003.js | 2 +-
src/model/InlineResponse20030.js | 2 +-
src/model/InlineResponse2004.js | 2 +-
src/model/InlineResponse2005.js | 2 +-
src/model/InlineResponse2006.js | 2 +-
src/model/InlineResponse2007.js | 2 +-
src/model/InlineResponse2008.js | 2 +-
src/model/InlineResponse2009.js | 2 +-
src/model/IntegrationEntity.js | 2 +-
src/model/IntegrationEvent.js | 2 +-
src/model/IntegrationProfileEntity.js | 2 +-
src/model/IntegrationRequest.js | 12 +-
src/model/IntegrationState.js | 2 +-
src/model/IntegrationStateV2.js | 11 +-
src/model/LedgerEntry.js | 2 +-
src/model/LibraryAttribute.js | 2 +-
src/model/LimitConfig.js | 45 +-
src/model/LoginParams.js | 2 +-
src/model/Loyalty.js | 2 +-
src/model/LoyaltyLedger.js | 2 +-
src/model/LoyaltyLedgerEntry.js | 2 +-
src/model/LoyaltyMembership.js | 2 +-
src/model/LoyaltyPoints.js | 2 +-
src/model/LoyaltyProgram.js | 2 +-
src/model/LoyaltyProgramBalance.js | 55 +-
src/model/LoyaltyProgramLedgers.js | 19 +-
src/model/LoyaltyStatistics.js | 2 +-
src/model/LoyaltySubLedger.js | 6 +-
src/model/ManagerConfig.js | 2 +-
src/model/Meta.js | 2 +-
src/model/ModelExport.js | 2 +-
src/model/ModelImport.js | 23 +-
src/model/MultiApplicationEntity.js | 2 +-
...ltipleCustomerProfileIntegrationRequest.js | 2 +-
...leCustomerProfileIntegrationRequestItem.js | 2 +-
...pleCustomerProfileIntegrationResponseV2.js | 2 +-
src/model/MutableEntity.js | 2 +-
src/model/NewAccount.js | 2 +-
src/model/NewAccountSignUp.js | 2 +-
src/model/NewAdditionalCost.js | 2 +-
src/model/NewApplication.js | 38 +-
src/model/NewApplicationAPIKey.js | 10 +-
src/model/NewAttribute.js | 2 +-
src/model/NewAudience.js | 2 +-
src/model/NewCampaign.js | 2 +-
src/model/NewCampaignGroup.js | 2 +-
src/model/NewCampaignSet.js | 2 +-
src/model/NewCoupons.js | 48 +-
src/model/NewCouponsForMultipleRecipients.js | 140 ++
src/model/NewCustomerProfile.js | 2 +-
src/model/NewCustomerSession.js | 2 +-
src/model/NewCustomerSessionV2.js | 2 +-
src/model/NewEvent.js | 2 +-
src/model/NewEventType.js | 2 +-
src/model/NewFeatureFlags.js | 2 +-
src/model/NewInvitation.js | 2 +-
src/model/NewInviteEmail.js | 2 +-
src/model/NewLoyaltyProgram.js | 2 +-
src/model/NewPassword.js | 2 +-
src/model/NewPasswordEmail.js | 2 +-
src/model/NewReferral.js | 2 +-
src/model/NewRole.js | 2 +-
src/model/NewRuleset.js | 2 +-
src/model/NewSamlConnection.js | 2 +-
src/model/NewTemplateDef.js | 2 +-
src/model/NewUser.js | 2 +-
src/model/NewWebhook.js | 2 +-
src/model/Notification.js | 2 +-
src/model/ProfileAudiencesChanges.js | 85 +
src/model/RedeemReferralEffectProps.js | 2 +-
src/model/Referral.js | 2 +-
src/model/ReferralCreatedEffectProps.js | 2 +-
src/model/ReferralRejectionReason.js | 2 +-
src/model/RejectCouponEffectProps.js | 29 +-
src/model/RejectReferralEffectProps.js | 29 +-
src/model/Role.js | 2 +-
src/model/RoleAssign.js | 2 +-
src/model/RoleMembership.js | 2 +-
.../RollbackAddedLoyaltyPointsEffectProps.js | 119 +
src/model/RollbackCouponEffectProps.js | 2 +-
...ollbackDeductedLoyaltyPointsEffectProps.js | 137 ++
src/model/RollbackDiscountEffectProps.js | 2 +-
src/model/RollbackReferralEffectProps.js | 75 +
src/model/Rule.js | 2 +-
src/model/RuleFailureReason.js | 182 ++
src/model/Ruleset.js | 2 +-
src/model/SamlConnection.js | 2 +-
src/model/SamlConnectionMetadata.js | 2 +-
src/model/SamlLoginEndpoint.js | 2 +-
src/model/Session.js | 2 +-
src/model/SetDiscountEffectProps.js | 2 +-
src/model/SetDiscountPerItemEffectProps.js | 2 +-
src/model/ShowBundleMetadataEffectProps.js | 2 +-
src/model/ShowNotificationEffectProps.js | 2 +-
src/model/SlotDef.js | 2 +-
src/model/TemplateArgDef.js | 2 +-
src/model/TemplateDef.js | 2 +-
src/model/TriggerWebhookEffectProps.js | 2 +-
src/model/UpdateAccount.js | 2 +-
src/model/UpdateApplication.js | 38 +-
src/model/UpdateAttributeEffectProps.js | 2 +-
src/model/UpdateAudience.js | 2 +-
src/model/UpdateCampaign.js | 2 +-
src/model/UpdateCampaignGroup.js | 2 +-
src/model/UpdateCoupon.js | 2 +-
src/model/UpdateCouponBatch.js | 2 +-
src/model/UpdateLoyaltyProgram.js | 2 +-
src/model/UpdateRole.js | 2 +-
src/model/UpdateUser.js | 2 +-
src/model/UpdateUserLatestFeedTimestamp.js | 2 +-
src/model/User.js | 2 +-
src/model/UserEntity.js | 2 +-
src/model/UserFeedNotifications.js | 2 +-
src/model/Webhook.js | 2 +-
src/model/WebhookActivationLogEntry.js | 2 +-
src/model/WebhookLogEntry.js | 2 +-
test/api/ManagementApi.spec.js | 90 +-
.../model/AddLoyaltyPointsEffectProps.spec.js | 6 +
test/model/Application.spec.js | 6 +
test/model/ApplicationEvent.spec.js | 6 +
test/model/Binding.spec.js | 6 +
test/model/Campaign.spec.js | 30 +
test/model/CartItem.spec.js | 6 -
test/model/Change.spec.js | 6 +
...ustomerProfileIntegrationRequestV2.spec.js | 6 +
.../DeductLoyaltyPointsEffectProps.spec.js | 6 +
test/model/Effect.spec.js | 6 +
test/model/EffectEntity.spec.js | 6 +
test/model/InlineResponse20027.spec.js | 6 -
test/model/InlineResponse20028.spec.js | 6 +
test/model/IntegrationStateV2.spec.js | 6 +
test/model/LoyaltyProgramBalance.spec.js | 24 +
test/model/LoyaltyProgramLedgers.spec.js | 6 +
test/model/NewApplication.spec.js | 6 +
test/model/NewCoupons.spec.js | 24 +-
.../NewCouponsForMultipleRecipients.spec.js | 107 +
test/model/ProfileAudiencesChanges.spec.js | 71 +
test/model/RejectCouponEffectProps.spec.js | 18 +
test/model/RejectReferralEffectProps.spec.js | 18 +
...lbackAddedLoyaltyPointsEffectProps.spec.js | 89 +
...ckDeductedLoyaltyPointsEffectProps.spec.js | 101 +
.../model/RollbackReferralEffectProps.spec.js | 65 +
test/model/RuleFailureReason.spec.js | 131 ++
test/model/UpdateApplication.spec.js | 6 +
299 files changed, 4393 insertions(+), 1495 deletions(-)
create mode 100644 docs/NewCouponsForMultipleRecipients.md
create mode 100644 docs/ProfileAudiencesChanges.md
create mode 100644 docs/RollbackAddedLoyaltyPointsEffectProps.md
create mode 100644 docs/RollbackDeductedLoyaltyPointsEffectProps.md
create mode 100644 docs/RollbackReferralEffectProps.md
create mode 100644 docs/RuleFailureReason.md
create mode 100644 src/model/NewCouponsForMultipleRecipients.js
create mode 100644 src/model/ProfileAudiencesChanges.js
create mode 100644 src/model/RollbackAddedLoyaltyPointsEffectProps.js
create mode 100644 src/model/RollbackDeductedLoyaltyPointsEffectProps.js
create mode 100644 src/model/RollbackReferralEffectProps.js
create mode 100644 src/model/RuleFailureReason.js
create mode 100644 test/model/NewCouponsForMultipleRecipients.spec.js
create mode 100644 test/model/ProfileAudiencesChanges.spec.js
create mode 100644 test/model/RollbackAddedLoyaltyPointsEffectProps.spec.js
create mode 100644 test/model/RollbackDeductedLoyaltyPointsEffectProps.spec.js
create mode 100644 test/model/RollbackReferralEffectProps.spec.js
create mode 100644 test/model/RuleFailureReason.spec.js
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
index ec87108d..ecedc98d 100644
--- a/.openapi-generator/VERSION
+++ b/.openapi-generator/VERSION
@@ -1 +1 @@
-4.2.3
\ No newline at end of file
+4.3.1
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
index eb2dc7a1..1c27e73a 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,10 +1,11 @@
language: node_js
cache: npm
node_js:
+ - "14.15.4"
+ - "12.20.1"
- "10.13.0"
- "8.11.0"
- "8.9.0"
- "6"
- "6.1"
- "5.11"
-
diff --git a/README.md b/README.md
index fbbc3d75..a9e0eaef 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ The API is available at the same hostname as these docs. For example, if you are
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
-- Package version: 4.2.0
+- Package version: 4.3.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
## Installation
@@ -307,8 +307,8 @@ Class | Method | HTTP request | Description
*TalonOne.IntegrationApi* | [**createCouponReservation**](docs/IntegrationApi.md#createCouponReservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
*TalonOne.IntegrationApi* | [**createReferral**](docs/IntegrationApi.md#createReferral) | **POST** /v1/referrals | Create a referral code for an advocate
*TalonOne.IntegrationApi* | [**deleteCouponReservation**](docs/IntegrationApi.md#deleteCouponReservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
-*TalonOne.IntegrationApi* | [**deleteCustomerData**](docs/IntegrationApi.md#deleteCustomerData) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
-*TalonOne.IntegrationApi* | [**getCustomerInventory**](docs/IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
+*TalonOne.IntegrationApi* | [**deleteCustomerData**](docs/IntegrationApi.md#deleteCustomerData) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
+*TalonOne.IntegrationApi* | [**getCustomerInventory**](docs/IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
*TalonOne.IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
*TalonOne.IntegrationApi* | [**trackEvent**](docs/IntegrationApi.md#trackEvent) | **POST** /v1/events | Track an Event
*TalonOne.IntegrationApi* | [**updateCustomerProfile**](docs/IntegrationApi.md#updateCustomerProfile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
@@ -323,6 +323,7 @@ Class | Method | HTTP request | Description
*TalonOne.ManagementApi* | [**createAttribute**](docs/ManagementApi.md#createAttribute) | **POST** /v1/attributes | Define a new custom attribute
*TalonOne.ManagementApi* | [**createCampaign**](docs/ManagementApi.md#createCampaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
*TalonOne.ManagementApi* | [**createCoupons**](docs/ManagementApi.md#createCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
+*TalonOne.ManagementApi* | [**createCouponsForMultipleRecipients**](docs/ManagementApi.md#createCouponsForMultipleRecipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create Coupons for Multiple Recipients
*TalonOne.ManagementApi* | [**createPasswordRecoveryEmail**](docs/ManagementApi.md#createPasswordRecoveryEmail) | **POST** /v1/password_recovery_emails | Request a password reset
*TalonOne.ManagementApi* | [**createRuleset**](docs/ManagementApi.md#createRuleset) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | Create a Ruleset
*TalonOne.ManagementApi* | [**createSession**](docs/ManagementApi.md#createSession) | **POST** /v1/sessions | Create a Session
@@ -331,6 +332,12 @@ Class | Method | HTTP request | Description
*TalonOne.ManagementApi* | [**deleteCoupons**](docs/ManagementApi.md#deleteCoupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete Coupons
*TalonOne.ManagementApi* | [**deleteReferral**](docs/ManagementApi.md#deleteReferral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete one Referral
*TalonOne.ManagementApi* | [**deleteRuleset**](docs/ManagementApi.md#deleteRuleset) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Delete a Ruleset
+*TalonOne.ManagementApi* | [**destroySession**](docs/ManagementApi.md#destroySession) | **DELETE** /v1/sessions | Destroy a Session
+*TalonOne.ManagementApi* | [**exportCoupons**](docs/ManagementApi.md#exportCoupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export Coupons to a CSV file
+*TalonOne.ManagementApi* | [**exportCustomerSessions**](docs/ManagementApi.md#exportCustomerSessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export Customer Sessions to a CSV file
+*TalonOne.ManagementApi* | [**exportEffects**](docs/ManagementApi.md#exportEffects) | **GET** /v1/applications/{applicationId}/export_effects | Export triggered Effects to a CSV file
+*TalonOne.ManagementApi* | [**exportLoyaltyBalance**](docs/ManagementApi.md#exportLoyaltyBalance) | **GET** /v1/loyalty_programs/{programID}/export_customer_balance | Export customer loyalty balance to a CSV file
+*TalonOne.ManagementApi* | [**exportLoyaltyLedger**](docs/ManagementApi.md#exportLoyaltyLedger) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID}/export_log | Export a customer's loyalty ledger log to a CSV file
*TalonOne.ManagementApi* | [**getAccessLogs**](docs/ManagementApi.md#getAccessLogs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application (with total count)
*TalonOne.ManagementApi* | [**getAccessLogsWithoutTotalCount**](docs/ManagementApi.md#getAccessLogsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
*TalonOne.ManagementApi* | [**getAccount**](docs/ManagementApi.md#getAccount) | **GET** /v1/accounts/{accountId} | Get Account Details
@@ -338,7 +345,7 @@ Class | Method | HTTP request | Description
*TalonOne.ManagementApi* | [**getAdditionalCost**](docs/ManagementApi.md#getAdditionalCost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
*TalonOne.ManagementApi* | [**getAdditionalCosts**](docs/ManagementApi.md#getAdditionalCosts) | **GET** /v1/additional_costs | List additional costs
*TalonOne.ManagementApi* | [**getAllAccessLogs**](docs/ManagementApi.md#getAllAccessLogs) | **GET** /v1/access_logs | Get all access logs
-*TalonOne.ManagementApi* | [**getAllRoles**](docs/ManagementApi.md#getAllRoles) | **GET** /v1/roles | Get all roles.
+*TalonOne.ManagementApi* | [**getAllRoles**](docs/ManagementApi.md#getAllRoles) | **GET** /v1/roles | Get all roles
*TalonOne.ManagementApi* | [**getApplication**](docs/ManagementApi.md#getApplication) | **GET** /v1/applications/{applicationId} | Get Application
*TalonOne.ManagementApi* | [**getApplicationApiHealth**](docs/ManagementApi.md#getApplicationApiHealth) | **GET** /v1/applications/{applicationId}/health_report | Get report of health of application API
*TalonOne.ManagementApi* | [**getApplicationCustomer**](docs/ManagementApi.md#getApplicationCustomer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
@@ -352,6 +359,7 @@ Class | Method | HTTP request | Description
*TalonOne.ManagementApi* | [**getApplications**](docs/ManagementApi.md#getApplications) | **GET** /v1/applications | List Applications
*TalonOne.ManagementApi* | [**getAttribute**](docs/ManagementApi.md#getAttribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
*TalonOne.ManagementApi* | [**getAttributes**](docs/ManagementApi.md#getAttributes) | **GET** /v1/attributes | List custom attributes
+*TalonOne.ManagementApi* | [**getAudiences**](docs/ManagementApi.md#getAudiences) | **GET** /v1/audiences | Get all audiences
*TalonOne.ManagementApi* | [**getCampaign**](docs/ManagementApi.md#getCampaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
*TalonOne.ManagementApi* | [**getCampaignAnalytics**](docs/ManagementApi.md#getCampaignAnalytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
*TalonOne.ManagementApi* | [**getCampaignByAttributes**](docs/ManagementApi.md#getCampaignByAttributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
@@ -370,14 +378,13 @@ Class | Method | HTTP request | Description
*TalonOne.ManagementApi* | [**getCustomersByAttributes**](docs/ManagementApi.md#getCustomersByAttributes) | **POST** /v1/customer_search/no_total | Get a list of the customer profiles that match the given attributes
*TalonOne.ManagementApi* | [**getEventTypes**](docs/ManagementApi.md#getEventTypes) | **GET** /v1/event_types | List Event Types
*TalonOne.ManagementApi* | [**getExports**](docs/ManagementApi.md#getExports) | **GET** /v1/exports | Get Exports
-*TalonOne.ManagementApi* | [**getImports**](docs/ManagementApi.md#getImports) | **GET** /v1/imports | Get Imports
*TalonOne.ManagementApi* | [**getLoyaltyPoints**](docs/ManagementApi.md#getLoyaltyPoints) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
*TalonOne.ManagementApi* | [**getLoyaltyProgram**](docs/ManagementApi.md#getLoyaltyProgram) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
*TalonOne.ManagementApi* | [**getLoyaltyPrograms**](docs/ManagementApi.md#getLoyaltyPrograms) | **GET** /v1/loyalty_programs | List all loyalty Programs
*TalonOne.ManagementApi* | [**getLoyaltyStatistics**](docs/ManagementApi.md#getLoyaltyStatistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
*TalonOne.ManagementApi* | [**getReferrals**](docs/ManagementApi.md#getReferrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
*TalonOne.ManagementApi* | [**getReferralsWithoutTotalCount**](docs/ManagementApi.md#getReferralsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
-*TalonOne.ManagementApi* | [**getRole**](docs/ManagementApi.md#getRole) | **GET** /v1/roles/{roleId} | Get information for the specified role.
+*TalonOne.ManagementApi* | [**getRole**](docs/ManagementApi.md#getRole) | **GET** /v1/roles/{roleId} | Get information for the specified role
*TalonOne.ManagementApi* | [**getRuleset**](docs/ManagementApi.md#getRuleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
*TalonOne.ManagementApi* | [**getRulesets**](docs/ManagementApi.md#getRulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List Campaign Rulesets
*TalonOne.ManagementApi* | [**getUser**](docs/ManagementApi.md#getUser) | **GET** /v1/users/{userId} | Get a single User
@@ -443,7 +450,6 @@ Class | Method | HTTP request | Description
- [TalonOne.CampaignSetLeafNode](docs/CampaignSetLeafNode.md)
- [TalonOne.CampaignSetNode](docs/CampaignSetNode.md)
- [TalonOne.CartItem](docs/CartItem.md)
- - [TalonOne.CartItemAdjustment](docs/CartItemAdjustment.md)
- [TalonOne.Change](docs/Change.md)
- [TalonOne.ChangeProfilePassword](docs/ChangeProfilePassword.md)
- [TalonOne.CodeGeneratorSettings](docs/CodeGeneratorSettings.md)
@@ -483,7 +489,6 @@ Class | Method | HTTP request | Description
- [TalonOne.FeedNotification](docs/FeedNotification.md)
- [TalonOne.FuncArgDef](docs/FuncArgDef.md)
- [TalonOne.FunctionDef](docs/FunctionDef.md)
- - [TalonOne.ImportCoupons](docs/ImportCoupons.md)
- [TalonOne.InlineResponse200](docs/InlineResponse200.md)
- [TalonOne.InlineResponse2001](docs/InlineResponse2001.md)
- [TalonOne.InlineResponse20010](docs/InlineResponse20010.md)
@@ -555,13 +560,13 @@ Class | Method | HTTP request | Description
- [TalonOne.NewCampaignGroup](docs/NewCampaignGroup.md)
- [TalonOne.NewCampaignSet](docs/NewCampaignSet.md)
- [TalonOne.NewCoupons](docs/NewCoupons.md)
+ - [TalonOne.NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md)
- [TalonOne.NewCustomerProfile](docs/NewCustomerProfile.md)
- [TalonOne.NewCustomerSession](docs/NewCustomerSession.md)
- [TalonOne.NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
- [TalonOne.NewEvent](docs/NewEvent.md)
- [TalonOne.NewEventType](docs/NewEventType.md)
- [TalonOne.NewFeatureFlags](docs/NewFeatureFlags.md)
- - [TalonOne.NewImport](docs/NewImport.md)
- [TalonOne.NewInvitation](docs/NewInvitation.md)
- [TalonOne.NewInviteEmail](docs/NewInviteEmail.md)
- [TalonOne.NewLoyaltyProgram](docs/NewLoyaltyProgram.md)
@@ -575,6 +580,7 @@ Class | Method | HTTP request | Description
- [TalonOne.NewUser](docs/NewUser.md)
- [TalonOne.NewWebhook](docs/NewWebhook.md)
- [TalonOne.Notification](docs/Notification.md)
+ - [TalonOne.ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
- [TalonOne.RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
- [TalonOne.Referral](docs/Referral.md)
- [TalonOne.ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md)
@@ -584,9 +590,13 @@ Class | Method | HTTP request | Description
- [TalonOne.Role](docs/Role.md)
- [TalonOne.RoleAssign](docs/RoleAssign.md)
- [TalonOne.RoleMembership](docs/RoleMembership.md)
+ - [TalonOne.RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md)
- [TalonOne.RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
+ - [TalonOne.RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
- [TalonOne.RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
+ - [TalonOne.RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
- [TalonOne.Rule](docs/Rule.md)
+ - [TalonOne.RuleFailureReason](docs/RuleFailureReason.md)
- [TalonOne.Ruleset](docs/Ruleset.md)
- [TalonOne.SamlConnection](docs/SamlConnection.md)
- [TalonOne.SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
diff --git a/docs/AddLoyaltyPointsEffectProps.md b/docs/AddLoyaltyPointsEffectProps.md
index 44d7378e..6b3341e3 100644
--- a/docs/AddLoyaltyPointsEffectProps.md
+++ b/docs/AddLoyaltyPointsEffectProps.md
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
**recipientIntegrationId** | **String** | The user for whom these points were added |
**startDate** | **Date** | Date after which points will be valid | [optional]
**expiryDate** | **Date** | Date after which points will expire | [optional]
+**transactionUUID** | **String** | The identifier of this addition in the loyalty ledger |
diff --git a/docs/Application.md b/docs/Application.md
index d859f5db..f694382e 100644
--- a/docs/Application.md
+++ b/docs/Application.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**limits** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
**campaignPriority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional]
**exclusiveCampaignsStrategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional]
+**defaultDiscountScope** | **String** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional]
**enableCascadingDiscounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional]
**enableFlattenedCartItems** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional]
**attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
@@ -63,3 +64,16 @@ Name | Type | Description | Notes
+
+## Enum: DefaultDiscountScopeEnum
+
+
+* `sessionTotal` (value: `"sessionTotal"`)
+
+* `cartItems` (value: `"cartItems"`)
+
+* `additionalCosts` (value: `"additionalCosts"`)
+
+
+
+
diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md
index 1c4e9825..2d74026f 100644
--- a/docs/ApplicationAPIKey.md
+++ b/docs/ApplicationAPIKey.md
@@ -26,6 +26,8 @@ Name | Type | Description | Notes
* `mparticle` (value: `"mparticle"`)
+* `selligent` (value: `"selligent"`)
+
diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md
index 1ac8fc90..8b4ad511 100644
--- a/docs/ApplicationEvent.md
+++ b/docs/ApplicationEvent.md
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
**type** | **String** | A string representing the event. Must not be a reserved event name. |
**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. |
**effects** | **[Object]** | An array containing the effects that were applied as a result of this event. |
+**ruleFailureReasons** | [**[RuleFailureReason]**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional]
diff --git a/docs/Binding.md b/docs/Binding.md
index c556fc65..151db780 100644
--- a/docs/Binding.md
+++ b/docs/Binding.md
@@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | A descriptive name for the value to be bound. |
+**type** | **String** | The kind of binding. Possible values are cartItemFilter, subledgerBalance. | [optional]
**expression** | **[Object]** | A Talang expression that will be evaluated and its result attached to the name of the binding. |
diff --git a/docs/Campaign.md b/docs/Campaign.md
index cb55b2b8..f69fca45 100644
--- a/docs/Campaign.md
+++ b/docs/Campaign.md
@@ -26,6 +26,11 @@ Name | Type | Description | Notes
**discountCount** | **Number** | Total amount of discounts redeemed in the campaign. | [optional]
**discountEffectCount** | **Number** | Total number of times discounts were redeemed in this campaign. | [optional]
**couponCreationCount** | **Number** | Total number of coupons created by rules in this campaign. | [optional]
+**referralCreationCount** | **Number** | Total number of referrals created by rules in this campaign. | [optional]
+**createdLoyaltyPointsCount** | **Number** | Total number of loyalty points created by rules in this campaign. | [optional]
+**createdLoyaltyPointsEffectCount** | **Number** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional]
+**redeemedLoyaltyPointsCount** | **Number** | Total number of loyalty points redeemed by rules in this campaign. | [optional]
+**redeemedLoyaltyPointsEffectCount** | **Number** | Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional]
**lastActivity** | **Date** | Timestamp of the most recent event received by this campaign. | [optional]
**updated** | **Date** | Timestamp of the most recent update to the campaign or any of its elements. | [optional]
**createdBy** | **String** | Name of the user who created this campaign if available. | [optional]
diff --git a/docs/CartItem.md b/docs/CartItem.md
index c4762028..0f350f82 100644
--- a/docs/CartItem.md
+++ b/docs/CartItem.md
@@ -15,6 +15,5 @@ Name | Type | Description | Notes
**length** | **Number** | Length of item in mm | [optional]
**position** | **Number** | Position of the Cart Item in the Cart (calculated internally) | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
-**adjustment** | [**CartItemAdjustment**](CartItemAdjustment.md) | | [optional]
diff --git a/docs/Change.md b/docs/Change.md
index 3ba299e7..4c0f26aa 100644
--- a/docs/Change.md
+++ b/docs/Change.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
**id** | **Number** | Unique ID for this entity. |
**created** | **Date** | The exact moment this entity was created. |
**userId** | **Number** | The ID of the account that owns this entity. |
+**applicationId** | **Number** | ID of application associated with change | [optional]
**entity** | **String** | API endpoint on which the change was initiated. |
**old** | [**Object**](.md) | Resource before the change occurred. | [optional]
**_new** | [**Object**](.md) | Resource after the change occurred. | [optional]
diff --git a/docs/CreateApplicationAPIKey.md b/docs/CreateApplicationAPIKey.md
index ad44a673..6092baf1 100644
--- a/docs/CreateApplicationAPIKey.md
+++ b/docs/CreateApplicationAPIKey.md
@@ -21,6 +21,8 @@ Name | Type | Description | Notes
* `mparticle` (value: `"mparticle"`)
+* `selligent` (value: `"selligent"`)
+
diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md
index 48e945f1..0ece23d0 100644
--- a/docs/CustomerProfileIntegrationRequestV2.md
+++ b/docs/CustomerProfileIntegrationRequestV2.md
@@ -5,7 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
-**responseContent** | **[String]** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\" and \"event\". | [optional]
+**audiencesChanges** | [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional]
+**responseContent** | **[String]** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\" and \"ruleFailureReasons\". | [optional]
@@ -20,6 +21,8 @@ Name | Type | Description | Notes
* `event` (value: `"event"`)
+* `ruleFailureReasons` (value: `"ruleFailureReasons"`)
+
diff --git a/docs/DeductLoyaltyPointsEffectProps.md b/docs/DeductLoyaltyPointsEffectProps.md
index 39cf5bbc..c612e7e6 100644
--- a/docs/DeductLoyaltyPointsEffectProps.md
+++ b/docs/DeductLoyaltyPointsEffectProps.md
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
**programId** | **Number** | The ID of the loyalty program where these points were added |
**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added |
**value** | **Number** | The amount of points that were deducted |
+**transactionUUID** | **String** | The identifier of this deduction in the loyalty ledger |
diff --git a/docs/Effect.md b/docs/Effect.md
index 60807302..c04e2f07 100644
--- a/docs/Effect.md
+++ b/docs/Effect.md
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
**ruleIndex** | **Number** | The position of the rule that triggered this effect within the ruleset |
**ruleName** | **String** | The name of the rule that triggered this effect |
**effectType** | **String** | The type of effect that was triggered |
+**triggeredByCoupon** | **Number** | The ID of the coupon that was being evaluated when this effect was triggered | [optional]
**props** | [**Object**](.md) | |
diff --git a/docs/EffectEntity.md b/docs/EffectEntity.md
index ddabead3..909cf580 100644
--- a/docs/EffectEntity.md
+++ b/docs/EffectEntity.md
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
**ruleIndex** | **Number** | The position of the rule that triggered this effect within the ruleset |
**ruleName** | **String** | The name of the rule that triggered this effect |
**effectType** | **String** | The type of effect that was triggered |
+**triggeredByCoupon** | **Number** | The ID of the coupon that was being evaluated when this effect was triggered | [optional]
diff --git a/docs/InlineResponse20020.md b/docs/InlineResponse20020.md
index 3549c7fe..2bb6d2db 100644
--- a/docs/InlineResponse20020.md
+++ b/docs/InlineResponse20020.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Number** | |
-**data** | [**[Attribute]**](Attribute.md) | |
+**totalResultSize** | **Number** | | [optional]
+**data** | [**[Audience]**](Audience.md) | |
diff --git a/docs/InlineResponse20021.md b/docs/InlineResponse20021.md
index d4c37ca2..aa8ecc68 100644
--- a/docs/InlineResponse20021.md
+++ b/docs/InlineResponse20021.md
@@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Number** | |
-**data** | [**[AccountAdditionalCost]**](AccountAdditionalCost.md) | |
+**data** | [**[Attribute]**](Attribute.md) | |
diff --git a/docs/InlineResponse20022.md b/docs/InlineResponse20022.md
index 93614467..6e9f87ae 100644
--- a/docs/InlineResponse20022.md
+++ b/docs/InlineResponse20022.md
@@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Number** | |
-**data** | [**[Webhook]**](Webhook.md) | |
+**data** | [**[AccountAdditionalCost]**](AccountAdditionalCost.md) | |
diff --git a/docs/InlineResponse20023.md b/docs/InlineResponse20023.md
index dbcaecc4..43d84509 100644
--- a/docs/InlineResponse20023.md
+++ b/docs/InlineResponse20023.md
@@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Number** | |
-**data** | [**[WebhookActivationLogEntry]**](WebhookActivationLogEntry.md) | |
+**data** | [**[Webhook]**](Webhook.md) | |
diff --git a/docs/InlineResponse20024.md b/docs/InlineResponse20024.md
index 0df17335..e95fe1d8 100644
--- a/docs/InlineResponse20024.md
+++ b/docs/InlineResponse20024.md
@@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Number** | |
-**data** | [**[WebhookLogEntry]**](WebhookLogEntry.md) | |
+**data** | [**[WebhookActivationLogEntry]**](WebhookActivationLogEntry.md) | |
diff --git a/docs/InlineResponse20025.md b/docs/InlineResponse20025.md
index 22ba9099..2a2107bb 100644
--- a/docs/InlineResponse20025.md
+++ b/docs/InlineResponse20025.md
@@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Number** | |
-**data** | [**[EventType]**](EventType.md) | |
+**data** | [**[WebhookLogEntry]**](WebhookLogEntry.md) | |
diff --git a/docs/InlineResponse20026.md b/docs/InlineResponse20026.md
index 4e56a474..82b3d126 100644
--- a/docs/InlineResponse20026.md
+++ b/docs/InlineResponse20026.md
@@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Number** | |
-**data** | [**[User]**](User.md) | |
+**data** | [**[EventType]**](EventType.md) | |
diff --git a/docs/InlineResponse20027.md b/docs/InlineResponse20027.md
index 8bee5048..28075a59 100644
--- a/docs/InlineResponse20027.md
+++ b/docs/InlineResponse20027.md
@@ -4,8 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Number** | | [optional]
-**hasMore** | **Boolean** | | [optional]
-**data** | [**[Change]**](Change.md) | |
+**totalResultSize** | **Number** | |
+**data** | [**[User]**](User.md) | |
diff --git a/docs/InlineResponse20028.md b/docs/InlineResponse20028.md
index 6bb3169e..6f547175 100644
--- a/docs/InlineResponse20028.md
+++ b/docs/InlineResponse20028.md
@@ -4,7 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**totalResultSize** | **Number** | |
-**data** | [**[ModelExport]**](ModelExport.md) | |
+**totalResultSize** | **Number** | | [optional]
+**hasMore** | **Boolean** | | [optional]
+**data** | [**[Change]**](Change.md) | |
diff --git a/docs/InlineResponse20029.md b/docs/InlineResponse20029.md
index 09de0dad..2616bc2c 100644
--- a/docs/InlineResponse20029.md
+++ b/docs/InlineResponse20029.md
@@ -5,6 +5,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalResultSize** | **Number** | |
-**data** | [**[ModelImport]**](ModelImport.md) | |
+**data** | [**[ModelExport]**](ModelExport.md) | |
diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md
index 35b748c6..2b78da98 100644
--- a/docs/IntegrationApi.md
+++ b/docs/IntegrationApi.md
@@ -7,8 +7,8 @@ Method | HTTP request | Description
[**createCouponReservation**](IntegrationApi.md#createCouponReservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
[**createReferral**](IntegrationApi.md#createReferral) | **POST** /v1/referrals | Create a referral code for an advocate
[**deleteCouponReservation**](IntegrationApi.md#deleteCouponReservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
-[**deleteCustomerData**](IntegrationApi.md#deleteCustomerData) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
-[**getCustomerInventory**](IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
+[**deleteCustomerData**](IntegrationApi.md#deleteCustomerData) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
+[**getCustomerInventory**](IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
[**getReservedCustomers**](IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
[**trackEvent**](IntegrationApi.md#trackEvent) | **POST** /v1/events | Track an Event
[**updateCustomerProfile**](IntegrationApi.md#updateCustomerProfile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
@@ -193,7 +193,7 @@ null (empty response body)
> deleteCustomerData(integrationId)
-Delete the personal data of a customer.
+Delete the personal data of a customer
Delete all attributes on the customer profile and on entities that reference that customer profile.
@@ -248,7 +248,7 @@ null (empty response body)
> CustomerInventory getCustomerInventory(integrationId, opts)
-Get an inventory of all data associated with a specific customer profile.
+Get an inventory of all data associated with a specific customer profile
Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
@@ -391,7 +391,7 @@ integration_auth.apiKey = 'YOUR API KEY';
let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.NewEvent(); // NewEvent |
let opts = {
- 'dry': true // Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ 'dry': true // Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
};
apiInstance.trackEvent(body, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -407,7 +407,7 @@ apiInstance.trackEvent(body, opts).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**NewEvent**](NewEvent.md)| |
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
### Return type
@@ -429,7 +429,7 @@ Name | Type | Description | Notes
Update a Customer Profile V1
-⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
+⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
### Example
@@ -451,7 +451,7 @@ let apiInstance = new TalonOne.IntegrationApi();
let integrationId = "integrationId_example"; // String | The custom identifier for this profile, must be unique within the account.
let body = new TalonOne.NewCustomerProfile(); // NewCustomerProfile |
let opts = {
- 'dry': true // Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ 'dry': true // Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
};
apiInstance.updateCustomerProfile(integrationId, body, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -468,7 +468,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**integrationId** | **String**| The custom identifier for this profile, must be unique within the account. |
**body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
### Return type
@@ -540,7 +540,7 @@ null (empty response body)
Update a Customer Profile
-Update (or create) a [Customer Profile][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. [Customer Profile]: /Getting-Started/entities#customer-profile
+Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Updating a customer profile returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter.
### Example
@@ -554,11 +554,11 @@ api_key_v1.apiKey = 'YOUR API KEY';
//api_key_v1.apiKeyPrefix = 'Token';
let apiInstance = new TalonOne.IntegrationApi();
-let integrationId = "integrationId_example"; // String | The custom identifier for this profile, must be unique within the account.
+let integrationId = "integrationId_example"; // String | The custom identifier for this profile. Must be unique within the account.
let body = new TalonOne.CustomerProfileIntegrationRequestV2(); // CustomerProfileIntegrationRequestV2 |
let opts = {
- 'runRuleEngine': true, // Boolean | Flag to indicate whether to run the rule engine (Defaults to false).
- 'dry': true // Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set to 'true').
+ 'runRuleEngine': false, // Boolean | Indicates whether to run the rule engine.
+ 'dry': true // Boolean | Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`.
};
apiInstance.updateCustomerProfileV2(integrationId, body, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -573,10 +573,10 @@ apiInstance.updateCustomerProfileV2(integrationId, body, opts).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **integrationId** | **String**| The custom identifier for this profile, must be unique within the account. |
+ **integrationId** | **String**| The custom identifier for this profile. Must be unique within the account. |
**body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md)| |
- **runRuleEngine** | **Boolean**| Flag to indicate whether to run the rule engine (Defaults to false). | [optional]
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set to 'true'). | [optional]
+ **runRuleEngine** | **Boolean**| Indicates whether to run the rule engine. | [optional] [default to false]
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`. | [optional]
### Return type
@@ -598,7 +598,7 @@ Name | Type | Description | Notes
Update multiple Customer Profiles
-Update (or create) up to 1000 [Customer Profiles][] in 1 request. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. [Customer Profiles]: /Getting-Started/entities#customer-profile
+Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://developers.talon.one/Integration-API/API-Reference#updateCustomerSessionV2).
### Example
@@ -614,7 +614,7 @@ api_key_v1.apiKey = 'YOUR API KEY';
let apiInstance = new TalonOne.IntegrationApi();
let body = new TalonOne.MultipleCustomerProfileIntegrationRequest(); // MultipleCustomerProfileIntegrationRequest |
let opts = {
- 'silent': "silent_example" // String | If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated.
+ 'silent': "silent_example" // String | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
};
apiInstance.updateCustomerProfilesV2(body, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -630,7 +630,7 @@ apiInstance.updateCustomerProfilesV2(body, opts).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| |
- **silent** | **String**| If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated. | [optional]
+ **silent** | **String**| If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | [optional]
### Return type
@@ -652,7 +652,7 @@ Name | Type | Description | Notes
Update a Customer Session V1
-⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
+⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](https://developers.talon.one/Getting-Started/APIV2). Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer profile returns a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
### Example
@@ -674,7 +674,7 @@ let apiInstance = new TalonOne.IntegrationApi();
let customerSessionId = "customerSessionId_example"; // String | The custom identifier for this session, must be unique within the account.
let body = new TalonOne.NewCustomerSession(); // NewCustomerSession |
let opts = {
- 'dry': true // Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ 'dry': true // Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
};
apiInstance.updateCustomerSession(customerSessionId, body, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -691,7 +691,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customerSessionId** | **String**| The custom identifier for this session, must be unique within the account. |
**body** | [**NewCustomerSession**](NewCustomerSession.md)| |
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
### Return type
@@ -713,7 +713,7 @@ Name | Type | Description | Notes
Update a Customer Session
-Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \"responseContent\". The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
+Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer session returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
### Example
@@ -730,7 +730,7 @@ let apiInstance = new TalonOne.IntegrationApi();
let customerSessionId = "customerSessionId_example"; // String | The custom identifier for this session, must be unique within the account.
let body = new TalonOne.IntegrationRequest(); // IntegrationRequest |
let opts = {
- 'dry': true // Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ 'dry': true // Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
};
apiInstance.updateCustomerSessionV2(customerSessionId, body, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -747,7 +747,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customerSessionId** | **String**| The custom identifier for this session, must be unique within the account. |
**body** | [**IntegrationRequest**](IntegrationRequest.md)| |
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
### Return type
diff --git a/docs/IntegrationRequest.md b/docs/IntegrationRequest.md
index 5fc2a187..b0cf1b7b 100644
--- a/docs/IntegrationRequest.md
+++ b/docs/IntegrationRequest.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**customerSession** | [**NewCustomerSessionV2**](NewCustomerSessionV2.md) | |
-**responseContent** | **[String]** | Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\" and \"event\". | [optional]
+**responseContent** | **[String]** | Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\", \"event\" and \"ruleFailureReasons\". | [optional]
@@ -26,6 +26,8 @@ Name | Type | Description | Notes
* `event` (value: `"event"`)
+* `ruleFailureReasons` (value: `"ruleFailureReasons"`)
+
diff --git a/docs/IntegrationStateV2.md b/docs/IntegrationStateV2.md
index 21e75dc4..e4b6b055 100644
--- a/docs/IntegrationStateV2.md
+++ b/docs/IntegrationStateV2.md
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
**coupons** | [**[Coupon]**](Coupon.md) | | [optional]
**triggeredCampaigns** | [**[Campaign]**](Campaign.md) | | [optional]
**effects** | [**[Effect]**](Effect.md) | |
+**ruleFailureReasons** | [**[RuleFailureReason]**](RuleFailureReason.md) | | [optional]
**createdCoupons** | [**[Coupon]**](Coupon.md) | |
**createdReferrals** | [**[Referral]**](Referral.md) | |
diff --git a/docs/LimitConfig.md b/docs/LimitConfig.md
index 3de1bcf5..824aa38a 100644
--- a/docs/LimitConfig.md
+++ b/docs/LimitConfig.md
@@ -10,23 +10,6 @@ Name | Type | Description | Notes
-## Enum: ActionEnum
-
-
-* `redeemCoupon` (value: `"redeemCoupon"`)
-
-* `redeemReferral` (value: `"redeemReferral"`)
-
-* `setDiscount` (value: `"setDiscount"`)
-
-* `createCoupon` (value: `"createCoupon"`)
-
-* `setDiscountEffect` (value: `"setDiscountEffect"`)
-
-
-
-
-
## Enum: [EntitiesEnum]
diff --git a/docs/LoyaltyProgramBalance.md b/docs/LoyaltyProgramBalance.md
index 7f56ce3d..f258f291 100644
--- a/docs/LoyaltyProgramBalance.md
+++ b/docs/LoyaltyProgramBalance.md
@@ -4,6 +4,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currentBalance** | **Number** | |
+**currentBalance** | **Number** | Sum of current active points amounts |
+**pendingBalance** | **Number** | Sum of pending points amounts |
+**expiredBalance** | **Number** | Sum of expired points amounts |
+**spentBalance** | **Number** | Sum of spent points amounts |
+**tentativeCurrentBalance** | **Number** | Sum of current active points amounts, including additions and deductions on open sessions |
diff --git a/docs/LoyaltyProgramLedgers.md b/docs/LoyaltyProgramLedgers.md
index f7c958b1..9a7c08fa 100644
--- a/docs/LoyaltyProgramLedgers.md
+++ b/docs/LoyaltyProgramLedgers.md
@@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
+**id** | **Number** | The internal ID of loyalty program |
**title** | **String** | Visible name of loyalty program |
**name** | **String** | Internal name of loyalty program |
**ledger** | [**LoyaltyProgramBalance**](LoyaltyProgramBalance.md) | |
diff --git a/docs/LoyaltySubLedger.md b/docs/LoyaltySubLedger.md
index f94ec6cd..06fc9660 100644
--- a/docs/LoyaltySubLedger.md
+++ b/docs/LoyaltySubLedger.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**total** | **Number** | ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance |
+**total** | **Number** | ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance |
**totalActivePoints** | **Number** | Total amount of currently active and available points in the customer's balance |
**totalPendingPoints** | **Number** | Total amount of pending points, which are not active yet but will become active in the future |
**totalSpentPoints** | **Number** | Total amount of points already spent by this customer |
diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md
index 2b16c1f7..6c5d8abb 100644
--- a/docs/ManagementApi.md
+++ b/docs/ManagementApi.md
@@ -10,6 +10,7 @@ Method | HTTP request | Description
[**createAttribute**](ManagementApi.md#createAttribute) | **POST** /v1/attributes | Define a new custom attribute
[**createCampaign**](ManagementApi.md#createCampaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
[**createCoupons**](ManagementApi.md#createCoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
+[**createCouponsForMultipleRecipients**](ManagementApi.md#createCouponsForMultipleRecipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create Coupons for Multiple Recipients
[**createPasswordRecoveryEmail**](ManagementApi.md#createPasswordRecoveryEmail) | **POST** /v1/password_recovery_emails | Request a password reset
[**createRuleset**](ManagementApi.md#createRuleset) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | Create a Ruleset
[**createSession**](ManagementApi.md#createSession) | **POST** /v1/sessions | Create a Session
@@ -18,6 +19,12 @@ Method | HTTP request | Description
[**deleteCoupons**](ManagementApi.md#deleteCoupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete Coupons
[**deleteReferral**](ManagementApi.md#deleteReferral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete one Referral
[**deleteRuleset**](ManagementApi.md#deleteRuleset) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Delete a Ruleset
+[**destroySession**](ManagementApi.md#destroySession) | **DELETE** /v1/sessions | Destroy a Session
+[**exportCoupons**](ManagementApi.md#exportCoupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export Coupons to a CSV file
+[**exportCustomerSessions**](ManagementApi.md#exportCustomerSessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export Customer Sessions to a CSV file
+[**exportEffects**](ManagementApi.md#exportEffects) | **GET** /v1/applications/{applicationId}/export_effects | Export triggered Effects to a CSV file
+[**exportLoyaltyBalance**](ManagementApi.md#exportLoyaltyBalance) | **GET** /v1/loyalty_programs/{programID}/export_customer_balance | Export customer loyalty balance to a CSV file
+[**exportLoyaltyLedger**](ManagementApi.md#exportLoyaltyLedger) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID}/export_log | Export a customer's loyalty ledger log to a CSV file
[**getAccessLogs**](ManagementApi.md#getAccessLogs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application (with total count)
[**getAccessLogsWithoutTotalCount**](ManagementApi.md#getAccessLogsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
[**getAccount**](ManagementApi.md#getAccount) | **GET** /v1/accounts/{accountId} | Get Account Details
@@ -25,7 +32,7 @@ Method | HTTP request | Description
[**getAdditionalCost**](ManagementApi.md#getAdditionalCost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
[**getAdditionalCosts**](ManagementApi.md#getAdditionalCosts) | **GET** /v1/additional_costs | List additional costs
[**getAllAccessLogs**](ManagementApi.md#getAllAccessLogs) | **GET** /v1/access_logs | Get all access logs
-[**getAllRoles**](ManagementApi.md#getAllRoles) | **GET** /v1/roles | Get all roles.
+[**getAllRoles**](ManagementApi.md#getAllRoles) | **GET** /v1/roles | Get all roles
[**getApplication**](ManagementApi.md#getApplication) | **GET** /v1/applications/{applicationId} | Get Application
[**getApplicationApiHealth**](ManagementApi.md#getApplicationApiHealth) | **GET** /v1/applications/{applicationId}/health_report | Get report of health of application API
[**getApplicationCustomer**](ManagementApi.md#getApplicationCustomer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
@@ -39,6 +46,7 @@ Method | HTTP request | Description
[**getApplications**](ManagementApi.md#getApplications) | **GET** /v1/applications | List Applications
[**getAttribute**](ManagementApi.md#getAttribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
[**getAttributes**](ManagementApi.md#getAttributes) | **GET** /v1/attributes | List custom attributes
+[**getAudiences**](ManagementApi.md#getAudiences) | **GET** /v1/audiences | Get all audiences
[**getCampaign**](ManagementApi.md#getCampaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
[**getCampaignAnalytics**](ManagementApi.md#getCampaignAnalytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
[**getCampaignByAttributes**](ManagementApi.md#getCampaignByAttributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
@@ -57,14 +65,13 @@ Method | HTTP request | Description
[**getCustomersByAttributes**](ManagementApi.md#getCustomersByAttributes) | **POST** /v1/customer_search/no_total | Get a list of the customer profiles that match the given attributes
[**getEventTypes**](ManagementApi.md#getEventTypes) | **GET** /v1/event_types | List Event Types
[**getExports**](ManagementApi.md#getExports) | **GET** /v1/exports | Get Exports
-[**getImports**](ManagementApi.md#getImports) | **GET** /v1/imports | Get Imports
[**getLoyaltyPoints**](ManagementApi.md#getLoyaltyPoints) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
[**getLoyaltyProgram**](ManagementApi.md#getLoyaltyProgram) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
[**getLoyaltyPrograms**](ManagementApi.md#getLoyaltyPrograms) | **GET** /v1/loyalty_programs | List all loyalty Programs
[**getLoyaltyStatistics**](ManagementApi.md#getLoyaltyStatistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
[**getReferrals**](ManagementApi.md#getReferrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
[**getReferralsWithoutTotalCount**](ManagementApi.md#getReferralsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
-[**getRole**](ManagementApi.md#getRole) | **GET** /v1/roles/{roleId} | Get information for the specified role.
+[**getRole**](ManagementApi.md#getRole) | **GET** /v1/roles/{roleId} | Get information for the specified role
[**getRuleset**](ManagementApi.md#getRuleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
[**getRulesets**](ManagementApi.md#getRulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List Campaign Rulesets
[**getUser**](ManagementApi.md#getUser) | **GET** /v1/users/{userId} | Get a single User
@@ -402,6 +409,64 @@ Name | Type | Description | Notes
- **Accept**: application/json
+## createCouponsForMultipleRecipients
+
+> InlineResponse2004 createCouponsForMultipleRecipients(applicationId, campaignId, body, opts)
+
+Create Coupons for Multiple Recipients
+
+Create coupons according to some pattern for up to 1000 recipients.
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+let applicationId = 56; // Number |
+let campaignId = 56; // Number |
+let body = new TalonOne.NewCouponsForMultipleRecipients(); // NewCouponsForMultipleRecipients |
+let opts = {
+ 'silent': "silent_example" // String | If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
+};
+apiInstance.createCouponsForMultipleRecipients(applicationId, campaignId, body, opts).then((data) => {
+ console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **applicationId** | **Number**| |
+ **campaignId** | **Number**| |
+ **body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md)| |
+ **silent** | **String**| If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000). | [optional]
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
## createPasswordRecoveryEmail
> NewPasswordEmail createPasswordRecoveryEmail(body)
@@ -676,12 +741,12 @@ let applicationId = 56; // Number |
let campaignId = 56; // Number |
let opts = {
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'startsAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'startsBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'expiresAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'expiresBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'startsAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'startsBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'expiresAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'expiresBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'batchId': "batchId_example", // String | Filter results by batches of coupons
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
@@ -705,12 +770,12 @@ Name | Type | Description | Notes
**applicationId** | **Number**| |
**campaignId** | **Number**| |
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **startsAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **startsBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **expiresAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **expiresBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **startsAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **startsBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **expiresAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **expiresBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**batchId** | **String**| Filter results by batches of coupons | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
@@ -836,6 +901,360 @@ null (empty response body)
- **Accept**: Not defined
+## destroySession
+
+> destroySession()
+
+Destroy a Session
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+apiInstance.destroySession().then(() => {
+ console.log('API called successfully.');
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## exportCoupons
+
+> String exportCoupons(applicationId, opts)
+
+Export Coupons to a CSV file
+
+Download a file with the coupons that match the given attributes.
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+let applicationId = 56; // Number |
+let opts = {
+ 'campaignId': 3.4, // Number | Filter results by campaign.
+ 'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ 'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ 'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ 'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ 'recipientIntegrationId': "recipientIntegrationId_example", // String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ 'batchId': "batchId_example", // String | Filter results by batches of coupons
+ 'exactMatch': false, // Boolean | Filter results to an exact case-insensitive matching against the coupon code
+ 'dateFormat': "dateFormat_example", // String | Determines the format of dates in the export document.
+ 'campaignState': "campaignState_example" // String | Filter results by the state of the campaign.
+};
+apiInstance.exportCoupons(applicationId, opts).then((data) => {
+ console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **applicationId** | **Number**| |
+ **campaignId** | **Number**| Filter results by campaign. | [optional]
+ **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
+ **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
+ **usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
+ **referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
+ **recipientIntegrationId** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
+ **batchId** | **String**| Filter results by batches of coupons | [optional]
+ **exactMatch** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional]
+ **campaignState** | **String**| Filter results by the state of the campaign. | [optional]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/csv
+
+
+## exportCustomerSessions
+
+> String exportCustomerSessions(applicationId, opts)
+
+Export Customer Sessions to a CSV file
+
+Download a file with the customer sessions that match the request.
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+let applicationId = 56; // Number |
+let opts = {
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ 'profileIntegrationId': "profileIntegrationId_example", // String | Only return sessions for the customer that matches this customer integration ID.
+ 'dateFormat': "dateFormat_example", // String | Determines the format of dates in the export document.
+ 'customerSessionState': "customerSessionState_example" // String | Filter results by state.
+};
+apiInstance.exportCustomerSessions(applicationId, opts).then((data) => {
+ console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **applicationId** | **Number**| |
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
+ **profileIntegrationId** | **String**| Only return sessions for the customer that matches this customer integration ID. | [optional]
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional]
+ **customerSessionState** | **String**| Filter results by state. | [optional]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/csv
+
+
+## exportEffects
+
+> String exportEffects(applicationId, opts)
+
+Export triggered Effects to a CSV file
+
+Download a file with the triggered effects that match the given attributes.
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+let applicationId = 56; // Number |
+let opts = {
+ 'campaignId': 3.4, // Number | Filter results by campaign.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'dateFormat': "dateFormat_example" // String | Determines the format of dates in the export document.
+};
+apiInstance.exportEffects(applicationId, opts).then((data) => {
+ console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **applicationId** | **Number**| |
+ **campaignId** | **Number**| Filter results by campaign. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/csv
+
+
+## exportLoyaltyBalance
+
+> String exportLoyaltyBalance(programID)
+
+Export customer loyalty balance to a CSV file
+
+Download a file with the balance of each customer in the loyalty program
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+let programID = "programID_example"; // String |
+apiInstance.exportLoyaltyBalance(programID).then((data) => {
+ console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **programID** | **String**| |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/csv
+
+
+## exportLoyaltyLedger
+
+> String exportLoyaltyLedger(rangeStart, rangeEnd, programID, integrationID, opts)
+
+Export a customer's loyalty ledger log to a CSV file
+
+Download a file with a customer's ledger log in the loyalty program
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+let rangeStart = new Date("2013-10-20T19:20:30+01:00"); // Date | Only return results from after this timestamp, must be an RFC3339 timestamp string
+let rangeEnd = new Date("2013-10-20T19:20:30+01:00"); // Date | Only return results from before this timestamp, must be an RFC3339 timestamp string
+let programID = "programID_example"; // String |
+let integrationID = "integrationID_example"; // String |
+let opts = {
+ 'dateFormat': "dateFormat_example" // String | Determines the format of dates in the export document.
+};
+apiInstance.exportLoyaltyLedger(rangeStart, rangeEnd, programID, integrationID, opts).then((data) => {
+ console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **rangeStart** | **Date**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
+ **rangeEnd** | **Date**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
+ **programID** | **String**| |
+ **integrationID** | **String**| |
+ **dateFormat** | **String**| Determines the format of dates in the export document. | [optional]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/csv
+
+
## getAccessLogs
> InlineResponse2009 getAccessLogs(applicationId, rangeStart, rangeEnd, opts)
@@ -1120,7 +1539,7 @@ Name | Type | Description | Notes
## getAdditionalCosts
-> InlineResponse20021 getAdditionalCosts(opts)
+> InlineResponse20022 getAdditionalCosts(opts)
List additional costs
@@ -1162,7 +1581,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20021**](InlineResponse20021.md)
+[**InlineResponse20022**](InlineResponse20022.md)
### Authorization
@@ -1244,7 +1663,7 @@ Name | Type | Description | Notes
> InlineResponse20030 getAllRoles()
-Get all roles.
+Get all roles
### Example
@@ -1624,8 +2043,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'type': "type_example", // String | Comma-separated list of types by which to filter events. Must be exact match(es).
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created after this date
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
'session': "session_example", // String | Session integration ID filter for events. Must be exact match.
'profile': "profile_example", // String | Profile integration ID filter for events. Must be exact match.
'customerName': "customerName_example", // String | Customer name filter for events. Will match substrings case-insensitively.
@@ -1653,8 +2072,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
- **createdBefore** | **Date**| Only return events created before this date | [optional]
- **createdAfter** | **Date**| Only return events created after this date | [optional]
+ **createdBefore** | **Date**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**session** | **String**| Session integration ID filter for events. Must be exact match. | [optional]
**profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
**customerName** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
@@ -1704,8 +2123,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'type': "type_example", // String | Comma-separated list of types by which to filter events. Must be exact match(es).
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created after this date
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
'session': "session_example", // String | Session integration ID filter for events. Must be exact match.
'profile': "profile_example", // String | Profile integration ID filter for events. Must be exact match.
'customerName': "customerName_example", // String | Customer name filter for events. Will match substrings case-insensitively.
@@ -1733,8 +2152,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
- **createdBefore** | **Date**| Only return events created before this date | [optional]
- **createdAfter** | **Date**| Only return events created after this date | [optional]
+ **createdBefore** | **Date**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**session** | **String**| Session integration ID filter for events. Must be exact match. | [optional]
**profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
**customerName** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
@@ -1833,8 +2252,8 @@ let opts = {
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'profile': "profile_example", // String | Profile integration ID filter for sessions. Must be exact match.
'state': "state_example", // String | Filter by sessions with this state. Must be exact match.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created after this date
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
'coupon': "coupon_example", // String | Filter by sessions with this coupon. Must be exact match.
'referral': "referral_example", // String | Filter by sessions with this referral. Must be exact match.
'integrationId': "integrationId_example" // String | Filter by sessions with this integrationId. Must be exact match.
@@ -1858,8 +2277,8 @@ Name | Type | Description | Notes
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
**state** | **String**| Filter by sessions with this state. Must be exact match. | [optional]
- **createdBefore** | **Date**| Only return events created before this date | [optional]
- **createdAfter** | **Date**| Only return events created after this date | [optional]
+ **createdBefore** | **Date**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional]
**referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional]
**integrationId** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional]
@@ -1986,7 +2405,7 @@ Name | Type | Description | Notes
## getAttributes
-> InlineResponse20020 getAttributes(opts)
+> InlineResponse20021 getAttributes(opts)
List custom attributes
@@ -2028,6 +2447,64 @@ Name | Type | Description | Notes
### Return type
+[**InlineResponse20021**](InlineResponse20021.md)
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## getAudiences
+
+> InlineResponse20020 getAudiences(opts)
+
+Get all audiences
+
+Get All audiences created in the account.
+
+### Example
+
+```javascript
+import TalonOne from 'talon_one';
+let defaultClient = TalonOne.ApiClient.instance;
+// Configure API key authorization: manager_auth
+let manager_auth = defaultClient.authentications['manager_auth'];
+manager_auth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//manager_auth.apiKeyPrefix = 'Token';
+
+let apiInstance = new TalonOne.ManagementApi();
+let opts = {
+ 'pageSize': 56, // Number | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ 'skip': 56, // Number | Skips the given number of items when paging through large result sets.
+ 'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ 'withTotalResultSize': true // Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
+};
+apiInstance.getAudiences(opts).then((data) => {
+ console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+ console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **pageSize** | **Number**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
+ **skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
+ **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
+ **withTotalResultSize** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. | [optional]
+
+### Return type
+
[**InlineResponse20020**](InlineResponse20020.md)
### Authorization
@@ -2236,8 +2713,8 @@ let opts = {
'campaignState': "campaignState_example", // String | Filter results by the state of the campaign.
'name': "name_example", // String | Filter results performing case-insensitive matching against the name of the campaign.
'tags': "tags_example", // String | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'campaignGroupId': 56 // Number | Filter results to campaigns owned by the specified campaign group ID.
};
apiInstance.getCampaigns(applicationId, opts).then((data) => {
@@ -2260,8 +2737,8 @@ Name | Type | Description | Notes
**campaignState** | **String**| Filter results by the state of the campaign. | [optional]
**name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
**tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**campaignGroupId** | **Number**| Filter results to campaigns owned by the specified campaign group ID. | [optional]
### Return type
@@ -2280,7 +2757,7 @@ Name | Type | Description | Notes
## getChanges
-> InlineResponse20027 getChanges(opts)
+> InlineResponse20028 getChanges(opts)
Get audit log for an account
@@ -2303,8 +2780,10 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'applicationId': 56, // Number |
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
+ 'entityPath': "entityPath_example", // String | Filter results on a case insensitive matching of the url path of the entity
+ 'userId': 56, // Number |
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'withTotalResultSize': true, // Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
'includeOld': true // Boolean | When this flag is set to false, the state without the change will not be returned. The default value is true.
};
@@ -2325,14 +2804,16 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**applicationId** | **Number**| | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
+ **entityPath** | **String**| Filter results on a case insensitive matching of the url path of the entity | [optional]
+ **userId** | **Number**| | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**withTotalResultSize** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. | [optional]
**includeOld** | **Boolean**| When this flag is set to false, the state without the change will not be returned. The default value is true. | [optional]
### Return type
-[**InlineResponse20027**](InlineResponse20027.md)
+[**InlineResponse20028**](InlineResponse20028.md)
### Authorization
@@ -2369,12 +2850,12 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'startsAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'startsBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'expiresAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'expiresBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'startsAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'startsBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'expiresAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'expiresBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'batchId': "batchId_example", // String | Filter results by batches of coupons
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
@@ -2401,12 +2882,12 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **startsAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **startsBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **expiresAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **expiresBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **startsAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **startsBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **expiresAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **expiresBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**batchId** | **String**| Filter results by batches of coupons | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
@@ -2456,8 +2937,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -2485,8 +2966,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
**referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
@@ -2535,8 +3016,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -2564,8 +3045,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
**referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
@@ -2613,8 +3094,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -2641,8 +3122,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
**referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
@@ -3084,7 +3565,7 @@ Name | Type | Description | Notes
## getEventTypes
-> InlineResponse20025 getEventTypes(opts)
+> InlineResponse20026 getEventTypes(opts)
List Event Types
@@ -3132,7 +3613,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20025**](InlineResponse20025.md)
+[**InlineResponse20026**](InlineResponse20026.md)
### Authorization
@@ -3146,7 +3627,7 @@ Name | Type | Description | Notes
## getExports
-> InlineResponse20028 getExports(opts)
+> InlineResponse20029 getExports(opts)
Get Exports
@@ -3192,60 +3673,6 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20028**](InlineResponse20028.md)
-
-### Authorization
-
-[manager_auth](../README.md#manager_auth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getImports
-
-> InlineResponse20029 getImports(opts)
-
-Get Imports
-
-Get a list of all past imports
-
-### Example
-
-```javascript
-import TalonOne from 'talon_one';
-let defaultClient = TalonOne.ApiClient.instance;
-// Configure API key authorization: manager_auth
-let manager_auth = defaultClient.authentications['manager_auth'];
-manager_auth.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//manager_auth.apiKeyPrefix = 'Token';
-
-let apiInstance = new TalonOne.ManagementApi();
-let opts = {
- 'pageSize': 56, // Number | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- 'skip': 56 // Number | Skips the given number of items when paging through large result sets.
-};
-apiInstance.getImports(opts).then((data) => {
- console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
- console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **pageSize** | **Number**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
- **skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
-
-### Return type
-
[**InlineResponse20029**](InlineResponse20029.md)
### Authorization
@@ -3475,8 +3902,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'code': "code_example", // String | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
'advocate': "advocate_example" // String | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
@@ -3500,8 +3927,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**code** | **String**| Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. | [optional]
**advocate** | **String**| Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field | [optional]
@@ -3545,8 +3972,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'code': "code_example", // String | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
'advocate': "advocate_example" // String | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
@@ -3570,8 +3997,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**code** | **String**| Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. | [optional]
**advocate** | **String**| Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field | [optional]
@@ -3594,7 +4021,7 @@ Name | Type | Description | Notes
> Role getRole(roleId)
-Get information for the specified role.
+Get information for the specified role
### Example
@@ -3800,7 +4227,7 @@ Name | Type | Description | Notes
## getUsers
-> InlineResponse20026 getUsers(opts)
+> InlineResponse20027 getUsers(opts)
List Users in your account
@@ -3842,7 +4269,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20026**](InlineResponse20026.md)
+[**InlineResponse20027**](InlineResponse20027.md)
### Authorization
@@ -3906,7 +4333,7 @@ Name | Type | Description | Notes
## getWebhookActivationLogs
-> InlineResponse20023 getWebhookActivationLogs(opts)
+> InlineResponse20024 getWebhookActivationLogs(opts)
List Webhook activation Log Entries
@@ -3932,8 +4359,8 @@ let opts = {
'webhookId': 3.4, // Number | Filter results by Webhook.
'applicationId': 3.4, // Number |
'campaignId': 3.4, // Number | Filter results by campaign.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00") // Date | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00") // Date | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
};
apiInstance.getWebhookActivationLogs(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -3955,12 +4382,12 @@ Name | Type | Description | Notes
**webhookId** | **Number**| Filter results by Webhook. | [optional]
**applicationId** | **Number**| | [optional]
**campaignId** | **Number**| Filter results by campaign. | [optional]
- **createdBefore** | **Date**| Only return events created before this date. | [optional]
- **createdAfter** | **Date**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. | [optional]
+ **createdBefore** | **Date**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
### Return type
-[**InlineResponse20023**](InlineResponse20023.md)
+[**InlineResponse20024**](InlineResponse20024.md)
### Authorization
@@ -3974,7 +4401,7 @@ Name | Type | Description | Notes
## getWebhookLogs
-> InlineResponse20024 getWebhookLogs(opts)
+> InlineResponse20025 getWebhookLogs(opts)
List Webhook Log Entries
@@ -3999,8 +4426,8 @@ let opts = {
'applicationId': 3.4, // Number |
'campaignId': 3.4, // Number | Filter results by campaign.
'requestUuid': "requestUuid_example", // String | Filter results by request UUID.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00") // Date | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00") // Date | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
};
apiInstance.getWebhookLogs(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
@@ -4023,12 +4450,12 @@ Name | Type | Description | Notes
**applicationId** | **Number**| | [optional]
**campaignId** | **Number**| Filter results by campaign. | [optional]
**requestUuid** | **String**| Filter results by request UUID. | [optional]
- **createdBefore** | **Date**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. | [optional]
- **createdAfter** | **Date**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. | [optional]
+ **createdBefore** | **Date**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
### Return type
-[**InlineResponse20024**](InlineResponse20024.md)
+[**InlineResponse20025**](InlineResponse20025.md)
### Authorization
@@ -4042,7 +4469,7 @@ Name | Type | Description | Notes
## getWebhooks
-> InlineResponse20022 getWebhooks(opts)
+> InlineResponse20023 getWebhooks(opts)
List Webhooks
@@ -4084,7 +4511,7 @@ Name | Type | Description | Notes
### Return type
-[**InlineResponse20022**](InlineResponse20022.md)
+[**InlineResponse20023**](InlineResponse20023.md)
### Authorization
@@ -4226,8 +4653,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -4255,8 +4682,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
**referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
@@ -4305,8 +4732,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -4334,8 +4761,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
**referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
@@ -4385,8 +4812,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -4414,8 +4841,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
**referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
@@ -4466,8 +4893,8 @@ let opts = {
'skip': 56, // Number | Skips the given number of items when paging through large result sets.
'sort': "sort_example", // String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
'value': "value_example", // String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
+ 'createdBefore': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ 'createdAfter': new Date("2013-10-20T19:20:30+01:00"), // Date | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
'valid': "valid_example", // String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
'usable': "usable_example", // String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
'referralId': 56, // Number | Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -4495,8 +4922,8 @@ Name | Type | Description | Notes
**skip** | **Number**| Skips the given number of items when paging through large result sets. | [optional]
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
- **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
- **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
+ **createdBefore** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
+ **createdAfter** | **Date**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
**referralId** | **Number**| Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code. | [optional]
diff --git a/docs/ModelImport.md b/docs/ModelImport.md
index 163c5a0f..234583fc 100644
--- a/docs/ModelImport.md
+++ b/docs/ModelImport.md
@@ -8,16 +8,7 @@ Name | Type | Description | Notes
**created** | **Date** | The exact moment this entity was created. |
**accountId** | **Number** | The ID of the account that owns this entity. |
**userId** | **Number** | The ID of the account that owns this entity. |
-**entity** | **String** | The name of the entity that was imported. |
+**entity** | **String** | The name of the entity that was imported. Possible values are Coupons and LoyaltyPoints. |
**amount** | **Number** | The number of members that imported. |
-
-## Enum: EntityEnum
-
-
-* `Coupon` (value: `"Coupon"`)
-
-
-
-
diff --git a/docs/NewApplication.md b/docs/NewApplication.md
index 15ccf574..6a7db40d 100644
--- a/docs/NewApplication.md
+++ b/docs/NewApplication.md
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
**limits** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
**campaignPriority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional]
**exclusiveCampaignsStrategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional]
+**defaultDiscountScope** | **String** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional]
**enableCascadingDiscounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional]
**enableFlattenedCartItems** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional]
**attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
@@ -59,3 +60,16 @@ Name | Type | Description | Notes
+
+## Enum: DefaultDiscountScopeEnum
+
+
+* `sessionTotal` (value: `"sessionTotal"`)
+
+* `cartItems` (value: `"cartItems"`)
+
+* `additionalCosts` (value: `"additionalCosts"`)
+
+
+
+
diff --git a/docs/NewApplicationAPIKey.md b/docs/NewApplicationAPIKey.md
index 0cc4d968..24a2db0d 100644
--- a/docs/NewApplicationAPIKey.md
+++ b/docs/NewApplicationAPIKey.md
@@ -27,6 +27,8 @@ Name | Type | Description | Notes
* `mparticle` (value: `"mparticle"`)
+* `selligent` (value: `"selligent"`)
+
diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md
index 2abbda51..717702b9 100644
--- a/docs/NewCoupons.md
+++ b/docs/NewCoupons.md
@@ -8,11 +8,11 @@ Name | Type | Description | Notes
**discountLimit** | **Number** | The amount of discounts that can be given with this coupon code. | [optional]
**startDate** | **Date** | Timestamp at which point the coupon becomes valid. | [optional]
**expiryDate** | **Date** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
-**validCharacters** | **[String]** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). |
-**couponPattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. |
**numberOfCoupons** | **Number** | The number of new coupon codes to generate for the campaign. Must be at least 1. |
**uniquePrefix** | **String** | A unique prefix to prepend to all generated coupons. | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
**recipientIntegrationId** | **String** | The integration ID for this coupon's beneficiary's profile | [optional]
+**validCharacters** | **[String]** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional]
+**couponPattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. | [optional]
diff --git a/docs/NewCouponsForMultipleRecipients.md b/docs/NewCouponsForMultipleRecipients.md
new file mode 100644
index 00000000..1fe5004b
--- /dev/null
+++ b/docs/NewCouponsForMultipleRecipients.md
@@ -0,0 +1,16 @@
+# TalonOne.NewCouponsForMultipleRecipients
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usageLimit** | **Number** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. |
+**discountLimit** | **Number** | The amount of discounts that can be given with this coupon code. | [optional]
+**startDate** | **Date** | Timestamp at which point the coupon becomes valid. | [optional]
+**expiryDate** | **Date** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
+**recipientsIntegrationIds** | **[String]** | The integration IDs for recipients |
+**validCharacters** | **[String]** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional]
+**couponPattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. | [optional]
+
+
diff --git a/docs/ProfileAudiencesChanges.md b/docs/ProfileAudiencesChanges.md
new file mode 100644
index 00000000..44061f5c
--- /dev/null
+++ b/docs/ProfileAudiencesChanges.md
@@ -0,0 +1,10 @@
+# TalonOne.ProfileAudiencesChanges
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adds** | **[Number]** | The IDs of the audiences for the customer to join. |
+**deletes** | **[Number]** | The IDs of the audiences for the customer to leave. |
+
+
diff --git a/docs/RejectCouponEffectProps.md b/docs/RejectCouponEffectProps.md
index 2f2624f1..95180218 100644
--- a/docs/RejectCouponEffectProps.md
+++ b/docs/RejectCouponEffectProps.md
@@ -6,5 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **String** | The coupon code that was rejected |
**rejectionReason** | **String** | The reason why this coupon was rejected |
+**conditionIndex** | **Number** | The index of the condition that caused the rejection of the coupon | [optional]
+**effectIndex** | **Number** | The index of the effect that caused the rejection of the coupon | [optional]
+**details** | **String** | More details about the failure | [optional]
diff --git a/docs/RejectReferralEffectProps.md b/docs/RejectReferralEffectProps.md
index 70bcbe6f..a7fbb6b1 100644
--- a/docs/RejectReferralEffectProps.md
+++ b/docs/RejectReferralEffectProps.md
@@ -6,5 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **String** | The referral code that was rejected |
**rejectionReason** | **String** | The reason why this referral code was rejected |
+**conditionIndex** | **Number** | The index of the condition that caused the rejection of the referral | [optional]
+**effectIndex** | **Number** | The index of the effect that caused the rejection of the referral | [optional]
+**details** | **String** | More details about the failure | [optional]
diff --git a/docs/RollbackAddedLoyaltyPointsEffectProps.md b/docs/RollbackAddedLoyaltyPointsEffectProps.md
new file mode 100644
index 00000000..f5d4823d
--- /dev/null
+++ b/docs/RollbackAddedLoyaltyPointsEffectProps.md
@@ -0,0 +1,13 @@
+# TalonOne.RollbackAddedLoyaltyPointsEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**programId** | **Number** | The ID of the loyalty program where the points were originally added |
+**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were originally added |
+**value** | **Number** | The amount of points that were rolled back |
+**recipientIntegrationId** | **String** | The user for whom these points were originally added |
+**transactionUUID** | **String** | The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. |
+
+
diff --git a/docs/RollbackDeductedLoyaltyPointsEffectProps.md b/docs/RollbackDeductedLoyaltyPointsEffectProps.md
new file mode 100644
index 00000000..697ec5f5
--- /dev/null
+++ b/docs/RollbackDeductedLoyaltyPointsEffectProps.md
@@ -0,0 +1,15 @@
+# TalonOne.RollbackDeductedLoyaltyPointsEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**programId** | **Number** | The ID of the loyalty program where these points were reimbursed |
+**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were reimbursed |
+**value** | **Number** | The amount of reimbursed points that were added |
+**recipientIntegrationId** | **String** | The user for whom these points were reimbursed |
+**startDate** | **Date** | Date after which the reimbursed points will be valid | [optional]
+**expiryDate** | **Date** | Date after which the reimbursed points will expire | [optional]
+**transactionUUID** | **String** | The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back |
+
+
diff --git a/docs/RollbackReferralEffectProps.md b/docs/RollbackReferralEffectProps.md
new file mode 100644
index 00000000..4fc0d4b1
--- /dev/null
+++ b/docs/RollbackReferralEffectProps.md
@@ -0,0 +1,9 @@
+# TalonOne.RollbackReferralEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The referral code whose usage has been rolled back |
+
+
diff --git a/docs/RuleFailureReason.md b/docs/RuleFailureReason.md
new file mode 100644
index 00000000..a0d5ad8f
--- /dev/null
+++ b/docs/RuleFailureReason.md
@@ -0,0 +1,20 @@
+# TalonOne.RuleFailureReason
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaignID** | **Number** | The ID of the campaign that contains the rule that failed |
+**campaignName** | **String** | The name of the campaign that contains the rule that failed |
+**rulesetID** | **Number** | The ID of the ruleset that contains the rule that failed |
+**couponID** | **Number** | The ID of the coupon that was being evaluated at the time of the rule failure | [optional]
+**couponValue** | **String** | The value of the coupon that was being evaluated at the time of the rule failure | [optional]
+**referralID** | **Number** | The ID of the referral that was being evaluated at the time of the rule failure | [optional]
+**referralValue** | **String** | The value of the referral that was being evaluated at the time of the rule failure | [optional]
+**ruleIndex** | **Number** | The index of the rule that failed within the ruleset |
+**ruleName** | **String** | The name of the rule that failed within the ruleset |
+**conditionIndex** | **Number** | The index of the condition that failed | [optional]
+**effectIndex** | **Number** | The index of the effect that failed | [optional]
+**details** | **String** | More details about the failure | [optional]
+
+
diff --git a/docs/UpdateApplication.md b/docs/UpdateApplication.md
index dd62754c..9e468ba2 100644
--- a/docs/UpdateApplication.md
+++ b/docs/UpdateApplication.md
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
**limits** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
**campaignPriority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional]
**exclusiveCampaignsStrategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional]
+**defaultDiscountScope** | **String** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional]
**enableCascadingDiscounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional]
**enableFlattenedCartItems** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional]
**attributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
@@ -58,3 +59,16 @@ Name | Type | Description | Notes
+
+## Enum: DefaultDiscountScopeEnum
+
+
+* `sessionTotal` (value: `"sessionTotal"`)
+
+* `cartItems` (value: `"cartItems"`)
+
+* `additionalCosts` (value: `"additionalCosts"`)
+
+
+
+
diff --git a/package.json b/package.json
index 38d6ce17..ccd7c8ae 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "talon_one",
- "version": "4.2.0",
+ "version": "4.3.0",
"description": "Talon.One API SDK for Javascript",
"homepage": "https://developers.talon.one/SDKs/JavaScript",
"author": {
diff --git a/src/ApiClient.js b/src/ApiClient.js
index 205d2fd2..39c19f3d 100644
--- a/src/ApiClient.js
+++ b/src/ApiClient.js
@@ -17,7 +17,7 @@ import querystring from "querystring";
/**
* @module ApiClient
-* @version 4.2.0
+* @version 4.3.0
*/
/**
@@ -399,8 +399,6 @@ class ApiClient {
if(contentType != 'multipart/form-data') {
request.type(contentType);
}
- } else if (!request.header['Content-Type']) {
- request.type('application/json');
}
if (contentType === 'application/x-www-form-urlencoded') {
@@ -418,6 +416,9 @@ class ApiClient {
}
}
} else if (bodyParam !== null && bodyParam !== undefined) {
+ if (!request.header['Content-Type']) {
+ request.type('application/json');
+ }
request.send(bodyParam);
}
diff --git a/src/api/IntegrationApi.js b/src/api/IntegrationApi.js
index 7ded21ca..e64d4b89 100644
--- a/src/api/IntegrationApi.js
+++ b/src/api/IntegrationApi.js
@@ -33,7 +33,7 @@ import Referral from '../model/Referral';
/**
* Integration service.
* @module api/IntegrationApi
-* @version 4.2.0
+* @version 4.3.0
*/
export default class IntegrationApi {
@@ -206,7 +206,7 @@ export default class IntegrationApi {
/**
- * Delete the personal data of a customer.
+ * Delete the personal data of a customer
* Delete all attributes on the customer profile and on entities that reference that customer profile.
* @param {String} integrationId The custom identifier for this profile, must be unique within the account.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
@@ -240,7 +240,7 @@ export default class IntegrationApi {
}
/**
- * Delete the personal data of a customer.
+ * Delete the personal data of a customer
* Delete all attributes on the customer profile and on entities that reference that customer profile.
* @param {String} integrationId The custom identifier for this profile, must be unique within the account.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
@@ -254,14 +254,14 @@ export default class IntegrationApi {
/**
- * Get an inventory of all data associated with a specific customer profile.
+ * Get an inventory of all data associated with a specific customer profile
* Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
* @param {String} integrationId The custom identifier for this profile, must be unique within the account.
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.profile optional flag to decide if you would like customer profile information in the response
- * @param {Boolean} opts.referrals optional flag to decide if you would like referral information in the response
- * @param {Boolean} opts.coupons optional flag to decide if you would like coupon information in the response
- * @param {Boolean} opts.loyalty optional flag to decide if you would like loyalty information in the response
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.profile] optional flag to decide if you would like customer profile information in the response
+ * @param {Boolean=} [opts.referrals] optional flag to decide if you would like referral information in the response
+ * @param {Boolean=} [opts.coupons] optional flag to decide if you would like coupon information in the response
+ * @param {Boolean=} [opts.loyalty] optional flag to decide if you would like loyalty information in the response
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CustomerInventory} and HTTP response
*/
getCustomerInventoryWithHttpInfo(integrationId, opts) {
@@ -298,14 +298,14 @@ export default class IntegrationApi {
}
/**
- * Get an inventory of all data associated with a specific customer profile.
+ * Get an inventory of all data associated with a specific customer profile
* Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
* @param {String} integrationId The custom identifier for this profile, must be unique within the account.
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.profile optional flag to decide if you would like customer profile information in the response
- * @param {Boolean} opts.referrals optional flag to decide if you would like referral information in the response
- * @param {Boolean} opts.coupons optional flag to decide if you would like coupon information in the response
- * @param {Boolean} opts.loyalty optional flag to decide if you would like loyalty information in the response
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.profile] optional flag to decide if you would like customer profile information in the response
+ * @param {Boolean=} [opts.referrals] optional flag to decide if you would like referral information in the response
+ * @param {Boolean=} [opts.coupons] optional flag to decide if you would like coupon information in the response
+ * @param {Boolean=} [opts.loyalty] optional flag to decide if you would like loyalty information in the response
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomerInventory}
*/
getCustomerInventory(integrationId, opts) {
@@ -368,8 +368,8 @@ export default class IntegrationApi {
* Track an Event
* Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
* @param {module:model/NewEvent} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationState} and HTTP response
*/
trackEventWithHttpInfo(body, opts) {
@@ -405,8 +405,8 @@ export default class IntegrationApi {
* Track an Event
* Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
* @param {module:model/NewEvent} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationState}
*/
trackEvent(body, opts) {
@@ -419,11 +419,11 @@ export default class IntegrationApi {
/**
* Update a Customer Profile V1
- * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
+ * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
* @param {String} integrationId The custom identifier for this profile, must be unique within the account.
* @param {module:model/NewCustomerProfile} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationState} and HTTP response
*/
updateCustomerProfileWithHttpInfo(integrationId, body, opts) {
@@ -462,11 +462,11 @@ export default class IntegrationApi {
/**
* Update a Customer Profile V1
- * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
+ * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
* @param {String} integrationId The custom identifier for this profile, must be unique within the account.
* @param {module:model/NewCustomerProfile} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationState}
*/
updateCustomerProfile(integrationId, body, opts) {
@@ -526,12 +526,12 @@ export default class IntegrationApi {
/**
* Update a Customer Profile
- * Update (or create) a [Customer Profile][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. [Customer Profile]: /Getting-Started/entities#customer-profile
- * @param {String} integrationId The custom identifier for this profile, must be unique within the account.
+ * Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Updating a customer profile returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter.
+ * @param {String} integrationId The custom identifier for this profile. Must be unique within the account.
* @param {module:model/CustomerProfileIntegrationRequestV2} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.runRuleEngine Flag to indicate whether to run the rule engine (Defaults to false).
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.runRuleEngine] Indicates whether to run the rule engine. (default to false)
+ * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationStateV2} and HTTP response
*/
updateCustomerProfileV2WithHttpInfo(integrationId, body, opts) {
@@ -571,12 +571,12 @@ export default class IntegrationApi {
/**
* Update a Customer Profile
- * Update (or create) a [Customer Profile][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. [Customer Profile]: /Getting-Started/entities#customer-profile
- * @param {String} integrationId The custom identifier for this profile, must be unique within the account.
+ * Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Updating a customer profile returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter.
+ * @param {String} integrationId The custom identifier for this profile. Must be unique within the account.
* @param {module:model/CustomerProfileIntegrationRequestV2} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.runRuleEngine Flag to indicate whether to run the rule engine (Defaults to false).
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.runRuleEngine] Indicates whether to run the rule engine. (default to false)
+ * @param {Boolean=} [opts.dry] Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationStateV2}
*/
updateCustomerProfileV2(integrationId, body, opts) {
@@ -589,10 +589,10 @@ export default class IntegrationApi {
/**
* Update multiple Customer Profiles
- * Update (or create) up to 1000 [Customer Profiles][] in 1 request. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. [Customer Profiles]: /Getting-Started/entities#customer-profile
+ * Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://developers.talon.one/Integration-API/API-Reference#updateCustomerSessionV2).
* @param {module:model/MultipleCustomerProfileIntegrationRequest} body
- * @param {Object} opts Optional parameters
- * @param {String} opts.silent If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.silent] If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MultipleCustomerProfileIntegrationResponseV2} and HTTP response
*/
updateCustomerProfilesV2WithHttpInfo(body, opts) {
@@ -626,10 +626,10 @@ export default class IntegrationApi {
/**
* Update multiple Customer Profiles
- * Update (or create) up to 1000 [Customer Profiles][] in 1 request. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. [Customer Profiles]: /Getting-Started/entities#customer-profile
+ * Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://developers.talon.one/Integration-API/API-Reference#updateCustomerSessionV2).
* @param {module:model/MultipleCustomerProfileIntegrationRequest} body
- * @param {Object} opts Optional parameters
- * @param {String} opts.silent If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.silent] If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MultipleCustomerProfileIntegrationResponseV2}
*/
updateCustomerProfilesV2(body, opts) {
@@ -642,11 +642,11 @@ export default class IntegrationApi {
/**
* Update a Customer Session V1
- * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
+ * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](https://developers.talon.one/Getting-Started/APIV2). Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer profile returns a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
* @param {String} customerSessionId The custom identifier for this session, must be unique within the account.
* @param {module:model/NewCustomerSession} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationState} and HTTP response
*/
updateCustomerSessionWithHttpInfo(customerSessionId, body, opts) {
@@ -685,11 +685,11 @@ export default class IntegrationApi {
/**
* Update a Customer Session V1
- * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
+ * ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](https://developers.talon.one/Getting-Started/APIV2). Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer profile returns a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
* @param {String} customerSessionId The custom identifier for this session, must be unique within the account.
* @param {module:model/NewCustomerSession} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationState}
*/
updateCustomerSession(customerSessionId, body, opts) {
@@ -702,11 +702,11 @@ export default class IntegrationApi {
/**
* Update a Customer Session
- * Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \"responseContent\". The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
+ * Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer session returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
* @param {String} customerSessionId The custom identifier for this session, must be unique within the account.
* @param {module:model/IntegrationRequest} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/IntegrationStateV2} and HTTP response
*/
updateCustomerSessionV2WithHttpInfo(customerSessionId, body, opts) {
@@ -745,11 +745,11 @@ export default class IntegrationApi {
/**
* Update a Customer Session
- * Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \"responseContent\". The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
+ * Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer session returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
* @param {String} customerSessionId The custom identifier for this session, must be unique within the account.
* @param {module:model/IntegrationRequest} body
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+ * @param {Object} [opts] Optional parameters
+ * @param {Boolean=} [opts.dry] Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/IntegrationStateV2}
*/
updateCustomerSessionV2(customerSessionId, body, opts) {
diff --git a/src/api/ManagementApi.js b/src/api/ManagementApi.js
index 95027d35..35718385 100644
--- a/src/api/ManagementApi.js
+++ b/src/api/ManagementApi.js
@@ -68,6 +68,7 @@ import NewAdditionalCost from '../model/NewAdditionalCost';
import NewAttribute from '../model/NewAttribute';
import NewCampaign from '../model/NewCampaign';
import NewCoupons from '../model/NewCoupons';
+import NewCouponsForMultipleRecipients from '../model/NewCouponsForMultipleRecipients';
import NewPassword from '../model/NewPassword';
import NewPasswordEmail from '../model/NewPasswordEmail';
import NewRuleset from '../model/NewRuleset';
@@ -83,7 +84,7 @@ import Webhook from '../model/Webhook';
/**
* Management service.
* @module api/ManagementApi
-* @version 4.2.0
+* @version 4.3.0
*/
export default class ManagementApi {
@@ -372,8 +373,8 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {module:model/NewCoupons} body
- * @param {Object} opts Optional parameters
- * @param {String} opts.silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.silent] If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response
*/
createCouponsWithHttpInfo(applicationId, campaignId, body, opts) {
@@ -421,8 +422,8 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {module:model/NewCoupons} body
- * @param {Object} opts Optional parameters
- * @param {String} opts.silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.silent] If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004}
*/
createCoupons(applicationId, campaignId, body, opts) {
@@ -433,6 +434,73 @@ export default class ManagementApi {
}
+ /**
+ * Create Coupons for Multiple Recipients
+ * Create coupons according to some pattern for up to 1000 recipients.
+ * @param {Number} applicationId
+ * @param {Number} campaignId
+ * @param {module:model/NewCouponsForMultipleRecipients} body
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.silent] If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response
+ */
+ createCouponsForMultipleRecipientsWithHttpInfo(applicationId, campaignId, body, opts) {
+ opts = opts || {};
+ let postBody = body;
+ // verify the required parameter 'applicationId' is set
+ if (applicationId === undefined || applicationId === null) {
+ throw new Error("Missing the required parameter 'applicationId' when calling createCouponsForMultipleRecipients");
+ }
+ // verify the required parameter 'campaignId' is set
+ if (campaignId === undefined || campaignId === null) {
+ throw new Error("Missing the required parameter 'campaignId' when calling createCouponsForMultipleRecipients");
+ }
+ // verify the required parameter 'body' is set
+ if (body === undefined || body === null) {
+ throw new Error("Missing the required parameter 'body' when calling createCouponsForMultipleRecipients");
+ }
+
+ let pathParams = {
+ 'applicationId': applicationId,
+ 'campaignId': campaignId
+ };
+ let queryParams = {
+ 'silent': opts['silent']
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = ['application/json'];
+ let accepts = ['application/json'];
+ let returnType = InlineResponse2004;
+ return this.apiClient.callApi(
+ '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients', 'POST',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Create Coupons for Multiple Recipients
+ * Create coupons according to some pattern for up to 1000 recipients.
+ * @param {Number} applicationId
+ * @param {Number} campaignId
+ * @param {module:model/NewCouponsForMultipleRecipients} body
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.silent] If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004}
+ */
+ createCouponsForMultipleRecipients(applicationId, campaignId, body, opts) {
+ return this.createCouponsForMultipleRecipientsWithHttpInfo(applicationId, campaignId, body, opts)
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
/**
* Request a password reset
* Sends an email with a password recovery link to the email of an existing account.
@@ -701,20 +769,20 @@ export default class ManagementApi {
* Delete Coupons
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
*/
deleteCouponsWithHttpInfo(applicationId, campaignId, opts) {
@@ -768,20 +836,20 @@ export default class ManagementApi {
* Delete Coupons
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
*/
deleteCoupons(applicationId, campaignId, opts) {
@@ -912,18 +980,399 @@ export default class ManagementApi {
}
+ /**
+ * Destroy a Session
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+ */
+ destroySessionWithHttpInfo() {
+ let postBody = null;
+
+ let pathParams = {
+ };
+ let queryParams = {
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = [];
+ let accepts = [];
+ let returnType = null;
+ return this.apiClient.callApi(
+ '/v1/sessions', 'DELETE',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Destroy a Session
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+ */
+ destroySession() {
+ return this.destroySessionWithHttpInfo()
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
+ /**
+ * Export Coupons to a CSV file
+ * Download a file with the coupons that match the given attributes.
+ * @param {Number} applicationId
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response
+ */
+ exportCouponsWithHttpInfo(applicationId, opts) {
+ opts = opts || {};
+ let postBody = null;
+ // verify the required parameter 'applicationId' is set
+ if (applicationId === undefined || applicationId === null) {
+ throw new Error("Missing the required parameter 'applicationId' when calling exportCoupons");
+ }
+
+ let pathParams = {
+ 'applicationId': applicationId
+ };
+ let queryParams = {
+ 'campaignId': opts['campaignId'],
+ 'sort': opts['sort'],
+ 'value': opts['value'],
+ 'createdBefore': opts['createdBefore'],
+ 'createdAfter': opts['createdAfter'],
+ 'valid': opts['valid'],
+ 'usable': opts['usable'],
+ 'referralId': opts['referralId'],
+ 'recipientIntegrationId': opts['recipientIntegrationId'],
+ 'batchId': opts['batchId'],
+ 'exactMatch': opts['exactMatch'],
+ 'dateFormat': opts['dateFormat'],
+ 'campaignState': opts['campaignState']
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = [];
+ let accepts = ['application/csv'];
+ let returnType = 'String';
+ return this.apiClient.callApi(
+ '/v1/applications/{applicationId}/export_coupons', 'GET',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Export Coupons to a CSV file
+ * Download a file with the coupons that match the given attributes.
+ * @param {Number} applicationId
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String}
+ */
+ exportCoupons(applicationId, opts) {
+ return this.exportCouponsWithHttpInfo(applicationId, opts)
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
+ /**
+ * Export Customer Sessions to a CSV file
+ * Download a file with the customer sessions that match the request.
+ * @param {Number} applicationId
+ * @param {Object} [opts] Optional parameters
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ * @param {String=} [opts.profileIntegrationId] Only return sessions for the customer that matches this customer integration ID.
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @param {module:model/String=} [opts.customerSessionState] Filter results by state.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response
+ */
+ exportCustomerSessionsWithHttpInfo(applicationId, opts) {
+ opts = opts || {};
+ let postBody = null;
+ // verify the required parameter 'applicationId' is set
+ if (applicationId === undefined || applicationId === null) {
+ throw new Error("Missing the required parameter 'applicationId' when calling exportCustomerSessions");
+ }
+
+ let pathParams = {
+ 'applicationId': applicationId
+ };
+ let queryParams = {
+ 'createdBefore': opts['createdBefore'],
+ 'createdAfter': opts['createdAfter'],
+ 'profileIntegrationId': opts['profileIntegrationId'],
+ 'dateFormat': opts['dateFormat'],
+ 'customerSessionState': opts['customerSessionState']
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = [];
+ let accepts = ['application/csv'];
+ let returnType = 'String';
+ return this.apiClient.callApi(
+ '/v1/applications/{applicationId}/export_customer_sessions', 'GET',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Export Customer Sessions to a CSV file
+ * Download a file with the customer sessions that match the request.
+ * @param {Number} applicationId
+ * @param {Object} [opts] Optional parameters
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
+ * @param {String=} [opts.profileIntegrationId] Only return sessions for the customer that matches this customer integration ID.
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @param {module:model/String=} [opts.customerSessionState] Filter results by state.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String}
+ */
+ exportCustomerSessions(applicationId, opts) {
+ return this.exportCustomerSessionsWithHttpInfo(applicationId, opts)
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
+ /**
+ * Export triggered Effects to a CSV file
+ * Download a file with the triggered effects that match the given attributes.
+ * @param {Number} applicationId
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response
+ */
+ exportEffectsWithHttpInfo(applicationId, opts) {
+ opts = opts || {};
+ let postBody = null;
+ // verify the required parameter 'applicationId' is set
+ if (applicationId === undefined || applicationId === null) {
+ throw new Error("Missing the required parameter 'applicationId' when calling exportEffects");
+ }
+
+ let pathParams = {
+ 'applicationId': applicationId
+ };
+ let queryParams = {
+ 'campaignId': opts['campaignId'],
+ 'createdBefore': opts['createdBefore'],
+ 'createdAfter': opts['createdAfter'],
+ 'dateFormat': opts['dateFormat']
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = [];
+ let accepts = ['application/csv'];
+ let returnType = 'String';
+ return this.apiClient.callApi(
+ '/v1/applications/{applicationId}/export_effects', 'GET',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Export triggered Effects to a CSV file
+ * Download a file with the triggered effects that match the given attributes.
+ * @param {Number} applicationId
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String}
+ */
+ exportEffects(applicationId, opts) {
+ return this.exportEffectsWithHttpInfo(applicationId, opts)
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
+ /**
+ * Export customer loyalty balance to a CSV file
+ * Download a file with the balance of each customer in the loyalty program
+ * @param {String} programID
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response
+ */
+ exportLoyaltyBalanceWithHttpInfo(programID) {
+ let postBody = null;
+ // verify the required parameter 'programID' is set
+ if (programID === undefined || programID === null) {
+ throw new Error("Missing the required parameter 'programID' when calling exportLoyaltyBalance");
+ }
+
+ let pathParams = {
+ 'programID': programID
+ };
+ let queryParams = {
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = [];
+ let accepts = ['application/csv'];
+ let returnType = 'String';
+ return this.apiClient.callApi(
+ '/v1/loyalty_programs/{programID}/export_customer_balance', 'GET',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Export customer loyalty balance to a CSV file
+ * Download a file with the balance of each customer in the loyalty program
+ * @param {String} programID
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String}
+ */
+ exportLoyaltyBalance(programID) {
+ return this.exportLoyaltyBalanceWithHttpInfo(programID)
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
+ /**
+ * Export a customer's loyalty ledger log to a CSV file
+ * Download a file with a customer's ledger log in the loyalty program
+ * @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
+ * @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
+ * @param {String} programID
+ * @param {String} integrationID
+ * @param {Object} [opts] Optional parameters
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response
+ */
+ exportLoyaltyLedgerWithHttpInfo(rangeStart, rangeEnd, programID, integrationID, opts) {
+ opts = opts || {};
+ let postBody = null;
+ // verify the required parameter 'rangeStart' is set
+ if (rangeStart === undefined || rangeStart === null) {
+ throw new Error("Missing the required parameter 'rangeStart' when calling exportLoyaltyLedger");
+ }
+ // verify the required parameter 'rangeEnd' is set
+ if (rangeEnd === undefined || rangeEnd === null) {
+ throw new Error("Missing the required parameter 'rangeEnd' when calling exportLoyaltyLedger");
+ }
+ // verify the required parameter 'programID' is set
+ if (programID === undefined || programID === null) {
+ throw new Error("Missing the required parameter 'programID' when calling exportLoyaltyLedger");
+ }
+ // verify the required parameter 'integrationID' is set
+ if (integrationID === undefined || integrationID === null) {
+ throw new Error("Missing the required parameter 'integrationID' when calling exportLoyaltyLedger");
+ }
+
+ let pathParams = {
+ 'programID': programID,
+ 'integrationID': integrationID
+ };
+ let queryParams = {
+ 'rangeStart': rangeStart,
+ 'rangeEnd': rangeEnd,
+ 'dateFormat': opts['dateFormat']
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = [];
+ let accepts = ['application/csv'];
+ let returnType = 'String';
+ return this.apiClient.callApi(
+ '/v1/loyalty_programs/{programID}/profile/{integrationID}/export_log', 'GET',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Export a customer's loyalty ledger log to a CSV file
+ * Download a file with a customer's ledger log in the loyalty program
+ * @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
+ * @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
+ * @param {String} programID
+ * @param {String} integrationID
+ * @param {Object} [opts] Optional parameters
+ * @param {module:model/String=} [opts.dateFormat] Determines the format of dates in the export document.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String}
+ */
+ exportLoyaltyLedger(rangeStart, rangeEnd, programID, integrationID, opts) {
+ return this.exportLoyaltyLedgerWithHttpInfo(rangeStart, rangeEnd, programID, integrationID, opts)
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
/**
* Get access logs for application (with total count)
* @param {Number} applicationId
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {String} opts.path Only return results where the request path matches the given regular expression.
- * @param {module:model/String} opts.method Only return results where the request method matches the given regular expression.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.path] Only return results where the request path matches the given regular expression.
+ * @param {module:model/String=} [opts.method] Only return results where the request method matches the given regular expression.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2009} and HTTP response
*/
getAccessLogsWithHttpInfo(applicationId, rangeStart, rangeEnd, opts) {
@@ -976,13 +1425,13 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {String} opts.path Only return results where the request path matches the given regular expression.
- * @param {module:model/String} opts.method Only return results where the request method matches the given regular expression.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.path] Only return results where the request path matches the given regular expression.
+ * @param {module:model/String=} [opts.method] Only return results where the request method matches the given regular expression.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2009}
*/
getAccessLogs(applicationId, rangeStart, rangeEnd, opts) {
@@ -998,13 +1447,13 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {String} opts.path Only return results where the request path matches the given regular expression.
- * @param {module:model/String} opts.method Only return results where the request method matches the given regular expression.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.path] Only return results where the request path matches the given regular expression.
+ * @param {module:model/String=} [opts.method] Only return results where the request method matches the given regular expression.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20010} and HTTP response
*/
getAccessLogsWithoutTotalCountWithHttpInfo(applicationId, rangeStart, rangeEnd, opts) {
@@ -1057,13 +1506,13 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {String} opts.path Only return results where the request path matches the given regular expression.
- * @param {module:model/String} opts.method Only return results where the request method matches the given regular expression.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.path] Only return results where the request path matches the given regular expression.
+ * @param {module:model/String=} [opts.method] Only return results where the request method matches the given regular expression.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20010}
*/
getAccessLogsWithoutTotalCount(applicationId, rangeStart, rangeEnd, opts) {
@@ -1221,11 +1670,11 @@ export default class ManagementApi {
/**
* List additional costs
* Returns all the defined additional costs for the account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20021} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20022} and HTTP response
*/
getAdditionalCostsWithHttpInfo(opts) {
opts = opts || {};
@@ -1246,7 +1695,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20021;
+ let returnType = InlineResponse20022;
return this.apiClient.callApi(
'/v1/additional_costs', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -1257,11 +1706,11 @@ export default class ManagementApi {
/**
* List additional costs
* Returns all the defined additional costs for the account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20021}
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20022}
*/
getAdditionalCosts(opts) {
return this.getAdditionalCostsWithHttpInfo(opts)
@@ -1276,13 +1725,13 @@ export default class ManagementApi {
* Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {String} opts.path Only return results where the request path matches the given regular expression.
- * @param {module:model/String} opts.method Only return results where the request method matches the given regular expression.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.path] Only return results where the request path matches the given regular expression.
+ * @param {module:model/String=} [opts.method] Only return results where the request method matches the given regular expression.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2009} and HTTP response
*/
getAllAccessLogsWithHttpInfo(rangeStart, rangeEnd, opts) {
@@ -1330,13 +1779,13 @@ export default class ManagementApi {
* Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {String} opts.path Only return results where the request path matches the given regular expression.
- * @param {module:model/String} opts.method Only return results where the request method matches the given regular expression.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.path] Only return results where the request path matches the given regular expression.
+ * @param {module:model/String=} [opts.method] Only return results where the request method matches the given regular expression.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2009}
*/
getAllAccessLogs(rangeStart, rangeEnd, opts) {
@@ -1348,7 +1797,7 @@ export default class ManagementApi {
/**
- * Get all roles.
+ * Get all roles
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20030} and HTTP response
*/
getAllRolesWithHttpInfo() {
@@ -1375,7 +1824,7 @@ export default class ManagementApi {
}
/**
- * Get all roles.
+ * Get all roles
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20030}
*/
getAllRoles() {
@@ -1536,11 +1985,11 @@ export default class ManagementApi {
/**
* List Application Customers
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {String} opts.integrationId Filter results performing an exact matching against the profile integration identifier.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {Boolean} opts.withTotalResultSize When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.integrationId] Filter results performing an exact matching against the profile integration identifier.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {Boolean=} [opts.withTotalResultSize] When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20012} and HTTP response
*/
getApplicationCustomersWithHttpInfo(applicationId, opts) {
@@ -1579,11 +2028,11 @@ export default class ManagementApi {
/**
* List Application Customers
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {String} opts.integrationId Filter results performing an exact matching against the profile integration identifier.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {Boolean} opts.withTotalResultSize When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.integrationId] Filter results performing an exact matching against the profile integration identifier.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {Boolean=} [opts.withTotalResultSize] When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20012}
*/
getApplicationCustomers(applicationId, opts) {
@@ -1645,10 +2094,10 @@ export default class ManagementApi {
* List Applications Event Types
* Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](/integration-api/reference/#trackEvent)
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20019} and HTTP response
*/
getApplicationEventTypesWithHttpInfo(applicationId, opts) {
@@ -1687,10 +2136,10 @@ export default class ManagementApi {
* List Applications Event Types
* Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](/integration-api/reference/#trackEvent)
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20019}
*/
getApplicationEventTypes(applicationId, opts) {
@@ -1705,21 +2154,21 @@ export default class ManagementApi {
* List Applications Events (with total count)
* Lists all events recorded for an application.
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.type Comma-separated list of types by which to filter events. Must be exact match(es).
- * @param {Date} opts.createdBefore Only return events created before this date
- * @param {Date} opts.createdAfter Only return events created after this date
- * @param {String} opts.session Session integration ID filter for events. Must be exact match.
- * @param {String} opts.profile Profile integration ID filter for events. Must be exact match.
- * @param {String} opts.customerName Customer name filter for events. Will match substrings case-insensitively.
- * @param {String} opts.customerEmail Customer e-mail address filter for events. Will match substrings case-insensitively.
- * @param {String} opts.couponCode Coupon code
- * @param {String} opts.referralCode Referral code
- * @param {String} opts.ruleQuery Rule name filter for events
- * @param {String} opts.campaignQuery Campaign name filter for events
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.type] Comma-separated list of types by which to filter events. Must be exact match(es).
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {String=} [opts.session] Session integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.profile] Profile integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.customerName] Customer name filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.customerEmail] Customer e-mail address filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.couponCode] Coupon code
+ * @param {String=} [opts.referralCode] Referral code
+ * @param {String=} [opts.ruleQuery] Rule name filter for events
+ * @param {String=} [opts.campaignQuery] Campaign name filter for events
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20017} and HTTP response
*/
getApplicationEventsWithHttpInfo(applicationId, opts) {
@@ -1769,21 +2218,21 @@ export default class ManagementApi {
* List Applications Events (with total count)
* Lists all events recorded for an application.
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.type Comma-separated list of types by which to filter events. Must be exact match(es).
- * @param {Date} opts.createdBefore Only return events created before this date
- * @param {Date} opts.createdAfter Only return events created after this date
- * @param {String} opts.session Session integration ID filter for events. Must be exact match.
- * @param {String} opts.profile Profile integration ID filter for events. Must be exact match.
- * @param {String} opts.customerName Customer name filter for events. Will match substrings case-insensitively.
- * @param {String} opts.customerEmail Customer e-mail address filter for events. Will match substrings case-insensitively.
- * @param {String} opts.couponCode Coupon code
- * @param {String} opts.referralCode Referral code
- * @param {String} opts.ruleQuery Rule name filter for events
- * @param {String} opts.campaignQuery Campaign name filter for events
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.type] Comma-separated list of types by which to filter events. Must be exact match(es).
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {String=} [opts.session] Session integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.profile] Profile integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.customerName] Customer name filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.customerEmail] Customer e-mail address filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.couponCode] Coupon code
+ * @param {String=} [opts.referralCode] Referral code
+ * @param {String=} [opts.ruleQuery] Rule name filter for events
+ * @param {String=} [opts.campaignQuery] Campaign name filter for events
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20017}
*/
getApplicationEvents(applicationId, opts) {
@@ -1798,21 +2247,21 @@ export default class ManagementApi {
* List Applications Events
* Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results.
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.type Comma-separated list of types by which to filter events. Must be exact match(es).
- * @param {Date} opts.createdBefore Only return events created before this date
- * @param {Date} opts.createdAfter Only return events created after this date
- * @param {String} opts.session Session integration ID filter for events. Must be exact match.
- * @param {String} opts.profile Profile integration ID filter for events. Must be exact match.
- * @param {String} opts.customerName Customer name filter for events. Will match substrings case-insensitively.
- * @param {String} opts.customerEmail Customer e-mail address filter for events. Will match substrings case-insensitively.
- * @param {String} opts.couponCode Coupon code
- * @param {String} opts.referralCode Referral code
- * @param {String} opts.ruleQuery Rule name filter for events
- * @param {String} opts.campaignQuery Campaign name filter for events
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.type] Comma-separated list of types by which to filter events. Must be exact match(es).
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {String=} [opts.session] Session integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.profile] Profile integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.customerName] Customer name filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.customerEmail] Customer e-mail address filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.couponCode] Coupon code
+ * @param {String=} [opts.referralCode] Referral code
+ * @param {String=} [opts.ruleQuery] Rule name filter for events
+ * @param {String=} [opts.campaignQuery] Campaign name filter for events
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20018} and HTTP response
*/
getApplicationEventsWithoutTotalCountWithHttpInfo(applicationId, opts) {
@@ -1862,21 +2311,21 @@ export default class ManagementApi {
* List Applications Events
* Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results.
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.type Comma-separated list of types by which to filter events. Must be exact match(es).
- * @param {Date} opts.createdBefore Only return events created before this date
- * @param {Date} opts.createdAfter Only return events created after this date
- * @param {String} opts.session Session integration ID filter for events. Must be exact match.
- * @param {String} opts.profile Profile integration ID filter for events. Must be exact match.
- * @param {String} opts.customerName Customer name filter for events. Will match substrings case-insensitively.
- * @param {String} opts.customerEmail Customer e-mail address filter for events. Will match substrings case-insensitively.
- * @param {String} opts.couponCode Coupon code
- * @param {String} opts.referralCode Referral code
- * @param {String} opts.ruleQuery Rule name filter for events
- * @param {String} opts.campaignQuery Campaign name filter for events
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.type] Comma-separated list of types by which to filter events. Must be exact match(es).
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {String=} [opts.session] Session integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.profile] Profile integration ID filter for events. Must be exact match.
+ * @param {String=} [opts.customerName] Customer name filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.customerEmail] Customer e-mail address filter for events. Will match substrings case-insensitively.
+ * @param {String=} [opts.couponCode] Coupon code
+ * @param {String=} [opts.referralCode] Referral code
+ * @param {String=} [opts.ruleQuery] Rule name filter for events
+ * @param {String=} [opts.campaignQuery] Campaign name filter for events
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20018}
*/
getApplicationEventsWithoutTotalCount(applicationId, opts) {
@@ -1943,17 +2392,17 @@ export default class ManagementApi {
/**
* List Application Sessions
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.profile Profile integration ID filter for sessions. Must be exact match.
- * @param {module:model/String} opts.state Filter by sessions with this state. Must be exact match.
- * @param {Date} opts.createdBefore Only return events created before this date
- * @param {Date} opts.createdAfter Only return events created after this date
- * @param {String} opts.coupon Filter by sessions with this coupon. Must be exact match.
- * @param {String} opts.referral Filter by sessions with this referral. Must be exact match.
- * @param {String} opts.integrationId Filter by sessions with this integrationId. Must be exact match.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.profile] Profile integration ID filter for sessions. Must be exact match.
+ * @param {module:model/String=} [opts.state] Filter by sessions with this state. Must be exact match.
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {String=} [opts.coupon] Filter by sessions with this coupon. Must be exact match.
+ * @param {String=} [opts.referral] Filter by sessions with this referral. Must be exact match.
+ * @param {String=} [opts.integrationId] Filter by sessions with this integrationId. Must be exact match.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20016} and HTTP response
*/
getApplicationSessionsWithHttpInfo(applicationId, opts) {
@@ -1998,17 +2447,17 @@ export default class ManagementApi {
/**
* List Application Sessions
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.profile Profile integration ID filter for sessions. Must be exact match.
- * @param {module:model/String} opts.state Filter by sessions with this state. Must be exact match.
- * @param {Date} opts.createdBefore Only return events created before this date
- * @param {Date} opts.createdAfter Only return events created after this date
- * @param {String} opts.coupon Filter by sessions with this coupon. Must be exact match.
- * @param {String} opts.referral Filter by sessions with this referral. Must be exact match.
- * @param {String} opts.integrationId Filter by sessions with this integrationId. Must be exact match.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.profile] Profile integration ID filter for sessions. Must be exact match.
+ * @param {module:model/String=} [opts.state] Filter by sessions with this state. Must be exact match.
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {String=} [opts.coupon] Filter by sessions with this coupon. Must be exact match.
+ * @param {String=} [opts.referral] Filter by sessions with this referral. Must be exact match.
+ * @param {String=} [opts.integrationId] Filter by sessions with this integrationId. Must be exact match.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20016}
*/
getApplicationSessions(applicationId, opts) {
@@ -2022,10 +2471,10 @@ export default class ManagementApi {
/**
* List Applications
* List all application in the current account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2001} and HTTP response
*/
getApplicationsWithHttpInfo(opts) {
@@ -2058,10 +2507,10 @@ export default class ManagementApi {
/**
* List Applications
* List all application in the current account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2001}
*/
getApplications(opts) {
@@ -2123,11 +2572,11 @@ export default class ManagementApi {
/**
* List custom attributes
* Returns all the defined custom attributes for the account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20020} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20021} and HTTP response
*/
getAttributesWithHttpInfo(opts) {
opts = opts || {};
@@ -2148,7 +2597,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20020;
+ let returnType = InlineResponse20021;
return this.apiClient.callApi(
'/v1/attributes', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -2159,11 +2608,11 @@ export default class ManagementApi {
/**
* List custom attributes
* Returns all the defined custom attributes for the account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20020}
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20021}
*/
getAttributes(opts) {
return this.getAttributesWithHttpInfo(opts)
@@ -2173,6 +2622,62 @@ export default class ManagementApi {
}
+ /**
+ * Get all audiences
+ * Get All audiences created in the account.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Boolean=} [opts.withTotalResultSize] When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20020} and HTTP response
+ */
+ getAudiencesWithHttpInfo(opts) {
+ opts = opts || {};
+ let postBody = null;
+
+ let pathParams = {
+ };
+ let queryParams = {
+ 'pageSize': opts['pageSize'],
+ 'skip': opts['skip'],
+ 'sort': opts['sort'],
+ 'withTotalResultSize': opts['withTotalResultSize']
+ };
+ let headerParams = {
+ };
+ let formParams = {
+ };
+
+ let authNames = ['manager_auth'];
+ let contentTypes = [];
+ let accepts = ['application/json'];
+ let returnType = InlineResponse20020;
+ return this.apiClient.callApi(
+ '/v1/audiences', 'GET',
+ pathParams, queryParams, headerParams, formParams, postBody,
+ authNames, contentTypes, accepts, returnType, null
+ );
+ }
+
+ /**
+ * Get all audiences
+ * Get All audiences created in the account.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Boolean=} [opts.withTotalResultSize] When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20020}
+ */
+ getAudiences(opts) {
+ return this.getAudiencesWithHttpInfo(opts)
+ .then(function(response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+
/**
* Get a Campaign
* @param {Number} applicationId
@@ -2232,8 +2737,8 @@ export default class ManagementApi {
* @param {Number} campaignId
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {module:model/String} opts.granularity The time interval between the results in the returned time-series.
+ * @param {Object} [opts] Optional parameters
+ * @param {module:model/String=} [opts.granularity] The time interval between the results in the returned time-series.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20011} and HTTP response
*/
getCampaignAnalyticsWithHttpInfo(applicationId, campaignId, rangeStart, rangeEnd, opts) {
@@ -2287,8 +2792,8 @@ export default class ManagementApi {
* @param {Number} campaignId
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
- * @param {Object} opts Optional parameters
- * @param {module:model/String} opts.granularity The time interval between the results in the returned time-series.
+ * @param {Object} [opts] Optional parameters
+ * @param {module:model/String=} [opts.granularity] The time interval between the results in the returned time-series.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20011}
*/
getCampaignAnalytics(applicationId, campaignId, rangeStart, rangeEnd, opts) {
@@ -2304,11 +2809,11 @@ export default class ManagementApi {
* Gets a list of all the campaigns that exactly match a set of attributes.
* @param {Number} applicationId
* @param {module:model/CampaignSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2002} and HTTP response
*/
getCampaignByAttributesWithHttpInfo(applicationId, body, opts) {
@@ -2353,11 +2858,11 @@ export default class ManagementApi {
* Gets a list of all the campaigns that exactly match a set of attributes.
* @param {Number} applicationId
* @param {module:model/CampaignSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2002}
*/
getCampaignByAttributes(applicationId, body, opts) {
@@ -2371,16 +2876,16 @@ export default class ManagementApi {
/**
* List your Campaigns
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
- * @param {String} opts.name Filter results performing case-insensitive matching against the name of the campaign.
- * @param {String} opts.tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
- * @param {Number} opts.campaignGroupId Filter results to campaigns owned by the specified campaign group ID.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
+ * @param {String=} [opts.name] Filter results performing case-insensitive matching against the name of the campaign.
+ * @param {String=} [opts.tags] Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Number=} [opts.campaignGroupId] Filter results to campaigns owned by the specified campaign group ID.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2002} and HTTP response
*/
getCampaignsWithHttpInfo(applicationId, opts) {
@@ -2424,16 +2929,16 @@ export default class ManagementApi {
/**
* List your Campaigns
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
- * @param {String} opts.name Filter results performing case-insensitive matching against the name of the campaign.
- * @param {String} opts.tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
- * @param {Number} opts.campaignGroupId Filter results to campaigns owned by the specified campaign group ID.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
+ * @param {String=} [opts.name] Filter results performing case-insensitive matching against the name of the campaign.
+ * @param {String=} [opts.tags] Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Number=} [opts.campaignGroupId] Filter results to campaigns owned by the specified campaign group ID.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2002}
*/
getCampaigns(applicationId, opts) {
@@ -2447,16 +2952,18 @@ export default class ManagementApi {
/**
* Get audit log for an account
* Get list of changes caused by API calls for an account. Only accessible for admins.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {Number} opts.applicationId
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
- * @param {Boolean} opts.withTotalResultSize When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
- * @param {Boolean} opts.includeOld When this flag is set to false, the state without the change will not be returned. The default value is true.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20027} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Number=} [opts.applicationId]
+ * @param {String=} [opts.entityPath] Filter results on a case insensitive matching of the url path of the entity
+ * @param {Number=} [opts.userId]
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Boolean=} [opts.withTotalResultSize] When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
+ * @param {Boolean=} [opts.includeOld] When this flag is set to false, the state without the change will not be returned. The default value is true.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20028} and HTTP response
*/
getChangesWithHttpInfo(opts) {
opts = opts || {};
@@ -2469,6 +2976,8 @@ export default class ManagementApi {
'skip': opts['skip'],
'sort': opts['sort'],
'applicationId': opts['applicationId'],
+ 'entityPath': opts['entityPath'],
+ 'userId': opts['userId'],
'createdBefore': opts['createdBefore'],
'createdAfter': opts['createdAfter'],
'withTotalResultSize': opts['withTotalResultSize'],
@@ -2482,7 +2991,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20027;
+ let returnType = InlineResponse20028;
return this.apiClient.callApi(
'/v1/changes', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -2493,16 +3002,18 @@ export default class ManagementApi {
/**
* Get audit log for an account
* Get list of changes caused by API calls for an account. Only accessible for admins.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {Number} opts.applicationId
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
- * @param {Boolean} opts.withTotalResultSize When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
- * @param {Boolean} opts.includeOld When this flag is set to false, the state without the change will not be returned. The default value is true.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20027}
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Number=} [opts.applicationId]
+ * @param {String=} [opts.entityPath] Filter results on a case insensitive matching of the url path of the entity
+ * @param {Number=} [opts.userId]
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Boolean=} [opts.withTotalResultSize] When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
+ * @param {Boolean=} [opts.includeOld] When this flag is set to false, the state without the change will not be returned. The default value is true.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20028}
*/
getChanges(opts) {
return this.getChangesWithHttpInfo(opts)
@@ -2516,23 +3027,23 @@ export default class ManagementApi {
* List Coupons (with total count)
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response
*/
getCouponsWithHttpInfo(applicationId, campaignId, opts) {
@@ -2589,23 +3100,23 @@ export default class ManagementApi {
* List Coupons (with total count)
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.startsBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.expiresBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.startsBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.expiresBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004}
*/
getCoupons(applicationId, campaignId, opts) {
@@ -2622,19 +3133,19 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {module:model/CouponSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {String} opts.batchId Filter results by batches of coupons
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response
*/
getCouponsByAttributesWithHttpInfo(applicationId, campaignId, body, opts) {
@@ -2693,19 +3204,19 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {module:model/CouponSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {String} opts.batchId Filter results by batches of coupons
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004}
*/
getCouponsByAttributes(applicationId, campaignId, body, opts) {
@@ -2721,20 +3232,20 @@ export default class ManagementApi {
* Gets a list of all the coupons with attributes matching the query criteria Application wide
* @param {Number} applicationId
* @param {module:model/CouponSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response
*/
getCouponsByAttributesApplicationWideWithHttpInfo(applicationId, body, opts) {
@@ -2788,20 +3299,20 @@ export default class ManagementApi {
* Gets a list of all the coupons with attributes matching the query criteria Application wide
* @param {Number} applicationId
* @param {module:model/CouponSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004}
*/
getCouponsByAttributesApplicationWide(applicationId, body, opts) {
@@ -2816,19 +3327,19 @@ export default class ManagementApi {
* List Coupons
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2005} and HTTP response
*/
getCouponsWithoutTotalCountWithHttpInfo(applicationId, campaignId, opts) {
@@ -2881,19 +3392,19 @@ export default class ManagementApi {
* List Coupons
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2005}
*/
getCouponsWithoutTotalCount(applicationId, campaignId, opts) {
@@ -2911,9 +3422,9 @@ export default class ManagementApi {
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
* @param {Number} applicationId
* @param {Number} customerId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CustomerActivityReport} and HTTP response
*/
getCustomerActivityReportWithHttpInfo(rangeStart, rangeEnd, applicationId, customerId, opts) {
@@ -2969,9 +3480,9 @@ export default class ManagementApi {
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
* @param {Number} applicationId
* @param {Number} customerId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomerActivityReport}
*/
getCustomerActivityReport(rangeStart, rangeEnd, applicationId, customerId, opts) {
@@ -2988,14 +3499,14 @@ export default class ManagementApi {
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.name Only return reports matching the customer name
- * @param {String} opts.integrationId Only return reports matching the integrationId
- * @param {String} opts.campaignName Only return reports matching the campaignName
- * @param {String} opts.advocateName Only return reports matching the current customer referrer name
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.name] Only return reports matching the customer name
+ * @param {String=} [opts.integrationId] Only return reports matching the integrationId
+ * @param {String=} [opts.campaignName] Only return reports matching the campaignName
+ * @param {String=} [opts.advocateName] Only return reports matching the current customer referrer name
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20014} and HTTP response
*/
getCustomerActivityReportsWithHttpInfo(rangeStart, rangeEnd, applicationId, opts) {
@@ -3050,14 +3561,14 @@ export default class ManagementApi {
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.name Only return reports matching the customer name
- * @param {String} opts.integrationId Only return reports matching the integrationId
- * @param {String} opts.campaignName Only return reports matching the campaignName
- * @param {String} opts.advocateName Only return reports matching the current customer referrer name
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.name] Only return reports matching the customer name
+ * @param {String=} [opts.integrationId] Only return reports matching the integrationId
+ * @param {String=} [opts.campaignName] Only return reports matching the campaignName
+ * @param {String=} [opts.advocateName] Only return reports matching the current customer referrer name
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20014}
*/
getCustomerActivityReports(rangeStart, rangeEnd, applicationId, opts) {
@@ -3074,14 +3585,14 @@ export default class ManagementApi {
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.name Only return reports matching the customer name
- * @param {String} opts.integrationId Only return reports matching the integrationId
- * @param {String} opts.campaignName Only return reports matching the campaignName
- * @param {String} opts.advocateName Only return reports matching the current customer referrer name
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.name] Only return reports matching the customer name
+ * @param {String=} [opts.integrationId] Only return reports matching the integrationId
+ * @param {String=} [opts.campaignName] Only return reports matching the campaignName
+ * @param {String=} [opts.advocateName] Only return reports matching the current customer referrer name
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20015} and HTTP response
*/
getCustomerActivityReportsWithoutTotalCountWithHttpInfo(rangeStart, rangeEnd, applicationId, opts) {
@@ -3136,14 +3647,14 @@ export default class ManagementApi {
* @param {Date} rangeStart Only return results from after this timestamp, must be an RFC3339 timestamp string
* @param {Date} rangeEnd Only return results from before this timestamp, must be an RFC3339 timestamp string
* @param {Number} applicationId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.name Only return reports matching the customer name
- * @param {String} opts.integrationId Only return reports matching the integrationId
- * @param {String} opts.campaignName Only return reports matching the campaignName
- * @param {String} opts.advocateName Only return reports matching the current customer referrer name
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.name] Only return reports matching the customer name
+ * @param {String=} [opts.integrationId] Only return reports matching the integrationId
+ * @param {String=} [opts.campaignName] Only return reports matching the campaignName
+ * @param {String=} [opts.advocateName] Only return reports matching the current customer referrer name
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20015}
*/
getCustomerActivityReportsWithoutTotalCount(rangeStart, rangeEnd, applicationId, opts) {
@@ -3159,10 +3670,10 @@ export default class ManagementApi {
* Fetch analytics for single application customer
* @param {Number} applicationId
* @param {Number} customerId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CustomerAnalytics} and HTTP response
*/
getCustomerAnalyticsWithHttpInfo(applicationId, customerId, opts) {
@@ -3207,10 +3718,10 @@ export default class ManagementApi {
* Fetch analytics for single application customer
* @param {Number} applicationId
* @param {Number} customerId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomerAnalytics}
*/
getCustomerAnalytics(applicationId, customerId, opts) {
@@ -3269,9 +3780,9 @@ export default class ManagementApi {
/**
* List Customer Profiles
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20013} and HTTP response
*/
getCustomerProfilesWithHttpInfo(opts) {
@@ -3302,9 +3813,9 @@ export default class ManagementApi {
/**
* List Customer Profiles
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20013}
*/
getCustomerProfiles(opts) {
@@ -3319,9 +3830,9 @@ export default class ManagementApi {
* Get a list of the customer profiles that match the given attributes
* Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
* @param {module:model/ApplicationCustomerSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20013} and HTTP response
*/
getCustomersByAttributesWithHttpInfo(body, opts) {
@@ -3358,9 +3869,9 @@ export default class ManagementApi {
* Get a list of the customer profiles that match the given attributes
* Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
* @param {module:model/ApplicationCustomerSearch} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20013}
*/
getCustomersByAttributes(body, opts) {
@@ -3374,14 +3885,14 @@ export default class ManagementApi {
/**
* List Event Types
* Fetch all event type definitions for your account. Each event type can be
- * @param {Object} opts Optional parameters
- * @param {String} opts.applicationIds Filter by one or more application ids separated by comma
- * @param {String} opts.name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
- * @param {Boolean} opts.includeOldVersions Include all versions of every event type. (default to false)
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20025} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.applicationIds] Filter by one or more application ids separated by comma
+ * @param {String=} [opts.name] Filter results to event types with the given name. This parameter implies `includeOldVersions`.
+ * @param {Boolean=} [opts.includeOldVersions] Include all versions of every event type. (default to false)
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20026} and HTTP response
*/
getEventTypesWithHttpInfo(opts) {
opts = opts || {};
@@ -3405,7 +3916,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20025;
+ let returnType = InlineResponse20026;
return this.apiClient.callApi(
'/v1/event_types', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -3416,14 +3927,14 @@ export default class ManagementApi {
/**
* List Event Types
* Fetch all event type definitions for your account. Each event type can be
- * @param {Object} opts Optional parameters
- * @param {String} opts.applicationIds Filter by one or more application ids separated by comma
- * @param {String} opts.name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
- * @param {Boolean} opts.includeOldVersions Include all versions of every event type. (default to false)
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20025}
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.applicationIds] Filter by one or more application ids separated by comma
+ * @param {String=} [opts.name] Filter results to event types with the given name. This parameter implies `includeOldVersions`.
+ * @param {Boolean=} [opts.includeOldVersions] Include all versions of every event type. (default to false)
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20026}
*/
getEventTypes(opts) {
return this.getEventTypesWithHttpInfo(opts)
@@ -3436,13 +3947,13 @@ export default class ManagementApi {
/**
* Get Exports
* Get a list of all past exports
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {Number} opts.applicationId
- * @param {Number} opts.campaignId
- * @param {module:model/String} opts.entity The name of the entity type that was exported.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20028} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {Number=} [opts.applicationId]
+ * @param {Number=} [opts.campaignId]
+ * @param {module:model/String=} [opts.entity] The name of the entity type that was exported.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20029} and HTTP response
*/
getExportsWithHttpInfo(opts) {
opts = opts || {};
@@ -3465,7 +3976,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20028;
+ let returnType = InlineResponse20029;
return this.apiClient.callApi(
'/v1/exports', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -3476,13 +3987,13 @@ export default class ManagementApi {
/**
* Get Exports
* Get a list of all past exports
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {Number} opts.applicationId
- * @param {Number} opts.campaignId
- * @param {module:model/String} opts.entity The name of the entity type that was exported.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20028}
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {Number=} [opts.applicationId]
+ * @param {Number=} [opts.campaignId]
+ * @param {module:model/String=} [opts.entity] The name of the entity type that was exported.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20029}
*/
getExports(opts) {
return this.getExportsWithHttpInfo(opts)
@@ -3492,56 +4003,6 @@ export default class ManagementApi {
}
- /**
- * Get Imports
- * Get a list of all past imports
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20029} and HTTP response
- */
- getImportsWithHttpInfo(opts) {
- opts = opts || {};
- let postBody = null;
-
- let pathParams = {
- };
- let queryParams = {
- 'pageSize': opts['pageSize'],
- 'skip': opts['skip']
- };
- let headerParams = {
- };
- let formParams = {
- };
-
- let authNames = ['manager_auth'];
- let contentTypes = [];
- let accepts = ['application/json'];
- let returnType = InlineResponse20029;
- return this.apiClient.callApi(
- '/v1/imports', 'GET',
- pathParams, queryParams, headerParams, formParams, postBody,
- authNames, contentTypes, accepts, returnType, null
- );
- }
-
- /**
- * Get Imports
- * Get a list of all past imports
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20029}
- */
- getImports(opts) {
- return this.getImportsWithHttpInfo(opts)
- .then(function(response_and_data) {
- return response_and_data.data;
- });
- }
-
-
/**
* get the Loyalty Ledger for this integrationID
* Get the Loyalty Ledger for this profile integration ID.
@@ -3732,16 +4193,16 @@ export default class ManagementApi {
* List Referrals (with total count)
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
- * @param {String} opts.advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.code] Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
+ * @param {String=} [opts.advocate] Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2006} and HTTP response
*/
getReferralsWithHttpInfo(applicationId, campaignId, opts) {
@@ -3791,16 +4252,16 @@ export default class ManagementApi {
* List Referrals (with total count)
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
- * @param {String} opts.advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.code] Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
+ * @param {String=} [opts.advocate] Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2006}
*/
getReferrals(applicationId, campaignId, opts) {
@@ -3815,16 +4276,16 @@ export default class ManagementApi {
* List Referrals
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
- * @param {String} opts.advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.code] Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
+ * @param {String=} [opts.advocate] Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2007} and HTTP response
*/
getReferralsWithoutTotalCountWithHttpInfo(applicationId, campaignId, opts) {
@@ -3874,16 +4335,16 @@ export default class ManagementApi {
* List Referrals
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
- * @param {String} opts.advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.code] Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
+ * @param {String=} [opts.advocate] Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2007}
*/
getReferralsWithoutTotalCount(applicationId, campaignId, opts) {
@@ -3895,7 +4356,7 @@ export default class ManagementApi {
/**
- * Get information for the specified role.
+ * Get information for the specified role
* @param {Number} roleId
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Role} and HTTP response
*/
@@ -3928,7 +4389,7 @@ export default class ManagementApi {
}
/**
- * Get information for the specified role.
+ * Get information for the specified role
* @param {Number} roleId
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Role}
*/
@@ -4004,10 +4465,10 @@ export default class ManagementApi {
* List Campaign Rulesets
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2003} and HTTP response
*/
getRulesetsWithHttpInfo(applicationId, campaignId, opts) {
@@ -4051,10 +4512,10 @@ export default class ManagementApi {
* List Campaign Rulesets
* @param {Number} applicationId
* @param {Number} campaignId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2003}
*/
getRulesets(applicationId, campaignId, opts) {
@@ -4116,11 +4577,11 @@ export default class ManagementApi {
/**
* List Users in your account
* Retrieve all users in your account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20026} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20027} and HTTP response
*/
getUsersWithHttpInfo(opts) {
opts = opts || {};
@@ -4141,7 +4602,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20026;
+ let returnType = InlineResponse20027;
return this.apiClient.callApi(
'/v1/users', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -4152,11 +4613,11 @@ export default class ManagementApi {
/**
* List Users in your account
* Retrieve all users in your account.
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20026}
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20027}
*/
getUsers(opts) {
return this.getUsersWithHttpInfo(opts)
@@ -4217,17 +4678,17 @@ export default class ManagementApi {
/**
* List Webhook activation Log Entries
* Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.integrationRequestUuid Filter results by integration request UUID.
- * @param {Number} opts.webhookId Filter results by Webhook.
- * @param {Number} opts.applicationId
- * @param {Number} opts.campaignId Filter results by campaign.
- * @param {Date} opts.createdBefore Only return events created before this date.
- * @param {Date} opts.createdAfter Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20023} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.integrationRequestUuid] Filter results by integration request UUID.
+ * @param {Number=} [opts.webhookId] Filter results by Webhook.
+ * @param {Number=} [opts.applicationId]
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20024} and HTTP response
*/
getWebhookActivationLogsWithHttpInfo(opts) {
opts = opts || {};
@@ -4254,7 +4715,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20023;
+ let returnType = InlineResponse20024;
return this.apiClient.callApi(
'/v1/webhook_activation_logs', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -4265,17 +4726,17 @@ export default class ManagementApi {
/**
* List Webhook activation Log Entries
* Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.integrationRequestUuid Filter results by integration request UUID.
- * @param {Number} opts.webhookId Filter results by Webhook.
- * @param {Number} opts.applicationId
- * @param {Number} opts.campaignId Filter results by campaign.
- * @param {Date} opts.createdBefore Only return events created before this date.
- * @param {Date} opts.createdAfter Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20023}
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.integrationRequestUuid] Filter results by integration request UUID.
+ * @param {Number=} [opts.webhookId] Filter results by Webhook.
+ * @param {Number=} [opts.applicationId]
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {Date=} [opts.createdBefore] Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20024}
*/
getWebhookActivationLogs(opts) {
return this.getWebhookActivationLogsWithHttpInfo(opts)
@@ -4287,18 +4748,18 @@ export default class ManagementApi {
/**
* List Webhook Log Entries
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.webhookId Filter results by Webhook.
- * @param {Number} opts.applicationId
- * @param {Number} opts.campaignId Filter results by campaign.
- * @param {String} opts.requestUuid Filter results by request UUID.
- * @param {Date} opts.createdBefore Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
- * @param {Date} opts.createdAfter Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20024} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.webhookId] Filter results by Webhook.
+ * @param {Number=} [opts.applicationId]
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {String=} [opts.requestUuid] Filter results by request UUID.
+ * @param {Date=} [opts.createdBefore] Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20025} and HTTP response
*/
getWebhookLogsWithHttpInfo(opts) {
opts = opts || {};
@@ -4326,7 +4787,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20024;
+ let returnType = InlineResponse20025;
return this.apiClient.callApi(
'/v1/webhook_logs', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -4336,18 +4797,18 @@ export default class ManagementApi {
/**
* List Webhook Log Entries
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {module:model/String} opts.status Filter results by HTTP status codes.
- * @param {Number} opts.webhookId Filter results by Webhook.
- * @param {Number} opts.applicationId
- * @param {Number} opts.campaignId Filter results by campaign.
- * @param {String} opts.requestUuid Filter results by request UUID.
- * @param {Date} opts.createdBefore Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
- * @param {Date} opts.createdAfter Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20024}
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {module:model/String=} [opts.status] Filter results by HTTP status codes.
+ * @param {Number=} [opts.webhookId] Filter results by Webhook.
+ * @param {Number=} [opts.applicationId]
+ * @param {Number=} [opts.campaignId] Filter results by campaign.
+ * @param {String=} [opts.requestUuid] Filter results by request UUID.
+ * @param {Date=} [opts.createdBefore] Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20025}
*/
getWebhookLogs(opts) {
return this.getWebhookLogsWithHttpInfo(opts)
@@ -4359,12 +4820,12 @@ export default class ManagementApi {
/**
* List Webhooks
- * @param {Object} opts Optional parameters
- * @param {String} opts.applicationIds Filter by one or more application ids separated by comma
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20022} and HTTP response
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.applicationIds] Filter by one or more application ids separated by comma
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse20023} and HTTP response
*/
getWebhooksWithHttpInfo(opts) {
opts = opts || {};
@@ -4386,7 +4847,7 @@ export default class ManagementApi {
let authNames = ['manager_auth'];
let contentTypes = [];
let accepts = ['application/json'];
- let returnType = InlineResponse20022;
+ let returnType = InlineResponse20023;
return this.apiClient.callApi(
'/v1/webhooks', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
@@ -4396,12 +4857,12 @@ export default class ManagementApi {
/**
* List Webhooks
- * @param {Object} opts Optional parameters
- * @param {String} opts.applicationIds Filter by one or more application ids separated by comma
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20022}
+ * @param {Object} [opts] Optional parameters
+ * @param {String=} [opts.applicationIds] Filter by one or more application ids separated by comma
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse20023}
*/
getWebhooks(opts) {
return this.getWebhooksWithHttpInfo(opts)
@@ -4523,19 +4984,19 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {String} opts.batchId Filter results by batches of coupons
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response
*/
searchCouponsAdvancedWithHttpInfo(applicationId, campaignId, body, opts) {
@@ -4594,19 +5055,19 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {String} opts.batchId Filter results by batches of coupons
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004}
*/
searchCouponsAdvanced(applicationId, campaignId, body, opts) {
@@ -4622,20 +5083,20 @@ export default class ManagementApi {
* Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
* @param {Number} applicationId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2004} and HTTP response
*/
searchCouponsAdvancedApplicationWideWithHttpInfo(applicationId, body, opts) {
@@ -4689,20 +5150,20 @@ export default class ManagementApi {
* Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
* @param {Number} applicationId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2004}
*/
searchCouponsAdvancedApplicationWide(applicationId, body, opts) {
@@ -4718,20 +5179,20 @@ export default class ManagementApi {
* Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
* @param {Number} applicationId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2005} and HTTP response
*/
searchCouponsAdvancedApplicationWideWithoutTotalCountWithHttpInfo(applicationId, body, opts) {
@@ -4785,20 +5246,20 @@ export default class ManagementApi {
* Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
* @param {Number} applicationId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {String} opts.batchId Filter results by batches of coupons
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {module:model/String} opts.campaignState Filter results by the state of the campaign.
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {module:model/String=} [opts.campaignState] Filter results by the state of the campaign.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2005}
*/
searchCouponsAdvancedApplicationWideWithoutTotalCount(applicationId, body, opts) {
@@ -4815,19 +5276,19 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {String} opts.batchId Filter results by batches of coupons
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2005} and HTTP response
*/
searchCouponsAdvancedWithoutTotalCountWithHttpInfo(applicationId, campaignId, body, opts) {
@@ -4886,19 +5347,19 @@ export default class ManagementApi {
* @param {Number} applicationId
* @param {Number} campaignId
* @param {Object} body
- * @param {Object} opts Optional parameters
- * @param {Number} opts.pageSize The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
- * @param {Number} opts.skip Skips the given number of items when paging through large result sets.
- * @param {String} opts.sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
- * @param {String} opts.value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
- * @param {Date} opts.createdBefore Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {Date} opts.createdAfter Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
- * @param {module:model/String} opts.valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
- * @param {module:model/String} opts.usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
- * @param {Number} opts.referralId Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
- * @param {String} opts.recipientIntegrationId Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
- * @param {Boolean} opts.exactMatch Filter results to an exact case-insensitive matching against the coupon code (default to false)
- * @param {String} opts.batchId Filter results by batches of coupons
+ * @param {Object} [opts] Optional parameters
+ * @param {Number=} [opts.pageSize] The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+ * @param {Number=} [opts.skip] Skips the given number of items when paging through large result sets.
+ * @param {String=} [opts.sort] The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
+ * @param {String=} [opts.value] Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
+ * @param {Date=} [opts.createdBefore] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {Date=} [opts.createdAfter] Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
+ * @param {module:model/String=} [opts.valid] Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
+ * @param {module:model/String=} [opts.usable] Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
+ * @param {Number=} [opts.referralId] Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
+ * @param {String=} [opts.recipientIntegrationId] Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
+ * @param {Boolean=} [opts.exactMatch] Filter results to an exact case-insensitive matching against the coupon code (default to false)
+ * @param {String=} [opts.batchId] Filter results by batches of coupons
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2005}
*/
searchCouponsAdvancedWithoutTotalCount(applicationId, campaignId, body, opts) {
diff --git a/src/index.js b/src/index.js
index a81f32c8..941827da 100644
--- a/src/index.js
+++ b/src/index.js
@@ -54,7 +54,6 @@ import CampaignSetBranchNode from './model/CampaignSetBranchNode';
import CampaignSetLeafNode from './model/CampaignSetLeafNode';
import CampaignSetNode from './model/CampaignSetNode';
import CartItem from './model/CartItem';
-import CartItemAdjustment from './model/CartItemAdjustment';
import Change from './model/Change';
import ChangeProfilePassword from './model/ChangeProfilePassword';
import CodeGeneratorSettings from './model/CodeGeneratorSettings';
@@ -94,7 +93,6 @@ import FeaturesFeed from './model/FeaturesFeed';
import FeedNotification from './model/FeedNotification';
import FuncArgDef from './model/FuncArgDef';
import FunctionDef from './model/FunctionDef';
-import ImportCoupons from './model/ImportCoupons';
import InlineResponse200 from './model/InlineResponse200';
import InlineResponse2001 from './model/InlineResponse2001';
import InlineResponse20010 from './model/InlineResponse20010';
@@ -166,13 +164,13 @@ import NewCampaign from './model/NewCampaign';
import NewCampaignGroup from './model/NewCampaignGroup';
import NewCampaignSet from './model/NewCampaignSet';
import NewCoupons from './model/NewCoupons';
+import NewCouponsForMultipleRecipients from './model/NewCouponsForMultipleRecipients';
import NewCustomerProfile from './model/NewCustomerProfile';
import NewCustomerSession from './model/NewCustomerSession';
import NewCustomerSessionV2 from './model/NewCustomerSessionV2';
import NewEvent from './model/NewEvent';
import NewEventType from './model/NewEventType';
import NewFeatureFlags from './model/NewFeatureFlags';
-import NewImport from './model/NewImport';
import NewInvitation from './model/NewInvitation';
import NewInviteEmail from './model/NewInviteEmail';
import NewLoyaltyProgram from './model/NewLoyaltyProgram';
@@ -186,6 +184,7 @@ import NewTemplateDef from './model/NewTemplateDef';
import NewUser from './model/NewUser';
import NewWebhook from './model/NewWebhook';
import Notification from './model/Notification';
+import ProfileAudiencesChanges from './model/ProfileAudiencesChanges';
import RedeemReferralEffectProps from './model/RedeemReferralEffectProps';
import Referral from './model/Referral';
import ReferralCreatedEffectProps from './model/ReferralCreatedEffectProps';
@@ -195,9 +194,13 @@ import RejectReferralEffectProps from './model/RejectReferralEffectProps';
import Role from './model/Role';
import RoleAssign from './model/RoleAssign';
import RoleMembership from './model/RoleMembership';
+import RollbackAddedLoyaltyPointsEffectProps from './model/RollbackAddedLoyaltyPointsEffectProps';
import RollbackCouponEffectProps from './model/RollbackCouponEffectProps';
+import RollbackDeductedLoyaltyPointsEffectProps from './model/RollbackDeductedLoyaltyPointsEffectProps';
import RollbackDiscountEffectProps from './model/RollbackDiscountEffectProps';
+import RollbackReferralEffectProps from './model/RollbackReferralEffectProps';
import Rule from './model/Rule';
+import RuleFailureReason from './model/RuleFailureReason';
import Ruleset from './model/Ruleset';
import SamlConnection from './model/SamlConnection';
import SamlConnectionMetadata from './model/SamlConnectionMetadata';
@@ -262,7 +265,7 @@ import ManagementApi from './api/ManagementApi';
*
*
* @module index
-* @version 4.2.0
+* @version 4.3.0
*/
export {
/**
@@ -517,12 +520,6 @@ export {
*/
CartItem,
- /**
- * The CartItemAdjustment model constructor.
- * @property {module:model/CartItemAdjustment}
- */
- CartItemAdjustment,
-
/**
* The Change model constructor.
* @property {module:model/Change}
@@ -757,12 +754,6 @@ export {
*/
FunctionDef,
- /**
- * The ImportCoupons model constructor.
- * @property {module:model/ImportCoupons}
- */
- ImportCoupons,
-
/**
* The InlineResponse200 model constructor.
* @property {module:model/InlineResponse200}
@@ -1189,6 +1180,12 @@ export {
*/
NewCoupons,
+ /**
+ * The NewCouponsForMultipleRecipients model constructor.
+ * @property {module:model/NewCouponsForMultipleRecipients}
+ */
+ NewCouponsForMultipleRecipients,
+
/**
* The NewCustomerProfile model constructor.
* @property {module:model/NewCustomerProfile}
@@ -1225,12 +1222,6 @@ export {
*/
NewFeatureFlags,
- /**
- * The NewImport model constructor.
- * @property {module:model/NewImport}
- */
- NewImport,
-
/**
* The NewInvitation model constructor.
* @property {module:model/NewInvitation}
@@ -1309,6 +1300,12 @@ export {
*/
Notification,
+ /**
+ * The ProfileAudiencesChanges model constructor.
+ * @property {module:model/ProfileAudiencesChanges}
+ */
+ ProfileAudiencesChanges,
+
/**
* The RedeemReferralEffectProps model constructor.
* @property {module:model/RedeemReferralEffectProps}
@@ -1363,24 +1360,48 @@ export {
*/
RoleMembership,
+ /**
+ * The RollbackAddedLoyaltyPointsEffectProps model constructor.
+ * @property {module:model/RollbackAddedLoyaltyPointsEffectProps}
+ */
+ RollbackAddedLoyaltyPointsEffectProps,
+
/**
* The RollbackCouponEffectProps model constructor.
* @property {module:model/RollbackCouponEffectProps}
*/
RollbackCouponEffectProps,
+ /**
+ * The RollbackDeductedLoyaltyPointsEffectProps model constructor.
+ * @property {module:model/RollbackDeductedLoyaltyPointsEffectProps}
+ */
+ RollbackDeductedLoyaltyPointsEffectProps,
+
/**
* The RollbackDiscountEffectProps model constructor.
* @property {module:model/RollbackDiscountEffectProps}
*/
RollbackDiscountEffectProps,
+ /**
+ * The RollbackReferralEffectProps model constructor.
+ * @property {module:model/RollbackReferralEffectProps}
+ */
+ RollbackReferralEffectProps,
+
/**
* The Rule model constructor.
* @property {module:model/Rule}
*/
Rule,
+ /**
+ * The RuleFailureReason model constructor.
+ * @property {module:model/RuleFailureReason}
+ */
+ RuleFailureReason,
+
/**
* The Ruleset model constructor.
* @property {module:model/Ruleset}
diff --git a/src/model/APIError.js b/src/model/APIError.js
index 39ae8318..10a8cd04 100644
--- a/src/model/APIError.js
+++ b/src/model/APIError.js
@@ -17,7 +17,7 @@ import ErrorSource from './ErrorSource';
/**
* The APIError model module.
* @module model/APIError
- * @version 4.2.0
+ * @version 4.3.0
*/
class APIError {
/**
diff --git a/src/model/AcceptCouponEffectProps.js b/src/model/AcceptCouponEffectProps.js
index fa6544dd..ce7ea822 100644
--- a/src/model/AcceptCouponEffectProps.js
+++ b/src/model/AcceptCouponEffectProps.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AcceptCouponEffectProps model module.
* @module model/AcceptCouponEffectProps
- * @version 4.2.0
+ * @version 4.3.0
*/
class AcceptCouponEffectProps {
/**
diff --git a/src/model/AcceptReferralEffectProps.js b/src/model/AcceptReferralEffectProps.js
index 08620440..4021b9fd 100644
--- a/src/model/AcceptReferralEffectProps.js
+++ b/src/model/AcceptReferralEffectProps.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AcceptReferralEffectProps model module.
* @module model/AcceptReferralEffectProps
- * @version 4.2.0
+ * @version 4.3.0
*/
class AcceptReferralEffectProps {
/**
diff --git a/src/model/AccessLogEntry.js b/src/model/AccessLogEntry.js
index 03106b32..941c7587 100644
--- a/src/model/AccessLogEntry.js
+++ b/src/model/AccessLogEntry.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AccessLogEntry model module.
* @module model/AccessLogEntry
- * @version 4.2.0
+ * @version 4.3.0
*/
class AccessLogEntry {
/**
diff --git a/src/model/Account.js b/src/model/Account.js
index 6befc049..bd90cf74 100644
--- a/src/model/Account.js
+++ b/src/model/Account.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The Account model module.
* @module model/Account
- * @version 4.2.0
+ * @version 4.3.0
*/
class Account {
/**
diff --git a/src/model/AccountAdditionalCost.js b/src/model/AccountAdditionalCost.js
index 8f5e5643..055ada92 100644
--- a/src/model/AccountAdditionalCost.js
+++ b/src/model/AccountAdditionalCost.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AccountAdditionalCost model module.
* @module model/AccountAdditionalCost
- * @version 4.2.0
+ * @version 4.3.0
*/
class AccountAdditionalCost {
/**
diff --git a/src/model/AccountAnalytics.js b/src/model/AccountAnalytics.js
index 82c8382e..bac80114 100644
--- a/src/model/AccountAnalytics.js
+++ b/src/model/AccountAnalytics.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AccountAnalytics model module.
* @module model/AccountAnalytics
- * @version 4.2.0
+ * @version 4.3.0
*/
class AccountAnalytics {
/**
diff --git a/src/model/AccountEntity.js b/src/model/AccountEntity.js
index 8f78898e..9401feac 100644
--- a/src/model/AccountEntity.js
+++ b/src/model/AccountEntity.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AccountEntity model module.
* @module model/AccountEntity
- * @version 4.2.0
+ * @version 4.3.0
*/
class AccountEntity {
/**
diff --git a/src/model/AccountLimits.js b/src/model/AccountLimits.js
index a84d28ec..d8803535 100644
--- a/src/model/AccountLimits.js
+++ b/src/model/AccountLimits.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AccountLimits model module.
* @module model/AccountLimits
- * @version 4.2.0
+ * @version 4.3.0
*/
class AccountLimits {
/**
diff --git a/src/model/AddFreeItemEffectProps.js b/src/model/AddFreeItemEffectProps.js
index 32b8da45..2a5d9c6a 100644
--- a/src/model/AddFreeItemEffectProps.js
+++ b/src/model/AddFreeItemEffectProps.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AddFreeItemEffectProps model module.
* @module model/AddFreeItemEffectProps
- * @version 4.2.0
+ * @version 4.3.0
*/
class AddFreeItemEffectProps {
/**
diff --git a/src/model/AddLoyaltyPointsEffectProps.js b/src/model/AddLoyaltyPointsEffectProps.js
index 76d18662..0612c8da 100644
--- a/src/model/AddLoyaltyPointsEffectProps.js
+++ b/src/model/AddLoyaltyPointsEffectProps.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AddLoyaltyPointsEffectProps model module.
* @module model/AddLoyaltyPointsEffectProps
- * @version 4.2.0
+ * @version 4.3.0
*/
class AddLoyaltyPointsEffectProps {
/**
@@ -28,10 +28,11 @@ class AddLoyaltyPointsEffectProps {
* @param subLedgerId {String} The ID of the subledger within the loyalty program where these points were added
* @param value {Number} The amount of points that were added
* @param recipientIntegrationId {String} The user for whom these points were added
+ * @param transactionUUID {String} The identifier of this addition in the loyalty ledger
*/
- constructor(name, programId, subLedgerId, value, recipientIntegrationId) {
+ constructor(name, programId, subLedgerId, value, recipientIntegrationId, transactionUUID) {
- AddLoyaltyPointsEffectProps.initialize(this, name, programId, subLedgerId, value, recipientIntegrationId);
+ AddLoyaltyPointsEffectProps.initialize(this, name, programId, subLedgerId, value, recipientIntegrationId, transactionUUID);
}
/**
@@ -39,12 +40,13 @@ class AddLoyaltyPointsEffectProps {
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
* Only for internal use.
*/
- static initialize(obj, name, programId, subLedgerId, value, recipientIntegrationId) {
+ static initialize(obj, name, programId, subLedgerId, value, recipientIntegrationId, transactionUUID) {
obj['name'] = name;
obj['programId'] = programId;
obj['subLedgerId'] = subLedgerId;
obj['value'] = value;
obj['recipientIntegrationId'] = recipientIntegrationId;
+ obj['transactionUUID'] = transactionUUID;
}
/**
@@ -79,6 +81,9 @@ class AddLoyaltyPointsEffectProps {
if (data.hasOwnProperty('expiryDate')) {
obj['expiryDate'] = ApiClient.convertToType(data['expiryDate'], 'Date');
}
+ if (data.hasOwnProperty('transactionUUID')) {
+ obj['transactionUUID'] = ApiClient.convertToType(data['transactionUUID'], 'String');
+ }
}
return obj;
}
@@ -128,6 +133,12 @@ AddLoyaltyPointsEffectProps.prototype['startDate'] = undefined;
*/
AddLoyaltyPointsEffectProps.prototype['expiryDate'] = undefined;
+/**
+ * The identifier of this addition in the loyalty ledger
+ * @member {String} transactionUUID
+ */
+AddLoyaltyPointsEffectProps.prototype['transactionUUID'] = undefined;
+
diff --git a/src/model/AdditionalCost.js b/src/model/AdditionalCost.js
index af73c58f..bfdff774 100644
--- a/src/model/AdditionalCost.js
+++ b/src/model/AdditionalCost.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AdditionalCost model module.
* @module model/AdditionalCost
- * @version 4.2.0
+ * @version 4.3.0
*/
class AdditionalCost {
/**
diff --git a/src/model/Application.js b/src/model/Application.js
index 4a7e3cc6..b711c84d 100644
--- a/src/model/Application.js
+++ b/src/model/Application.js
@@ -19,7 +19,7 @@ import LoyaltyProgram from './LoyaltyProgram';
/**
* The Application model module.
* @module model/Application
- * @version 4.2.0
+ * @version 4.3.0
*/
class Application {
/**
@@ -106,6 +106,9 @@ class Application {
if (data.hasOwnProperty('exclusiveCampaignsStrategy')) {
obj['exclusiveCampaignsStrategy'] = ApiClient.convertToType(data['exclusiveCampaignsStrategy'], 'String');
}
+ if (data.hasOwnProperty('defaultDiscountScope')) {
+ obj['defaultDiscountScope'] = ApiClient.convertToType(data['defaultDiscountScope'], 'String');
+ }
if (data.hasOwnProperty('enableCascadingDiscounts')) {
obj['enableCascadingDiscounts'] = ApiClient.convertToType(data['enableCascadingDiscounts'], 'Boolean');
}
@@ -206,6 +209,12 @@ Application.prototype['campaignPriority'] = undefined;
*/
Application.prototype['exclusiveCampaignsStrategy'] = undefined;
+/**
+ * The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect.
+ * @member {module:model/Application.DefaultDiscountScopeEnum} defaultDiscountScope
+ */
+Application.prototype['defaultDiscountScope'] = undefined;
+
/**
* Flag indicating if discounts should cascade for this application
* @member {Boolean} enableCascadingDiscounts
@@ -320,6 +329,33 @@ Application['ExclusiveCampaignsStrategyEnum'] = {
};
+/**
+ * Allowed values for the defaultDiscountScope property.
+ * @enum {String}
+ * @readonly
+ */
+Application['DefaultDiscountScopeEnum'] = {
+
+ /**
+ * value: "sessionTotal"
+ * @const
+ */
+ "sessionTotal": "sessionTotal",
+
+ /**
+ * value: "cartItems"
+ * @const
+ */
+ "cartItems": "cartItems",
+
+ /**
+ * value: "additionalCosts"
+ * @const
+ */
+ "additionalCosts": "additionalCosts"
+};
+
+
export default Application;
diff --git a/src/model/ApplicationAPIKey.js b/src/model/ApplicationAPIKey.js
index 6036ad38..9a7cf9e5 100644
--- a/src/model/ApplicationAPIKey.js
+++ b/src/model/ApplicationAPIKey.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The ApplicationAPIKey model module.
* @module model/ApplicationAPIKey
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationAPIKey {
/**
@@ -174,7 +174,13 @@ ApplicationAPIKey['PlatformEnum'] = {
* value: "mparticle"
* @const
*/
- "mparticle": "mparticle"
+ "mparticle": "mparticle",
+
+ /**
+ * value: "selligent"
+ * @const
+ */
+ "selligent": "selligent"
};
diff --git a/src/model/ApplicationApiHealth.js b/src/model/ApplicationApiHealth.js
index 4b2f1362..266dcc25 100644
--- a/src/model/ApplicationApiHealth.js
+++ b/src/model/ApplicationApiHealth.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The ApplicationApiHealth model module.
* @module model/ApplicationApiHealth
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationApiHealth {
/**
diff --git a/src/model/ApplicationCustomer.js b/src/model/ApplicationCustomer.js
index c4ec46e6..3932243a 100644
--- a/src/model/ApplicationCustomer.js
+++ b/src/model/ApplicationCustomer.js
@@ -18,7 +18,7 @@ import LoyaltyMembership from './LoyaltyMembership';
/**
* The ApplicationCustomer model module.
* @module model/ApplicationCustomer
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationCustomer {
/**
diff --git a/src/model/ApplicationCustomerEntity.js b/src/model/ApplicationCustomerEntity.js
index 6ca53639..bbd15188 100644
--- a/src/model/ApplicationCustomerEntity.js
+++ b/src/model/ApplicationCustomerEntity.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The ApplicationCustomerEntity model module.
* @module model/ApplicationCustomerEntity
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationCustomerEntity {
/**
diff --git a/src/model/ApplicationCustomerSearch.js b/src/model/ApplicationCustomerSearch.js
index 9dbf6f85..23372257 100644
--- a/src/model/ApplicationCustomerSearch.js
+++ b/src/model/ApplicationCustomerSearch.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The ApplicationCustomerSearch model module.
* @module model/ApplicationCustomerSearch
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationCustomerSearch {
/**
diff --git a/src/model/ApplicationEntity.js b/src/model/ApplicationEntity.js
index 6a0fd33c..46b66555 100644
--- a/src/model/ApplicationEntity.js
+++ b/src/model/ApplicationEntity.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The ApplicationEntity model module.
* @module model/ApplicationEntity
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationEntity {
/**
diff --git a/src/model/ApplicationEvent.js b/src/model/ApplicationEvent.js
index 72eb0b6e..a0c1e581 100644
--- a/src/model/ApplicationEvent.js
+++ b/src/model/ApplicationEvent.js
@@ -12,11 +12,12 @@
*/
import ApiClient from '../ApiClient';
+import RuleFailureReason from './RuleFailureReason';
/**
* The ApplicationEvent model module.
* @module model/ApplicationEvent
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationEvent {
/**
@@ -84,6 +85,9 @@ class ApplicationEvent {
if (data.hasOwnProperty('effects')) {
obj['effects'] = ApiClient.convertToType(data['effects'], [Object]);
}
+ if (data.hasOwnProperty('ruleFailureReasons')) {
+ obj['ruleFailureReasons'] = ApiClient.convertToType(data['ruleFailureReasons'], [RuleFailureReason]);
+ }
}
return obj;
}
@@ -139,6 +143,12 @@ ApplicationEvent.prototype['attributes'] = undefined;
*/
ApplicationEvent.prototype['effects'] = undefined;
+/**
+ * An array containing the rule failure reasons which happened during this event.
+ * @member {Array.} ruleFailureReasons
+ */
+ApplicationEvent.prototype['ruleFailureReasons'] = undefined;
+
diff --git a/src/model/ApplicationSession.js b/src/model/ApplicationSession.js
index 7cb8a946..c3dd8ba1 100644
--- a/src/model/ApplicationSession.js
+++ b/src/model/ApplicationSession.js
@@ -17,7 +17,7 @@ import CartItem from './CartItem';
/**
* The ApplicationSession model module.
* @module model/ApplicationSession
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationSession {
/**
diff --git a/src/model/ApplicationSessionEntity.js b/src/model/ApplicationSessionEntity.js
index cbe9295d..fef9b84f 100644
--- a/src/model/ApplicationSessionEntity.js
+++ b/src/model/ApplicationSessionEntity.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The ApplicationSessionEntity model module.
* @module model/ApplicationSessionEntity
- * @version 4.2.0
+ * @version 4.3.0
*/
class ApplicationSessionEntity {
/**
diff --git a/src/model/Attribute.js b/src/model/Attribute.js
index 1b7d8f21..48ec989f 100644
--- a/src/model/Attribute.js
+++ b/src/model/Attribute.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The Attribute model module.
* @module model/Attribute
- * @version 4.2.0
+ * @version 4.3.0
*/
class Attribute {
/**
diff --git a/src/model/AttributesMandatory.js b/src/model/AttributesMandatory.js
index c86d6dbf..272378aa 100644
--- a/src/model/AttributesMandatory.js
+++ b/src/model/AttributesMandatory.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AttributesMandatory model module.
* @module model/AttributesMandatory
- * @version 4.2.0
+ * @version 4.3.0
*/
class AttributesMandatory {
/**
diff --git a/src/model/AttributesSettings.js b/src/model/AttributesSettings.js
index 99b065b2..cc11cfa4 100644
--- a/src/model/AttributesSettings.js
+++ b/src/model/AttributesSettings.js
@@ -17,7 +17,7 @@ import AttributesMandatory from './AttributesMandatory';
/**
* The AttributesSettings model module.
* @module model/AttributesSettings
- * @version 4.2.0
+ * @version 4.3.0
*/
class AttributesSettings {
/**
diff --git a/src/model/Audience.js b/src/model/Audience.js
index fcc2ab8d..e01e6630 100644
--- a/src/model/Audience.js
+++ b/src/model/Audience.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The Audience model module.
* @module model/Audience
- * @version 4.2.0
+ * @version 4.3.0
*/
class Audience {
/**
diff --git a/src/model/AudienceMembership.js b/src/model/AudienceMembership.js
index 5d12503e..b0ed3335 100644
--- a/src/model/AudienceMembership.js
+++ b/src/model/AudienceMembership.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The AudienceMembership model module.
* @module model/AudienceMembership
- * @version 4.2.0
+ * @version 4.3.0
*/
class AudienceMembership {
/**
diff --git a/src/model/BaseSamlConnection.js b/src/model/BaseSamlConnection.js
index 382776dc..1c499e93 100644
--- a/src/model/BaseSamlConnection.js
+++ b/src/model/BaseSamlConnection.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The BaseSamlConnection model module.
* @module model/BaseSamlConnection
- * @version 4.2.0
+ * @version 4.3.0
*/
class BaseSamlConnection {
/**
diff --git a/src/model/Binding.js b/src/model/Binding.js
index 146ae993..3b937619 100644
--- a/src/model/Binding.js
+++ b/src/model/Binding.js
@@ -16,7 +16,7 @@ import ApiClient from '../ApiClient';
/**
* The Binding model module.
* @module model/Binding
- * @version 4.2.0
+ * @version 4.3.0
*/
class Binding {
/**
@@ -54,6 +54,9 @@ class Binding {
if (data.hasOwnProperty('name')) {
obj['name'] = ApiClient.convertToType(data['name'], 'String');
}
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
+ }
if (data.hasOwnProperty('expression')) {
obj['expression'] = ApiClient.convertToType(data['expression'], [Object]);
}
@@ -70,6 +73,12 @@ class Binding {
*/
Binding.prototype['name'] = undefined;
+/**
+ * The kind of binding. Possible values are cartItemFilter, subledgerBalance.
+ * @member {String} type
+ */
+Binding.prototype['type'] = undefined;
+
/**
* A Talang expression that will be evaluated and its result attached to the name of the binding.
* @member {Array.