Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4.3.0: Multiple personal coupons creation endpoint, Loyalty and Referrals counters and Export Endpoints #22

Merged
merged 1 commit into from
Feb 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.2.3
4.3.1
3 changes: 2 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -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"

28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -331,14 +332,20 @@ 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
*TalonOne.ManagementApi* | [**getAccountAnalytics**](docs/ManagementApi.md#getAccountAnalytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
*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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down
1 change: 1 addition & 0 deletions docs/AddLoyaltyPointsEffectProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |


14 changes: 14 additions & 0 deletions docs/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -63,3 +64,16 @@ Name | Type | Description | Notes




## Enum: DefaultDiscountScopeEnum


* `sessionTotal` (value: `"sessionTotal"`)

* `cartItems` (value: `"cartItems"`)

* `additionalCosts` (value: `"additionalCosts"`)




2 changes: 2 additions & 0 deletions docs/ApplicationAPIKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Name | Type | Description | Notes

* `mparticle` (value: `"mparticle"`)

* `selligent` (value: `"selligent"`)




1 change: 1 addition & 0 deletions docs/ApplicationEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]


1 change: 1 addition & 0 deletions docs/Binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |


5 changes: 5 additions & 0 deletions docs/Campaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
1 change: 0 additions & 1 deletion docs/CartItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]


1 change: 1 addition & 0 deletions docs/Change.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 2 additions & 0 deletions docs/CreateApplicationAPIKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Name | Type | Description | Notes

* `mparticle` (value: `"mparticle"`)

* `selligent` (value: `"selligent"`)




Loading