talon_one 2.2.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +22 -12
- data/docs/AddLoyaltyPointsEffectProps.md +3 -1
- data/docs/Application.md +2 -0
- data/docs/ApplicationEvent.md +3 -1
- data/docs/Binding.md +2 -0
- data/docs/Campaign.md +11 -1
- data/docs/CartItem.md +1 -3
- data/docs/Change.md +2 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +3 -1
- data/docs/DeductLoyaltyPointsEffectProps.md +3 -1
- data/docs/Effect.md +2 -0
- data/docs/EffectEntity.md +3 -1
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20020.md +2 -2
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +2 -4
- data/docs/InlineResponse20028.md +4 -2
- data/docs/InlineResponse20029.md +1 -1
- data/docs/IntegrationApi.md +27 -27
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStateV2.md +2 -0
- data/docs/LoyaltyProgramBalance.md +10 -2
- data/docs/LoyaltyProgramLedgers.md +3 -1
- data/docs/LoyaltySubLedger.md +1 -1
- data/docs/ManagementApi.md +623 -169
- data/docs/NewApplication.md +2 -0
- data/docs/NewCoupons.md +5 -5
- data/docs/NewCouponsForMultipleRecipients.md +31 -0
- data/docs/ProfileAudiencesChanges.md +19 -0
- data/docs/RejectCouponEffectProps.md +7 -1
- data/docs/RejectReferralEffectProps.md +7 -1
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +25 -0
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +29 -0
- data/docs/RollbackReferralEffectProps.md +17 -0
- data/docs/RuleFailureReason.md +39 -0
- data/docs/UpdateApplication.md +2 -0
- data/lib/talon_one.rb +6 -3
- data/lib/talon_one/api/integration_api.rb +30 -30
- data/lib/talon_one/api/management_api.rb +816 -242
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +19 -4
- data/lib/talon_one/models/application.rb +23 -1
- data/lib/talon_one/models/application_api_key.rb +2 -2
- data/lib/talon_one/models/application_event.rb +16 -4
- data/lib/talon_one/models/binding.rb +11 -1
- data/lib/talon_one/models/campaign.rb +52 -2
- data/lib/talon_one/models/cart_item.rb +4 -13
- data/lib/talon_one/models/change.rb +11 -1
- data/lib/talon_one/models/code_generator_settings.rb +9 -0
- data/lib/talon_one/models/create_application_api_key.rb +2 -2
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +11 -2
- data/lib/talon_one/models/customer_session.rb +38 -0
- data/lib/talon_one/models/customer_session_v2.rb +15 -0
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +19 -4
- data/lib/talon_one/models/effect.rb +11 -1
- data/lib/talon_one/models/effect_entity.rb +14 -4
- data/lib/talon_one/models/import.rb +1 -35
- data/lib/talon_one/models/inline_response20020.rb +1 -6
- data/lib/talon_one/models/inline_response20021.rb +1 -1
- data/lib/talon_one/models/inline_response20022.rb +1 -1
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +1 -1
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -1
- data/lib/talon_one/models/inline_response20027.rb +7 -11
- data/lib/talon_one/models/inline_response20028.rb +11 -7
- data/lib/talon_one/models/inline_response20029.rb +1 -1
- data/lib/talon_one/models/integration_request.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +12 -1
- data/lib/talon_one/models/limit_config.rb +0 -12
- data/lib/talon_one/models/loyalty_points.rb +28 -0
- data/lib/talon_one/models/loyalty_program_balance.rb +65 -4
- data/lib/talon_one/models/loyalty_program_ledgers.rb +16 -1
- data/lib/talon_one/models/loyalty_sub_ledger.rb +1 -1
- data/lib/talon_one/models/new_application.rb +23 -1
- data/lib/talon_one/models/new_application_api_key.rb +2 -2
- data/lib/talon_one/models/new_coupons.rb +36 -41
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +368 -0
- data/lib/talon_one/models/new_customer_session.rb +30 -0
- data/lib/talon_one/models/new_customer_session_v2.rb +15 -0
- data/lib/talon_one/models/{new_import.rb → profile_audiences_changes.rb} +32 -48
- data/lib/talon_one/models/reject_coupon_effect_props.rb +34 -4
- data/lib/talon_one/models/reject_referral_effect_props.rb +34 -4
- data/lib/talon_one/models/{cart_item_adjustment.rb → rollback_added_loyalty_points_effect_props.rb} +63 -61
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +293 -0
- data/lib/talon_one/models/{import_coupons.rb → rollback_referral_effect_props.rb} +15 -13
- data/lib/talon_one/models/rule_failure_reason.rb +343 -0
- data/lib/talon_one/models/update_application.rb +23 -1
- data/lib/talon_one/version.rb +1 -1
- data/spec/api/integration_api_spec.rb +15 -15
- data/spec/api/management_api_spec.rb +183 -68
- data/spec/models/add_loyalty_points_effect_props_spec.rb +6 -0
- data/spec/models/application_api_key_spec.rb +1 -1
- data/spec/models/application_event_spec.rb +6 -0
- data/spec/models/application_spec.rb +10 -0
- data/spec/models/binding_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +30 -0
- data/spec/models/cart_item_spec.rb +0 -6
- data/spec/models/change_spec.rb +6 -0
- data/spec/models/create_application_api_key_spec.rb +1 -1
- data/spec/models/customer_profile_integration_request_v2_spec.rb +7 -1
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +6 -0
- data/spec/models/effect_entity_spec.rb +6 -0
- data/spec/models/effect_spec.rb +6 -0
- data/spec/models/import_spec.rb +0 -4
- data/spec/models/inline_response20027_spec.rb +0 -6
- data/spec/models/inline_response20028_spec.rb +6 -0
- data/spec/models/integration_request_spec.rb +1 -1
- data/spec/models/integration_state_v2_spec.rb +6 -0
- data/spec/models/limit_config_spec.rb +0 -4
- data/spec/models/loyalty_program_balance_spec.rb +24 -0
- data/spec/models/loyalty_program_ledgers_spec.rb +6 -0
- data/spec/models/new_application_api_key_spec.rb +1 -1
- data/spec/models/new_application_spec.rb +10 -0
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +83 -0
- data/spec/models/new_coupons_spec.rb +6 -6
- data/spec/models/{cart_item_adjustment_spec.rb → profile_audiences_changes_spec.rb} +8 -14
- data/spec/models/reject_coupon_effect_props_spec.rb +18 -0
- data/spec/models/reject_referral_effect_props_spec.rb +18 -0
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +65 -0
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +77 -0
- data/spec/models/{import_coupons_spec.rb → rollback_referral_effect_props_spec.rb} +7 -7
- data/spec/models/rule_failure_reason_spec.rb +107 -0
- data/spec/models/update_application_spec.rb +10 -0
- metadata +26 -14
- data/docs/CartItemAdjustment.md +0 -21
- data/docs/ImportCoupons.md +0 -17
- data/docs/NewImport.md +0 -17
- data/spec/models/new_import_spec.rb +0 -45
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 97eb90f854cb3af50499b64ab4ffa89b44de09dc29e7b6baddd9a91861d33a40
|
4
|
+
data.tar.gz: 8dcc4edc84f3ea8bc5ad121fb58ca77889f9eca102f6c813714cb81d3696b1df
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5ad825b7c179e6bd919f209c2dad074761e14dbd34f4f6269a364733b5a09e91c9a50c4aeb76b16e0154e6a503bebb5ec778681ec889e3d74f5a63971b1aaf92
|
7
|
+
data.tar.gz: b6569b8456ab120e9c0db3d59921161af43b40b98c526435fa0cf29ea9dd4b99935a2f8b8da1deea92edc598d200d711191a55e4b324e331dde84ebe6909b8df
|
data/README.md
CHANGED
@@ -17,7 +17,7 @@ The API is available at the same hostname as these docs. For example, if you are
|
|
17
17
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
18
18
|
|
19
19
|
- API version: 1.0.0
|
20
|
-
- Package version: 2.
|
20
|
+
- Package version: 2.3.0
|
21
21
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
22
22
|
|
23
23
|
## Installation
|
@@ -33,16 +33,16 @@ gem build talon_one.gemspec
|
|
33
33
|
Then either install the gem locally:
|
34
34
|
|
35
35
|
```shell
|
36
|
-
gem install ./talon_one-2.
|
36
|
+
gem install ./talon_one-2.3.0.gem
|
37
37
|
```
|
38
38
|
|
39
|
-
(for development, run `gem install --dev ./talon_one-2.
|
39
|
+
(for development, run `gem install --dev ./talon_one-2.3.0.gem` to install the development dependencies)
|
40
40
|
|
41
41
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
42
42
|
|
43
43
|
Finally add this to the Gemfile:
|
44
44
|
|
45
|
-
gem 'talon_one', '~> 2.
|
45
|
+
gem 'talon_one', '~> 2.3.0'
|
46
46
|
|
47
47
|
### Install from Git
|
48
48
|
|
@@ -242,8 +242,8 @@ Class | Method | HTTP request | Description
|
|
242
242
|
*TalonOne::IntegrationApi* | [**create_coupon_reservation**](docs/IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
|
243
243
|
*TalonOne::IntegrationApi* | [**create_referral**](docs/IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
|
244
244
|
*TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
245
|
-
*TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
|
246
|
-
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
|
245
|
+
*TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
|
246
|
+
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
|
247
247
|
*TalonOne::IntegrationApi* | [**get_reserved_customers**](docs/IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
|
248
248
|
*TalonOne::IntegrationApi* | [**track_event**](docs/IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
|
249
249
|
*TalonOne::IntegrationApi* | [**update_customer_profile**](docs/IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
|
@@ -258,6 +258,7 @@ Class | Method | HTTP request | Description
|
|
258
258
|
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
|
259
259
|
*TalonOne::ManagementApi* | [**create_campaign**](docs/ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
|
260
260
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
|
261
|
+
*TalonOne::ManagementApi* | [**create_coupons_for_multiple_recipients**](docs/ManagementApi.md#create_coupons_for_multiple_recipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create Coupons for Multiple Recipients
|
261
262
|
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
262
263
|
*TalonOne::ManagementApi* | [**create_ruleset**](docs/ManagementApi.md#create_ruleset) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | Create a Ruleset
|
263
264
|
*TalonOne::ManagementApi* | [**create_session**](docs/ManagementApi.md#create_session) | **POST** /v1/sessions | Create a Session
|
@@ -266,6 +267,12 @@ Class | Method | HTTP request | Description
|
|
266
267
|
*TalonOne::ManagementApi* | [**delete_coupons**](docs/ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete Coupons
|
267
268
|
*TalonOne::ManagementApi* | [**delete_referral**](docs/ManagementApi.md#delete_referral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete one Referral
|
268
269
|
*TalonOne::ManagementApi* | [**delete_ruleset**](docs/ManagementApi.md#delete_ruleset) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Delete a Ruleset
|
270
|
+
*TalonOne::ManagementApi* | [**destroy_session**](docs/ManagementApi.md#destroy_session) | **DELETE** /v1/sessions | Destroy a Session
|
271
|
+
*TalonOne::ManagementApi* | [**export_coupons**](docs/ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export Coupons to a CSV file
|
272
|
+
*TalonOne::ManagementApi* | [**export_customer_sessions**](docs/ManagementApi.md#export_customer_sessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export Customer Sessions to a CSV file
|
273
|
+
*TalonOne::ManagementApi* | [**export_effects**](docs/ManagementApi.md#export_effects) | **GET** /v1/applications/{applicationId}/export_effects | Export triggered Effects to a CSV file
|
274
|
+
*TalonOne::ManagementApi* | [**export_loyalty_balance**](docs/ManagementApi.md#export_loyalty_balance) | **GET** /v1/loyalty_programs/{programID}/export_customer_balance | Export customer loyalty balance to a CSV file
|
275
|
+
*TalonOne::ManagementApi* | [**export_loyalty_ledger**](docs/ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID}/export_log | Export a customer's loyalty ledger log to a CSV file
|
269
276
|
*TalonOne::ManagementApi* | [**get_access_logs**](docs/ManagementApi.md#get_access_logs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application (with total count)
|
270
277
|
*TalonOne::ManagementApi* | [**get_access_logs_without_total_count**](docs/ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
|
271
278
|
*TalonOne::ManagementApi* | [**get_account**](docs/ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
|
@@ -273,7 +280,7 @@ Class | Method | HTTP request | Description
|
|
273
280
|
*TalonOne::ManagementApi* | [**get_additional_cost**](docs/ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
|
274
281
|
*TalonOne::ManagementApi* | [**get_additional_costs**](docs/ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
275
282
|
*TalonOne::ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
|
276
|
-
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles
|
283
|
+
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles
|
277
284
|
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
278
285
|
*TalonOne::ManagementApi* | [**get_application_api_health**](docs/ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get report of health of application API
|
279
286
|
*TalonOne::ManagementApi* | [**get_application_customer**](docs/ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
|
@@ -287,6 +294,7 @@ Class | Method | HTTP request | Description
|
|
287
294
|
*TalonOne::ManagementApi* | [**get_applications**](docs/ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
|
288
295
|
*TalonOne::ManagementApi* | [**get_attribute**](docs/ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
|
289
296
|
*TalonOne::ManagementApi* | [**get_attributes**](docs/ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
|
297
|
+
*TalonOne::ManagementApi* | [**get_audiences**](docs/ManagementApi.md#get_audiences) | **GET** /v1/audiences | Get all audiences
|
290
298
|
*TalonOne::ManagementApi* | [**get_campaign**](docs/ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
|
291
299
|
*TalonOne::ManagementApi* | [**get_campaign_analytics**](docs/ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
|
292
300
|
*TalonOne::ManagementApi* | [**get_campaign_by_attributes**](docs/ManagementApi.md#get_campaign_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
|
@@ -305,14 +313,13 @@ Class | Method | HTTP request | Description
|
|
305
313
|
*TalonOne::ManagementApi* | [**get_customers_by_attributes**](docs/ManagementApi.md#get_customers_by_attributes) | **POST** /v1/customer_search/no_total | Get a list of the customer profiles that match the given attributes
|
306
314
|
*TalonOne::ManagementApi* | [**get_event_types**](docs/ManagementApi.md#get_event_types) | **GET** /v1/event_types | List Event Types
|
307
315
|
*TalonOne::ManagementApi* | [**get_exports**](docs/ManagementApi.md#get_exports) | **GET** /v1/exports | Get Exports
|
308
|
-
*TalonOne::ManagementApi* | [**get_imports**](docs/ManagementApi.md#get_imports) | **GET** /v1/imports | Get Imports
|
309
316
|
*TalonOne::ManagementApi* | [**get_loyalty_points**](docs/ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
|
310
317
|
*TalonOne::ManagementApi* | [**get_loyalty_program**](docs/ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
|
311
318
|
*TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List all loyalty Programs
|
312
319
|
*TalonOne::ManagementApi* | [**get_loyalty_statistics**](docs/ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
|
313
320
|
*TalonOne::ManagementApi* | [**get_referrals**](docs/ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
|
314
321
|
*TalonOne::ManagementApi* | [**get_referrals_without_total_count**](docs/ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
|
315
|
-
*TalonOne::ManagementApi* | [**get_role**](docs/ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role
|
322
|
+
*TalonOne::ManagementApi* | [**get_role**](docs/ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role
|
316
323
|
*TalonOne::ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
|
317
324
|
*TalonOne::ManagementApi* | [**get_rulesets**](docs/ManagementApi.md#get_rulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List Campaign Rulesets
|
318
325
|
*TalonOne::ManagementApi* | [**get_user**](docs/ManagementApi.md#get_user) | **GET** /v1/users/{userId} | Get a single User
|
@@ -378,7 +385,6 @@ Class | Method | HTTP request | Description
|
|
378
385
|
- [TalonOne::CampaignSetLeafNode](docs/CampaignSetLeafNode.md)
|
379
386
|
- [TalonOne::CampaignSetNode](docs/CampaignSetNode.md)
|
380
387
|
- [TalonOne::CartItem](docs/CartItem.md)
|
381
|
-
- [TalonOne::CartItemAdjustment](docs/CartItemAdjustment.md)
|
382
388
|
- [TalonOne::Change](docs/Change.md)
|
383
389
|
- [TalonOne::ChangeProfilePassword](docs/ChangeProfilePassword.md)
|
384
390
|
- [TalonOne::CodeGeneratorSettings](docs/CodeGeneratorSettings.md)
|
@@ -420,7 +426,6 @@ Class | Method | HTTP request | Description
|
|
420
426
|
- [TalonOne::FuncArgDef](docs/FuncArgDef.md)
|
421
427
|
- [TalonOne::FunctionDef](docs/FunctionDef.md)
|
422
428
|
- [TalonOne::Import](docs/Import.md)
|
423
|
-
- [TalonOne::ImportCoupons](docs/ImportCoupons.md)
|
424
429
|
- [TalonOne::InlineResponse200](docs/InlineResponse200.md)
|
425
430
|
- [TalonOne::InlineResponse2001](docs/InlineResponse2001.md)
|
426
431
|
- [TalonOne::InlineResponse20010](docs/InlineResponse20010.md)
|
@@ -490,13 +495,13 @@ Class | Method | HTTP request | Description
|
|
490
495
|
- [TalonOne::NewCampaignGroup](docs/NewCampaignGroup.md)
|
491
496
|
- [TalonOne::NewCampaignSet](docs/NewCampaignSet.md)
|
492
497
|
- [TalonOne::NewCoupons](docs/NewCoupons.md)
|
498
|
+
- [TalonOne::NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md)
|
493
499
|
- [TalonOne::NewCustomerProfile](docs/NewCustomerProfile.md)
|
494
500
|
- [TalonOne::NewCustomerSession](docs/NewCustomerSession.md)
|
495
501
|
- [TalonOne::NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
|
496
502
|
- [TalonOne::NewEvent](docs/NewEvent.md)
|
497
503
|
- [TalonOne::NewEventType](docs/NewEventType.md)
|
498
504
|
- [TalonOne::NewFeatureFlags](docs/NewFeatureFlags.md)
|
499
|
-
- [TalonOne::NewImport](docs/NewImport.md)
|
500
505
|
- [TalonOne::NewInvitation](docs/NewInvitation.md)
|
501
506
|
- [TalonOne::NewInviteEmail](docs/NewInviteEmail.md)
|
502
507
|
- [TalonOne::NewLoyaltyProgram](docs/NewLoyaltyProgram.md)
|
@@ -510,6 +515,7 @@ Class | Method | HTTP request | Description
|
|
510
515
|
- [TalonOne::NewUser](docs/NewUser.md)
|
511
516
|
- [TalonOne::NewWebhook](docs/NewWebhook.md)
|
512
517
|
- [TalonOne::Notification](docs/Notification.md)
|
518
|
+
- [TalonOne::ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
|
513
519
|
- [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
|
514
520
|
- [TalonOne::Referral](docs/Referral.md)
|
515
521
|
- [TalonOne::ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md)
|
@@ -519,9 +525,13 @@ Class | Method | HTTP request | Description
|
|
519
525
|
- [TalonOne::Role](docs/Role.md)
|
520
526
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
521
527
|
- [TalonOne::RoleMembership](docs/RoleMembership.md)
|
528
|
+
- [TalonOne::RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md)
|
522
529
|
- [TalonOne::RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
|
530
|
+
- [TalonOne::RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
|
523
531
|
- [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
|
532
|
+
- [TalonOne::RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
|
524
533
|
- [TalonOne::Rule](docs/Rule.md)
|
534
|
+
- [TalonOne::RuleFailureReason](docs/RuleFailureReason.md)
|
525
535
|
- [TalonOne::Ruleset](docs/Ruleset.md)
|
526
536
|
- [TalonOne::SamlConnection](docs/SamlConnection.md)
|
527
537
|
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**recipient_integration_id** | **String** | The user for whom these points were added |
|
12
12
|
**start_date** | **DateTime** | Date after which points will be valid | [optional]
|
13
13
|
**expiry_date** | **DateTime** | Date after which points will expire | [optional]
|
14
|
+
**transaction_uuid** | **String** | The identifier of this addition in the loyalty ledger |
|
14
15
|
|
15
16
|
## Code Sample
|
16
17
|
|
@@ -23,7 +24,8 @@ instance = TalonOne::AddLoyaltyPointsEffectProps.new(name: null,
|
|
23
24
|
value: null,
|
24
25
|
recipient_integration_id: null,
|
25
26
|
start_date: null,
|
26
|
-
expiry_date: null
|
27
|
+
expiry_date: null,
|
28
|
+
transaction_uuid: null)
|
27
29
|
```
|
28
30
|
|
29
31
|
|
data/docs/Application.md
CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
17
17
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
|
18
18
|
**campaign_priority** | **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]
|
19
19
|
**exclusive_campaigns_strategy** | **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]
|
20
|
+
**default_discount_scope** | **String** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional]
|
20
21
|
**enable_cascading_discounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional]
|
21
22
|
**enable_flattened_cart_items** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional]
|
22
23
|
**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
|
@@ -41,6 +42,7 @@ instance = TalonOne::Application.new(id: null,
|
|
41
42
|
limits: null,
|
42
43
|
campaign_priority: null,
|
43
44
|
exclusive_campaigns_strategy: null,
|
45
|
+
default_discount_scope: null,
|
44
46
|
enable_cascading_discounts: null,
|
45
47
|
enable_flattened_cart_items: null,
|
46
48
|
attributes_settings: null,
|
data/docs/ApplicationEvent.md
CHANGED
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**type** | **String** | A string representing the event. Must not be a reserved event name. |
|
13
13
|
**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. |
|
14
14
|
**effects** | **Array<Object>** | An array containing the effects that were applied as a result of this event. |
|
15
|
+
**rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional]
|
15
16
|
|
16
17
|
## Code Sample
|
17
18
|
|
@@ -25,7 +26,8 @@ instance = TalonOne::ApplicationEvent.new(id: null,
|
|
25
26
|
session_id: null,
|
26
27
|
type: null,
|
27
28
|
attributes: null,
|
28
|
-
effects: null
|
29
|
+
effects: null,
|
30
|
+
rule_failure_reasons: null)
|
29
31
|
```
|
30
32
|
|
31
33
|
|
data/docs/Binding.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**name** | **String** | A descriptive name for the value to be bound. |
|
8
|
+
**type** | **String** | The kind of binding. Possible values are cartItemFilter, subledgerBalance. | [optional]
|
8
9
|
**expression** | **Array<Object>** | A Talang expression that will be evaluated and its result attached to the name of the binding. |
|
9
10
|
|
10
11
|
## Code Sample
|
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'TalonOne'
|
14
15
|
|
15
16
|
instance = TalonOne::Binding.new(name: null,
|
17
|
+
type: null,
|
16
18
|
expression: null)
|
17
19
|
```
|
18
20
|
|
data/docs/Campaign.md
CHANGED
@@ -23,9 +23,14 @@ Name | Type | Description | Notes
|
|
23
23
|
**campaign_groups** | **Array<Integer>** | The IDs of the campaign groups that own this entity. | [optional]
|
24
24
|
**coupon_redemption_count** | **Integer** | Number of coupons redeemed in the campaign. | [optional]
|
25
25
|
**referral_redemption_count** | **Integer** | Number of referral codes redeemed in the campaign. | [optional]
|
26
|
-
**discount_count** | **
|
26
|
+
**discount_count** | **Float** | Total amount of discounts redeemed in the campaign. | [optional]
|
27
27
|
**discount_effect_count** | **Integer** | Total number of times discounts were redeemed in this campaign. | [optional]
|
28
28
|
**coupon_creation_count** | **Integer** | Total number of coupons created by rules in this campaign. | [optional]
|
29
|
+
**referral_creation_count** | **Integer** | Total number of referrals created by rules in this campaign. | [optional]
|
30
|
+
**created_loyalty_points_count** | **Float** | Total number of loyalty points created by rules in this campaign. | [optional]
|
31
|
+
**created_loyalty_points_effect_count** | **Integer** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional]
|
32
|
+
**redeemed_loyalty_points_count** | **Float** | Total number of loyalty points redeemed by rules in this campaign. | [optional]
|
33
|
+
**redeemed_loyalty_points_effect_count** | **Integer** | Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional]
|
29
34
|
**last_activity** | **DateTime** | Timestamp of the most recent event received by this campaign. | [optional]
|
30
35
|
**updated** | **DateTime** | Timestamp of the most recent update to the campaign or any of its elements. | [optional]
|
31
36
|
**created_by** | **String** | Name of the user who created this campaign if available. | [optional]
|
@@ -58,6 +63,11 @@ instance = TalonOne::Campaign.new(id: null,
|
|
58
63
|
discount_count: null,
|
59
64
|
discount_effect_count: null,
|
60
65
|
coupon_creation_count: null,
|
66
|
+
referral_creation_count: null,
|
67
|
+
created_loyalty_points_count: null,
|
68
|
+
created_loyalty_points_effect_count: null,
|
69
|
+
redeemed_loyalty_points_count: null,
|
70
|
+
redeemed_loyalty_points_effect_count: null,
|
61
71
|
last_activity: null,
|
62
72
|
updated: null,
|
63
73
|
created_by: null,
|
data/docs/CartItem.md
CHANGED
@@ -15,7 +15,6 @@ Name | Type | Description | Notes
|
|
15
15
|
**length** | **Float** | Length of item in mm | [optional]
|
16
16
|
**position** | **Float** | Position of the Cart Item in the Cart (calculated internally) | [optional]
|
17
17
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
18
|
-
**adjustment** | [**CartItemAdjustment**](CartItemAdjustment.md) | | [optional]
|
19
18
|
|
20
19
|
## Code Sample
|
21
20
|
|
@@ -32,8 +31,7 @@ instance = TalonOne::CartItem.new(name: null,
|
|
32
31
|
width: null,
|
33
32
|
length: null,
|
34
33
|
position: null,
|
35
|
-
attributes: null
|
36
|
-
adjustment: null)
|
34
|
+
attributes: null)
|
37
35
|
```
|
38
36
|
|
39
37
|
|
data/docs/Change.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**id** | **Integer** | Unique ID for this entity. |
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
9
9
|
**user_id** | **Integer** | The ID of the account that owns this entity. |
|
10
|
+
**application_id** | **Integer** | ID of application associated with change | [optional]
|
10
11
|
**entity** | **String** | API endpoint on which the change was initiated. |
|
11
12
|
**old** | [**Object**](.md) | Resource before the change occurred. | [optional]
|
12
13
|
**new** | [**Object**](.md) | Resource after the change occurred. | [optional]
|
@@ -19,6 +20,7 @@ require 'TalonOne'
|
|
19
20
|
instance = TalonOne::Change.new(id: null,
|
20
21
|
created: null,
|
21
22
|
user_id: null,
|
23
|
+
application_id: null,
|
22
24
|
entity: null,
|
23
25
|
old: null,
|
24
26
|
new: null)
|
@@ -5,7 +5,8 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
8
|
-
**
|
8
|
+
**audiences_changes** | [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional]
|
9
|
+
**response_content** | **Array<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]
|
9
10
|
|
10
11
|
## Code Sample
|
11
12
|
|
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'TalonOne'
|
14
15
|
|
15
16
|
instance = TalonOne::CustomerProfileIntegrationRequestV2.new(attributes: null,
|
17
|
+
audiences_changes: null,
|
16
18
|
response_content: null)
|
17
19
|
```
|
18
20
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**program_id** | **Integer** | The ID of the loyalty program where these points were added |
|
9
9
|
**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added |
|
10
10
|
**value** | **Float** | The amount of points that were deducted |
|
11
|
+
**transaction_uuid** | **String** | The identifier of this deduction in the loyalty ledger |
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
@@ -17,7 +18,8 @@ require 'TalonOne'
|
|
17
18
|
instance = TalonOne::DeductLoyaltyPointsEffectProps.new(rule_title: null,
|
18
19
|
program_id: null,
|
19
20
|
sub_ledger_id: null,
|
20
|
-
value: null
|
21
|
+
value: null,
|
22
|
+
transaction_uuid: null)
|
21
23
|
```
|
22
24
|
|
23
25
|
|
data/docs/Effect.md
CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset |
|
10
10
|
**rule_name** | **String** | The name of the rule that triggered this effect |
|
11
11
|
**effect_type** | **String** | The type of effect that was triggered |
|
12
|
+
**triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered | [optional]
|
12
13
|
**props** | [**Object**](.md) | |
|
13
14
|
|
14
15
|
## Code Sample
|
@@ -21,6 +22,7 @@ instance = TalonOne::Effect.new(campaign_id: null,
|
|
21
22
|
rule_index: null,
|
22
23
|
rule_name: null,
|
23
24
|
effect_type: null,
|
25
|
+
triggered_by_coupon: null,
|
24
26
|
props: null)
|
25
27
|
```
|
26
28
|
|
data/docs/EffectEntity.md
CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset |
|
10
10
|
**rule_name** | **String** | The name of the rule that triggered this effect |
|
11
11
|
**effect_type** | **String** | The type of effect that was triggered |
|
12
|
+
**triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered | [optional]
|
12
13
|
|
13
14
|
## Code Sample
|
14
15
|
|
@@ -19,7 +20,8 @@ instance = TalonOne::EffectEntity.new(campaign_id: null,
|
|
19
20
|
ruleset_id: null,
|
20
21
|
rule_index: null,
|
21
22
|
rule_name: null,
|
22
|
-
effect_type: null
|
23
|
+
effect_type: null,
|
24
|
+
triggered_by_coupon: null)
|
23
25
|
```
|
24
26
|
|
25
27
|
|
data/docs/Import.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**user_id** | **Integer** | The ID of the account that owns this entity. |
|
11
|
-
**entity** | **String** | The name of the entity that was imported. |
|
11
|
+
**entity** | **String** | The name of the entity that was imported. Possible values are Coupons and LoyaltyPoints. |
|
12
12
|
**amount** | **Integer** | The number of members that imported. |
|
13
13
|
|
14
14
|
## Code Sample
|
data/docs/InlineResponse20020.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**total_result_size** | **Integer** | |
|
8
|
-
**data** | [**Array<
|
7
|
+
**total_result_size** | **Integer** | | [optional]
|
8
|
+
**data** | [**Array<Audience>**](Audience.md) | |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InlineResponse20021.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**total_result_size** | **Integer** | |
|
8
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<Attribute>**](Attribute.md) | |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InlineResponse20022.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**total_result_size** | **Integer** | |
|
8
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<AccountAdditionalCost>**](AccountAdditionalCost.md) | |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InlineResponse20023.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**total_result_size** | **Integer** | |
|
8
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<Webhook>**](Webhook.md) | |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InlineResponse20024.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**total_result_size** | **Integer** | |
|
8
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InlineResponse20025.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**total_result_size** | **Integer** | |
|
8
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<WebhookLogEntry>**](WebhookLogEntry.md) | |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InlineResponse20026.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**total_result_size** | **Integer** | |
|
8
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<EventType>**](EventType.md) | |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
data/docs/InlineResponse20027.md
CHANGED
@@ -4,9 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**total_result_size** | **Integer** | |
|
8
|
-
**
|
9
|
-
**data** | [**Array<Change>**](Change.md) | |
|
7
|
+
**total_result_size** | **Integer** | |
|
8
|
+
**data** | [**Array<User>**](User.md) | |
|
10
9
|
|
11
10
|
## Code Sample
|
12
11
|
|
@@ -14,7 +13,6 @@ Name | Type | Description | Notes
|
|
14
13
|
require 'TalonOne'
|
15
14
|
|
16
15
|
instance = TalonOne::InlineResponse20027.new(total_result_size: null,
|
17
|
-
has_more: null,
|
18
16
|
data: null)
|
19
17
|
```
|
20
18
|
|