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.} expression diff --git a/src/model/Campaign.js b/src/model/Campaign.js index 7b951047..add19cd4 100644 --- a/src/model/Campaign.js +++ b/src/model/Campaign.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The Campaign model module. * @module model/Campaign - * @version 4.2.0 + * @version 4.3.0 */ class Campaign { /** @@ -136,6 +136,21 @@ class Campaign { if (data.hasOwnProperty('couponCreationCount')) { obj['couponCreationCount'] = ApiClient.convertToType(data['couponCreationCount'], 'Number'); } + if (data.hasOwnProperty('referralCreationCount')) { + obj['referralCreationCount'] = ApiClient.convertToType(data['referralCreationCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsCount')) { + obj['createdLoyaltyPointsCount'] = ApiClient.convertToType(data['createdLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('createdLoyaltyPointsEffectCount')) { + obj['createdLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['createdLoyaltyPointsEffectCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsCount')) { + obj['redeemedLoyaltyPointsCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsCount'], 'Number'); + } + if (data.hasOwnProperty('redeemedLoyaltyPointsEffectCount')) { + obj['redeemedLoyaltyPointsEffectCount'] = ApiClient.convertToType(data['redeemedLoyaltyPointsEffectCount'], 'Number'); + } if (data.hasOwnProperty('lastActivity')) { obj['lastActivity'] = ApiClient.convertToType(data['lastActivity'], 'Date'); } @@ -286,6 +301,36 @@ Campaign.prototype['discountEffectCount'] = undefined; */ Campaign.prototype['couponCreationCount'] = undefined; +/** + * Total number of referrals created by rules in this campaign. + * @member {Number} referralCreationCount + */ +Campaign.prototype['referralCreationCount'] = undefined; + +/** + * Total number of loyalty points created by rules in this campaign. + * @member {Number} createdLoyaltyPointsCount + */ +Campaign.prototype['createdLoyaltyPointsCount'] = undefined; + +/** + * Total number of loyalty point creation effects triggered by rules in this campaign. + * @member {Number} createdLoyaltyPointsEffectCount + */ +Campaign.prototype['createdLoyaltyPointsEffectCount'] = undefined; + +/** + * Total number of loyalty points redeemed by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsCount + */ +Campaign.prototype['redeemedLoyaltyPointsCount'] = undefined; + +/** + * Total number of loyalty point redemption effects triggered by rules in this campaign. + * @member {Number} redeemedLoyaltyPointsEffectCount + */ +Campaign.prototype['redeemedLoyaltyPointsEffectCount'] = undefined; + /** * Timestamp of the most recent event received by this campaign. * @member {Date} lastActivity diff --git a/src/model/CampaignAnalytics.js b/src/model/CampaignAnalytics.js index 57379bd6..69af7864 100644 --- a/src/model/CampaignAnalytics.js +++ b/src/model/CampaignAnalytics.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignAnalytics model module. * @module model/CampaignAnalytics - * @version 4.2.0 + * @version 4.3.0 */ class CampaignAnalytics { /** diff --git a/src/model/CampaignCopy.js b/src/model/CampaignCopy.js index 9208ee67..f8d94bde 100644 --- a/src/model/CampaignCopy.js +++ b/src/model/CampaignCopy.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignCopy model module. * @module model/CampaignCopy - * @version 4.2.0 + * @version 4.3.0 */ class CampaignCopy { /** diff --git a/src/model/CampaignEntity.js b/src/model/CampaignEntity.js index d316f477..ec72e24c 100644 --- a/src/model/CampaignEntity.js +++ b/src/model/CampaignEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignEntity model module. * @module model/CampaignEntity - * @version 4.2.0 + * @version 4.3.0 */ class CampaignEntity { /** diff --git a/src/model/CampaignGroup.js b/src/model/CampaignGroup.js index 55d9fc0b..9acc978f 100644 --- a/src/model/CampaignGroup.js +++ b/src/model/CampaignGroup.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignGroup model module. * @module model/CampaignGroup - * @version 4.2.0 + * @version 4.3.0 */ class CampaignGroup { /** diff --git a/src/model/CampaignGroupEntity.js b/src/model/CampaignGroupEntity.js index a9b5696d..109569ff 100644 --- a/src/model/CampaignGroupEntity.js +++ b/src/model/CampaignGroupEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignGroupEntity model module. * @module model/CampaignGroupEntity - * @version 4.2.0 + * @version 4.3.0 */ class CampaignGroupEntity { /** diff --git a/src/model/CampaignSearch.js b/src/model/CampaignSearch.js index 099bc39f..0d5bff8e 100644 --- a/src/model/CampaignSearch.js +++ b/src/model/CampaignSearch.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignSearch model module. * @module model/CampaignSearch - * @version 4.2.0 + * @version 4.3.0 */ class CampaignSearch { /** diff --git a/src/model/CampaignSet.js b/src/model/CampaignSet.js index 52600036..906969d6 100644 --- a/src/model/CampaignSet.js +++ b/src/model/CampaignSet.js @@ -17,7 +17,7 @@ import CampaignSetBranchNode from './CampaignSetBranchNode'; /** * The CampaignSet model module. * @module model/CampaignSet - * @version 4.2.0 + * @version 4.3.0 */ class CampaignSet { /** diff --git a/src/model/CampaignSetBranchNode.js b/src/model/CampaignSetBranchNode.js index 3bb17699..82c9cd4f 100644 --- a/src/model/CampaignSetBranchNode.js +++ b/src/model/CampaignSetBranchNode.js @@ -17,7 +17,7 @@ import CampaignSetNode from './CampaignSetNode'; /** * The CampaignSetBranchNode model module. * @module model/CampaignSetBranchNode - * @version 4.2.0 + * @version 4.3.0 */ class CampaignSetBranchNode { /** diff --git a/src/model/CampaignSetLeafNode.js b/src/model/CampaignSetLeafNode.js index 49ab6723..d2d61ecb 100644 --- a/src/model/CampaignSetLeafNode.js +++ b/src/model/CampaignSetLeafNode.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignSetLeafNode model module. * @module model/CampaignSetLeafNode - * @version 4.2.0 + * @version 4.3.0 */ class CampaignSetLeafNode { /** diff --git a/src/model/CampaignSetNode.js b/src/model/CampaignSetNode.js index f24fe0a7..ac2da988 100644 --- a/src/model/CampaignSetNode.js +++ b/src/model/CampaignSetNode.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CampaignSetNode model module. * @module model/CampaignSetNode - * @version 4.2.0 + * @version 4.3.0 */ class CampaignSetNode { /** diff --git a/src/model/CartItem.js b/src/model/CartItem.js index 9771afc4..491b5730 100644 --- a/src/model/CartItem.js +++ b/src/model/CartItem.js @@ -12,12 +12,11 @@ */ import ApiClient from '../ApiClient'; -import CartItemAdjustment from './CartItemAdjustment'; /** * The CartItem model module. * @module model/CartItem - * @version 4.2.0 + * @version 4.3.0 */ class CartItem { /** @@ -89,9 +88,6 @@ class CartItem { if (data.hasOwnProperty('attributes')) { obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); } - if (data.hasOwnProperty('adjustment')) { - obj['adjustment'] = CartItemAdjustment.constructFromObject(data['adjustment']); - } } return obj; } @@ -160,11 +156,6 @@ CartItem.prototype['position'] = undefined; */ CartItem.prototype['attributes'] = undefined; -/** - * @member {module:model/CartItemAdjustment} adjustment - */ -CartItem.prototype['adjustment'] = undefined; - diff --git a/src/model/Change.js b/src/model/Change.js index a2da7bf1..0c27692d 100644 --- a/src/model/Change.js +++ b/src/model/Change.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Change model module. * @module model/Change - * @version 4.2.0 + * @version 4.3.0 */ class Change { /** @@ -65,6 +65,9 @@ class Change { if (data.hasOwnProperty('userId')) { obj['userId'] = ApiClient.convertToType(data['userId'], 'Number'); } + if (data.hasOwnProperty('applicationId')) { + obj['applicationId'] = ApiClient.convertToType(data['applicationId'], 'Number'); + } if (data.hasOwnProperty('entity')) { obj['entity'] = ApiClient.convertToType(data['entity'], 'String'); } @@ -99,6 +102,12 @@ Change.prototype['created'] = undefined; */ Change.prototype['userId'] = undefined; +/** + * ID of application associated with change + * @member {Number} applicationId + */ +Change.prototype['applicationId'] = undefined; + /** * API endpoint on which the change was initiated. * @member {String} entity diff --git a/src/model/ChangeProfilePassword.js b/src/model/ChangeProfilePassword.js index 2ad1b8a5..78f51a3c 100644 --- a/src/model/ChangeProfilePassword.js +++ b/src/model/ChangeProfilePassword.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ChangeProfilePassword model module. * @module model/ChangeProfilePassword - * @version 4.2.0 + * @version 4.3.0 */ class ChangeProfilePassword { /** diff --git a/src/model/CodeGeneratorSettings.js b/src/model/CodeGeneratorSettings.js index a715126f..616f2280 100644 --- a/src/model/CodeGeneratorSettings.js +++ b/src/model/CodeGeneratorSettings.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CodeGeneratorSettings model module. * @module model/CodeGeneratorSettings - * @version 4.2.0 + * @version 4.3.0 */ class CodeGeneratorSettings { /** diff --git a/src/model/Coupon.js b/src/model/Coupon.js index ae33d2dc..0fa5344d 100644 --- a/src/model/Coupon.js +++ b/src/model/Coupon.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Coupon model module. * @module model/Coupon - * @version 4.2.0 + * @version 4.3.0 */ class Coupon { /** diff --git a/src/model/CouponConstraints.js b/src/model/CouponConstraints.js index 694e7b11..84fb758d 100644 --- a/src/model/CouponConstraints.js +++ b/src/model/CouponConstraints.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponConstraints model module. * @module model/CouponConstraints - * @version 4.2.0 + * @version 4.3.0 */ class CouponConstraints { /** diff --git a/src/model/CouponCreatedEffectProps.js b/src/model/CouponCreatedEffectProps.js index 9f9fbbdb..821db9da 100644 --- a/src/model/CouponCreatedEffectProps.js +++ b/src/model/CouponCreatedEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponCreatedEffectProps model module. * @module model/CouponCreatedEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class CouponCreatedEffectProps { /** diff --git a/src/model/CouponRejectionReason.js b/src/model/CouponRejectionReason.js index 2e1905d5..9200339a 100644 --- a/src/model/CouponRejectionReason.js +++ b/src/model/CouponRejectionReason.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponRejectionReason model module. * @module model/CouponRejectionReason - * @version 4.2.0 + * @version 4.3.0 */ class CouponRejectionReason { /** diff --git a/src/model/CouponReservations.js b/src/model/CouponReservations.js index 54b19df5..c2b5e63c 100644 --- a/src/model/CouponReservations.js +++ b/src/model/CouponReservations.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponReservations model module. * @module model/CouponReservations - * @version 4.2.0 + * @version 4.3.0 */ class CouponReservations { /** diff --git a/src/model/CouponSearch.js b/src/model/CouponSearch.js index 3664aac8..3b0cca28 100644 --- a/src/model/CouponSearch.js +++ b/src/model/CouponSearch.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponSearch model module. * @module model/CouponSearch - * @version 4.2.0 + * @version 4.3.0 */ class CouponSearch { /** diff --git a/src/model/CouponValue.js b/src/model/CouponValue.js index 8fd26add..7c8a374b 100644 --- a/src/model/CouponValue.js +++ b/src/model/CouponValue.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CouponValue model module. * @module model/CouponValue - * @version 4.2.0 + * @version 4.3.0 */ class CouponValue { /** diff --git a/src/model/CreateApplicationAPIKey.js b/src/model/CreateApplicationAPIKey.js index deb07d14..1b3440f7 100644 --- a/src/model/CreateApplicationAPIKey.js +++ b/src/model/CreateApplicationAPIKey.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CreateApplicationAPIKey model module. * @module model/CreateApplicationAPIKey - * @version 4.2.0 + * @version 4.3.0 */ class CreateApplicationAPIKey { /** @@ -118,7 +118,13 @@ CreateApplicationAPIKey['PlatformEnum'] = { * value: "mparticle" * @const */ - "mparticle": "mparticle" + "mparticle": "mparticle", + + /** + * value: "selligent" + * @const + */ + "selligent": "selligent" }; diff --git a/src/model/CustomerActivityReport.js b/src/model/CustomerActivityReport.js index 28092f5f..e1659553 100644 --- a/src/model/CustomerActivityReport.js +++ b/src/model/CustomerActivityReport.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerActivityReport model module. * @module model/CustomerActivityReport - * @version 4.2.0 + * @version 4.3.0 */ class CustomerActivityReport { /** diff --git a/src/model/CustomerAnalytics.js b/src/model/CustomerAnalytics.js index 01ef3c6e..1e76f931 100644 --- a/src/model/CustomerAnalytics.js +++ b/src/model/CustomerAnalytics.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerAnalytics model module. * @module model/CustomerAnalytics - * @version 4.2.0 + * @version 4.3.0 */ class CustomerAnalytics { /** diff --git a/src/model/CustomerInventory.js b/src/model/CustomerInventory.js index ccba6dde..503dd162 100644 --- a/src/model/CustomerInventory.js +++ b/src/model/CustomerInventory.js @@ -20,7 +20,7 @@ import Referral from './Referral'; /** * The CustomerInventory model module. * @module model/CustomerInventory - * @version 4.2.0 + * @version 4.3.0 */ class CustomerInventory { /** diff --git a/src/model/CustomerProfile.js b/src/model/CustomerProfile.js index 8321141a..7e8fa3e8 100644 --- a/src/model/CustomerProfile.js +++ b/src/model/CustomerProfile.js @@ -18,7 +18,7 @@ import LoyaltyMembership from './LoyaltyMembership'; /** * The CustomerProfile model module. * @module model/CustomerProfile - * @version 4.2.0 + * @version 4.3.0 */ class CustomerProfile { /** diff --git a/src/model/CustomerProfileAudienceRequest.js b/src/model/CustomerProfileAudienceRequest.js index c08700b6..4a552c74 100644 --- a/src/model/CustomerProfileAudienceRequest.js +++ b/src/model/CustomerProfileAudienceRequest.js @@ -17,7 +17,7 @@ import CustomerProfileAudienceRequestItem from './CustomerProfileAudienceRequest /** * The CustomerProfileAudienceRequest model module. * @module model/CustomerProfileAudienceRequest - * @version 4.2.0 + * @version 4.3.0 */ class CustomerProfileAudienceRequest { /** diff --git a/src/model/CustomerProfileAudienceRequestItem.js b/src/model/CustomerProfileAudienceRequestItem.js index 7e131191..155740fe 100644 --- a/src/model/CustomerProfileAudienceRequestItem.js +++ b/src/model/CustomerProfileAudienceRequestItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerProfileAudienceRequestItem model module. * @module model/CustomerProfileAudienceRequestItem - * @version 4.2.0 + * @version 4.3.0 */ class CustomerProfileAudienceRequestItem { /** diff --git a/src/model/CustomerProfileIntegrationRequestV2.js b/src/model/CustomerProfileIntegrationRequestV2.js index 80700a61..4ac5c4ea 100644 --- a/src/model/CustomerProfileIntegrationRequestV2.js +++ b/src/model/CustomerProfileIntegrationRequestV2.js @@ -12,11 +12,12 @@ */ import ApiClient from '../ApiClient'; +import ProfileAudiencesChanges from './ProfileAudiencesChanges'; /** * The CustomerProfileIntegrationRequestV2 model module. * @module model/CustomerProfileIntegrationRequestV2 - * @version 4.2.0 + * @version 4.3.0 */ class CustomerProfileIntegrationRequestV2 { /** @@ -51,6 +52,9 @@ class CustomerProfileIntegrationRequestV2 { if (data.hasOwnProperty('attributes')) { obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); } + if (data.hasOwnProperty('audiencesChanges')) { + obj['audiencesChanges'] = ProfileAudiencesChanges.constructFromObject(data['audiencesChanges']); + } if (data.hasOwnProperty('responseContent')) { obj['responseContent'] = ApiClient.convertToType(data['responseContent'], ['String']); } @@ -68,7 +72,12 @@ class CustomerProfileIntegrationRequestV2 { CustomerProfileIntegrationRequestV2.prototype['attributes'] = undefined; /** - * Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\" and \"event\". + * @member {module:model/ProfileAudiencesChanges} audiencesChanges + */ +CustomerProfileIntegrationRequestV2.prototype['audiencesChanges'] = undefined; + +/** + * 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\". * @member {Array.} responseContent */ CustomerProfileIntegrationRequestV2.prototype['responseContent'] = undefined; @@ -106,7 +115,13 @@ CustomerProfileIntegrationRequestV2['ResponseContentEnum'] = { * value: "event" * @const */ - "event": "event" + "event": "event", + + /** + * value: "ruleFailureReasons" + * @const + */ + "ruleFailureReasons": "ruleFailureReasons" }; diff --git a/src/model/CustomerProfileSearchQuery.js b/src/model/CustomerProfileSearchQuery.js index 20068b68..8873f6a5 100644 --- a/src/model/CustomerProfileSearchQuery.js +++ b/src/model/CustomerProfileSearchQuery.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The CustomerProfileSearchQuery model module. * @module model/CustomerProfileSearchQuery - * @version 4.2.0 + * @version 4.3.0 */ class CustomerProfileSearchQuery { /** diff --git a/src/model/CustomerSession.js b/src/model/CustomerSession.js index dbf0eb0d..7b8bbe5d 100644 --- a/src/model/CustomerSession.js +++ b/src/model/CustomerSession.js @@ -17,7 +17,7 @@ import CartItem from './CartItem'; /** * The CustomerSession model module. * @module model/CustomerSession - * @version 4.2.0 + * @version 4.3.0 */ class CustomerSession { /** diff --git a/src/model/CustomerSessionV2.js b/src/model/CustomerSessionV2.js index bee6e794..1f02d7ff 100644 --- a/src/model/CustomerSessionV2.js +++ b/src/model/CustomerSessionV2.js @@ -18,7 +18,7 @@ import CartItem from './CartItem'; /** * The CustomerSessionV2 model module. * @module model/CustomerSessionV2 - * @version 4.2.0 + * @version 4.3.0 */ class CustomerSessionV2 { /** diff --git a/src/model/DeductLoyaltyPointsEffectProps.js b/src/model/DeductLoyaltyPointsEffectProps.js index 6bdd68a3..4cb228a1 100644 --- a/src/model/DeductLoyaltyPointsEffectProps.js +++ b/src/model/DeductLoyaltyPointsEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The DeductLoyaltyPointsEffectProps model module. * @module model/DeductLoyaltyPointsEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class DeductLoyaltyPointsEffectProps { /** @@ -27,10 +27,11 @@ class DeductLoyaltyPointsEffectProps { * @param programId {Number} The ID of the loyalty program where these points were added * @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 deducted + * @param transactionUUID {String} The identifier of this deduction in the loyalty ledger */ - constructor(ruleTitle, programId, subLedgerId, value) { + constructor(ruleTitle, programId, subLedgerId, value, transactionUUID) { - DeductLoyaltyPointsEffectProps.initialize(this, ruleTitle, programId, subLedgerId, value); + DeductLoyaltyPointsEffectProps.initialize(this, ruleTitle, programId, subLedgerId, value, transactionUUID); } /** @@ -38,11 +39,12 @@ class DeductLoyaltyPointsEffectProps { * 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, ruleTitle, programId, subLedgerId, value) { + static initialize(obj, ruleTitle, programId, subLedgerId, value, transactionUUID) { obj['ruleTitle'] = ruleTitle; obj['programId'] = programId; obj['subLedgerId'] = subLedgerId; obj['value'] = value; + obj['transactionUUID'] = transactionUUID; } /** @@ -68,6 +70,9 @@ class DeductLoyaltyPointsEffectProps { if (data.hasOwnProperty('value')) { obj['value'] = ApiClient.convertToType(data['value'], 'Number'); } + if (data.hasOwnProperty('transactionUUID')) { + obj['transactionUUID'] = ApiClient.convertToType(data['transactionUUID'], 'String'); + } } return obj; } @@ -99,6 +104,12 @@ DeductLoyaltyPointsEffectProps.prototype['subLedgerId'] = undefined; */ DeductLoyaltyPointsEffectProps.prototype['value'] = undefined; +/** + * The identifier of this deduction in the loyalty ledger + * @member {String} transactionUUID + */ +DeductLoyaltyPointsEffectProps.prototype['transactionUUID'] = undefined; + diff --git a/src/model/Effect.js b/src/model/Effect.js index 089c9349..94feee80 100644 --- a/src/model/Effect.js +++ b/src/model/Effect.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Effect model module. * @module model/Effect - * @version 4.2.0 + * @version 4.3.0 */ class Effect { /** @@ -75,6 +75,9 @@ class Effect { if (data.hasOwnProperty('effectType')) { obj['effectType'] = ApiClient.convertToType(data['effectType'], 'String'); } + if (data.hasOwnProperty('triggeredByCoupon')) { + obj['triggeredByCoupon'] = ApiClient.convertToType(data['triggeredByCoupon'], 'Number'); + } if (data.hasOwnProperty('props')) { obj['props'] = ApiClient.convertToType(data['props'], Object); } @@ -115,6 +118,12 @@ Effect.prototype['ruleName'] = undefined; */ Effect.prototype['effectType'] = undefined; +/** + * The ID of the coupon that was being evaluated when this effect was triggered + * @member {Number} triggeredByCoupon + */ +Effect.prototype['triggeredByCoupon'] = undefined; + /** * @member {Object} props */ diff --git a/src/model/EffectEntity.js b/src/model/EffectEntity.js index 75474139..a2613cd9 100644 --- a/src/model/EffectEntity.js +++ b/src/model/EffectEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EffectEntity model module. * @module model/EffectEntity - * @version 4.2.0 + * @version 4.3.0 */ class EffectEntity { /** @@ -73,6 +73,9 @@ class EffectEntity { if (data.hasOwnProperty('effectType')) { obj['effectType'] = ApiClient.convertToType(data['effectType'], 'String'); } + if (data.hasOwnProperty('triggeredByCoupon')) { + obj['triggeredByCoupon'] = ApiClient.convertToType(data['triggeredByCoupon'], 'Number'); + } } return obj; } @@ -110,6 +113,12 @@ EffectEntity.prototype['ruleName'] = undefined; */ EffectEntity.prototype['effectType'] = undefined; +/** + * The ID of the coupon that was being evaluated when this effect was triggered + * @member {Number} triggeredByCoupon + */ +EffectEntity.prototype['triggeredByCoupon'] = undefined; + diff --git a/src/model/EmailEntity.js b/src/model/EmailEntity.js index dda6baed..47421808 100644 --- a/src/model/EmailEntity.js +++ b/src/model/EmailEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EmailEntity model module. * @module model/EmailEntity - * @version 4.2.0 + * @version 4.3.0 */ class EmailEntity { /** diff --git a/src/model/Entity.js b/src/model/Entity.js index 215496da..a80f37e2 100644 --- a/src/model/Entity.js +++ b/src/model/Entity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Entity model module. * @module model/Entity - * @version 4.2.0 + * @version 4.3.0 */ class Entity { /** diff --git a/src/model/EntityWithTalangVisibleID.js b/src/model/EntityWithTalangVisibleID.js index c082e6e7..d2bef422 100644 --- a/src/model/EntityWithTalangVisibleID.js +++ b/src/model/EntityWithTalangVisibleID.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EntityWithTalangVisibleID model module. * @module model/EntityWithTalangVisibleID - * @version 4.2.0 + * @version 4.3.0 */ class EntityWithTalangVisibleID { /** diff --git a/src/model/Environment.js b/src/model/Environment.js index 9e22f332..85ebbead 100644 --- a/src/model/Environment.js +++ b/src/model/Environment.js @@ -19,7 +19,7 @@ import TemplateDef from './TemplateDef'; /** * The Environment model module. * @module model/Environment - * @version 4.2.0 + * @version 4.3.0 */ class Environment { /** diff --git a/src/model/ErrorEffectProps.js b/src/model/ErrorEffectProps.js index 555affec..39adac1a 100644 --- a/src/model/ErrorEffectProps.js +++ b/src/model/ErrorEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ErrorEffectProps model module. * @module model/ErrorEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class ErrorEffectProps { /** diff --git a/src/model/ErrorResponse.js b/src/model/ErrorResponse.js index 162ced32..432856de 100644 --- a/src/model/ErrorResponse.js +++ b/src/model/ErrorResponse.js @@ -17,7 +17,7 @@ import APIError from './APIError'; /** * The ErrorResponse model module. * @module model/ErrorResponse - * @version 4.2.0 + * @version 4.3.0 */ class ErrorResponse { /** diff --git a/src/model/ErrorSource.js b/src/model/ErrorSource.js index 64866de4..7963b2a2 100644 --- a/src/model/ErrorSource.js +++ b/src/model/ErrorSource.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ErrorSource model module. * @module model/ErrorSource - * @version 4.2.0 + * @version 4.3.0 */ class ErrorSource { /** diff --git a/src/model/Event.js b/src/model/Event.js index d29c9103..d16b94b6 100644 --- a/src/model/Event.js +++ b/src/model/Event.js @@ -18,7 +18,7 @@ import Meta from './Meta'; /** * The Event model module. * @module model/Event - * @version 4.2.0 + * @version 4.3.0 */ class Event { /** diff --git a/src/model/EventType.js b/src/model/EventType.js index 20fe8fb3..b37a75a2 100644 --- a/src/model/EventType.js +++ b/src/model/EventType.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The EventType model module. * @module model/EventType - * @version 4.2.0 + * @version 4.3.0 */ class EventType { /** diff --git a/src/model/FeatureFlag.js b/src/model/FeatureFlag.js index 12d1125a..bd20907a 100644 --- a/src/model/FeatureFlag.js +++ b/src/model/FeatureFlag.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FeatureFlag model module. * @module model/FeatureFlag - * @version 4.2.0 + * @version 4.3.0 */ class FeatureFlag { /** diff --git a/src/model/FeatureFlags.js b/src/model/FeatureFlags.js index cd2d3c4c..6fd21f7a 100644 --- a/src/model/FeatureFlags.js +++ b/src/model/FeatureFlags.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FeatureFlags model module. * @module model/FeatureFlags - * @version 4.2.0 + * @version 4.3.0 */ class FeatureFlags { /** diff --git a/src/model/FeaturesFeed.js b/src/model/FeaturesFeed.js index 1dd1dd85..b6e17712 100644 --- a/src/model/FeaturesFeed.js +++ b/src/model/FeaturesFeed.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FeaturesFeed model module. * @module model/FeaturesFeed - * @version 4.2.0 + * @version 4.3.0 */ class FeaturesFeed { /** diff --git a/src/model/FeedNotification.js b/src/model/FeedNotification.js index 015ce637..a65dbc00 100644 --- a/src/model/FeedNotification.js +++ b/src/model/FeedNotification.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FeedNotification model module. * @module model/FeedNotification - * @version 4.2.0 + * @version 4.3.0 */ class FeedNotification { /** diff --git a/src/model/FuncArgDef.js b/src/model/FuncArgDef.js index edc01e7e..4ee00869 100644 --- a/src/model/FuncArgDef.js +++ b/src/model/FuncArgDef.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The FuncArgDef model module. * @module model/FuncArgDef - * @version 4.2.0 + * @version 4.3.0 */ class FuncArgDef { /** diff --git a/src/model/FunctionDef.js b/src/model/FunctionDef.js index 8686b144..36a59554 100644 --- a/src/model/FunctionDef.js +++ b/src/model/FunctionDef.js @@ -17,7 +17,7 @@ import FuncArgDef from './FuncArgDef'; /** * The FunctionDef model module. * @module model/FunctionDef - * @version 4.2.0 + * @version 4.3.0 */ class FunctionDef { /** diff --git a/src/model/InlineResponse200.js b/src/model/InlineResponse200.js index 7475c4f5..da393fb0 100644 --- a/src/model/InlineResponse200.js +++ b/src/model/InlineResponse200.js @@ -17,7 +17,7 @@ import CustomerProfile from './CustomerProfile'; /** * The InlineResponse200 model module. * @module model/InlineResponse200 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse200 { /** diff --git a/src/model/InlineResponse2001.js b/src/model/InlineResponse2001.js index d1a3a02c..fa2114f3 100644 --- a/src/model/InlineResponse2001.js +++ b/src/model/InlineResponse2001.js @@ -17,7 +17,7 @@ import Application from './Application'; /** * The InlineResponse2001 model module. * @module model/InlineResponse2001 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2001 { /** diff --git a/src/model/InlineResponse20010.js b/src/model/InlineResponse20010.js index f937e79c..d20182d4 100644 --- a/src/model/InlineResponse20010.js +++ b/src/model/InlineResponse20010.js @@ -17,7 +17,7 @@ import AccessLogEntry from './AccessLogEntry'; /** * The InlineResponse20010 model module. * @module model/InlineResponse20010 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20010 { /** diff --git a/src/model/InlineResponse20011.js b/src/model/InlineResponse20011.js index e281a059..fe9e1f95 100644 --- a/src/model/InlineResponse20011.js +++ b/src/model/InlineResponse20011.js @@ -17,7 +17,7 @@ import CampaignAnalytics from './CampaignAnalytics'; /** * The InlineResponse20011 model module. * @module model/InlineResponse20011 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20011 { /** diff --git a/src/model/InlineResponse20012.js b/src/model/InlineResponse20012.js index 8752f88a..3af65c2c 100644 --- a/src/model/InlineResponse20012.js +++ b/src/model/InlineResponse20012.js @@ -17,7 +17,7 @@ import ApplicationCustomer from './ApplicationCustomer'; /** * The InlineResponse20012 model module. * @module model/InlineResponse20012 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20012 { /** diff --git a/src/model/InlineResponse20013.js b/src/model/InlineResponse20013.js index bd0d81ac..e0b08860 100644 --- a/src/model/InlineResponse20013.js +++ b/src/model/InlineResponse20013.js @@ -17,7 +17,7 @@ import ApplicationCustomer from './ApplicationCustomer'; /** * The InlineResponse20013 model module. * @module model/InlineResponse20013 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20013 { /** diff --git a/src/model/InlineResponse20014.js b/src/model/InlineResponse20014.js index 5a01ca3f..fc5f67e7 100644 --- a/src/model/InlineResponse20014.js +++ b/src/model/InlineResponse20014.js @@ -17,7 +17,7 @@ import CustomerActivityReport from './CustomerActivityReport'; /** * The InlineResponse20014 model module. * @module model/InlineResponse20014 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20014 { /** diff --git a/src/model/InlineResponse20015.js b/src/model/InlineResponse20015.js index e2ecf183..ea96cc59 100644 --- a/src/model/InlineResponse20015.js +++ b/src/model/InlineResponse20015.js @@ -17,7 +17,7 @@ import CustomerActivityReport from './CustomerActivityReport'; /** * The InlineResponse20015 model module. * @module model/InlineResponse20015 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20015 { /** diff --git a/src/model/InlineResponse20016.js b/src/model/InlineResponse20016.js index 4da965d9..62303c86 100644 --- a/src/model/InlineResponse20016.js +++ b/src/model/InlineResponse20016.js @@ -17,7 +17,7 @@ import ApplicationSession from './ApplicationSession'; /** * The InlineResponse20016 model module. * @module model/InlineResponse20016 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20016 { /** diff --git a/src/model/InlineResponse20017.js b/src/model/InlineResponse20017.js index 67f4d1ff..6d3484a2 100644 --- a/src/model/InlineResponse20017.js +++ b/src/model/InlineResponse20017.js @@ -17,7 +17,7 @@ import ApplicationEvent from './ApplicationEvent'; /** * The InlineResponse20017 model module. * @module model/InlineResponse20017 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20017 { /** diff --git a/src/model/InlineResponse20018.js b/src/model/InlineResponse20018.js index 7bf840d2..a650a380 100644 --- a/src/model/InlineResponse20018.js +++ b/src/model/InlineResponse20018.js @@ -17,7 +17,7 @@ import ApplicationEvent from './ApplicationEvent'; /** * The InlineResponse20018 model module. * @module model/InlineResponse20018 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20018 { /** diff --git a/src/model/InlineResponse20019.js b/src/model/InlineResponse20019.js index 41bc2170..6bde2399 100644 --- a/src/model/InlineResponse20019.js +++ b/src/model/InlineResponse20019.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The InlineResponse20019 model module. * @module model/InlineResponse20019 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20019 { /** diff --git a/src/model/InlineResponse2002.js b/src/model/InlineResponse2002.js index 42e2318d..e997dcb8 100644 --- a/src/model/InlineResponse2002.js +++ b/src/model/InlineResponse2002.js @@ -17,7 +17,7 @@ import Campaign from './Campaign'; /** * The InlineResponse2002 model module. * @module model/InlineResponse2002 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2002 { /** diff --git a/src/model/InlineResponse20020.js b/src/model/InlineResponse20020.js index d6fac1a2..0c0ccc8b 100644 --- a/src/model/InlineResponse20020.js +++ b/src/model/InlineResponse20020.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import Attribute from './Attribute'; +import Audience from './Audience'; /** * The InlineResponse20020 model module. * @module model/InlineResponse20020 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20020 { /** * Constructs a new InlineResponse20020. * @alias module:model/InlineResponse20020 - * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(data) { - InlineResponse20020.initialize(this, totalResultSize, data); + InlineResponse20020.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20020 { * 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, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, data) { obj['data'] = data; } @@ -56,7 +54,7 @@ class InlineResponse20020 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Attribute]); + obj['data'] = ApiClient.convertToType(data['data'], [Audience]); } } return obj; @@ -71,7 +69,7 @@ class InlineResponse20020 { InlineResponse20020.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20020.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20021.js b/src/model/InlineResponse20021.js index 27abfec4..b7c31bc2 100644 --- a/src/model/InlineResponse20021.js +++ b/src/model/InlineResponse20021.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import AccountAdditionalCost from './AccountAdditionalCost'; +import Attribute from './Attribute'; /** * The InlineResponse20021 model module. * @module model/InlineResponse20021 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20021 { /** * Constructs a new InlineResponse20021. * @alias module:model/InlineResponse20021 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20021 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [AccountAdditionalCost]); + obj['data'] = ApiClient.convertToType(data['data'], [Attribute]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20021 { InlineResponse20021.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20021.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20022.js b/src/model/InlineResponse20022.js index 40ae885d..ebefa7e1 100644 --- a/src/model/InlineResponse20022.js +++ b/src/model/InlineResponse20022.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import Webhook from './Webhook'; +import AccountAdditionalCost from './AccountAdditionalCost'; /** * The InlineResponse20022 model module. * @module model/InlineResponse20022 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20022 { /** * Constructs a new InlineResponse20022. * @alias module:model/InlineResponse20022 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20022 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Webhook]); + obj['data'] = ApiClient.convertToType(data['data'], [AccountAdditionalCost]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20022 { InlineResponse20022.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20022.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20023.js b/src/model/InlineResponse20023.js index 6c4a7ad6..9075ecc1 100644 --- a/src/model/InlineResponse20023.js +++ b/src/model/InlineResponse20023.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import WebhookActivationLogEntry from './WebhookActivationLogEntry'; +import Webhook from './Webhook'; /** * The InlineResponse20023 model module. * @module model/InlineResponse20023 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20023 { /** * Constructs a new InlineResponse20023. * @alias module:model/InlineResponse20023 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20023 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [WebhookActivationLogEntry]); + obj['data'] = ApiClient.convertToType(data['data'], [Webhook]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20023 { InlineResponse20023.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20023.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20024.js b/src/model/InlineResponse20024.js index 5e8bf4e7..789b026a 100644 --- a/src/model/InlineResponse20024.js +++ b/src/model/InlineResponse20024.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import WebhookLogEntry from './WebhookLogEntry'; +import WebhookActivationLogEntry from './WebhookActivationLogEntry'; /** * The InlineResponse20024 model module. * @module model/InlineResponse20024 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20024 { /** * Constructs a new InlineResponse20024. * @alias module:model/InlineResponse20024 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20024 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [WebhookLogEntry]); + obj['data'] = ApiClient.convertToType(data['data'], [WebhookActivationLogEntry]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20024 { InlineResponse20024.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20024.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20025.js b/src/model/InlineResponse20025.js index b13c683f..72250b51 100644 --- a/src/model/InlineResponse20025.js +++ b/src/model/InlineResponse20025.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import EventType from './EventType'; +import WebhookLogEntry from './WebhookLogEntry'; /** * The InlineResponse20025 model module. * @module model/InlineResponse20025 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20025 { /** * Constructs a new InlineResponse20025. * @alias module:model/InlineResponse20025 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20025 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [EventType]); + obj['data'] = ApiClient.convertToType(data['data'], [WebhookLogEntry]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20025 { InlineResponse20025.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20025.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20026.js b/src/model/InlineResponse20026.js index a107e9f9..ad34e8bf 100644 --- a/src/model/InlineResponse20026.js +++ b/src/model/InlineResponse20026.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import User from './User'; +import EventType from './EventType'; /** * The InlineResponse20026 model module. * @module model/InlineResponse20026 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20026 { /** * Constructs a new InlineResponse20026. * @alias module:model/InlineResponse20026 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20026 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [User]); + obj['data'] = ApiClient.convertToType(data['data'], [EventType]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20026 { InlineResponse20026.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20026.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20027.js b/src/model/InlineResponse20027.js index 6467dd47..a049eb44 100644 --- a/src/model/InlineResponse20027.js +++ b/src/model/InlineResponse20027.js @@ -12,22 +12,23 @@ */ import ApiClient from '../ApiClient'; -import Change from './Change'; +import User from './User'; /** * The InlineResponse20027 model module. * @module model/InlineResponse20027 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20027 { /** * Constructs a new InlineResponse20027. * @alias module:model/InlineResponse20027 - * @param data {Array.} + * @param totalResultSize {Number} + * @param data {Array.} */ - constructor(data) { + constructor(totalResultSize, data) { - InlineResponse20027.initialize(this, data); + InlineResponse20027.initialize(this, totalResultSize, data); } /** @@ -35,7 +36,8 @@ class InlineResponse20027 { * 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, data) { + static initialize(obj, totalResultSize, data) { + obj['totalResultSize'] = totalResultSize; obj['data'] = data; } @@ -53,11 +55,8 @@ class InlineResponse20027 { if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } - if (data.hasOwnProperty('hasMore')) { - obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); - } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [Change]); + obj['data'] = ApiClient.convertToType(data['data'], [User]); } } return obj; @@ -72,12 +71,7 @@ class InlineResponse20027 { InlineResponse20027.prototype['totalResultSize'] = undefined; /** - * @member {Boolean} hasMore - */ -InlineResponse20027.prototype['hasMore'] = undefined; - -/** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20027.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20028.js b/src/model/InlineResponse20028.js index 68b1b46b..4605af9f 100644 --- a/src/model/InlineResponse20028.js +++ b/src/model/InlineResponse20028.js @@ -12,23 +12,22 @@ */ import ApiClient from '../ApiClient'; -import ModelExport from './ModelExport'; +import Change from './Change'; /** * The InlineResponse20028 model module. * @module model/InlineResponse20028 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20028 { /** * Constructs a new InlineResponse20028. * @alias module:model/InlineResponse20028 - * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ - constructor(totalResultSize, data) { + constructor(data) { - InlineResponse20028.initialize(this, totalResultSize, data); + InlineResponse20028.initialize(this, data); } /** @@ -36,8 +35,7 @@ class InlineResponse20028 { * 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, totalResultSize, data) { - obj['totalResultSize'] = totalResultSize; + static initialize(obj, data) { obj['data'] = data; } @@ -55,8 +53,11 @@ class InlineResponse20028 { if (data.hasOwnProperty('totalResultSize')) { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } + if (data.hasOwnProperty('hasMore')) { + obj['hasMore'] = ApiClient.convertToType(data['hasMore'], 'Boolean'); + } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [ModelExport]); + obj['data'] = ApiClient.convertToType(data['data'], [Change]); } } return obj; @@ -71,7 +72,12 @@ class InlineResponse20028 { InlineResponse20028.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Boolean} hasMore + */ +InlineResponse20028.prototype['hasMore'] = undefined; + +/** + * @member {Array.} data */ InlineResponse20028.prototype['data'] = undefined; diff --git a/src/model/InlineResponse20029.js b/src/model/InlineResponse20029.js index fbef47b5..432eef11 100644 --- a/src/model/InlineResponse20029.js +++ b/src/model/InlineResponse20029.js @@ -12,19 +12,19 @@ */ import ApiClient from '../ApiClient'; -import ModelImport from './ModelImport'; +import ModelExport from './ModelExport'; /** * The InlineResponse20029 model module. * @module model/InlineResponse20029 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20029 { /** * Constructs a new InlineResponse20029. * @alias module:model/InlineResponse20029 * @param totalResultSize {Number} - * @param data {Array.} + * @param data {Array.} */ constructor(totalResultSize, data) { @@ -56,7 +56,7 @@ class InlineResponse20029 { obj['totalResultSize'] = ApiClient.convertToType(data['totalResultSize'], 'Number'); } if (data.hasOwnProperty('data')) { - obj['data'] = ApiClient.convertToType(data['data'], [ModelImport]); + obj['data'] = ApiClient.convertToType(data['data'], [ModelExport]); } } return obj; @@ -71,7 +71,7 @@ class InlineResponse20029 { InlineResponse20029.prototype['totalResultSize'] = undefined; /** - * @member {Array.} data + * @member {Array.} data */ InlineResponse20029.prototype['data'] = undefined; diff --git a/src/model/InlineResponse2003.js b/src/model/InlineResponse2003.js index 59a8fe4e..7dc04e37 100644 --- a/src/model/InlineResponse2003.js +++ b/src/model/InlineResponse2003.js @@ -17,7 +17,7 @@ import Ruleset from './Ruleset'; /** * The InlineResponse2003 model module. * @module model/InlineResponse2003 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2003 { /** diff --git a/src/model/InlineResponse20030.js b/src/model/InlineResponse20030.js index 49694bfa..ea40e9cb 100644 --- a/src/model/InlineResponse20030.js +++ b/src/model/InlineResponse20030.js @@ -17,7 +17,7 @@ import Role from './Role'; /** * The InlineResponse20030 model module. * @module model/InlineResponse20030 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse20030 { /** diff --git a/src/model/InlineResponse2004.js b/src/model/InlineResponse2004.js index e3e472db..91fa0e38 100644 --- a/src/model/InlineResponse2004.js +++ b/src/model/InlineResponse2004.js @@ -17,7 +17,7 @@ import Coupon from './Coupon'; /** * The InlineResponse2004 model module. * @module model/InlineResponse2004 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2004 { /** diff --git a/src/model/InlineResponse2005.js b/src/model/InlineResponse2005.js index e6016ce6..d51ef1f3 100644 --- a/src/model/InlineResponse2005.js +++ b/src/model/InlineResponse2005.js @@ -17,7 +17,7 @@ import Coupon from './Coupon'; /** * The InlineResponse2005 model module. * @module model/InlineResponse2005 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2005 { /** diff --git a/src/model/InlineResponse2006.js b/src/model/InlineResponse2006.js index 8df8acfe..ffdbbeda 100644 --- a/src/model/InlineResponse2006.js +++ b/src/model/InlineResponse2006.js @@ -17,7 +17,7 @@ import Referral from './Referral'; /** * The InlineResponse2006 model module. * @module model/InlineResponse2006 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2006 { /** diff --git a/src/model/InlineResponse2007.js b/src/model/InlineResponse2007.js index 32de9404..53d242b2 100644 --- a/src/model/InlineResponse2007.js +++ b/src/model/InlineResponse2007.js @@ -17,7 +17,7 @@ import Referral from './Referral'; /** * The InlineResponse2007 model module. * @module model/InlineResponse2007 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2007 { /** diff --git a/src/model/InlineResponse2008.js b/src/model/InlineResponse2008.js index 9d46762a..462a1a38 100644 --- a/src/model/InlineResponse2008.js +++ b/src/model/InlineResponse2008.js @@ -17,7 +17,7 @@ import LoyaltyProgram from './LoyaltyProgram'; /** * The InlineResponse2008 model module. * @module model/InlineResponse2008 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2008 { /** diff --git a/src/model/InlineResponse2009.js b/src/model/InlineResponse2009.js index 33462d67..9e92201a 100644 --- a/src/model/InlineResponse2009.js +++ b/src/model/InlineResponse2009.js @@ -17,7 +17,7 @@ import AccessLogEntry from './AccessLogEntry'; /** * The InlineResponse2009 model module. * @module model/InlineResponse2009 - * @version 4.2.0 + * @version 4.3.0 */ class InlineResponse2009 { /** diff --git a/src/model/IntegrationEntity.js b/src/model/IntegrationEntity.js index 0f01780c..437286ea 100644 --- a/src/model/IntegrationEntity.js +++ b/src/model/IntegrationEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The IntegrationEntity model module. * @module model/IntegrationEntity - * @version 4.2.0 + * @version 4.3.0 */ class IntegrationEntity { /** diff --git a/src/model/IntegrationEvent.js b/src/model/IntegrationEvent.js index 8147f7b2..10f4a6d4 100644 --- a/src/model/IntegrationEvent.js +++ b/src/model/IntegrationEvent.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The IntegrationEvent model module. * @module model/IntegrationEvent - * @version 4.2.0 + * @version 4.3.0 */ class IntegrationEvent { /** diff --git a/src/model/IntegrationProfileEntity.js b/src/model/IntegrationProfileEntity.js index 2cd8ec22..10e9e2b7 100644 --- a/src/model/IntegrationProfileEntity.js +++ b/src/model/IntegrationProfileEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The IntegrationProfileEntity model module. * @module model/IntegrationProfileEntity - * @version 4.2.0 + * @version 4.3.0 */ class IntegrationProfileEntity { /** diff --git a/src/model/IntegrationRequest.js b/src/model/IntegrationRequest.js index 87e3e578..5c2efd9f 100644 --- a/src/model/IntegrationRequest.js +++ b/src/model/IntegrationRequest.js @@ -17,7 +17,7 @@ import NewCustomerSessionV2 from './NewCustomerSessionV2'; /** * The IntegrationRequest model module. * @module model/IntegrationRequest - * @version 4.2.0 + * @version 4.3.0 */ class IntegrationRequest { /** @@ -70,7 +70,7 @@ class IntegrationRequest { IntegrationRequest.prototype['customerSession'] = undefined; /** - * 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 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\". * @member {Array.} responseContent */ IntegrationRequest.prototype['responseContent'] = undefined; @@ -126,7 +126,13 @@ IntegrationRequest['ResponseContentEnum'] = { * value: "event" * @const */ - "event": "event" + "event": "event", + + /** + * value: "ruleFailureReasons" + * @const + */ + "ruleFailureReasons": "ruleFailureReasons" }; diff --git a/src/model/IntegrationState.js b/src/model/IntegrationState.js index 02aee8fd..a222f2a4 100644 --- a/src/model/IntegrationState.js +++ b/src/model/IntegrationState.js @@ -21,7 +21,7 @@ import Loyalty from './Loyalty'; /** * The IntegrationState model module. * @module model/IntegrationState - * @version 4.2.0 + * @version 4.3.0 */ class IntegrationState { /** diff --git a/src/model/IntegrationStateV2.js b/src/model/IntegrationStateV2.js index 0e3ae59a..ee2983bc 100644 --- a/src/model/IntegrationStateV2.js +++ b/src/model/IntegrationStateV2.js @@ -20,11 +20,12 @@ import Effect from './Effect'; import Event from './Event'; import Loyalty from './Loyalty'; import Referral from './Referral'; +import RuleFailureReason from './RuleFailureReason'; /** * The IntegrationStateV2 model module. * @module model/IntegrationStateV2 - * @version 4.2.0 + * @version 4.3.0 */ class IntegrationStateV2 { /** @@ -86,6 +87,9 @@ class IntegrationStateV2 { if (data.hasOwnProperty('effects')) { obj['effects'] = ApiClient.convertToType(data['effects'], [Effect]); } + if (data.hasOwnProperty('ruleFailureReasons')) { + obj['ruleFailureReasons'] = ApiClient.convertToType(data['ruleFailureReasons'], [RuleFailureReason]); + } if (data.hasOwnProperty('createdCoupons')) { obj['createdCoupons'] = ApiClient.convertToType(data['createdCoupons'], [Coupon]); } @@ -139,6 +143,11 @@ IntegrationStateV2.prototype['triggeredCampaigns'] = undefined; */ IntegrationStateV2.prototype['effects'] = undefined; +/** + * @member {Array.} ruleFailureReasons + */ +IntegrationStateV2.prototype['ruleFailureReasons'] = undefined; + /** * @member {Array.} createdCoupons */ diff --git a/src/model/LedgerEntry.js b/src/model/LedgerEntry.js index ae9b57fb..784d7330 100644 --- a/src/model/LedgerEntry.js +++ b/src/model/LedgerEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LedgerEntry model module. * @module model/LedgerEntry - * @version 4.2.0 + * @version 4.3.0 */ class LedgerEntry { /** diff --git a/src/model/LibraryAttribute.js b/src/model/LibraryAttribute.js index 09084eed..68b687dc 100644 --- a/src/model/LibraryAttribute.js +++ b/src/model/LibraryAttribute.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LibraryAttribute model module. * @module model/LibraryAttribute - * @version 4.2.0 + * @version 4.3.0 */ class LibraryAttribute { /** diff --git a/src/model/LimitConfig.js b/src/model/LimitConfig.js index 4d3bc5fb..a21abdff 100644 --- a/src/model/LimitConfig.js +++ b/src/model/LimitConfig.js @@ -16,13 +16,13 @@ import ApiClient from '../ApiClient'; /** * The LimitConfig model module. * @module model/LimitConfig - * @version 4.2.0 + * @version 4.3.0 */ class LimitConfig { /** * Constructs a new LimitConfig. * @alias module:model/LimitConfig - * @param action {module:model/LimitConfig.ActionEnum} The limitable action to which this limit will be applied + * @param action {String} The limitable action to which this limit will be applied * @param limit {Number} The value to set for the limit * @param entities {Array.} The entities that make the address of this limit */ @@ -71,7 +71,7 @@ class LimitConfig { /** * The limitable action to which this limit will be applied - * @member {module:model/LimitConfig.ActionEnum} action + * @member {String} action */ LimitConfig.prototype['action'] = undefined; @@ -91,45 +91,6 @@ LimitConfig.prototype['entities'] = undefined; -/** - * Allowed values for the action property. - * @enum {String} - * @readonly - */ -LimitConfig['ActionEnum'] = { - - /** - * value: "redeemCoupon" - * @const - */ - "redeemCoupon": "redeemCoupon", - - /** - * value: "redeemReferral" - * @const - */ - "redeemReferral": "redeemReferral", - - /** - * value: "setDiscount" - * @const - */ - "setDiscount": "setDiscount", - - /** - * value: "createCoupon" - * @const - */ - "createCoupon": "createCoupon", - - /** - * value: "setDiscountEffect" - * @const - */ - "setDiscountEffect": "setDiscountEffect" -}; - - /** * Allowed values for the entities property. * @enum {String} diff --git a/src/model/LoginParams.js b/src/model/LoginParams.js index bb87662a..4732a047 100644 --- a/src/model/LoginParams.js +++ b/src/model/LoginParams.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoginParams model module. * @module model/LoginParams - * @version 4.2.0 + * @version 4.3.0 */ class LoginParams { /** diff --git a/src/model/Loyalty.js b/src/model/Loyalty.js index c72f6428..cdf68eaa 100644 --- a/src/model/Loyalty.js +++ b/src/model/Loyalty.js @@ -17,7 +17,7 @@ import LoyaltyProgramLedgers from './LoyaltyProgramLedgers'; /** * The Loyalty model module. * @module model/Loyalty - * @version 4.2.0 + * @version 4.3.0 */ class Loyalty { /** diff --git a/src/model/LoyaltyLedger.js b/src/model/LoyaltyLedger.js index 694bafa0..7839e0d2 100644 --- a/src/model/LoyaltyLedger.js +++ b/src/model/LoyaltyLedger.js @@ -17,7 +17,7 @@ import LoyaltySubLedger from './LoyaltySubLedger'; /** * The LoyaltyLedger model module. * @module model/LoyaltyLedger - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyLedger { /** diff --git a/src/model/LoyaltyLedgerEntry.js b/src/model/LoyaltyLedgerEntry.js index d7225bfd..3e8d2464 100644 --- a/src/model/LoyaltyLedgerEntry.js +++ b/src/model/LoyaltyLedgerEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyLedgerEntry model module. * @module model/LoyaltyLedgerEntry - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyLedgerEntry { /** diff --git a/src/model/LoyaltyMembership.js b/src/model/LoyaltyMembership.js index cff4e607..bd96baf8 100644 --- a/src/model/LoyaltyMembership.js +++ b/src/model/LoyaltyMembership.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyMembership model module. * @module model/LoyaltyMembership - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyMembership { /** diff --git a/src/model/LoyaltyPoints.js b/src/model/LoyaltyPoints.js index 3fd0b6e1..eeada0e0 100644 --- a/src/model/LoyaltyPoints.js +++ b/src/model/LoyaltyPoints.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyPoints model module. * @module model/LoyaltyPoints - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyPoints { /** diff --git a/src/model/LoyaltyProgram.js b/src/model/LoyaltyProgram.js index 8fd592ca..3e07dc2d 100644 --- a/src/model/LoyaltyProgram.js +++ b/src/model/LoyaltyProgram.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyProgram model module. * @module model/LoyaltyProgram - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyProgram { /** diff --git a/src/model/LoyaltyProgramBalance.js b/src/model/LoyaltyProgramBalance.js index 7e85d9bc..20e0c14c 100644 --- a/src/model/LoyaltyProgramBalance.js +++ b/src/model/LoyaltyProgramBalance.js @@ -16,18 +16,22 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyProgramBalance model module. * @module model/LoyaltyProgramBalance - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyProgramBalance { /** * Constructs a new LoyaltyProgramBalance. * The balance in a Loyalty Program for some Customer. * @alias module:model/LoyaltyProgramBalance - * @param currentBalance {Number} + * @param currentBalance {Number} Sum of current active points amounts + * @param pendingBalance {Number} Sum of pending points amounts + * @param expiredBalance {Number} Sum of expired points amounts + * @param spentBalance {Number} Sum of spent points amounts + * @param tentativeCurrentBalance {Number} Sum of current active points amounts, including additions and deductions on open sessions */ - constructor(currentBalance) { + constructor(currentBalance, pendingBalance, expiredBalance, spentBalance, tentativeCurrentBalance) { - LoyaltyProgramBalance.initialize(this, currentBalance); + LoyaltyProgramBalance.initialize(this, currentBalance, pendingBalance, expiredBalance, spentBalance, tentativeCurrentBalance); } /** @@ -35,8 +39,12 @@ class LoyaltyProgramBalance { * 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, currentBalance) { + static initialize(obj, currentBalance, pendingBalance, expiredBalance, spentBalance, tentativeCurrentBalance) { obj['currentBalance'] = currentBalance; + obj['pendingBalance'] = pendingBalance; + obj['expiredBalance'] = expiredBalance; + obj['spentBalance'] = spentBalance; + obj['tentativeCurrentBalance'] = tentativeCurrentBalance; } /** @@ -53,6 +61,18 @@ class LoyaltyProgramBalance { if (data.hasOwnProperty('currentBalance')) { obj['currentBalance'] = ApiClient.convertToType(data['currentBalance'], 'Number'); } + if (data.hasOwnProperty('pendingBalance')) { + obj['pendingBalance'] = ApiClient.convertToType(data['pendingBalance'], 'Number'); + } + if (data.hasOwnProperty('expiredBalance')) { + obj['expiredBalance'] = ApiClient.convertToType(data['expiredBalance'], 'Number'); + } + if (data.hasOwnProperty('spentBalance')) { + obj['spentBalance'] = ApiClient.convertToType(data['spentBalance'], 'Number'); + } + if (data.hasOwnProperty('tentativeCurrentBalance')) { + obj['tentativeCurrentBalance'] = ApiClient.convertToType(data['tentativeCurrentBalance'], 'Number'); + } } return obj; } @@ -61,10 +81,35 @@ class LoyaltyProgramBalance { } /** + * Sum of current active points amounts * @member {Number} currentBalance */ LoyaltyProgramBalance.prototype['currentBalance'] = undefined; +/** + * Sum of pending points amounts + * @member {Number} pendingBalance + */ +LoyaltyProgramBalance.prototype['pendingBalance'] = undefined; + +/** + * Sum of expired points amounts + * @member {Number} expiredBalance + */ +LoyaltyProgramBalance.prototype['expiredBalance'] = undefined; + +/** + * Sum of spent points amounts + * @member {Number} spentBalance + */ +LoyaltyProgramBalance.prototype['spentBalance'] = undefined; + +/** + * Sum of current active points amounts, including additions and deductions on open sessions + * @member {Number} tentativeCurrentBalance + */ +LoyaltyProgramBalance.prototype['tentativeCurrentBalance'] = undefined; + diff --git a/src/model/LoyaltyProgramLedgers.js b/src/model/LoyaltyProgramLedgers.js index c5919a4d..55660499 100644 --- a/src/model/LoyaltyProgramLedgers.js +++ b/src/model/LoyaltyProgramLedgers.js @@ -17,20 +17,21 @@ import LoyaltyProgramBalance from './LoyaltyProgramBalance'; /** * The LoyaltyProgramLedgers model module. * @module model/LoyaltyProgramLedgers - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyProgramLedgers { /** * Constructs a new LoyaltyProgramLedgers. * Customer specific information about loyalty points. * @alias module:model/LoyaltyProgramLedgers + * @param id {Number} The internal ID of loyalty program * @param title {String} Visible name of loyalty program * @param name {String} Internal name of loyalty program * @param ledger {module:model/LoyaltyProgramBalance} */ - constructor(title, name, ledger) { + constructor(id, title, name, ledger) { - LoyaltyProgramLedgers.initialize(this, title, name, ledger); + LoyaltyProgramLedgers.initialize(this, id, title, name, ledger); } /** @@ -38,7 +39,8 @@ class LoyaltyProgramLedgers { * 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, title, name, ledger) { + static initialize(obj, id, title, name, ledger) { + obj['id'] = id; obj['title'] = title; obj['name'] = name; obj['ledger'] = ledger; @@ -55,6 +57,9 @@ class LoyaltyProgramLedgers { if (data) { obj = obj || new LoyaltyProgramLedgers(); + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'Number'); + } if (data.hasOwnProperty('title')) { obj['title'] = ApiClient.convertToType(data['title'], 'String'); } @@ -74,6 +79,12 @@ class LoyaltyProgramLedgers { } +/** + * The internal ID of loyalty program + * @member {Number} id + */ +LoyaltyProgramLedgers.prototype['id'] = undefined; + /** * Visible name of loyalty program * @member {String} title diff --git a/src/model/LoyaltyStatistics.js b/src/model/LoyaltyStatistics.js index 8f8e22ff..d2df1663 100644 --- a/src/model/LoyaltyStatistics.js +++ b/src/model/LoyaltyStatistics.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The LoyaltyStatistics model module. * @module model/LoyaltyStatistics - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltyStatistics { /** diff --git a/src/model/LoyaltySubLedger.js b/src/model/LoyaltySubLedger.js index cf7c8fee..11605b44 100644 --- a/src/model/LoyaltySubLedger.js +++ b/src/model/LoyaltySubLedger.js @@ -17,14 +17,14 @@ import LoyaltyLedgerEntry from './LoyaltyLedgerEntry'; /** * The LoyaltySubLedger model module. * @module model/LoyaltySubLedger - * @version 4.2.0 + * @version 4.3.0 */ class LoyaltySubLedger { /** * Constructs a new LoyaltySubLedger. * Ledger of Balance in Loyalty Program for a Customer * @alias module:model/LoyaltySubLedger - * @param total {Number} ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance + * @param total {Number} ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance * @param totalActivePoints {Number} Total amount of currently active and available points in the customer's balance * @param totalPendingPoints {Number} Total amount of pending points, which are not active yet but will become active in the future * @param totalSpentPoints {Number} Total amount of points already spent by this customer @@ -97,7 +97,7 @@ class LoyaltySubLedger { } /** - * ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance + * ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance * @member {Number} total */ LoyaltySubLedger.prototype['total'] = undefined; diff --git a/src/model/ManagerConfig.js b/src/model/ManagerConfig.js index e4bc3c69..34f2feae 100644 --- a/src/model/ManagerConfig.js +++ b/src/model/ManagerConfig.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ManagerConfig model module. * @module model/ManagerConfig - * @version 4.2.0 + * @version 4.3.0 */ class ManagerConfig { /** diff --git a/src/model/Meta.js b/src/model/Meta.js index d8b2320d..82cb0fa7 100644 --- a/src/model/Meta.js +++ b/src/model/Meta.js @@ -18,7 +18,7 @@ import ReferralRejectionReason from './ReferralRejectionReason'; /** * The Meta model module. * @module model/Meta - * @version 4.2.0 + * @version 4.3.0 */ class Meta { /** diff --git a/src/model/ModelExport.js b/src/model/ModelExport.js index c3b61a1f..325e45b0 100644 --- a/src/model/ModelExport.js +++ b/src/model/ModelExport.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ModelExport model module. * @module model/ModelExport - * @version 4.2.0 + * @version 4.3.0 */ class ModelExport { /** diff --git a/src/model/ModelImport.js b/src/model/ModelImport.js index 675cdb1c..fb0d6541 100644 --- a/src/model/ModelImport.js +++ b/src/model/ModelImport.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ModelImport model module. * @module model/ModelImport - * @version 4.2.0 + * @version 4.3.0 */ class ModelImport { /** @@ -27,7 +27,7 @@ class ModelImport { * @param created {Date} The exact moment this entity was created. * @param accountId {Number} The ID of the account that owns this entity. * @param userId {Number} The ID of the account that owns this entity. - * @param entity {module:model/ModelImport.EntityEnum} The name of the entity that was imported. + * @param entity {String} The name of the entity that was imported. Possible values are Coupons and LoyaltyPoints. * @param amount {Number} The number of members that imported. */ constructor(id, created, accountId, userId, entity, amount) { @@ -110,8 +110,8 @@ ModelImport.prototype['accountId'] = undefined; ModelImport.prototype['userId'] = undefined; /** - * The name of the entity that was imported. - * @member {module:model/ModelImport.EntityEnum} entity + * The name of the entity that was imported. Possible values are Coupons and LoyaltyPoints. + * @member {String} entity */ ModelImport.prototype['entity'] = undefined; @@ -125,21 +125,6 @@ ModelImport.prototype['amount'] = undefined; -/** - * Allowed values for the entity property. - * @enum {String} - * @readonly - */ -ModelImport['EntityEnum'] = { - - /** - * value: "Coupon" - * @const - */ - "Coupon": "Coupon" -}; - - export default ModelImport; diff --git a/src/model/MultiApplicationEntity.js b/src/model/MultiApplicationEntity.js index d57b7964..6ef0d39d 100644 --- a/src/model/MultiApplicationEntity.js +++ b/src/model/MultiApplicationEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The MultiApplicationEntity model module. * @module model/MultiApplicationEntity - * @version 4.2.0 + * @version 4.3.0 */ class MultiApplicationEntity { /** diff --git a/src/model/MultipleCustomerProfileIntegrationRequest.js b/src/model/MultipleCustomerProfileIntegrationRequest.js index ca1c9a52..0013688c 100644 --- a/src/model/MultipleCustomerProfileIntegrationRequest.js +++ b/src/model/MultipleCustomerProfileIntegrationRequest.js @@ -17,7 +17,7 @@ import MultipleCustomerProfileIntegrationRequestItem from './MultipleCustomerPro /** * The MultipleCustomerProfileIntegrationRequest model module. * @module model/MultipleCustomerProfileIntegrationRequest - * @version 4.2.0 + * @version 4.3.0 */ class MultipleCustomerProfileIntegrationRequest { /** diff --git a/src/model/MultipleCustomerProfileIntegrationRequestItem.js b/src/model/MultipleCustomerProfileIntegrationRequestItem.js index 576c8ad5..5718cc85 100644 --- a/src/model/MultipleCustomerProfileIntegrationRequestItem.js +++ b/src/model/MultipleCustomerProfileIntegrationRequestItem.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The MultipleCustomerProfileIntegrationRequestItem model module. * @module model/MultipleCustomerProfileIntegrationRequestItem - * @version 4.2.0 + * @version 4.3.0 */ class MultipleCustomerProfileIntegrationRequestItem { /** diff --git a/src/model/MultipleCustomerProfileIntegrationResponseV2.js b/src/model/MultipleCustomerProfileIntegrationResponseV2.js index 29b817ae..75d952e5 100644 --- a/src/model/MultipleCustomerProfileIntegrationResponseV2.js +++ b/src/model/MultipleCustomerProfileIntegrationResponseV2.js @@ -17,7 +17,7 @@ import IntegrationStateV2 from './IntegrationStateV2'; /** * The MultipleCustomerProfileIntegrationResponseV2 model module. * @module model/MultipleCustomerProfileIntegrationResponseV2 - * @version 4.2.0 + * @version 4.3.0 */ class MultipleCustomerProfileIntegrationResponseV2 { /** diff --git a/src/model/MutableEntity.js b/src/model/MutableEntity.js index eb7f2175..670f1e62 100644 --- a/src/model/MutableEntity.js +++ b/src/model/MutableEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The MutableEntity model module. * @module model/MutableEntity - * @version 4.2.0 + * @version 4.3.0 */ class MutableEntity { /** diff --git a/src/model/NewAccount.js b/src/model/NewAccount.js index e835724e..da5ca5fe 100644 --- a/src/model/NewAccount.js +++ b/src/model/NewAccount.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAccount model module. * @module model/NewAccount - * @version 4.2.0 + * @version 4.3.0 */ class NewAccount { /** diff --git a/src/model/NewAccountSignUp.js b/src/model/NewAccountSignUp.js index df13189b..7039a8ac 100644 --- a/src/model/NewAccountSignUp.js +++ b/src/model/NewAccountSignUp.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAccountSignUp model module. * @module model/NewAccountSignUp - * @version 4.2.0 + * @version 4.3.0 */ class NewAccountSignUp { /** diff --git a/src/model/NewAdditionalCost.js b/src/model/NewAdditionalCost.js index 6478fec1..1a20b43b 100644 --- a/src/model/NewAdditionalCost.js +++ b/src/model/NewAdditionalCost.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAdditionalCost model module. * @module model/NewAdditionalCost - * @version 4.2.0 + * @version 4.3.0 */ class NewAdditionalCost { /** diff --git a/src/model/NewApplication.js b/src/model/NewApplication.js index f2906a80..21d26a44 100644 --- a/src/model/NewApplication.js +++ b/src/model/NewApplication.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The NewApplication model module. * @module model/NewApplication - * @version 4.2.0 + * @version 4.3.0 */ class NewApplication { /** @@ -83,6 +83,9 @@ class NewApplication { 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'); } @@ -159,6 +162,12 @@ NewApplication.prototype['campaignPriority'] = undefined; */ NewApplication.prototype['exclusiveCampaignsStrategy'] = undefined; +/** + * The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. + * @member {module:model/NewApplication.DefaultDiscountScopeEnum} defaultDiscountScope + */ +NewApplication.prototype['defaultDiscountScope'] = undefined; + /** * Flag indicating if discounts should cascade for this application * @member {Boolean} enableCascadingDiscounts @@ -273,6 +282,33 @@ NewApplication['ExclusiveCampaignsStrategyEnum'] = { }; +/** + * Allowed values for the defaultDiscountScope property. + * @enum {String} + * @readonly + */ +NewApplication['DefaultDiscountScopeEnum'] = { + + /** + * value: "sessionTotal" + * @const + */ + "sessionTotal": "sessionTotal", + + /** + * value: "cartItems" + * @const + */ + "cartItems": "cartItems", + + /** + * value: "additionalCosts" + * @const + */ + "additionalCosts": "additionalCosts" +}; + + export default NewApplication; diff --git a/src/model/NewApplicationAPIKey.js b/src/model/NewApplicationAPIKey.js index ec582b64..9f10a39e 100644 --- a/src/model/NewApplicationAPIKey.js +++ b/src/model/NewApplicationAPIKey.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewApplicationAPIKey model module. * @module model/NewApplicationAPIKey - * @version 4.2.0 + * @version 4.3.0 */ class NewApplicationAPIKey { /** @@ -185,7 +185,13 @@ NewApplicationAPIKey['PlatformEnum'] = { * value: "mparticle" * @const */ - "mparticle": "mparticle" + "mparticle": "mparticle", + + /** + * value: "selligent" + * @const + */ + "selligent": "selligent" }; diff --git a/src/model/NewAttribute.js b/src/model/NewAttribute.js index 250a1175..ea5076ff 100644 --- a/src/model/NewAttribute.js +++ b/src/model/NewAttribute.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAttribute model module. * @module model/NewAttribute - * @version 4.2.0 + * @version 4.3.0 */ class NewAttribute { /** diff --git a/src/model/NewAudience.js b/src/model/NewAudience.js index 5cec8db5..4af3ce77 100644 --- a/src/model/NewAudience.js +++ b/src/model/NewAudience.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewAudience model module. * @module model/NewAudience - * @version 4.2.0 + * @version 4.3.0 */ class NewAudience { /** diff --git a/src/model/NewCampaign.js b/src/model/NewCampaign.js index 976bf0a8..38af3cf7 100644 --- a/src/model/NewCampaign.js +++ b/src/model/NewCampaign.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The NewCampaign model module. * @module model/NewCampaign - * @version 4.2.0 + * @version 4.3.0 */ class NewCampaign { /** diff --git a/src/model/NewCampaignGroup.js b/src/model/NewCampaignGroup.js index 83d61c1f..37509f88 100644 --- a/src/model/NewCampaignGroup.js +++ b/src/model/NewCampaignGroup.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCampaignGroup model module. * @module model/NewCampaignGroup - * @version 4.2.0 + * @version 4.3.0 */ class NewCampaignGroup { /** diff --git a/src/model/NewCampaignSet.js b/src/model/NewCampaignSet.js index 54bbb3d3..86469092 100644 --- a/src/model/NewCampaignSet.js +++ b/src/model/NewCampaignSet.js @@ -17,7 +17,7 @@ import CampaignSetBranchNode from './CampaignSetBranchNode'; /** * The NewCampaignSet model module. * @module model/NewCampaignSet - * @version 4.2.0 + * @version 4.3.0 */ class NewCampaignSet { /** diff --git a/src/model/NewCoupons.js b/src/model/NewCoupons.js index 78d1cdff..dbdb075d 100644 --- a/src/model/NewCoupons.js +++ b/src/model/NewCoupons.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCoupons model module. * @module model/NewCoupons - * @version 4.2.0 + * @version 4.3.0 */ class NewCoupons { /** @@ -24,13 +24,11 @@ class NewCoupons { * * @alias module:model/NewCoupons * @param 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. - * @param validCharacters {Array.} Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). - * @param 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. * @param numberOfCoupons {Number} The number of new coupon codes to generate for the campaign. Must be at least 1. */ - constructor(usageLimit, validCharacters, couponPattern, numberOfCoupons) { + constructor(usageLimit, numberOfCoupons) { - NewCoupons.initialize(this, usageLimit, validCharacters, couponPattern, numberOfCoupons); + NewCoupons.initialize(this, usageLimit, numberOfCoupons); } /** @@ -38,10 +36,8 @@ class NewCoupons { * 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, usageLimit, validCharacters, couponPattern, numberOfCoupons) { + static initialize(obj, usageLimit, numberOfCoupons) { obj['usageLimit'] = usageLimit; - obj['validCharacters'] = validCharacters; - obj['couponPattern'] = couponPattern; obj['numberOfCoupons'] = numberOfCoupons; } @@ -68,12 +64,6 @@ class NewCoupons { if (data.hasOwnProperty('expiryDate')) { obj['expiryDate'] = ApiClient.convertToType(data['expiryDate'], 'Date'); } - if (data.hasOwnProperty('validCharacters')) { - obj['validCharacters'] = ApiClient.convertToType(data['validCharacters'], ['String']); - } - if (data.hasOwnProperty('couponPattern')) { - obj['couponPattern'] = ApiClient.convertToType(data['couponPattern'], 'String'); - } if (data.hasOwnProperty('numberOfCoupons')) { obj['numberOfCoupons'] = ApiClient.convertToType(data['numberOfCoupons'], 'Number'); } @@ -86,6 +76,12 @@ class NewCoupons { if (data.hasOwnProperty('recipientIntegrationId')) { obj['recipientIntegrationId'] = ApiClient.convertToType(data['recipientIntegrationId'], 'String'); } + if (data.hasOwnProperty('validCharacters')) { + obj['validCharacters'] = ApiClient.convertToType(data['validCharacters'], ['String']); + } + if (data.hasOwnProperty('couponPattern')) { + obj['couponPattern'] = ApiClient.convertToType(data['couponPattern'], 'String'); + } } return obj; } @@ -117,18 +113,6 @@ NewCoupons.prototype['startDate'] = undefined; */ NewCoupons.prototype['expiryDate'] = undefined; -/** - * Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). - * @member {Array.} validCharacters - */ -NewCoupons.prototype['validCharacters'] = undefined; - -/** - * 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. - * @member {String} couponPattern - */ -NewCoupons.prototype['couponPattern'] = undefined; - /** * The number of new coupon codes to generate for the campaign. Must be at least 1. * @member {Number} numberOfCoupons @@ -153,6 +137,18 @@ NewCoupons.prototype['attributes'] = undefined; */ NewCoupons.prototype['recipientIntegrationId'] = undefined; +/** + * Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). + * @member {Array.} validCharacters + */ +NewCoupons.prototype['validCharacters'] = undefined; + +/** + * 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. + * @member {String} couponPattern + */ +NewCoupons.prototype['couponPattern'] = undefined; + diff --git a/src/model/NewCouponsForMultipleRecipients.js b/src/model/NewCouponsForMultipleRecipients.js new file mode 100644 index 00000000..79c2f61e --- /dev/null +++ b/src/model/NewCouponsForMultipleRecipients.js @@ -0,0 +1,140 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The NewCouponsForMultipleRecipients model module. + * @module model/NewCouponsForMultipleRecipients + * @version 4.3.0 + */ +class NewCouponsForMultipleRecipients { + /** + * Constructs a new NewCouponsForMultipleRecipients. + * + * @alias module:model/NewCouponsForMultipleRecipients + * @param 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. + * @param recipientsIntegrationIds {Array.} The integration IDs for recipients + */ + constructor(usageLimit, recipientsIntegrationIds) { + + NewCouponsForMultipleRecipients.initialize(this, usageLimit, recipientsIntegrationIds); + } + + /** + * Initializes the fields of this object. + * 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, usageLimit, recipientsIntegrationIds) { + obj['usageLimit'] = usageLimit; + obj['recipientsIntegrationIds'] = recipientsIntegrationIds; + } + + /** + * Constructs a NewCouponsForMultipleRecipients from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/NewCouponsForMultipleRecipients} obj Optional instance to populate. + * @return {module:model/NewCouponsForMultipleRecipients} The populated NewCouponsForMultipleRecipients instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new NewCouponsForMultipleRecipients(); + + if (data.hasOwnProperty('usageLimit')) { + obj['usageLimit'] = ApiClient.convertToType(data['usageLimit'], 'Number'); + } + if (data.hasOwnProperty('discountLimit')) { + obj['discountLimit'] = ApiClient.convertToType(data['discountLimit'], 'Number'); + } + if (data.hasOwnProperty('startDate')) { + obj['startDate'] = ApiClient.convertToType(data['startDate'], 'Date'); + } + if (data.hasOwnProperty('expiryDate')) { + obj['expiryDate'] = ApiClient.convertToType(data['expiryDate'], 'Date'); + } + if (data.hasOwnProperty('attributes')) { + obj['attributes'] = ApiClient.convertToType(data['attributes'], Object); + } + if (data.hasOwnProperty('recipientsIntegrationIds')) { + obj['recipientsIntegrationIds'] = ApiClient.convertToType(data['recipientsIntegrationIds'], ['String']); + } + if (data.hasOwnProperty('validCharacters')) { + obj['validCharacters'] = ApiClient.convertToType(data['validCharacters'], ['String']); + } + if (data.hasOwnProperty('couponPattern')) { + obj['couponPattern'] = ApiClient.convertToType(data['couponPattern'], 'String'); + } + } + return obj; + } + + +} + +/** + * 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. + * @member {Number} usageLimit + */ +NewCouponsForMultipleRecipients.prototype['usageLimit'] = undefined; + +/** + * The amount of discounts that can be given with this coupon code. + * @member {Number} discountLimit + */ +NewCouponsForMultipleRecipients.prototype['discountLimit'] = undefined; + +/** + * Timestamp at which point the coupon becomes valid. + * @member {Date} startDate + */ +NewCouponsForMultipleRecipients.prototype['startDate'] = undefined; + +/** + * Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + * @member {Date} expiryDate + */ +NewCouponsForMultipleRecipients.prototype['expiryDate'] = undefined; + +/** + * Arbitrary properties associated with this item + * @member {Object} attributes + */ +NewCouponsForMultipleRecipients.prototype['attributes'] = undefined; + +/** + * The integration IDs for recipients + * @member {Array.} recipientsIntegrationIds + */ +NewCouponsForMultipleRecipients.prototype['recipientsIntegrationIds'] = undefined; + +/** + * Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). + * @member {Array.} validCharacters + */ +NewCouponsForMultipleRecipients.prototype['validCharacters'] = undefined; + +/** + * 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. + * @member {String} couponPattern + */ +NewCouponsForMultipleRecipients.prototype['couponPattern'] = undefined; + + + + + + +export default NewCouponsForMultipleRecipients; + diff --git a/src/model/NewCustomerProfile.js b/src/model/NewCustomerProfile.js index ca1a70ff..55066e4f 100644 --- a/src/model/NewCustomerProfile.js +++ b/src/model/NewCustomerProfile.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewCustomerProfile model module. * @module model/NewCustomerProfile - * @version 4.2.0 + * @version 4.3.0 */ class NewCustomerProfile { /** diff --git a/src/model/NewCustomerSession.js b/src/model/NewCustomerSession.js index b89d57a6..f93f3af1 100644 --- a/src/model/NewCustomerSession.js +++ b/src/model/NewCustomerSession.js @@ -17,7 +17,7 @@ import CartItem from './CartItem'; /** * The NewCustomerSession model module. * @module model/NewCustomerSession - * @version 4.2.0 + * @version 4.3.0 */ class NewCustomerSession { /** diff --git a/src/model/NewCustomerSessionV2.js b/src/model/NewCustomerSessionV2.js index 368276d4..86c24a52 100644 --- a/src/model/NewCustomerSessionV2.js +++ b/src/model/NewCustomerSessionV2.js @@ -18,7 +18,7 @@ import CartItem from './CartItem'; /** * The NewCustomerSessionV2 model module. * @module model/NewCustomerSessionV2 - * @version 4.2.0 + * @version 4.3.0 */ class NewCustomerSessionV2 { /** diff --git a/src/model/NewEvent.js b/src/model/NewEvent.js index e778aa85..efb8ac29 100644 --- a/src/model/NewEvent.js +++ b/src/model/NewEvent.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewEvent model module. * @module model/NewEvent - * @version 4.2.0 + * @version 4.3.0 */ class NewEvent { /** diff --git a/src/model/NewEventType.js b/src/model/NewEventType.js index 3427295d..0c4b6b29 100644 --- a/src/model/NewEventType.js +++ b/src/model/NewEventType.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewEventType model module. * @module model/NewEventType - * @version 4.2.0 + * @version 4.3.0 */ class NewEventType { /** diff --git a/src/model/NewFeatureFlags.js b/src/model/NewFeatureFlags.js index 95ed39f5..685cb2ca 100644 --- a/src/model/NewFeatureFlags.js +++ b/src/model/NewFeatureFlags.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewFeatureFlags model module. * @module model/NewFeatureFlags - * @version 4.2.0 + * @version 4.3.0 */ class NewFeatureFlags { /** diff --git a/src/model/NewInvitation.js b/src/model/NewInvitation.js index e889e8a5..e5f45d69 100644 --- a/src/model/NewInvitation.js +++ b/src/model/NewInvitation.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewInvitation model module. * @module model/NewInvitation - * @version 4.2.0 + * @version 4.3.0 */ class NewInvitation { /** diff --git a/src/model/NewInviteEmail.js b/src/model/NewInviteEmail.js index 50af0dad..30426de1 100644 --- a/src/model/NewInviteEmail.js +++ b/src/model/NewInviteEmail.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewInviteEmail model module. * @module model/NewInviteEmail - * @version 4.2.0 + * @version 4.3.0 */ class NewInviteEmail { /** diff --git a/src/model/NewLoyaltyProgram.js b/src/model/NewLoyaltyProgram.js index f308be69..63b15f3c 100644 --- a/src/model/NewLoyaltyProgram.js +++ b/src/model/NewLoyaltyProgram.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewLoyaltyProgram model module. * @module model/NewLoyaltyProgram - * @version 4.2.0 + * @version 4.3.0 */ class NewLoyaltyProgram { /** diff --git a/src/model/NewPassword.js b/src/model/NewPassword.js index 0b6e38db..209b939b 100644 --- a/src/model/NewPassword.js +++ b/src/model/NewPassword.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewPassword model module. * @module model/NewPassword - * @version 4.2.0 + * @version 4.3.0 */ class NewPassword { /** diff --git a/src/model/NewPasswordEmail.js b/src/model/NewPasswordEmail.js index 980468be..d66741a8 100644 --- a/src/model/NewPasswordEmail.js +++ b/src/model/NewPasswordEmail.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewPasswordEmail model module. * @module model/NewPasswordEmail - * @version 4.2.0 + * @version 4.3.0 */ class NewPasswordEmail { /** diff --git a/src/model/NewReferral.js b/src/model/NewReferral.js index 696aab83..681c167f 100644 --- a/src/model/NewReferral.js +++ b/src/model/NewReferral.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewReferral model module. * @module model/NewReferral - * @version 4.2.0 + * @version 4.3.0 */ class NewReferral { /** diff --git a/src/model/NewRole.js b/src/model/NewRole.js index 3d5f196a..e345d4cf 100644 --- a/src/model/NewRole.js +++ b/src/model/NewRole.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewRole model module. * @module model/NewRole - * @version 4.2.0 + * @version 4.3.0 */ class NewRole { /** diff --git a/src/model/NewRuleset.js b/src/model/NewRuleset.js index 88673396..af6dfa0d 100644 --- a/src/model/NewRuleset.js +++ b/src/model/NewRuleset.js @@ -18,7 +18,7 @@ import Rule from './Rule'; /** * The NewRuleset model module. * @module model/NewRuleset - * @version 4.2.0 + * @version 4.3.0 */ class NewRuleset { /** diff --git a/src/model/NewSamlConnection.js b/src/model/NewSamlConnection.js index 34dd85d0..c8874783 100644 --- a/src/model/NewSamlConnection.js +++ b/src/model/NewSamlConnection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewSamlConnection model module. * @module model/NewSamlConnection - * @version 4.2.0 + * @version 4.3.0 */ class NewSamlConnection { /** diff --git a/src/model/NewTemplateDef.js b/src/model/NewTemplateDef.js index 505ade25..bf859d21 100644 --- a/src/model/NewTemplateDef.js +++ b/src/model/NewTemplateDef.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The NewTemplateDef model module. * @module model/NewTemplateDef - * @version 4.2.0 + * @version 4.3.0 */ class NewTemplateDef { /** diff --git a/src/model/NewUser.js b/src/model/NewUser.js index b08e8960..7f9ec315 100644 --- a/src/model/NewUser.js +++ b/src/model/NewUser.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The NewUser model module. * @module model/NewUser - * @version 4.2.0 + * @version 4.3.0 */ class NewUser { /** diff --git a/src/model/NewWebhook.js b/src/model/NewWebhook.js index 85611de3..77af8f9e 100644 --- a/src/model/NewWebhook.js +++ b/src/model/NewWebhook.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The NewWebhook model module. * @module model/NewWebhook - * @version 4.2.0 + * @version 4.3.0 */ class NewWebhook { /** diff --git a/src/model/Notification.js b/src/model/Notification.js index 3ce01b28..61811a48 100644 --- a/src/model/Notification.js +++ b/src/model/Notification.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Notification model module. * @module model/Notification - * @version 4.2.0 + * @version 4.3.0 */ class Notification { /** diff --git a/src/model/ProfileAudiencesChanges.js b/src/model/ProfileAudiencesChanges.js new file mode 100644 index 00000000..c6c2ec31 --- /dev/null +++ b/src/model/ProfileAudiencesChanges.js @@ -0,0 +1,85 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The ProfileAudiencesChanges model module. + * @module model/ProfileAudiencesChanges + * @version 4.3.0 + */ +class ProfileAudiencesChanges { + /** + * Constructs a new ProfileAudiencesChanges. + * @alias module:model/ProfileAudiencesChanges + * @param adds {Array.} The IDs of the audiences for the customer to join. + * @param deletes {Array.} The IDs of the audiences for the customer to leave. + */ + constructor(adds, deletes) { + + ProfileAudiencesChanges.initialize(this, adds, deletes); + } + + /** + * Initializes the fields of this object. + * 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, adds, deletes) { + obj['adds'] = adds; + obj['deletes'] = deletes; + } + + /** + * Constructs a ProfileAudiencesChanges from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ProfileAudiencesChanges} obj Optional instance to populate. + * @return {module:model/ProfileAudiencesChanges} The populated ProfileAudiencesChanges instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new ProfileAudiencesChanges(); + + if (data.hasOwnProperty('adds')) { + obj['adds'] = ApiClient.convertToType(data['adds'], ['Number']); + } + if (data.hasOwnProperty('deletes')) { + obj['deletes'] = ApiClient.convertToType(data['deletes'], ['Number']); + } + } + return obj; + } + + +} + +/** + * The IDs of the audiences for the customer to join. + * @member {Array.} adds + */ +ProfileAudiencesChanges.prototype['adds'] = undefined; + +/** + * The IDs of the audiences for the customer to leave. + * @member {Array.} deletes + */ +ProfileAudiencesChanges.prototype['deletes'] = undefined; + + + + + + +export default ProfileAudiencesChanges; + diff --git a/src/model/RedeemReferralEffectProps.js b/src/model/RedeemReferralEffectProps.js index c924055c..67110dc2 100644 --- a/src/model/RedeemReferralEffectProps.js +++ b/src/model/RedeemReferralEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RedeemReferralEffectProps model module. * @module model/RedeemReferralEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class RedeemReferralEffectProps { /** diff --git a/src/model/Referral.js b/src/model/Referral.js index bc8c16fd..35e4a534 100644 --- a/src/model/Referral.js +++ b/src/model/Referral.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Referral model module. * @module model/Referral - * @version 4.2.0 + * @version 4.3.0 */ class Referral { /** diff --git a/src/model/ReferralCreatedEffectProps.js b/src/model/ReferralCreatedEffectProps.js index 8d1c2cfc..f16010a6 100644 --- a/src/model/ReferralCreatedEffectProps.js +++ b/src/model/ReferralCreatedEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ReferralCreatedEffectProps model module. * @module model/ReferralCreatedEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class ReferralCreatedEffectProps { /** diff --git a/src/model/ReferralRejectionReason.js b/src/model/ReferralRejectionReason.js index a231a00e..686d5f3f 100644 --- a/src/model/ReferralRejectionReason.js +++ b/src/model/ReferralRejectionReason.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ReferralRejectionReason model module. * @module model/ReferralRejectionReason - * @version 4.2.0 + * @version 4.3.0 */ class ReferralRejectionReason { /** diff --git a/src/model/RejectCouponEffectProps.js b/src/model/RejectCouponEffectProps.js index b604f263..8448df5c 100644 --- a/src/model/RejectCouponEffectProps.js +++ b/src/model/RejectCouponEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RejectCouponEffectProps model module. * @module model/RejectCouponEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class RejectCouponEffectProps { /** @@ -58,6 +58,15 @@ class RejectCouponEffectProps { if (data.hasOwnProperty('rejectionReason')) { obj['rejectionReason'] = ApiClient.convertToType(data['rejectionReason'], 'String'); } + if (data.hasOwnProperty('conditionIndex')) { + obj['conditionIndex'] = ApiClient.convertToType(data['conditionIndex'], 'Number'); + } + if (data.hasOwnProperty('effectIndex')) { + obj['effectIndex'] = ApiClient.convertToType(data['effectIndex'], 'Number'); + } + if (data.hasOwnProperty('details')) { + obj['details'] = ApiClient.convertToType(data['details'], 'String'); + } } return obj; } @@ -77,6 +86,24 @@ RejectCouponEffectProps.prototype['value'] = undefined; */ RejectCouponEffectProps.prototype['rejectionReason'] = undefined; +/** + * The index of the condition that caused the rejection of the coupon + * @member {Number} conditionIndex + */ +RejectCouponEffectProps.prototype['conditionIndex'] = undefined; + +/** + * The index of the effect that caused the rejection of the coupon + * @member {Number} effectIndex + */ +RejectCouponEffectProps.prototype['effectIndex'] = undefined; + +/** + * More details about the failure + * @member {String} details + */ +RejectCouponEffectProps.prototype['details'] = undefined; + diff --git a/src/model/RejectReferralEffectProps.js b/src/model/RejectReferralEffectProps.js index 5086365a..6ad156e8 100644 --- a/src/model/RejectReferralEffectProps.js +++ b/src/model/RejectReferralEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RejectReferralEffectProps model module. * @module model/RejectReferralEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class RejectReferralEffectProps { /** @@ -58,6 +58,15 @@ class RejectReferralEffectProps { if (data.hasOwnProperty('rejectionReason')) { obj['rejectionReason'] = ApiClient.convertToType(data['rejectionReason'], 'String'); } + if (data.hasOwnProperty('conditionIndex')) { + obj['conditionIndex'] = ApiClient.convertToType(data['conditionIndex'], 'Number'); + } + if (data.hasOwnProperty('effectIndex')) { + obj['effectIndex'] = ApiClient.convertToType(data['effectIndex'], 'Number'); + } + if (data.hasOwnProperty('details')) { + obj['details'] = ApiClient.convertToType(data['details'], 'String'); + } } return obj; } @@ -77,6 +86,24 @@ RejectReferralEffectProps.prototype['value'] = undefined; */ RejectReferralEffectProps.prototype['rejectionReason'] = undefined; +/** + * The index of the condition that caused the rejection of the referral + * @member {Number} conditionIndex + */ +RejectReferralEffectProps.prototype['conditionIndex'] = undefined; + +/** + * The index of the effect that caused the rejection of the referral + * @member {Number} effectIndex + */ +RejectReferralEffectProps.prototype['effectIndex'] = undefined; + +/** + * More details about the failure + * @member {String} details + */ +RejectReferralEffectProps.prototype['details'] = undefined; + diff --git a/src/model/Role.js b/src/model/Role.js index 645ab9c5..ee449d75 100644 --- a/src/model/Role.js +++ b/src/model/Role.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Role model module. * @module model/Role - * @version 4.2.0 + * @version 4.3.0 */ class Role { /** diff --git a/src/model/RoleAssign.js b/src/model/RoleAssign.js index 61eb6283..1ea576fd 100644 --- a/src/model/RoleAssign.js +++ b/src/model/RoleAssign.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RoleAssign model module. * @module model/RoleAssign - * @version 4.2.0 + * @version 4.3.0 */ class RoleAssign { /** diff --git a/src/model/RoleMembership.js b/src/model/RoleMembership.js index 4c0034c9..cc3720d9 100644 --- a/src/model/RoleMembership.js +++ b/src/model/RoleMembership.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RoleMembership model module. * @module model/RoleMembership - * @version 4.2.0 + * @version 4.3.0 */ class RoleMembership { /** diff --git a/src/model/RollbackAddedLoyaltyPointsEffectProps.js b/src/model/RollbackAddedLoyaltyPointsEffectProps.js new file mode 100644 index 00000000..40b6d504 --- /dev/null +++ b/src/model/RollbackAddedLoyaltyPointsEffectProps.js @@ -0,0 +1,119 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The RollbackAddedLoyaltyPointsEffectProps model module. + * @module model/RollbackAddedLoyaltyPointsEffectProps + * @version 4.3.0 + */ +class RollbackAddedLoyaltyPointsEffectProps { + /** + * Constructs a new RollbackAddedLoyaltyPointsEffectProps. + * The properties specific to the \"rollbackAddedLoyaltyPoints\" effect. This gets triggered whenever previously a closed session with an addLoyaltyPoints effect is cancelled. + * @alias module:model/RollbackAddedLoyaltyPointsEffectProps + * @param programId {Number} The ID of the loyalty program where the points were originally added + * @param subLedgerId {String} The ID of the subledger within the loyalty program where these points were originally added + * @param value {Number} The amount of points that were rolled back + * @param recipientIntegrationId {String} The user for whom these points were originally added + * @param transactionUUID {String} The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. + */ + constructor(programId, subLedgerId, value, recipientIntegrationId, transactionUUID) { + + RollbackAddedLoyaltyPointsEffectProps.initialize(this, programId, subLedgerId, value, recipientIntegrationId, transactionUUID); + } + + /** + * Initializes the fields of this object. + * 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, programId, subLedgerId, value, recipientIntegrationId, transactionUUID) { + obj['programId'] = programId; + obj['subLedgerId'] = subLedgerId; + obj['value'] = value; + obj['recipientIntegrationId'] = recipientIntegrationId; + obj['transactionUUID'] = transactionUUID; + } + + /** + * Constructs a RollbackAddedLoyaltyPointsEffectProps from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RollbackAddedLoyaltyPointsEffectProps} obj Optional instance to populate. + * @return {module:model/RollbackAddedLoyaltyPointsEffectProps} The populated RollbackAddedLoyaltyPointsEffectProps instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new RollbackAddedLoyaltyPointsEffectProps(); + + if (data.hasOwnProperty('programId')) { + obj['programId'] = ApiClient.convertToType(data['programId'], 'Number'); + } + if (data.hasOwnProperty('subLedgerId')) { + obj['subLedgerId'] = ApiClient.convertToType(data['subLedgerId'], 'String'); + } + if (data.hasOwnProperty('value')) { + obj['value'] = ApiClient.convertToType(data['value'], 'Number'); + } + if (data.hasOwnProperty('recipientIntegrationId')) { + obj['recipientIntegrationId'] = ApiClient.convertToType(data['recipientIntegrationId'], 'String'); + } + if (data.hasOwnProperty('transactionUUID')) { + obj['transactionUUID'] = ApiClient.convertToType(data['transactionUUID'], 'String'); + } + } + return obj; + } + + +} + +/** + * The ID of the loyalty program where the points were originally added + * @member {Number} programId + */ +RollbackAddedLoyaltyPointsEffectProps.prototype['programId'] = undefined; + +/** + * The ID of the subledger within the loyalty program where these points were originally added + * @member {String} subLedgerId + */ +RollbackAddedLoyaltyPointsEffectProps.prototype['subLedgerId'] = undefined; + +/** + * The amount of points that were rolled back + * @member {Number} value + */ +RollbackAddedLoyaltyPointsEffectProps.prototype['value'] = undefined; + +/** + * The user for whom these points were originally added + * @member {String} recipientIntegrationId + */ +RollbackAddedLoyaltyPointsEffectProps.prototype['recipientIntegrationId'] = undefined; + +/** + * The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. + * @member {String} transactionUUID + */ +RollbackAddedLoyaltyPointsEffectProps.prototype['transactionUUID'] = undefined; + + + + + + +export default RollbackAddedLoyaltyPointsEffectProps; + diff --git a/src/model/RollbackCouponEffectProps.js b/src/model/RollbackCouponEffectProps.js index 1c767d00..cdb4309b 100644 --- a/src/model/RollbackCouponEffectProps.js +++ b/src/model/RollbackCouponEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RollbackCouponEffectProps model module. * @module model/RollbackCouponEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class RollbackCouponEffectProps { /** diff --git a/src/model/RollbackDeductedLoyaltyPointsEffectProps.js b/src/model/RollbackDeductedLoyaltyPointsEffectProps.js new file mode 100644 index 00000000..6d486100 --- /dev/null +++ b/src/model/RollbackDeductedLoyaltyPointsEffectProps.js @@ -0,0 +1,137 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The RollbackDeductedLoyaltyPointsEffectProps model module. + * @module model/RollbackDeductedLoyaltyPointsEffectProps + * @version 4.3.0 + */ +class RollbackDeductedLoyaltyPointsEffectProps { + /** + * Constructs a new RollbackDeductedLoyaltyPointsEffectProps. + * The properties specific to the \"rollbackDeductedLoyaltyPoints\" effect. This effect is triggered whenever a previously closed session is cancelled and a deductLoyaltyPoints effect was revoked. + * @alias module:model/RollbackDeductedLoyaltyPointsEffectProps + * @param programId {Number} The ID of the loyalty program where these points were reimbursed + * @param subLedgerId {String} The ID of the subledger within the loyalty program where these points were reimbursed + * @param value {Number} The amount of reimbursed points that were added + * @param recipientIntegrationId {String} The user for whom these points were reimbursed + * @param transactionUUID {String} The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back + */ + constructor(programId, subLedgerId, value, recipientIntegrationId, transactionUUID) { + + RollbackDeductedLoyaltyPointsEffectProps.initialize(this, programId, subLedgerId, value, recipientIntegrationId, transactionUUID); + } + + /** + * Initializes the fields of this object. + * 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, programId, subLedgerId, value, recipientIntegrationId, transactionUUID) { + obj['programId'] = programId; + obj['subLedgerId'] = subLedgerId; + obj['value'] = value; + obj['recipientIntegrationId'] = recipientIntegrationId; + obj['transactionUUID'] = transactionUUID; + } + + /** + * Constructs a RollbackDeductedLoyaltyPointsEffectProps from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RollbackDeductedLoyaltyPointsEffectProps} obj Optional instance to populate. + * @return {module:model/RollbackDeductedLoyaltyPointsEffectProps} The populated RollbackDeductedLoyaltyPointsEffectProps instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new RollbackDeductedLoyaltyPointsEffectProps(); + + if (data.hasOwnProperty('programId')) { + obj['programId'] = ApiClient.convertToType(data['programId'], 'Number'); + } + if (data.hasOwnProperty('subLedgerId')) { + obj['subLedgerId'] = ApiClient.convertToType(data['subLedgerId'], 'String'); + } + if (data.hasOwnProperty('value')) { + obj['value'] = ApiClient.convertToType(data['value'], 'Number'); + } + if (data.hasOwnProperty('recipientIntegrationId')) { + obj['recipientIntegrationId'] = ApiClient.convertToType(data['recipientIntegrationId'], 'String'); + } + if (data.hasOwnProperty('startDate')) { + obj['startDate'] = ApiClient.convertToType(data['startDate'], 'Date'); + } + if (data.hasOwnProperty('expiryDate')) { + obj['expiryDate'] = ApiClient.convertToType(data['expiryDate'], 'Date'); + } + if (data.hasOwnProperty('transactionUUID')) { + obj['transactionUUID'] = ApiClient.convertToType(data['transactionUUID'], 'String'); + } + } + return obj; + } + + +} + +/** + * The ID of the loyalty program where these points were reimbursed + * @member {Number} programId + */ +RollbackDeductedLoyaltyPointsEffectProps.prototype['programId'] = undefined; + +/** + * The ID of the subledger within the loyalty program where these points were reimbursed + * @member {String} subLedgerId + */ +RollbackDeductedLoyaltyPointsEffectProps.prototype['subLedgerId'] = undefined; + +/** + * The amount of reimbursed points that were added + * @member {Number} value + */ +RollbackDeductedLoyaltyPointsEffectProps.prototype['value'] = undefined; + +/** + * The user for whom these points were reimbursed + * @member {String} recipientIntegrationId + */ +RollbackDeductedLoyaltyPointsEffectProps.prototype['recipientIntegrationId'] = undefined; + +/** + * Date after which the reimbursed points will be valid + * @member {Date} startDate + */ +RollbackDeductedLoyaltyPointsEffectProps.prototype['startDate'] = undefined; + +/** + * Date after which the reimbursed points will expire + * @member {Date} expiryDate + */ +RollbackDeductedLoyaltyPointsEffectProps.prototype['expiryDate'] = undefined; + +/** + * The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back + * @member {String} transactionUUID + */ +RollbackDeductedLoyaltyPointsEffectProps.prototype['transactionUUID'] = undefined; + + + + + + +export default RollbackDeductedLoyaltyPointsEffectProps; + diff --git a/src/model/RollbackDiscountEffectProps.js b/src/model/RollbackDiscountEffectProps.js index 9bf8c25d..a2142f08 100644 --- a/src/model/RollbackDiscountEffectProps.js +++ b/src/model/RollbackDiscountEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The RollbackDiscountEffectProps model module. * @module model/RollbackDiscountEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class RollbackDiscountEffectProps { /** diff --git a/src/model/RollbackReferralEffectProps.js b/src/model/RollbackReferralEffectProps.js new file mode 100644 index 00000000..04fece4e --- /dev/null +++ b/src/model/RollbackReferralEffectProps.js @@ -0,0 +1,75 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The RollbackReferralEffectProps model module. + * @module model/RollbackReferralEffectProps + * @version 4.3.0 + */ +class RollbackReferralEffectProps { + /** + * Constructs a new RollbackReferralEffectProps. + * The properties specific to the \"rollbackReferral\" effect. This gets triggered whenever previously closed session is now cancelled and a referral redemption was cancelled on our internal usage limit counters. + * @alias module:model/RollbackReferralEffectProps + * @param value {String} The referral code whose usage has been rolled back + */ + constructor(value) { + + RollbackReferralEffectProps.initialize(this, value); + } + + /** + * Initializes the fields of this object. + * 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, value) { + obj['value'] = value; + } + + /** + * Constructs a RollbackReferralEffectProps from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RollbackReferralEffectProps} obj Optional instance to populate. + * @return {module:model/RollbackReferralEffectProps} The populated RollbackReferralEffectProps instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new RollbackReferralEffectProps(); + + if (data.hasOwnProperty('value')) { + obj['value'] = ApiClient.convertToType(data['value'], 'String'); + } + } + return obj; + } + + +} + +/** + * The referral code whose usage has been rolled back + * @member {String} value + */ +RollbackReferralEffectProps.prototype['value'] = undefined; + + + + + + +export default RollbackReferralEffectProps; + diff --git a/src/model/Rule.js b/src/model/Rule.js index 226bc67c..b00101c0 100644 --- a/src/model/Rule.js +++ b/src/model/Rule.js @@ -17,7 +17,7 @@ import Binding from './Binding'; /** * The Rule model module. * @module model/Rule - * @version 4.2.0 + * @version 4.3.0 */ class Rule { /** diff --git a/src/model/RuleFailureReason.js b/src/model/RuleFailureReason.js new file mode 100644 index 00000000..0800cb67 --- /dev/null +++ b/src/model/RuleFailureReason.js @@ -0,0 +1,182 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The RuleFailureReason model module. + * @module model/RuleFailureReason + * @version 4.3.0 + */ +class RuleFailureReason { + /** + * Constructs a new RuleFailureReason. + * Details about why a rule failed + * @alias module:model/RuleFailureReason + * @param campaignID {Number} The ID of the campaign that contains the rule that failed + * @param campaignName {String} The name of the campaign that contains the rule that failed + * @param rulesetID {Number} The ID of the ruleset that contains the rule that failed + * @param ruleIndex {Number} The index of the rule that failed within the ruleset + * @param ruleName {String} The name of the rule that failed within the ruleset + */ + constructor(campaignID, campaignName, rulesetID, ruleIndex, ruleName) { + + RuleFailureReason.initialize(this, campaignID, campaignName, rulesetID, ruleIndex, ruleName); + } + + /** + * Initializes the fields of this object. + * 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, campaignID, campaignName, rulesetID, ruleIndex, ruleName) { + obj['campaignID'] = campaignID; + obj['campaignName'] = campaignName; + obj['rulesetID'] = rulesetID; + obj['ruleIndex'] = ruleIndex; + obj['ruleName'] = ruleName; + } + + /** + * Constructs a RuleFailureReason from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RuleFailureReason} obj Optional instance to populate. + * @return {module:model/RuleFailureReason} The populated RuleFailureReason instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new RuleFailureReason(); + + if (data.hasOwnProperty('campaignID')) { + obj['campaignID'] = ApiClient.convertToType(data['campaignID'], 'Number'); + } + if (data.hasOwnProperty('campaignName')) { + obj['campaignName'] = ApiClient.convertToType(data['campaignName'], 'String'); + } + if (data.hasOwnProperty('rulesetID')) { + obj['rulesetID'] = ApiClient.convertToType(data['rulesetID'], 'Number'); + } + if (data.hasOwnProperty('couponID')) { + obj['couponID'] = ApiClient.convertToType(data['couponID'], 'Number'); + } + if (data.hasOwnProperty('couponValue')) { + obj['couponValue'] = ApiClient.convertToType(data['couponValue'], 'String'); + } + if (data.hasOwnProperty('referralID')) { + obj['referralID'] = ApiClient.convertToType(data['referralID'], 'Number'); + } + if (data.hasOwnProperty('referralValue')) { + obj['referralValue'] = ApiClient.convertToType(data['referralValue'], 'String'); + } + if (data.hasOwnProperty('ruleIndex')) { + obj['ruleIndex'] = ApiClient.convertToType(data['ruleIndex'], 'Number'); + } + if (data.hasOwnProperty('ruleName')) { + obj['ruleName'] = ApiClient.convertToType(data['ruleName'], 'String'); + } + if (data.hasOwnProperty('conditionIndex')) { + obj['conditionIndex'] = ApiClient.convertToType(data['conditionIndex'], 'Number'); + } + if (data.hasOwnProperty('effectIndex')) { + obj['effectIndex'] = ApiClient.convertToType(data['effectIndex'], 'Number'); + } + if (data.hasOwnProperty('details')) { + obj['details'] = ApiClient.convertToType(data['details'], 'String'); + } + } + return obj; + } + + +} + +/** + * The ID of the campaign that contains the rule that failed + * @member {Number} campaignID + */ +RuleFailureReason.prototype['campaignID'] = undefined; + +/** + * The name of the campaign that contains the rule that failed + * @member {String} campaignName + */ +RuleFailureReason.prototype['campaignName'] = undefined; + +/** + * The ID of the ruleset that contains the rule that failed + * @member {Number} rulesetID + */ +RuleFailureReason.prototype['rulesetID'] = undefined; + +/** + * The ID of the coupon that was being evaluated at the time of the rule failure + * @member {Number} couponID + */ +RuleFailureReason.prototype['couponID'] = undefined; + +/** + * The value of the coupon that was being evaluated at the time of the rule failure + * @member {String} couponValue + */ +RuleFailureReason.prototype['couponValue'] = undefined; + +/** + * The ID of the referral that was being evaluated at the time of the rule failure + * @member {Number} referralID + */ +RuleFailureReason.prototype['referralID'] = undefined; + +/** + * The value of the referral that was being evaluated at the time of the rule failure + * @member {String} referralValue + */ +RuleFailureReason.prototype['referralValue'] = undefined; + +/** + * The index of the rule that failed within the ruleset + * @member {Number} ruleIndex + */ +RuleFailureReason.prototype['ruleIndex'] = undefined; + +/** + * The name of the rule that failed within the ruleset + * @member {String} ruleName + */ +RuleFailureReason.prototype['ruleName'] = undefined; + +/** + * The index of the condition that failed + * @member {Number} conditionIndex + */ +RuleFailureReason.prototype['conditionIndex'] = undefined; + +/** + * The index of the effect that failed + * @member {Number} effectIndex + */ +RuleFailureReason.prototype['effectIndex'] = undefined; + +/** + * More details about the failure + * @member {String} details + */ +RuleFailureReason.prototype['details'] = undefined; + + + + + + +export default RuleFailureReason; + diff --git a/src/model/Ruleset.js b/src/model/Ruleset.js index 4411519d..08349b70 100644 --- a/src/model/Ruleset.js +++ b/src/model/Ruleset.js @@ -18,7 +18,7 @@ import Rule from './Rule'; /** * The Ruleset model module. * @module model/Ruleset - * @version 4.2.0 + * @version 4.3.0 */ class Ruleset { /** diff --git a/src/model/SamlConnection.js b/src/model/SamlConnection.js index 0b709270..82266085 100644 --- a/src/model/SamlConnection.js +++ b/src/model/SamlConnection.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SamlConnection model module. * @module model/SamlConnection - * @version 4.2.0 + * @version 4.3.0 */ class SamlConnection { /** diff --git a/src/model/SamlConnectionMetadata.js b/src/model/SamlConnectionMetadata.js index f3d7b798..7a0c0913 100644 --- a/src/model/SamlConnectionMetadata.js +++ b/src/model/SamlConnectionMetadata.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SamlConnectionMetadata model module. * @module model/SamlConnectionMetadata - * @version 4.2.0 + * @version 4.3.0 */ class SamlConnectionMetadata { /** diff --git a/src/model/SamlLoginEndpoint.js b/src/model/SamlLoginEndpoint.js index 2eb8d06f..903e0ca4 100644 --- a/src/model/SamlLoginEndpoint.js +++ b/src/model/SamlLoginEndpoint.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SamlLoginEndpoint model module. * @module model/SamlLoginEndpoint - * @version 4.2.0 + * @version 4.3.0 */ class SamlLoginEndpoint { /** diff --git a/src/model/Session.js b/src/model/Session.js index ee4be5bf..adcdd235 100644 --- a/src/model/Session.js +++ b/src/model/Session.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The Session model module. * @module model/Session - * @version 4.2.0 + * @version 4.3.0 */ class Session { /** diff --git a/src/model/SetDiscountEffectProps.js b/src/model/SetDiscountEffectProps.js index cef9ffb8..5b4d9be4 100644 --- a/src/model/SetDiscountEffectProps.js +++ b/src/model/SetDiscountEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SetDiscountEffectProps model module. * @module model/SetDiscountEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class SetDiscountEffectProps { /** diff --git a/src/model/SetDiscountPerItemEffectProps.js b/src/model/SetDiscountPerItemEffectProps.js index 56baff06..4fd5706a 100644 --- a/src/model/SetDiscountPerItemEffectProps.js +++ b/src/model/SetDiscountPerItemEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SetDiscountPerItemEffectProps model module. * @module model/SetDiscountPerItemEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class SetDiscountPerItemEffectProps { /** diff --git a/src/model/ShowBundleMetadataEffectProps.js b/src/model/ShowBundleMetadataEffectProps.js index 889f677f..e2cdbdc4 100644 --- a/src/model/ShowBundleMetadataEffectProps.js +++ b/src/model/ShowBundleMetadataEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ShowBundleMetadataEffectProps model module. * @module model/ShowBundleMetadataEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class ShowBundleMetadataEffectProps { /** diff --git a/src/model/ShowNotificationEffectProps.js b/src/model/ShowNotificationEffectProps.js index 3650fe33..914168c7 100644 --- a/src/model/ShowNotificationEffectProps.js +++ b/src/model/ShowNotificationEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The ShowNotificationEffectProps model module. * @module model/ShowNotificationEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class ShowNotificationEffectProps { /** diff --git a/src/model/SlotDef.js b/src/model/SlotDef.js index 6457e6c8..9a77182d 100644 --- a/src/model/SlotDef.js +++ b/src/model/SlotDef.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The SlotDef model module. * @module model/SlotDef - * @version 4.2.0 + * @version 4.3.0 */ class SlotDef { /** diff --git a/src/model/TemplateArgDef.js b/src/model/TemplateArgDef.js index 538b6732..ffd91b84 100644 --- a/src/model/TemplateArgDef.js +++ b/src/model/TemplateArgDef.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TemplateArgDef model module. * @module model/TemplateArgDef - * @version 4.2.0 + * @version 4.3.0 */ class TemplateArgDef { /** diff --git a/src/model/TemplateDef.js b/src/model/TemplateDef.js index 9e3210c2..e216a05e 100644 --- a/src/model/TemplateDef.js +++ b/src/model/TemplateDef.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The TemplateDef model module. * @module model/TemplateDef - * @version 4.2.0 + * @version 4.3.0 */ class TemplateDef { /** diff --git a/src/model/TriggerWebhookEffectProps.js b/src/model/TriggerWebhookEffectProps.js index 3f40ee14..ed14ea3d 100644 --- a/src/model/TriggerWebhookEffectProps.js +++ b/src/model/TriggerWebhookEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The TriggerWebhookEffectProps model module. * @module model/TriggerWebhookEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class TriggerWebhookEffectProps { /** diff --git a/src/model/UpdateAccount.js b/src/model/UpdateAccount.js index f466452c..a2d825c4 100644 --- a/src/model/UpdateAccount.js +++ b/src/model/UpdateAccount.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateAccount model module. * @module model/UpdateAccount - * @version 4.2.0 + * @version 4.3.0 */ class UpdateAccount { /** diff --git a/src/model/UpdateApplication.js b/src/model/UpdateApplication.js index 81ed1495..20c97988 100644 --- a/src/model/UpdateApplication.js +++ b/src/model/UpdateApplication.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The UpdateApplication model module. * @module model/UpdateApplication - * @version 4.2.0 + * @version 4.3.0 */ class UpdateApplication { /** @@ -82,6 +82,9 @@ class UpdateApplication { 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'); } @@ -155,6 +158,12 @@ UpdateApplication.prototype['campaignPriority'] = undefined; */ UpdateApplication.prototype['exclusiveCampaignsStrategy'] = undefined; +/** + * The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. + * @member {module:model/UpdateApplication.DefaultDiscountScopeEnum} defaultDiscountScope + */ +UpdateApplication.prototype['defaultDiscountScope'] = undefined; + /** * Flag indicating if discounts should cascade for this application * @member {Boolean} enableCascadingDiscounts @@ -263,6 +272,33 @@ UpdateApplication['ExclusiveCampaignsStrategyEnum'] = { }; +/** + * Allowed values for the defaultDiscountScope property. + * @enum {String} + * @readonly + */ +UpdateApplication['DefaultDiscountScopeEnum'] = { + + /** + * value: "sessionTotal" + * @const + */ + "sessionTotal": "sessionTotal", + + /** + * value: "cartItems" + * @const + */ + "cartItems": "cartItems", + + /** + * value: "additionalCosts" + * @const + */ + "additionalCosts": "additionalCosts" +}; + + export default UpdateApplication; diff --git a/src/model/UpdateAttributeEffectProps.js b/src/model/UpdateAttributeEffectProps.js index a0acf292..f67622d5 100644 --- a/src/model/UpdateAttributeEffectProps.js +++ b/src/model/UpdateAttributeEffectProps.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateAttributeEffectProps model module. * @module model/UpdateAttributeEffectProps - * @version 4.2.0 + * @version 4.3.0 */ class UpdateAttributeEffectProps { /** diff --git a/src/model/UpdateAudience.js b/src/model/UpdateAudience.js index 4d63eeea..06d2992d 100644 --- a/src/model/UpdateAudience.js +++ b/src/model/UpdateAudience.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateAudience model module. * @module model/UpdateAudience - * @version 4.2.0 + * @version 4.3.0 */ class UpdateAudience { /** diff --git a/src/model/UpdateCampaign.js b/src/model/UpdateCampaign.js index f24408b1..a167fe4b 100644 --- a/src/model/UpdateCampaign.js +++ b/src/model/UpdateCampaign.js @@ -18,7 +18,7 @@ import LimitConfig from './LimitConfig'; /** * The UpdateCampaign model module. * @module model/UpdateCampaign - * @version 4.2.0 + * @version 4.3.0 */ class UpdateCampaign { /** diff --git a/src/model/UpdateCampaignGroup.js b/src/model/UpdateCampaignGroup.js index ba7d1ad3..2d4fc921 100644 --- a/src/model/UpdateCampaignGroup.js +++ b/src/model/UpdateCampaignGroup.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCampaignGroup model module. * @module model/UpdateCampaignGroup - * @version 4.2.0 + * @version 4.3.0 */ class UpdateCampaignGroup { /** diff --git a/src/model/UpdateCoupon.js b/src/model/UpdateCoupon.js index 26d3d659..0af024bc 100644 --- a/src/model/UpdateCoupon.js +++ b/src/model/UpdateCoupon.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCoupon model module. * @module model/UpdateCoupon - * @version 4.2.0 + * @version 4.3.0 */ class UpdateCoupon { /** diff --git a/src/model/UpdateCouponBatch.js b/src/model/UpdateCouponBatch.js index 11fb09de..e187230e 100644 --- a/src/model/UpdateCouponBatch.js +++ b/src/model/UpdateCouponBatch.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateCouponBatch model module. * @module model/UpdateCouponBatch - * @version 4.2.0 + * @version 4.3.0 */ class UpdateCouponBatch { /** diff --git a/src/model/UpdateLoyaltyProgram.js b/src/model/UpdateLoyaltyProgram.js index fa297695..244f6830 100644 --- a/src/model/UpdateLoyaltyProgram.js +++ b/src/model/UpdateLoyaltyProgram.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateLoyaltyProgram model module. * @module model/UpdateLoyaltyProgram - * @version 4.2.0 + * @version 4.3.0 */ class UpdateLoyaltyProgram { /** diff --git a/src/model/UpdateRole.js b/src/model/UpdateRole.js index 3f523f06..9275d8ff 100644 --- a/src/model/UpdateRole.js +++ b/src/model/UpdateRole.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateRole model module. * @module model/UpdateRole - * @version 4.2.0 + * @version 4.3.0 */ class UpdateRole { /** diff --git a/src/model/UpdateUser.js b/src/model/UpdateUser.js index 0d425529..742c4464 100644 --- a/src/model/UpdateUser.js +++ b/src/model/UpdateUser.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateUser model module. * @module model/UpdateUser - * @version 4.2.0 + * @version 4.3.0 */ class UpdateUser { /** diff --git a/src/model/UpdateUserLatestFeedTimestamp.js b/src/model/UpdateUserLatestFeedTimestamp.js index 2229d42d..add7b06a 100644 --- a/src/model/UpdateUserLatestFeedTimestamp.js +++ b/src/model/UpdateUserLatestFeedTimestamp.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UpdateUserLatestFeedTimestamp model module. * @module model/UpdateUserLatestFeedTimestamp - * @version 4.2.0 + * @version 4.3.0 */ class UpdateUserLatestFeedTimestamp { /** diff --git a/src/model/User.js b/src/model/User.js index 9a5689fe..d30a9c6f 100644 --- a/src/model/User.js +++ b/src/model/User.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The User model module. * @module model/User - * @version 4.2.0 + * @version 4.3.0 */ class User { /** diff --git a/src/model/UserEntity.js b/src/model/UserEntity.js index 0be2d8c8..63850382 100644 --- a/src/model/UserEntity.js +++ b/src/model/UserEntity.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The UserEntity model module. * @module model/UserEntity - * @version 4.2.0 + * @version 4.3.0 */ class UserEntity { /** diff --git a/src/model/UserFeedNotifications.js b/src/model/UserFeedNotifications.js index 7a3c2cc3..8f4084f8 100644 --- a/src/model/UserFeedNotifications.js +++ b/src/model/UserFeedNotifications.js @@ -17,7 +17,7 @@ import FeedNotification from './FeedNotification'; /** * The UserFeedNotifications model module. * @module model/UserFeedNotifications - * @version 4.2.0 + * @version 4.3.0 */ class UserFeedNotifications { /** diff --git a/src/model/Webhook.js b/src/model/Webhook.js index c9a09de6..ab61a191 100644 --- a/src/model/Webhook.js +++ b/src/model/Webhook.js @@ -17,7 +17,7 @@ import TemplateArgDef from './TemplateArgDef'; /** * The Webhook model module. * @module model/Webhook - * @version 4.2.0 + * @version 4.3.0 */ class Webhook { /** diff --git a/src/model/WebhookActivationLogEntry.js b/src/model/WebhookActivationLogEntry.js index c7e4ba2e..eb9e228b 100644 --- a/src/model/WebhookActivationLogEntry.js +++ b/src/model/WebhookActivationLogEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The WebhookActivationLogEntry model module. * @module model/WebhookActivationLogEntry - * @version 4.2.0 + * @version 4.3.0 */ class WebhookActivationLogEntry { /** diff --git a/src/model/WebhookLogEntry.js b/src/model/WebhookLogEntry.js index d529edee..2fc48a4d 100644 --- a/src/model/WebhookLogEntry.js +++ b/src/model/WebhookLogEntry.js @@ -16,7 +16,7 @@ import ApiClient from '../ApiClient'; /** * The WebhookLogEntry model module. * @module model/WebhookLogEntry - * @version 4.2.0 + * @version 4.3.0 */ class WebhookLogEntry { /** diff --git a/test/api/ManagementApi.spec.js b/test/api/ManagementApi.spec.js index 4596c637..b9c72268 100644 --- a/test/api/ManagementApi.spec.js +++ b/test/api/ManagementApi.spec.js @@ -108,6 +108,16 @@ done(); }); }); + describe('createCouponsForMultipleRecipients', function() { + it('should call createCouponsForMultipleRecipients successfully', function(done) { + //uncomment below and update the code to test createCouponsForMultipleRecipients + //instance.createCouponsForMultipleRecipients(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('createPasswordRecoveryEmail', function() { it('should call createPasswordRecoveryEmail successfully', function(done) { //uncomment below and update the code to test createPasswordRecoveryEmail @@ -188,6 +198,66 @@ done(); }); }); + describe('destroySession', function() { + it('should call destroySession successfully', function(done) { + //uncomment below and update the code to test destroySession + //instance.destroySession(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('exportCoupons', function() { + it('should call exportCoupons successfully', function(done) { + //uncomment below and update the code to test exportCoupons + //instance.exportCoupons(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('exportCustomerSessions', function() { + it('should call exportCustomerSessions successfully', function(done) { + //uncomment below and update the code to test exportCustomerSessions + //instance.exportCustomerSessions(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('exportEffects', function() { + it('should call exportEffects successfully', function(done) { + //uncomment below and update the code to test exportEffects + //instance.exportEffects(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('exportLoyaltyBalance', function() { + it('should call exportLoyaltyBalance successfully', function(done) { + //uncomment below and update the code to test exportLoyaltyBalance + //instance.exportLoyaltyBalance(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('exportLoyaltyLedger', function() { + it('should call exportLoyaltyLedger successfully', function(done) { + //uncomment below and update the code to test exportLoyaltyLedger + //instance.exportLoyaltyLedger(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('getAccessLogs', function() { it('should call getAccessLogs successfully', function(done) { //uncomment below and update the code to test getAccessLogs @@ -398,6 +468,16 @@ done(); }); }); + describe('getAudiences', function() { + it('should call getAudiences successfully', function(done) { + //uncomment below and update the code to test getAudiences + //instance.getAudiences(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); describe('getCampaign', function() { it('should call getCampaign successfully', function(done) { //uncomment below and update the code to test getCampaign @@ -578,16 +658,6 @@ done(); }); }); - describe('getImports', function() { - it('should call getImports successfully', function(done) { - //uncomment below and update the code to test getImports - //instance.getImports(function(error) { - // if (error) throw error; - //expect().to.be(); - //}); - done(); - }); - }); describe('getLoyaltyPoints', function() { it('should call getLoyaltyPoints successfully', function(done) { //uncomment below and update the code to test getLoyaltyPoints diff --git a/test/model/AddLoyaltyPointsEffectProps.spec.js b/test/model/AddLoyaltyPointsEffectProps.spec.js index f3ce14f2..f0a5494f 100644 --- a/test/model/AddLoyaltyPointsEffectProps.spec.js +++ b/test/model/AddLoyaltyPointsEffectProps.spec.js @@ -96,6 +96,12 @@ //expect(instance).to.be(); }); + it('should have the property transactionUUID (base name: "transactionUUID")', function() { + // uncomment below and update the code to test the property transactionUUID + //var instane = new TalonOne.AddLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Application.spec.js b/test/model/Application.spec.js index 722e46a3..ef2a1071 100644 --- a/test/model/Application.spec.js +++ b/test/model/Application.spec.js @@ -132,6 +132,12 @@ //expect(instance).to.be(); }); + it('should have the property defaultDiscountScope (base name: "defaultDiscountScope")', function() { + // uncomment below and update the code to test the property defaultDiscountScope + //var instane = new TalonOne.Application(); + //expect(instance).to.be(); + }); + it('should have the property enableCascadingDiscounts (base name: "enableCascadingDiscounts")', function() { // uncomment below and update the code to test the property enableCascadingDiscounts //var instane = new TalonOne.Application(); diff --git a/test/model/ApplicationEvent.spec.js b/test/model/ApplicationEvent.spec.js index 36a08209..2e005719 100644 --- a/test/model/ApplicationEvent.spec.js +++ b/test/model/ApplicationEvent.spec.js @@ -102,6 +102,12 @@ //expect(instance).to.be(); }); + it('should have the property ruleFailureReasons (base name: "ruleFailureReasons")', function() { + // uncomment below and update the code to test the property ruleFailureReasons + //var instane = new TalonOne.ApplicationEvent(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Binding.spec.js b/test/model/Binding.spec.js index 145e7ed8..9e3276e7 100644 --- a/test/model/Binding.spec.js +++ b/test/model/Binding.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new TalonOne.Binding(); + //expect(instance).to.be(); + }); + it('should have the property expression (base name: "expression")', function() { // uncomment below and update the code to test the property expression //var instane = new TalonOne.Binding(); diff --git a/test/model/Campaign.spec.js b/test/model/Campaign.spec.js index 6508db99..752fbb59 100644 --- a/test/model/Campaign.spec.js +++ b/test/model/Campaign.spec.js @@ -186,6 +186,36 @@ //expect(instance).to.be(); }); + it('should have the property referralCreationCount (base name: "referralCreationCount")', function() { + // uncomment below and update the code to test the property referralCreationCount + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsCount (base name: "createdLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsCount + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + + it('should have the property createdLoyaltyPointsEffectCount (base name: "createdLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property createdLoyaltyPointsEffectCount + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsCount (base name: "redeemedLoyaltyPointsCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsCount + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + + it('should have the property redeemedLoyaltyPointsEffectCount (base name: "redeemedLoyaltyPointsEffectCount")', function() { + // uncomment below and update the code to test the property redeemedLoyaltyPointsEffectCount + //var instane = new TalonOne.Campaign(); + //expect(instance).to.be(); + }); + it('should have the property lastActivity (base name: "lastActivity")', function() { // uncomment below and update the code to test the property lastActivity //var instane = new TalonOne.Campaign(); diff --git a/test/model/CartItem.spec.js b/test/model/CartItem.spec.js index f1b3e504..ee81d750 100644 --- a/test/model/CartItem.spec.js +++ b/test/model/CartItem.spec.js @@ -120,12 +120,6 @@ //expect(instance).to.be(); }); - it('should have the property adjustment (base name: "adjustment")', function() { - // uncomment below and update the code to test the property adjustment - //var instane = new TalonOne.CartItem(); - //expect(instance).to.be(); - }); - }); })); diff --git a/test/model/Change.spec.js b/test/model/Change.spec.js index 0a371e8c..ad9ec69a 100644 --- a/test/model/Change.spec.js +++ b/test/model/Change.spec.js @@ -72,6 +72,12 @@ //expect(instance).to.be(); }); + it('should have the property applicationId (base name: "applicationId")', function() { + // uncomment below and update the code to test the property applicationId + //var instane = new TalonOne.Change(); + //expect(instance).to.be(); + }); + it('should have the property entity (base name: "entity")', function() { // uncomment below and update the code to test the property entity //var instane = new TalonOne.Change(); diff --git a/test/model/CustomerProfileIntegrationRequestV2.spec.js b/test/model/CustomerProfileIntegrationRequestV2.spec.js index be120373..0dec7776 100644 --- a/test/model/CustomerProfileIntegrationRequestV2.spec.js +++ b/test/model/CustomerProfileIntegrationRequestV2.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property audiencesChanges (base name: "audiencesChanges")', function() { + // uncomment below and update the code to test the property audiencesChanges + //var instane = new TalonOne.CustomerProfileIntegrationRequestV2(); + //expect(instance).to.be(); + }); + it('should have the property responseContent (base name: "responseContent")', function() { // uncomment below and update the code to test the property responseContent //var instane = new TalonOne.CustomerProfileIntegrationRequestV2(); diff --git a/test/model/DeductLoyaltyPointsEffectProps.spec.js b/test/model/DeductLoyaltyPointsEffectProps.spec.js index d2150cf3..f4ab2866 100644 --- a/test/model/DeductLoyaltyPointsEffectProps.spec.js +++ b/test/model/DeductLoyaltyPointsEffectProps.spec.js @@ -78,6 +78,12 @@ //expect(instance).to.be(); }); + it('should have the property transactionUUID (base name: "transactionUUID")', function() { + // uncomment below and update the code to test the property transactionUUID + //var instane = new TalonOne.DeductLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/Effect.spec.js b/test/model/Effect.spec.js index e472002c..de742641 100644 --- a/test/model/Effect.spec.js +++ b/test/model/Effect.spec.js @@ -84,6 +84,12 @@ //expect(instance).to.be(); }); + it('should have the property triggeredByCoupon (base name: "triggeredByCoupon")', function() { + // uncomment below and update the code to test the property triggeredByCoupon + //var instane = new TalonOne.Effect(); + //expect(instance).to.be(); + }); + it('should have the property props (base name: "props")', function() { // uncomment below and update the code to test the property props //var instane = new TalonOne.Effect(); diff --git a/test/model/EffectEntity.spec.js b/test/model/EffectEntity.spec.js index 302d95f3..e961a0c2 100644 --- a/test/model/EffectEntity.spec.js +++ b/test/model/EffectEntity.spec.js @@ -84,6 +84,12 @@ //expect(instance).to.be(); }); + it('should have the property triggeredByCoupon (base name: "triggeredByCoupon")', function() { + // uncomment below and update the code to test the property triggeredByCoupon + //var instane = new TalonOne.EffectEntity(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/InlineResponse20027.spec.js b/test/model/InlineResponse20027.spec.js index 7bc25769..d3d16303 100644 --- a/test/model/InlineResponse20027.spec.js +++ b/test/model/InlineResponse20027.spec.js @@ -60,12 +60,6 @@ //expect(instance).to.be(); }); - it('should have the property hasMore (base name: "hasMore")', function() { - // uncomment below and update the code to test the property hasMore - //var instane = new TalonOne.InlineResponse20027(); - //expect(instance).to.be(); - }); - it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20027(); diff --git a/test/model/InlineResponse20028.spec.js b/test/model/InlineResponse20028.spec.js index d1463181..29a2aa57 100644 --- a/test/model/InlineResponse20028.spec.js +++ b/test/model/InlineResponse20028.spec.js @@ -60,6 +60,12 @@ //expect(instance).to.be(); }); + it('should have the property hasMore (base name: "hasMore")', function() { + // uncomment below and update the code to test the property hasMore + //var instane = new TalonOne.InlineResponse20028(); + //expect(instance).to.be(); + }); + it('should have the property data (base name: "data")', function() { // uncomment below and update the code to test the property data //var instane = new TalonOne.InlineResponse20028(); diff --git a/test/model/IntegrationStateV2.spec.js b/test/model/IntegrationStateV2.spec.js index ad26d384..bc8a5fba 100644 --- a/test/model/IntegrationStateV2.spec.js +++ b/test/model/IntegrationStateV2.spec.js @@ -102,6 +102,12 @@ //expect(instance).to.be(); }); + it('should have the property ruleFailureReasons (base name: "ruleFailureReasons")', function() { + // uncomment below and update the code to test the property ruleFailureReasons + //var instane = new TalonOne.IntegrationStateV2(); + //expect(instance).to.be(); + }); + it('should have the property createdCoupons (base name: "createdCoupons")', function() { // uncomment below and update the code to test the property createdCoupons //var instane = new TalonOne.IntegrationStateV2(); diff --git a/test/model/LoyaltyProgramBalance.spec.js b/test/model/LoyaltyProgramBalance.spec.js index d17629b0..95fe812d 100644 --- a/test/model/LoyaltyProgramBalance.spec.js +++ b/test/model/LoyaltyProgramBalance.spec.js @@ -60,6 +60,30 @@ //expect(instance).to.be(); }); + it('should have the property pendingBalance (base name: "pendingBalance")', function() { + // uncomment below and update the code to test the property pendingBalance + //var instane = new TalonOne.LoyaltyProgramBalance(); + //expect(instance).to.be(); + }); + + it('should have the property expiredBalance (base name: "expiredBalance")', function() { + // uncomment below and update the code to test the property expiredBalance + //var instane = new TalonOne.LoyaltyProgramBalance(); + //expect(instance).to.be(); + }); + + it('should have the property spentBalance (base name: "spentBalance")', function() { + // uncomment below and update the code to test the property spentBalance + //var instane = new TalonOne.LoyaltyProgramBalance(); + //expect(instance).to.be(); + }); + + it('should have the property tentativeCurrentBalance (base name: "tentativeCurrentBalance")', function() { + // uncomment below and update the code to test the property tentativeCurrentBalance + //var instane = new TalonOne.LoyaltyProgramBalance(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/LoyaltyProgramLedgers.spec.js b/test/model/LoyaltyProgramLedgers.spec.js index 09c990d9..b6a8c07c 100644 --- a/test/model/LoyaltyProgramLedgers.spec.js +++ b/test/model/LoyaltyProgramLedgers.spec.js @@ -54,6 +54,12 @@ //expect(instance).to.be.a(TalonOne.LoyaltyProgramLedgers); }); + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new TalonOne.LoyaltyProgramLedgers(); + //expect(instance).to.be(); + }); + it('should have the property title (base name: "title")', function() { // uncomment below and update the code to test the property title //var instane = new TalonOne.LoyaltyProgramLedgers(); diff --git a/test/model/NewApplication.spec.js b/test/model/NewApplication.spec.js index 298938e9..aa92017b 100644 --- a/test/model/NewApplication.spec.js +++ b/test/model/NewApplication.spec.js @@ -108,6 +108,12 @@ //expect(instance).to.be(); }); + it('should have the property defaultDiscountScope (base name: "defaultDiscountScope")', function() { + // uncomment below and update the code to test the property defaultDiscountScope + //var instane = new TalonOne.NewApplication(); + //expect(instance).to.be(); + }); + it('should have the property enableCascadingDiscounts (base name: "enableCascadingDiscounts")', function() { // uncomment below and update the code to test the property enableCascadingDiscounts //var instane = new TalonOne.NewApplication(); diff --git a/test/model/NewCoupons.spec.js b/test/model/NewCoupons.spec.js index 59016c91..ed939400 100644 --- a/test/model/NewCoupons.spec.js +++ b/test/model/NewCoupons.spec.js @@ -78,18 +78,6 @@ //expect(instance).to.be(); }); - it('should have the property validCharacters (base name: "validCharacters")', function() { - // uncomment below and update the code to test the property validCharacters - //var instane = new TalonOne.NewCoupons(); - //expect(instance).to.be(); - }); - - it('should have the property couponPattern (base name: "couponPattern")', function() { - // uncomment below and update the code to test the property couponPattern - //var instane = new TalonOne.NewCoupons(); - //expect(instance).to.be(); - }); - it('should have the property numberOfCoupons (base name: "numberOfCoupons")', function() { // uncomment below and update the code to test the property numberOfCoupons //var instane = new TalonOne.NewCoupons(); @@ -114,6 +102,18 @@ //expect(instance).to.be(); }); + it('should have the property validCharacters (base name: "validCharacters")', function() { + // uncomment below and update the code to test the property validCharacters + //var instane = new TalonOne.NewCoupons(); + //expect(instance).to.be(); + }); + + it('should have the property couponPattern (base name: "couponPattern")', function() { + // uncomment below and update the code to test the property couponPattern + //var instane = new TalonOne.NewCoupons(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/NewCouponsForMultipleRecipients.spec.js b/test/model/NewCouponsForMultipleRecipients.spec.js new file mode 100644 index 00000000..a67bd143 --- /dev/null +++ b/test/model/NewCouponsForMultipleRecipients.spec.js @@ -0,0 +1,107 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.NewCouponsForMultipleRecipients(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('NewCouponsForMultipleRecipients', function() { + it('should create an instance of NewCouponsForMultipleRecipients', function() { + // uncomment below and update the code to test NewCouponsForMultipleRecipients + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be.a(TalonOne.NewCouponsForMultipleRecipients); + }); + + it('should have the property usageLimit (base name: "usageLimit")', function() { + // uncomment below and update the code to test the property usageLimit + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + it('should have the property discountLimit (base name: "discountLimit")', function() { + // uncomment below and update the code to test the property discountLimit + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + it('should have the property startDate (base name: "startDate")', function() { + // uncomment below and update the code to test the property startDate + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + it('should have the property expiryDate (base name: "expiryDate")', function() { + // uncomment below and update the code to test the property expiryDate + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + it('should have the property attributes (base name: "attributes")', function() { + // uncomment below and update the code to test the property attributes + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + it('should have the property recipientsIntegrationIds (base name: "recipientsIntegrationIds")', function() { + // uncomment below and update the code to test the property recipientsIntegrationIds + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + it('should have the property validCharacters (base name: "validCharacters")', function() { + // uncomment below and update the code to test the property validCharacters + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + it('should have the property couponPattern (base name: "couponPattern")', function() { + // uncomment below and update the code to test the property couponPattern + //var instane = new TalonOne.NewCouponsForMultipleRecipients(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/ProfileAudiencesChanges.spec.js b/test/model/ProfileAudiencesChanges.spec.js new file mode 100644 index 00000000..013cfab8 --- /dev/null +++ b/test/model/ProfileAudiencesChanges.spec.js @@ -0,0 +1,71 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.ProfileAudiencesChanges(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('ProfileAudiencesChanges', function() { + it('should create an instance of ProfileAudiencesChanges', function() { + // uncomment below and update the code to test ProfileAudiencesChanges + //var instane = new TalonOne.ProfileAudiencesChanges(); + //expect(instance).to.be.a(TalonOne.ProfileAudiencesChanges); + }); + + it('should have the property adds (base name: "adds")', function() { + // uncomment below and update the code to test the property adds + //var instane = new TalonOne.ProfileAudiencesChanges(); + //expect(instance).to.be(); + }); + + it('should have the property deletes (base name: "deletes")', function() { + // uncomment below and update the code to test the property deletes + //var instane = new TalonOne.ProfileAudiencesChanges(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/RejectCouponEffectProps.spec.js b/test/model/RejectCouponEffectProps.spec.js index 2e5d8e01..9a5af4b7 100644 --- a/test/model/RejectCouponEffectProps.spec.js +++ b/test/model/RejectCouponEffectProps.spec.js @@ -66,6 +66,24 @@ //expect(instance).to.be(); }); + it('should have the property conditionIndex (base name: "conditionIndex")', function() { + // uncomment below and update the code to test the property conditionIndex + //var instane = new TalonOne.RejectCouponEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property effectIndex (base name: "effectIndex")', function() { + // uncomment below and update the code to test the property effectIndex + //var instane = new TalonOne.RejectCouponEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property details (base name: "details")', function() { + // uncomment below and update the code to test the property details + //var instane = new TalonOne.RejectCouponEffectProps(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/RejectReferralEffectProps.spec.js b/test/model/RejectReferralEffectProps.spec.js index e91fc0ec..873c8de0 100644 --- a/test/model/RejectReferralEffectProps.spec.js +++ b/test/model/RejectReferralEffectProps.spec.js @@ -66,6 +66,24 @@ //expect(instance).to.be(); }); + it('should have the property conditionIndex (base name: "conditionIndex")', function() { + // uncomment below and update the code to test the property conditionIndex + //var instane = new TalonOne.RejectReferralEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property effectIndex (base name: "effectIndex")', function() { + // uncomment below and update the code to test the property effectIndex + //var instane = new TalonOne.RejectReferralEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property details (base name: "details")', function() { + // uncomment below and update the code to test the property details + //var instane = new TalonOne.RejectReferralEffectProps(); + //expect(instance).to.be(); + }); + }); })); diff --git a/test/model/RollbackAddedLoyaltyPointsEffectProps.spec.js b/test/model/RollbackAddedLoyaltyPointsEffectProps.spec.js new file mode 100644 index 00000000..5ad8ecd1 --- /dev/null +++ b/test/model/RollbackAddedLoyaltyPointsEffectProps.spec.js @@ -0,0 +1,89 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.RollbackAddedLoyaltyPointsEffectProps(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('RollbackAddedLoyaltyPointsEffectProps', function() { + it('should create an instance of RollbackAddedLoyaltyPointsEffectProps', function() { + // uncomment below and update the code to test RollbackAddedLoyaltyPointsEffectProps + //var instane = new TalonOne.RollbackAddedLoyaltyPointsEffectProps(); + //expect(instance).to.be.a(TalonOne.RollbackAddedLoyaltyPointsEffectProps); + }); + + it('should have the property programId (base name: "programId")', function() { + // uncomment below and update the code to test the property programId + //var instane = new TalonOne.RollbackAddedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property subLedgerId (base name: "subLedgerId")', function() { + // uncomment below and update the code to test the property subLedgerId + //var instane = new TalonOne.RollbackAddedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property value (base name: "value")', function() { + // uncomment below and update the code to test the property value + //var instane = new TalonOne.RollbackAddedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property recipientIntegrationId (base name: "recipientIntegrationId")', function() { + // uncomment below and update the code to test the property recipientIntegrationId + //var instane = new TalonOne.RollbackAddedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property transactionUUID (base name: "transactionUUID")', function() { + // uncomment below and update the code to test the property transactionUUID + //var instane = new TalonOne.RollbackAddedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/RollbackDeductedLoyaltyPointsEffectProps.spec.js b/test/model/RollbackDeductedLoyaltyPointsEffectProps.spec.js new file mode 100644 index 00000000..476bfd3f --- /dev/null +++ b/test/model/RollbackDeductedLoyaltyPointsEffectProps.spec.js @@ -0,0 +1,101 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('RollbackDeductedLoyaltyPointsEffectProps', function() { + it('should create an instance of RollbackDeductedLoyaltyPointsEffectProps', function() { + // uncomment below and update the code to test RollbackDeductedLoyaltyPointsEffectProps + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be.a(TalonOne.RollbackDeductedLoyaltyPointsEffectProps); + }); + + it('should have the property programId (base name: "programId")', function() { + // uncomment below and update the code to test the property programId + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property subLedgerId (base name: "subLedgerId")', function() { + // uncomment below and update the code to test the property subLedgerId + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property value (base name: "value")', function() { + // uncomment below and update the code to test the property value + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property recipientIntegrationId (base name: "recipientIntegrationId")', function() { + // uncomment below and update the code to test the property recipientIntegrationId + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property startDate (base name: "startDate")', function() { + // uncomment below and update the code to test the property startDate + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property expiryDate (base name: "expiryDate")', function() { + // uncomment below and update the code to test the property expiryDate + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + it('should have the property transactionUUID (base name: "transactionUUID")', function() { + // uncomment below and update the code to test the property transactionUUID + //var instane = new TalonOne.RollbackDeductedLoyaltyPointsEffectProps(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/RollbackReferralEffectProps.spec.js b/test/model/RollbackReferralEffectProps.spec.js new file mode 100644 index 00000000..952e81e7 --- /dev/null +++ b/test/model/RollbackReferralEffectProps.spec.js @@ -0,0 +1,65 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.RollbackReferralEffectProps(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('RollbackReferralEffectProps', function() { + it('should create an instance of RollbackReferralEffectProps', function() { + // uncomment below and update the code to test RollbackReferralEffectProps + //var instane = new TalonOne.RollbackReferralEffectProps(); + //expect(instance).to.be.a(TalonOne.RollbackReferralEffectProps); + }); + + it('should have the property value (base name: "value")', function() { + // uncomment below and update the code to test the property value + //var instane = new TalonOne.RollbackReferralEffectProps(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/RuleFailureReason.spec.js b/test/model/RuleFailureReason.spec.js new file mode 100644 index 00000000..e955f52d --- /dev/null +++ b/test/model/RuleFailureReason.spec.js @@ -0,0 +1,131 @@ +/** + * Talon.One API + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.TalonOne); + } +}(this, function(expect, TalonOne) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new TalonOne.RuleFailureReason(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('RuleFailureReason', function() { + it('should create an instance of RuleFailureReason', function() { + // uncomment below and update the code to test RuleFailureReason + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be.a(TalonOne.RuleFailureReason); + }); + + it('should have the property campaignID (base name: "campaignID")', function() { + // uncomment below and update the code to test the property campaignID + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property campaignName (base name: "campaignName")', function() { + // uncomment below and update the code to test the property campaignName + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property rulesetID (base name: "rulesetID")', function() { + // uncomment below and update the code to test the property rulesetID + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property couponID (base name: "couponID")', function() { + // uncomment below and update the code to test the property couponID + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property couponValue (base name: "couponValue")', function() { + // uncomment below and update the code to test the property couponValue + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property referralID (base name: "referralID")', function() { + // uncomment below and update the code to test the property referralID + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property referralValue (base name: "referralValue")', function() { + // uncomment below and update the code to test the property referralValue + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property ruleIndex (base name: "ruleIndex")', function() { + // uncomment below and update the code to test the property ruleIndex + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property ruleName (base name: "ruleName")', function() { + // uncomment below and update the code to test the property ruleName + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property conditionIndex (base name: "conditionIndex")', function() { + // uncomment below and update the code to test the property conditionIndex + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property effectIndex (base name: "effectIndex")', function() { + // uncomment below and update the code to test the property effectIndex + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + it('should have the property details (base name: "details")', function() { + // uncomment below and update the code to test the property details + //var instane = new TalonOne.RuleFailureReason(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/test/model/UpdateApplication.spec.js b/test/model/UpdateApplication.spec.js index c4297e18..25771819 100644 --- a/test/model/UpdateApplication.spec.js +++ b/test/model/UpdateApplication.spec.js @@ -108,6 +108,12 @@ //expect(instance).to.be(); }); + it('should have the property defaultDiscountScope (base name: "defaultDiscountScope")', function() { + // uncomment below and update the code to test the property defaultDiscountScope + //var instane = new TalonOne.UpdateApplication(); + //expect(instance).to.be(); + }); + it('should have the property enableCascadingDiscounts (base name: "enableCascadingDiscounts")', function() { // uncomment below and update the code to test the property enableCascadingDiscounts //var instane = new TalonOne.UpdateApplication();