talon_one 2.2.0 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (134) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +22 -12
  3. data/docs/AddLoyaltyPointsEffectProps.md +3 -1
  4. data/docs/Application.md +2 -0
  5. data/docs/ApplicationEvent.md +3 -1
  6. data/docs/Binding.md +2 -0
  7. data/docs/Campaign.md +11 -1
  8. data/docs/CartItem.md +1 -3
  9. data/docs/Change.md +2 -0
  10. data/docs/CustomerProfileIntegrationRequestV2.md +3 -1
  11. data/docs/DeductLoyaltyPointsEffectProps.md +3 -1
  12. data/docs/Effect.md +2 -0
  13. data/docs/EffectEntity.md +3 -1
  14. data/docs/Import.md +1 -1
  15. data/docs/InlineResponse20020.md +2 -2
  16. data/docs/InlineResponse20021.md +1 -1
  17. data/docs/InlineResponse20022.md +1 -1
  18. data/docs/InlineResponse20023.md +1 -1
  19. data/docs/InlineResponse20024.md +1 -1
  20. data/docs/InlineResponse20025.md +1 -1
  21. data/docs/InlineResponse20026.md +1 -1
  22. data/docs/InlineResponse20027.md +2 -4
  23. data/docs/InlineResponse20028.md +4 -2
  24. data/docs/InlineResponse20029.md +1 -1
  25. data/docs/IntegrationApi.md +27 -27
  26. data/docs/IntegrationRequest.md +1 -1
  27. data/docs/IntegrationStateV2.md +2 -0
  28. data/docs/LoyaltyProgramBalance.md +10 -2
  29. data/docs/LoyaltyProgramLedgers.md +3 -1
  30. data/docs/LoyaltySubLedger.md +1 -1
  31. data/docs/ManagementApi.md +623 -169
  32. data/docs/NewApplication.md +2 -0
  33. data/docs/NewCoupons.md +5 -5
  34. data/docs/NewCouponsForMultipleRecipients.md +31 -0
  35. data/docs/ProfileAudiencesChanges.md +19 -0
  36. data/docs/RejectCouponEffectProps.md +7 -1
  37. data/docs/RejectReferralEffectProps.md +7 -1
  38. data/docs/RollbackAddedLoyaltyPointsEffectProps.md +25 -0
  39. data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +29 -0
  40. data/docs/RollbackReferralEffectProps.md +17 -0
  41. data/docs/RuleFailureReason.md +39 -0
  42. data/docs/UpdateApplication.md +2 -0
  43. data/lib/talon_one.rb +6 -3
  44. data/lib/talon_one/api/integration_api.rb +30 -30
  45. data/lib/talon_one/api/management_api.rb +816 -242
  46. data/lib/talon_one/models/add_loyalty_points_effect_props.rb +19 -4
  47. data/lib/talon_one/models/application.rb +23 -1
  48. data/lib/talon_one/models/application_api_key.rb +2 -2
  49. data/lib/talon_one/models/application_event.rb +16 -4
  50. data/lib/talon_one/models/binding.rb +11 -1
  51. data/lib/talon_one/models/campaign.rb +52 -2
  52. data/lib/talon_one/models/cart_item.rb +4 -13
  53. data/lib/talon_one/models/change.rb +11 -1
  54. data/lib/talon_one/models/code_generator_settings.rb +9 -0
  55. data/lib/talon_one/models/create_application_api_key.rb +2 -2
  56. data/lib/talon_one/models/customer_profile_integration_request_v2.rb +11 -2
  57. data/lib/talon_one/models/customer_session.rb +38 -0
  58. data/lib/talon_one/models/customer_session_v2.rb +15 -0
  59. data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +19 -4
  60. data/lib/talon_one/models/effect.rb +11 -1
  61. data/lib/talon_one/models/effect_entity.rb +14 -4
  62. data/lib/talon_one/models/import.rb +1 -35
  63. data/lib/talon_one/models/inline_response20020.rb +1 -6
  64. data/lib/talon_one/models/inline_response20021.rb +1 -1
  65. data/lib/talon_one/models/inline_response20022.rb +1 -1
  66. data/lib/talon_one/models/inline_response20023.rb +1 -1
  67. data/lib/talon_one/models/inline_response20024.rb +1 -1
  68. data/lib/talon_one/models/inline_response20025.rb +1 -1
  69. data/lib/talon_one/models/inline_response20026.rb +1 -1
  70. data/lib/talon_one/models/inline_response20027.rb +7 -11
  71. data/lib/talon_one/models/inline_response20028.rb +11 -7
  72. data/lib/talon_one/models/inline_response20029.rb +1 -1
  73. data/lib/talon_one/models/integration_request.rb +1 -1
  74. data/lib/talon_one/models/integration_state_v2.rb +12 -1
  75. data/lib/talon_one/models/limit_config.rb +0 -12
  76. data/lib/talon_one/models/loyalty_points.rb +28 -0
  77. data/lib/talon_one/models/loyalty_program_balance.rb +65 -4
  78. data/lib/talon_one/models/loyalty_program_ledgers.rb +16 -1
  79. data/lib/talon_one/models/loyalty_sub_ledger.rb +1 -1
  80. data/lib/talon_one/models/new_application.rb +23 -1
  81. data/lib/talon_one/models/new_application_api_key.rb +2 -2
  82. data/lib/talon_one/models/new_coupons.rb +36 -41
  83. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +368 -0
  84. data/lib/talon_one/models/new_customer_session.rb +30 -0
  85. data/lib/talon_one/models/new_customer_session_v2.rb +15 -0
  86. data/lib/talon_one/models/{new_import.rb → profile_audiences_changes.rb} +32 -48
  87. data/lib/talon_one/models/reject_coupon_effect_props.rb +34 -4
  88. data/lib/talon_one/models/reject_referral_effect_props.rb +34 -4
  89. data/lib/talon_one/models/{cart_item_adjustment.rb → rollback_added_loyalty_points_effect_props.rb} +63 -61
  90. data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +293 -0
  91. data/lib/talon_one/models/{import_coupons.rb → rollback_referral_effect_props.rb} +15 -13
  92. data/lib/talon_one/models/rule_failure_reason.rb +343 -0
  93. data/lib/talon_one/models/update_application.rb +23 -1
  94. data/lib/talon_one/version.rb +1 -1
  95. data/spec/api/integration_api_spec.rb +15 -15
  96. data/spec/api/management_api_spec.rb +183 -68
  97. data/spec/models/add_loyalty_points_effect_props_spec.rb +6 -0
  98. data/spec/models/application_api_key_spec.rb +1 -1
  99. data/spec/models/application_event_spec.rb +6 -0
  100. data/spec/models/application_spec.rb +10 -0
  101. data/spec/models/binding_spec.rb +6 -0
  102. data/spec/models/campaign_spec.rb +30 -0
  103. data/spec/models/cart_item_spec.rb +0 -6
  104. data/spec/models/change_spec.rb +6 -0
  105. data/spec/models/create_application_api_key_spec.rb +1 -1
  106. data/spec/models/customer_profile_integration_request_v2_spec.rb +7 -1
  107. data/spec/models/deduct_loyalty_points_effect_props_spec.rb +6 -0
  108. data/spec/models/effect_entity_spec.rb +6 -0
  109. data/spec/models/effect_spec.rb +6 -0
  110. data/spec/models/import_spec.rb +0 -4
  111. data/spec/models/inline_response20027_spec.rb +0 -6
  112. data/spec/models/inline_response20028_spec.rb +6 -0
  113. data/spec/models/integration_request_spec.rb +1 -1
  114. data/spec/models/integration_state_v2_spec.rb +6 -0
  115. data/spec/models/limit_config_spec.rb +0 -4
  116. data/spec/models/loyalty_program_balance_spec.rb +24 -0
  117. data/spec/models/loyalty_program_ledgers_spec.rb +6 -0
  118. data/spec/models/new_application_api_key_spec.rb +1 -1
  119. data/spec/models/new_application_spec.rb +10 -0
  120. data/spec/models/new_coupons_for_multiple_recipients_spec.rb +83 -0
  121. data/spec/models/new_coupons_spec.rb +6 -6
  122. data/spec/models/{cart_item_adjustment_spec.rb → profile_audiences_changes_spec.rb} +8 -14
  123. data/spec/models/reject_coupon_effect_props_spec.rb +18 -0
  124. data/spec/models/reject_referral_effect_props_spec.rb +18 -0
  125. data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +65 -0
  126. data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +77 -0
  127. data/spec/models/{import_coupons_spec.rb → rollback_referral_effect_props_spec.rb} +7 -7
  128. data/spec/models/rule_failure_reason_spec.rb +107 -0
  129. data/spec/models/update_application_spec.rb +10 -0
  130. metadata +26 -14
  131. data/docs/CartItemAdjustment.md +0 -21
  132. data/docs/ImportCoupons.md +0 -17
  133. data/docs/NewImport.md +0 -17
  134. data/spec/models/new_import_spec.rb +0 -45
@@ -4,8 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total_result_size** | **Integer** | |
8
- **data** | [**Array<Export>**](Export.md) | |
7
+ **total_result_size** | **Integer** | | [optional]
8
+ **has_more** | **Boolean** | | [optional]
9
+ **data** | [**Array<Change>**](Change.md) | |
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::InlineResponse20028.new(total_result_size: null,
17
+ has_more: null,
16
18
  data: null)
17
19
  ```
18
20
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **total_result_size** | **Integer** | |
8
- **data** | [**Array<Import>**](Import.md) | |
8
+ **data** | [**Array<Export>**](Export.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -7,8 +7,8 @@ Method | HTTP request | Description
7
7
  [**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
8
8
  [**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
9
9
  [**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
10
- [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
11
- [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
10
+ [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
11
+ [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
12
12
  [**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
13
13
  [**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
14
14
  [**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
@@ -204,7 +204,7 @@ nil (empty response body)
204
204
 
205
205
  > delete_customer_data(integration_id)
206
206
 
207
- Delete the personal data of a customer.
207
+ Delete the personal data of a customer
208
208
 
209
209
  Delete all attributes on the customer profile and on entities that reference that customer profile.
210
210
 
@@ -230,7 +230,7 @@ api_instance = TalonOne::IntegrationApi.new
230
230
  integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
231
231
 
232
232
  begin
233
- #Delete the personal data of a customer.
233
+ #Delete the personal data of a customer
234
234
  api_instance.delete_customer_data(integration_id)
235
235
  rescue TalonOne::ApiError => e
236
236
  puts "Exception when calling IntegrationApi->delete_customer_data: #{e}"
@@ -262,7 +262,7 @@ nil (empty response body)
262
262
 
263
263
  > CustomerInventory get_customer_inventory(integration_id, opts)
264
264
 
265
- Get an inventory of all data associated with a specific customer profile.
265
+ Get an inventory of all data associated with a specific customer profile
266
266
 
267
267
  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.
268
268
 
@@ -294,7 +294,7 @@ opts = {
294
294
  }
295
295
 
296
296
  begin
297
- #Get an inventory of all data associated with a specific customer profile.
297
+ #Get an inventory of all data associated with a specific customer profile
298
298
  result = api_instance.get_customer_inventory(integration_id, opts)
299
299
  p result
300
300
  rescue TalonOne::ApiError => e
@@ -415,7 +415,7 @@ end
415
415
  api_instance = TalonOne::IntegrationApi.new
416
416
  body = TalonOne::NewEvent.new # NewEvent |
417
417
  opts = {
418
- dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
418
+ dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
419
419
  }
420
420
 
421
421
  begin
@@ -433,7 +433,7 @@ end
433
433
  Name | Type | Description | Notes
434
434
  ------------- | ------------- | ------------- | -------------
435
435
  **body** | [**NewEvent**](NewEvent.md)| |
436
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
436
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
437
437
 
438
438
  ### Return type
439
439
 
@@ -455,7 +455,7 @@ Name | Type | Description | Notes
455
455
 
456
456
  Update a Customer Profile V1
457
457
 
458
- ⚠️ 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
458
+ ⚠️ 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
459
459
 
460
460
  ### Example
461
461
 
@@ -479,7 +479,7 @@ api_instance = TalonOne::IntegrationApi.new
479
479
  integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
480
480
  body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
481
481
  opts = {
482
- dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
482
+ dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
483
483
  }
484
484
 
485
485
  begin
@@ -498,7 +498,7 @@ Name | Type | Description | Notes
498
498
  ------------- | ------------- | ------------- | -------------
499
499
  **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
500
500
  **body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
501
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
501
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
502
502
 
503
503
  ### Return type
504
504
 
@@ -573,7 +573,7 @@ nil (empty response body)
573
573
 
574
574
  Update a Customer Profile
575
575
 
576
- 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
576
+ 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.
577
577
 
578
578
  ### Example
579
579
 
@@ -589,11 +589,11 @@ TalonOne.configure do |config|
589
589
  end
590
590
 
591
591
  api_instance = TalonOne::IntegrationApi.new
592
- integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
592
+ integration_id = 'integration_id_example' # String | The custom identifier for this profile. Must be unique within the account.
593
593
  body = TalonOne::CustomerProfileIntegrationRequestV2.new # CustomerProfileIntegrationRequestV2 |
594
594
  opts = {
595
- run_rule_engine: true, # Boolean | Flag to indicate whether to run the rule engine (Defaults to false).
596
- 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').
595
+ run_rule_engine: false, # Boolean | Indicates whether to run the rule engine.
596
+ dry: true # Boolean | Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`.
597
597
  }
598
598
 
599
599
  begin
@@ -610,10 +610,10 @@ end
610
610
 
611
611
  Name | Type | Description | Notes
612
612
  ------------- | ------------- | ------------- | -------------
613
- **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
613
+ **integration_id** | **String**| The custom identifier for this profile. Must be unique within the account. |
614
614
  **body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md)| |
615
- **run_rule_engine** | **Boolean**| Flag to indicate whether to run the rule engine (Defaults to false). | [optional]
616
- **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]
615
+ **run_rule_engine** | **Boolean**| Indicates whether to run the rule engine. | [optional] [default to false]
616
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`. | [optional]
617
617
 
618
618
  ### Return type
619
619
 
@@ -635,7 +635,7 @@ Name | Type | Description | Notes
635
635
 
636
636
  Update multiple Customer Profiles
637
637
 
638
- 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
638
+ 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).
639
639
 
640
640
  ### Example
641
641
 
@@ -653,7 +653,7 @@ end
653
653
  api_instance = TalonOne::IntegrationApi.new
654
654
  body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest |
655
655
  opts = {
656
- silent: 'silent_example' # String | If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated.
656
+ 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).
657
657
  }
658
658
 
659
659
  begin
@@ -671,7 +671,7 @@ end
671
671
  Name | Type | Description | Notes
672
672
  ------------- | ------------- | ------------- | -------------
673
673
  **body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| |
674
- **silent** | **String**| If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated. | [optional]
674
+ **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]
675
675
 
676
676
  ### Return type
677
677
 
@@ -693,7 +693,7 @@ Name | Type | Description | Notes
693
693
 
694
694
  Update a Customer Session V1
695
695
 
696
- ⚠️ 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
696
+ ⚠️ 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.
697
697
 
698
698
  ### Example
699
699
 
@@ -717,7 +717,7 @@ api_instance = TalonOne::IntegrationApi.new
717
717
  customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
718
718
  body = TalonOne::NewCustomerSession.new # NewCustomerSession |
719
719
  opts = {
720
- dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
720
+ dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
721
721
  }
722
722
 
723
723
  begin
@@ -736,7 +736,7 @@ Name | Type | Description | Notes
736
736
  ------------- | ------------- | ------------- | -------------
737
737
  **customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
738
738
  **body** | [**NewCustomerSession**](NewCustomerSession.md)| |
739
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
739
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
740
740
 
741
741
  ### Return type
742
742
 
@@ -758,7 +758,7 @@ Name | Type | Description | Notes
758
758
 
759
759
  Update a Customer Session
760
760
 
761
- 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
761
+ 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.
762
762
 
763
763
  ### Example
764
764
 
@@ -777,7 +777,7 @@ api_instance = TalonOne::IntegrationApi.new
777
777
  customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
778
778
  body = TalonOne::IntegrationRequest.new # IntegrationRequest |
779
779
  opts = {
780
- dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
780
+ dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
781
781
  }
782
782
 
783
783
  begin
@@ -796,7 +796,7 @@ Name | Type | Description | Notes
796
796
  ------------- | ------------- | ------------- | -------------
797
797
  **customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
798
798
  **body** | [**IntegrationRequest**](IntegrationRequest.md)| |
799
- **dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
799
+ **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
800
800
 
801
801
  ### Return type
802
802
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **customer_session** | [**NewCustomerSessionV2**](NewCustomerSessionV2.md) | |
8
- **response_content** | **Array<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]
8
+ **response_content** | **Array<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]
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **coupons** | [**Array<Coupon>**](Coupon.md) | | [optional]
13
13
  **triggered_campaigns** | [**Array<Campaign>**](Campaign.md) | | [optional]
14
14
  **effects** | [**Array<Effect>**](Effect.md) | |
15
+ **rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | | [optional]
15
16
  **created_coupons** | [**Array<Coupon>**](Coupon.md) | |
16
17
  **created_referrals** | [**Array<Referral>**](Referral.md) | |
17
18
 
@@ -28,6 +29,7 @@ instance = TalonOne::IntegrationStateV2.new(customer_session: null,
28
29
  coupons: null,
29
30
  triggered_campaigns: null,
30
31
  effects: null,
32
+ rule_failure_reasons: null,
31
33
  created_coupons: null,
32
34
  created_referrals: null)
33
35
  ```
@@ -4,14 +4,22 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **current_balance** | **Float** | |
7
+ **current_balance** | **Float** | Sum of current active points amounts |
8
+ **pending_balance** | **Float** | Sum of pending points amounts |
9
+ **expired_balance** | **Float** | Sum of expired points amounts |
10
+ **spent_balance** | **Float** | Sum of spent points amounts |
11
+ **tentative_current_balance** | **Float** | Sum of current active points amounts, including additions and deductions on open sessions |
8
12
 
9
13
  ## Code Sample
10
14
 
11
15
  ```ruby
12
16
  require 'TalonOne'
13
17
 
14
- instance = TalonOne::LoyaltyProgramBalance.new(current_balance: null)
18
+ instance = TalonOne::LoyaltyProgramBalance.new(current_balance: null,
19
+ pending_balance: null,
20
+ expired_balance: null,
21
+ spent_balance: null,
22
+ tentative_current_balance: null)
15
23
  ```
16
24
 
17
25
 
@@ -4,6 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | The internal ID of loyalty program |
7
8
  **title** | **String** | Visible name of loyalty program |
8
9
  **name** | **String** | Internal name of loyalty program |
9
10
  **ledger** | [**LoyaltyProgramBalance**](LoyaltyProgramBalance.md) | |
@@ -14,7 +15,8 @@ Name | Type | Description | Notes
14
15
  ```ruby
15
16
  require 'TalonOne'
16
17
 
17
- instance = TalonOne::LoyaltyProgramLedgers.new(title: null,
18
+ instance = TalonOne::LoyaltyProgramLedgers.new(id: null,
19
+ title: null,
18
20
  name: null,
19
21
  ledger: null,
20
22
  sub_ledgers: null)
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total** | **Float** | ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance |
7
+ **total** | **Float** | ⚠️ Deprecated: Use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance |
8
8
  **total_active_points** | **Float** | Total amount of currently active and available points in the customer's balance |
9
9
  **total_pending_points** | **Float** | Total amount of pending points, which are not active yet but will become active in the future |
10
10
  **total_spent_points** | **Float** | Total amount of points already spent by this customer |
@@ -10,6 +10,7 @@ Method | HTTP request | Description
10
10
  [**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
11
11
  [**create_campaign**](ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
12
12
  [**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
13
+ [**create_coupons_for_multiple_recipients**](ManagementApi.md#create_coupons_for_multiple_recipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create Coupons for Multiple Recipients
13
14
  [**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
14
15
  [**create_ruleset**](ManagementApi.md#create_ruleset) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | Create a Ruleset
15
16
  [**create_session**](ManagementApi.md#create_session) | **POST** /v1/sessions | Create a Session
@@ -18,6 +19,12 @@ Method | HTTP request | Description
18
19
  [**delete_coupons**](ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete Coupons
19
20
  [**delete_referral**](ManagementApi.md#delete_referral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete one Referral
20
21
  [**delete_ruleset**](ManagementApi.md#delete_ruleset) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Delete a Ruleset
22
+ [**destroy_session**](ManagementApi.md#destroy_session) | **DELETE** /v1/sessions | Destroy a Session
23
+ [**export_coupons**](ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export Coupons to a CSV file
24
+ [**export_customer_sessions**](ManagementApi.md#export_customer_sessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export Customer Sessions to a CSV file
25
+ [**export_effects**](ManagementApi.md#export_effects) | **GET** /v1/applications/{applicationId}/export_effects | Export triggered Effects to a CSV file
26
+ [**export_loyalty_balance**](ManagementApi.md#export_loyalty_balance) | **GET** /v1/loyalty_programs/{programID}/export_customer_balance | Export customer loyalty balance to a CSV file
27
+ [**export_loyalty_ledger**](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
21
28
  [**get_access_logs**](ManagementApi.md#get_access_logs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application (with total count)
22
29
  [**get_access_logs_without_total_count**](ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
23
30
  [**get_account**](ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
@@ -25,7 +32,7 @@ Method | HTTP request | Description
25
32
  [**get_additional_cost**](ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
26
33
  [**get_additional_costs**](ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
27
34
  [**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
28
- [**get_all_roles**](ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
35
+ [**get_all_roles**](ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles
29
36
  [**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
30
37
  [**get_application_api_health**](ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get report of health of application API
31
38
  [**get_application_customer**](ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
@@ -39,6 +46,7 @@ Method | HTTP request | Description
39
46
  [**get_applications**](ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
40
47
  [**get_attribute**](ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
41
48
  [**get_attributes**](ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
49
+ [**get_audiences**](ManagementApi.md#get_audiences) | **GET** /v1/audiences | Get all audiences
42
50
  [**get_campaign**](ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
43
51
  [**get_campaign_analytics**](ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
44
52
  [**get_campaign_by_attributes**](ManagementApi.md#get_campaign_by_attributes) | **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
57
65
  [**get_customers_by_attributes**](ManagementApi.md#get_customers_by_attributes) | **POST** /v1/customer_search/no_total | Get a list of the customer profiles that match the given attributes
58
66
  [**get_event_types**](ManagementApi.md#get_event_types) | **GET** /v1/event_types | List Event Types
59
67
  [**get_exports**](ManagementApi.md#get_exports) | **GET** /v1/exports | Get Exports
60
- [**get_imports**](ManagementApi.md#get_imports) | **GET** /v1/imports | Get Imports
61
68
  [**get_loyalty_points**](ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
62
69
  [**get_loyalty_program**](ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
63
70
  [**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List all loyalty Programs
64
71
  [**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
65
72
  [**get_referrals**](ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
66
73
  [**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
67
- [**get_role**](ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role.
74
+ [**get_role**](ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role
68
75
  [**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
69
76
  [**get_rulesets**](ManagementApi.md#get_rulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List Campaign Rulesets
70
77
  [**get_user**](ManagementApi.md#get_user) | **GET** /v1/users/{userId} | Get a single User
@@ -425,6 +432,68 @@ Name | Type | Description | Notes
425
432
  - **Accept**: application/json
426
433
 
427
434
 
435
+ ## create_coupons_for_multiple_recipients
436
+
437
+ > InlineResponse2004 create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
438
+
439
+ Create Coupons for Multiple Recipients
440
+
441
+ Create coupons according to some pattern for up to 1000 recipients.
442
+
443
+ ### Example
444
+
445
+ ```ruby
446
+ # load the gem
447
+ require 'talon_one'
448
+ # setup authorization
449
+ TalonOne.configure do |config|
450
+ # Configure API key authorization: manager_auth
451
+ config.api_key['Authorization'] = 'YOUR API KEY'
452
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
453
+ #config.api_key_prefix['Authorization'] = 'Bearer'
454
+ end
455
+
456
+ api_instance = TalonOne::ManagementApi.new
457
+ application_id = 56 # Integer |
458
+ campaign_id = 56 # Integer |
459
+ body = TalonOne::NewCouponsForMultipleRecipients.new # NewCouponsForMultipleRecipients |
460
+ opts = {
461
+ silent: 'silent_example' # String | If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
462
+ }
463
+
464
+ begin
465
+ #Create Coupons for Multiple Recipients
466
+ result = api_instance.create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
467
+ p result
468
+ rescue TalonOne::ApiError => e
469
+ puts "Exception when calling ManagementApi->create_coupons_for_multiple_recipients: #{e}"
470
+ end
471
+ ```
472
+
473
+ ### Parameters
474
+
475
+
476
+ Name | Type | Description | Notes
477
+ ------------- | ------------- | ------------- | -------------
478
+ **application_id** | **Integer**| |
479
+ **campaign_id** | **Integer**| |
480
+ **body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md)| |
481
+ **silent** | **String**| If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000). | [optional]
482
+
483
+ ### Return type
484
+
485
+ [**InlineResponse2004**](InlineResponse2004.md)
486
+
487
+ ### Authorization
488
+
489
+ [manager_auth](../README.md#manager_auth)
490
+
491
+ ### HTTP request headers
492
+
493
+ - **Content-Type**: application/json
494
+ - **Accept**: application/json
495
+
496
+
428
497
  ## create_password_recovery_email
429
498
 
430
499
  > NewPasswordEmail create_password_recovery_email(body)
@@ -719,12 +788,12 @@ application_id = 56 # Integer |
719
788
  campaign_id = 56 # Integer |
720
789
  opts = {
721
790
  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.
722
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
723
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
724
- starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
725
- starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
726
- expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
727
- expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
791
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
792
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
793
+ starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
794
+ starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
795
+ expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
796
+ expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
728
797
  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.
729
798
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
730
799
  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`.
@@ -749,12 +818,12 @@ Name | Type | Description | Notes
749
818
  **application_id** | **Integer**| |
750
819
  **campaign_id** | **Integer**| |
751
820
  **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]
752
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
753
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
754
- **starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
755
- **starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
756
- **expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
757
- **expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
821
+ **created_before** | **DateTime**| 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]
822
+ **created_after** | **DateTime**| 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]
823
+ **starts_after** | **DateTime**| 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]
824
+ **starts_before** | **DateTime**| 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]
825
+ **expires_after** | **DateTime**| 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]
826
+ **expires_before** | **DateTime**| 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]
758
827
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
759
828
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
760
829
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
@@ -886,6 +955,383 @@ nil (empty response body)
886
955
  - **Accept**: Not defined
887
956
 
888
957
 
958
+ ## destroy_session
959
+
960
+ > destroy_session
961
+
962
+ Destroy a Session
963
+
964
+ ### Example
965
+
966
+ ```ruby
967
+ # load the gem
968
+ require 'talon_one'
969
+ # setup authorization
970
+ TalonOne.configure do |config|
971
+ # Configure API key authorization: manager_auth
972
+ config.api_key['Authorization'] = 'YOUR API KEY'
973
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
974
+ #config.api_key_prefix['Authorization'] = 'Bearer'
975
+ end
976
+
977
+ api_instance = TalonOne::ManagementApi.new
978
+
979
+ begin
980
+ #Destroy a Session
981
+ api_instance.destroy_session
982
+ rescue TalonOne::ApiError => e
983
+ puts "Exception when calling ManagementApi->destroy_session: #{e}"
984
+ end
985
+ ```
986
+
987
+ ### Parameters
988
+
989
+ This endpoint does not need any parameter.
990
+
991
+ ### Return type
992
+
993
+ nil (empty response body)
994
+
995
+ ### Authorization
996
+
997
+ [manager_auth](../README.md#manager_auth)
998
+
999
+ ### HTTP request headers
1000
+
1001
+ - **Content-Type**: Not defined
1002
+ - **Accept**: Not defined
1003
+
1004
+
1005
+ ## export_coupons
1006
+
1007
+ > String export_coupons(application_id, opts)
1008
+
1009
+ Export Coupons to a CSV file
1010
+
1011
+ Download a file with the coupons that match the given attributes.
1012
+
1013
+ ### Example
1014
+
1015
+ ```ruby
1016
+ # load the gem
1017
+ require 'talon_one'
1018
+ # setup authorization
1019
+ TalonOne.configure do |config|
1020
+ # Configure API key authorization: manager_auth
1021
+ config.api_key['Authorization'] = 'YOUR API KEY'
1022
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1023
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1024
+ end
1025
+
1026
+ api_instance = TalonOne::ManagementApi.new
1027
+ application_id = 56 # Integer |
1028
+ opts = {
1029
+ campaign_id: 3.4, # Float | Filter results by campaign.
1030
+ 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.
1031
+ 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.
1032
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
1033
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
1034
+ 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.
1035
+ 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`.
1036
+ referral_id: 56, # Integer | 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.
1037
+ recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
1038
+ batch_id: 'batch_id_example', # String | Filter results by batches of coupons
1039
+ exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
1040
+ date_format: 'date_format_example', # String | Determines the format of dates in the export document.
1041
+ campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
1042
+ }
1043
+
1044
+ begin
1045
+ #Export Coupons to a CSV file
1046
+ result = api_instance.export_coupons(application_id, opts)
1047
+ p result
1048
+ rescue TalonOne::ApiError => e
1049
+ puts "Exception when calling ManagementApi->export_coupons: #{e}"
1050
+ end
1051
+ ```
1052
+
1053
+ ### Parameters
1054
+
1055
+
1056
+ Name | Type | Description | Notes
1057
+ ------------- | ------------- | ------------- | -------------
1058
+ **application_id** | **Integer**| |
1059
+ **campaign_id** | **Float**| Filter results by campaign. | [optional]
1060
+ **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
1061
+ **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]
1062
+ **created_before** | **DateTime**| 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]
1063
+ **created_after** | **DateTime**| 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]
1064
+ **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
1065
+ **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
1066
+ **referral_id** | **Integer**| 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]
1067
+ **recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field | [optional]
1068
+ **batch_id** | **String**| Filter results by batches of coupons | [optional]
1069
+ **exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
1070
+ **date_format** | **String**| Determines the format of dates in the export document. | [optional]
1071
+ **campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
1072
+
1073
+ ### Return type
1074
+
1075
+ **String**
1076
+
1077
+ ### Authorization
1078
+
1079
+ [manager_auth](../README.md#manager_auth)
1080
+
1081
+ ### HTTP request headers
1082
+
1083
+ - **Content-Type**: Not defined
1084
+ - **Accept**: application/csv
1085
+
1086
+
1087
+ ## export_customer_sessions
1088
+
1089
+ > String export_customer_sessions(application_id, opts)
1090
+
1091
+ Export Customer Sessions to a CSV file
1092
+
1093
+ Download a file with the customer sessions that match the request.
1094
+
1095
+ ### Example
1096
+
1097
+ ```ruby
1098
+ # load the gem
1099
+ require 'talon_one'
1100
+ # setup authorization
1101
+ TalonOne.configure do |config|
1102
+ # Configure API key authorization: manager_auth
1103
+ config.api_key['Authorization'] = 'YOUR API KEY'
1104
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1105
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1106
+ end
1107
+
1108
+ api_instance = TalonOne::ManagementApi.new
1109
+ application_id = 56 # Integer |
1110
+ opts = {
1111
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
1112
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
1113
+ profile_integration_id: 'profile_integration_id_example', # String | Only return sessions for the customer that matches this customer integration ID.
1114
+ date_format: 'date_format_example', # String | Determines the format of dates in the export document.
1115
+ customer_session_state: 'customer_session_state_example' # String | Filter results by state.
1116
+ }
1117
+
1118
+ begin
1119
+ #Export Customer Sessions to a CSV file
1120
+ result = api_instance.export_customer_sessions(application_id, opts)
1121
+ p result
1122
+ rescue TalonOne::ApiError => e
1123
+ puts "Exception when calling ManagementApi->export_customer_sessions: #{e}"
1124
+ end
1125
+ ```
1126
+
1127
+ ### Parameters
1128
+
1129
+
1130
+ Name | Type | Description | Notes
1131
+ ------------- | ------------- | ------------- | -------------
1132
+ **application_id** | **Integer**| |
1133
+ **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
1134
+ **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. | [optional]
1135
+ **profile_integration_id** | **String**| Only return sessions for the customer that matches this customer integration ID. | [optional]
1136
+ **date_format** | **String**| Determines the format of dates in the export document. | [optional]
1137
+ **customer_session_state** | **String**| Filter results by state. | [optional]
1138
+
1139
+ ### Return type
1140
+
1141
+ **String**
1142
+
1143
+ ### Authorization
1144
+
1145
+ [manager_auth](../README.md#manager_auth)
1146
+
1147
+ ### HTTP request headers
1148
+
1149
+ - **Content-Type**: Not defined
1150
+ - **Accept**: application/csv
1151
+
1152
+
1153
+ ## export_effects
1154
+
1155
+ > String export_effects(application_id, opts)
1156
+
1157
+ Export triggered Effects to a CSV file
1158
+
1159
+ Download a file with the triggered effects that match the given attributes.
1160
+
1161
+ ### Example
1162
+
1163
+ ```ruby
1164
+ # load the gem
1165
+ require 'talon_one'
1166
+ # setup authorization
1167
+ TalonOne.configure do |config|
1168
+ # Configure API key authorization: manager_auth
1169
+ config.api_key['Authorization'] = 'YOUR API KEY'
1170
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1171
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1172
+ end
1173
+
1174
+ api_instance = TalonOne::ManagementApi.new
1175
+ application_id = 56 # Integer |
1176
+ opts = {
1177
+ campaign_id: 3.4, # Float | Filter results by campaign.
1178
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
1179
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
1180
+ date_format: 'date_format_example' # String | Determines the format of dates in the export document.
1181
+ }
1182
+
1183
+ begin
1184
+ #Export triggered Effects to a CSV file
1185
+ result = api_instance.export_effects(application_id, opts)
1186
+ p result
1187
+ rescue TalonOne::ApiError => e
1188
+ puts "Exception when calling ManagementApi->export_effects: #{e}"
1189
+ end
1190
+ ```
1191
+
1192
+ ### Parameters
1193
+
1194
+
1195
+ Name | Type | Description | Notes
1196
+ ------------- | ------------- | ------------- | -------------
1197
+ **application_id** | **Integer**| |
1198
+ **campaign_id** | **Float**| Filter results by campaign. | [optional]
1199
+ **created_before** | **DateTime**| 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]
1200
+ **created_after** | **DateTime**| 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]
1201
+ **date_format** | **String**| Determines the format of dates in the export document. | [optional]
1202
+
1203
+ ### Return type
1204
+
1205
+ **String**
1206
+
1207
+ ### Authorization
1208
+
1209
+ [manager_auth](../README.md#manager_auth)
1210
+
1211
+ ### HTTP request headers
1212
+
1213
+ - **Content-Type**: Not defined
1214
+ - **Accept**: application/csv
1215
+
1216
+
1217
+ ## export_loyalty_balance
1218
+
1219
+ > String export_loyalty_balance(program_id)
1220
+
1221
+ Export customer loyalty balance to a CSV file
1222
+
1223
+ Download a file with the balance of each customer in the loyalty program
1224
+
1225
+ ### Example
1226
+
1227
+ ```ruby
1228
+ # load the gem
1229
+ require 'talon_one'
1230
+ # setup authorization
1231
+ TalonOne.configure do |config|
1232
+ # Configure API key authorization: manager_auth
1233
+ config.api_key['Authorization'] = 'YOUR API KEY'
1234
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1235
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1236
+ end
1237
+
1238
+ api_instance = TalonOne::ManagementApi.new
1239
+ program_id = 'program_id_example' # String |
1240
+
1241
+ begin
1242
+ #Export customer loyalty balance to a CSV file
1243
+ result = api_instance.export_loyalty_balance(program_id)
1244
+ p result
1245
+ rescue TalonOne::ApiError => e
1246
+ puts "Exception when calling ManagementApi->export_loyalty_balance: #{e}"
1247
+ end
1248
+ ```
1249
+
1250
+ ### Parameters
1251
+
1252
+
1253
+ Name | Type | Description | Notes
1254
+ ------------- | ------------- | ------------- | -------------
1255
+ **program_id** | **String**| |
1256
+
1257
+ ### Return type
1258
+
1259
+ **String**
1260
+
1261
+ ### Authorization
1262
+
1263
+ [manager_auth](../README.md#manager_auth)
1264
+
1265
+ ### HTTP request headers
1266
+
1267
+ - **Content-Type**: Not defined
1268
+ - **Accept**: application/csv
1269
+
1270
+
1271
+ ## export_loyalty_ledger
1272
+
1273
+ > String export_loyalty_ledger(range_start, range_end, program_id, integration_id, opts)
1274
+
1275
+ Export a customer's loyalty ledger log to a CSV file
1276
+
1277
+ Download a file with a customer's ledger log in the loyalty program
1278
+
1279
+ ### Example
1280
+
1281
+ ```ruby
1282
+ # load the gem
1283
+ require 'talon_one'
1284
+ # setup authorization
1285
+ TalonOne.configure do |config|
1286
+ # Configure API key authorization: manager_auth
1287
+ config.api_key['Authorization'] = 'YOUR API KEY'
1288
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1289
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1290
+ end
1291
+
1292
+ api_instance = TalonOne::ManagementApi.new
1293
+ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
1294
+ range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
1295
+ program_id = 'program_id_example' # String |
1296
+ integration_id = 'integration_id_example' # String |
1297
+ opts = {
1298
+ date_format: 'date_format_example' # String | Determines the format of dates in the export document.
1299
+ }
1300
+
1301
+ begin
1302
+ #Export a customer's loyalty ledger log to a CSV file
1303
+ result = api_instance.export_loyalty_ledger(range_start, range_end, program_id, integration_id, opts)
1304
+ p result
1305
+ rescue TalonOne::ApiError => e
1306
+ puts "Exception when calling ManagementApi->export_loyalty_ledger: #{e}"
1307
+ end
1308
+ ```
1309
+
1310
+ ### Parameters
1311
+
1312
+
1313
+ Name | Type | Description | Notes
1314
+ ------------- | ------------- | ------------- | -------------
1315
+ **range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
1316
+ **range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
1317
+ **program_id** | **String**| |
1318
+ **integration_id** | **String**| |
1319
+ **date_format** | **String**| Determines the format of dates in the export document. | [optional]
1320
+
1321
+ ### Return type
1322
+
1323
+ **String**
1324
+
1325
+ ### Authorization
1326
+
1327
+ [manager_auth](../README.md#manager_auth)
1328
+
1329
+ ### HTTP request headers
1330
+
1331
+ - **Content-Type**: Not defined
1332
+ - **Accept**: application/csv
1333
+
1334
+
889
1335
  ## get_access_logs
890
1336
 
891
1337
  > InlineResponse2009 get_access_logs(application_id, range_start, range_end, opts)
@@ -1190,7 +1636,7 @@ Name | Type | Description | Notes
1190
1636
 
1191
1637
  ## get_additional_costs
1192
1638
 
1193
- > InlineResponse20021 get_additional_costs(opts)
1639
+ > InlineResponse20022 get_additional_costs(opts)
1194
1640
 
1195
1641
  List additional costs
1196
1642
 
@@ -1236,7 +1682,7 @@ Name | Type | Description | Notes
1236
1682
 
1237
1683
  ### Return type
1238
1684
 
1239
- [**InlineResponse20021**](InlineResponse20021.md)
1685
+ [**InlineResponse20022**](InlineResponse20022.md)
1240
1686
 
1241
1687
  ### Authorization
1242
1688
 
@@ -1322,7 +1768,7 @@ Name | Type | Description | Notes
1322
1768
 
1323
1769
  > InlineResponse20030 get_all_roles
1324
1770
 
1325
- Get all roles.
1771
+ Get all roles
1326
1772
 
1327
1773
  ### Example
1328
1774
 
@@ -1340,7 +1786,7 @@ end
1340
1786
  api_instance = TalonOne::ManagementApi.new
1341
1787
 
1342
1788
  begin
1343
- #Get all roles.
1789
+ #Get all roles
1344
1790
  result = api_instance.get_all_roles
1345
1791
  p result
1346
1792
  rescue TalonOne::ApiError => e
@@ -1732,8 +2178,8 @@ opts = {
1732
2178
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
1733
2179
  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.
1734
2180
  type: 'type_example', # String | Comma-separated list of types by which to filter events. Must be exact match(es).
1735
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date
1736
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date
2181
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2182
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
1737
2183
  session: 'session_example', # String | Session integration ID filter for events. Must be exact match.
1738
2184
  profile: 'profile_example', # String | Profile integration ID filter for events. Must be exact match.
1739
2185
  customer_name: 'customer_name_example', # String | Customer name filter for events. Will match substrings case-insensitively.
@@ -1763,8 +2209,8 @@ Name | Type | Description | Notes
1763
2209
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
1764
2210
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
1765
2211
  **type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
1766
- **created_before** | **DateTime**| Only return events created before this date | [optional]
1767
- **created_after** | **DateTime**| Only return events created after this date | [optional]
2212
+ **created_before** | **DateTime**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
2213
+ **created_after** | **DateTime**| Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
1768
2214
  **session** | **String**| Session integration ID filter for events. Must be exact match. | [optional]
1769
2215
  **profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
1770
2216
  **customer_name** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
@@ -1816,8 +2262,8 @@ opts = {
1816
2262
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
1817
2263
  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.
1818
2264
  type: 'type_example', # String | Comma-separated list of types by which to filter events. Must be exact match(es).
1819
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date
1820
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date
2265
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2266
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
1821
2267
  session: 'session_example', # String | Session integration ID filter for events. Must be exact match.
1822
2268
  profile: 'profile_example', # String | Profile integration ID filter for events. Must be exact match.
1823
2269
  customer_name: 'customer_name_example', # String | Customer name filter for events. Will match substrings case-insensitively.
@@ -1847,8 +2293,8 @@ Name | Type | Description | Notes
1847
2293
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
1848
2294
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
1849
2295
  **type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
1850
- **created_before** | **DateTime**| Only return events created before this date | [optional]
1851
- **created_after** | **DateTime**| Only return events created after this date | [optional]
2296
+ **created_before** | **DateTime**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
2297
+ **created_after** | **DateTime**| Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
1852
2298
  **session** | **String**| Session integration ID filter for events. Must be exact match. | [optional]
1853
2299
  **profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
1854
2300
  **customer_name** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
@@ -1953,8 +2399,8 @@ opts = {
1953
2399
  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.
1954
2400
  profile: 'profile_example', # String | Profile integration ID filter for sessions. Must be exact match.
1955
2401
  state: 'state_example', # String | Filter by sessions with this state. Must be exact match.
1956
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date
1957
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date
2402
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2403
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
1958
2404
  coupon: 'coupon_example', # String | Filter by sessions with this coupon. Must be exact match.
1959
2405
  referral: 'referral_example', # String | Filter by sessions with this referral. Must be exact match.
1960
2406
  integration_id: 'integration_id_example' # String | Filter by sessions with this integrationId. Must be exact match.
@@ -1980,8 +2426,8 @@ Name | Type | Description | Notes
1980
2426
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
1981
2427
  **profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
1982
2428
  **state** | **String**| Filter by sessions with this state. Must be exact match. | [optional]
1983
- **created_before** | **DateTime**| Only return events created before this date | [optional]
1984
- **created_after** | **DateTime**| Only return events created after this date | [optional]
2429
+ **created_before** | **DateTime**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
2430
+ **created_after** | **DateTime**| Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
1985
2431
  **coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional]
1986
2432
  **referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional]
1987
2433
  **integration_id** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional]
@@ -2116,7 +2562,7 @@ Name | Type | Description | Notes
2116
2562
 
2117
2563
  ## get_attributes
2118
2564
 
2119
- > InlineResponse20020 get_attributes(opts)
2565
+ > InlineResponse20021 get_attributes(opts)
2120
2566
 
2121
2567
  List custom attributes
2122
2568
 
@@ -2162,6 +2608,68 @@ Name | Type | Description | Notes
2162
2608
 
2163
2609
  ### Return type
2164
2610
 
2611
+ [**InlineResponse20021**](InlineResponse20021.md)
2612
+
2613
+ ### Authorization
2614
+
2615
+ [manager_auth](../README.md#manager_auth)
2616
+
2617
+ ### HTTP request headers
2618
+
2619
+ - **Content-Type**: Not defined
2620
+ - **Accept**: application/json
2621
+
2622
+
2623
+ ## get_audiences
2624
+
2625
+ > InlineResponse20020 get_audiences(opts)
2626
+
2627
+ Get all audiences
2628
+
2629
+ Get All audiences created in the account.
2630
+
2631
+ ### Example
2632
+
2633
+ ```ruby
2634
+ # load the gem
2635
+ require 'talon_one'
2636
+ # setup authorization
2637
+ TalonOne.configure do |config|
2638
+ # Configure API key authorization: manager_auth
2639
+ config.api_key['Authorization'] = 'YOUR API KEY'
2640
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2641
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2642
+ end
2643
+
2644
+ api_instance = TalonOne::ManagementApi.new
2645
+ opts = {
2646
+ page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
2647
+ skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2648
+ 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.
2649
+ with_total_result_size: 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.
2650
+ }
2651
+
2652
+ begin
2653
+ #Get all audiences
2654
+ result = api_instance.get_audiences(opts)
2655
+ p result
2656
+ rescue TalonOne::ApiError => e
2657
+ puts "Exception when calling ManagementApi->get_audiences: #{e}"
2658
+ end
2659
+ ```
2660
+
2661
+ ### Parameters
2662
+
2663
+
2664
+ Name | Type | Description | Notes
2665
+ ------------- | ------------- | ------------- | -------------
2666
+ **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
2667
+ **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2668
+ **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
2669
+ **with_total_result_size** | **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]
2670
+
2671
+ ### Return type
2672
+
2165
2673
  [**InlineResponse20020**](InlineResponse20020.md)
2166
2674
 
2167
2675
  ### Authorization
@@ -2384,8 +2892,8 @@ opts = {
2384
2892
  campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign.
2385
2893
  name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
2386
2894
  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
2387
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
2388
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
2895
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2896
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2389
2897
  campaign_group_id: 56 # Integer | Filter results to campaigns owned by the specified campaign group ID.
2390
2898
  }
2391
2899
 
@@ -2410,8 +2918,8 @@ Name | Type | Description | Notes
2410
2918
  **campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
2411
2919
  **name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
2412
2920
  **tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values | [optional]
2413
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional]
2414
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional]
2921
+ **created_before** | **DateTime**| 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]
2922
+ **created_after** | **DateTime**| 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]
2415
2923
  **campaign_group_id** | **Integer**| Filter results to campaigns owned by the specified campaign group ID. | [optional]
2416
2924
 
2417
2925
  ### Return type
@@ -2430,7 +2938,7 @@ Name | Type | Description | Notes
2430
2938
 
2431
2939
  ## get_changes
2432
2940
 
2433
- > InlineResponse20027 get_changes(opts)
2941
+ > InlineResponse20028 get_changes(opts)
2434
2942
 
2435
2943
  Get audit log for an account
2436
2944
 
@@ -2455,8 +2963,10 @@ opts = {
2455
2963
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2456
2964
  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.
2457
2965
  application_id: 56, # Integer |
2458
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
2459
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
2966
+ entity_path: 'entity_path_example', # String | Filter results on a case insensitive matching of the url path of the entity
2967
+ user_id: 56, # Integer |
2968
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2969
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2460
2970
  with_total_result_size: 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.
2461
2971
  include_old: true # Boolean | When this flag is set to false, the state without the change will not be returned. The default value is true.
2462
2972
  }
@@ -2479,14 +2989,16 @@ Name | Type | Description | Notes
2479
2989
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2480
2990
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
2481
2991
  **application_id** | **Integer**| | [optional]
2482
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
2483
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
2992
+ **entity_path** | **String**| Filter results on a case insensitive matching of the url path of the entity | [optional]
2993
+ **user_id** | **Integer**| | [optional]
2994
+ **created_before** | **DateTime**| 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]
2995
+ **created_after** | **DateTime**| 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]
2484
2996
  **with_total_result_size** | **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]
2485
2997
  **include_old** | **Boolean**| When this flag is set to false, the state without the change will not be returned. The default value is true. | [optional]
2486
2998
 
2487
2999
  ### Return type
2488
3000
 
2489
- [**InlineResponse20027**](InlineResponse20027.md)
3001
+ [**InlineResponse20028**](InlineResponse20028.md)
2490
3002
 
2491
3003
  ### Authorization
2492
3004
 
@@ -2525,12 +3037,12 @@ opts = {
2525
3037
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2526
3038
  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.
2527
3039
  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.
2528
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2529
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2530
- starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2531
- starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2532
- expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2533
- expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3040
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3041
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3042
+ starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3043
+ starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3044
+ expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3045
+ expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2534
3046
  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.
2535
3047
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
2536
3048
  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`.
@@ -2559,12 +3071,12 @@ Name | Type | Description | Notes
2559
3071
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2560
3072
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
2561
3073
  **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]
2562
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2563
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2564
- **starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2565
- **starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2566
- **expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2567
- **expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
3074
+ **created_before** | **DateTime**| 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]
3075
+ **created_after** | **DateTime**| 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]
3076
+ **starts_after** | **DateTime**| 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]
3077
+ **starts_before** | **DateTime**| 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]
3078
+ **expires_after** | **DateTime**| 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]
3079
+ **expires_before** | **DateTime**| 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]
2568
3080
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
2569
3081
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
2570
3082
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
@@ -2616,8 +3128,8 @@ opts = {
2616
3128
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2617
3129
  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.
2618
3130
  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.
2619
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2620
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3131
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3132
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2621
3133
  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.
2622
3134
  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`.
2623
3135
  referral_id: 56, # Integer | 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.
@@ -2647,8 +3159,8 @@ Name | Type | Description | Notes
2647
3159
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2648
3160
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
2649
3161
  **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]
2650
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2651
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
3162
+ **created_before** | **DateTime**| 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]
3163
+ **created_after** | **DateTime**| 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]
2652
3164
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
2653
3165
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
2654
3166
  **referral_id** | **Integer**| 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]
@@ -2699,8 +3211,8 @@ opts = {
2699
3211
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2700
3212
  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.
2701
3213
  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.
2702
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2703
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3214
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3215
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2704
3216
  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.
2705
3217
  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`.
2706
3218
  referral_id: 56, # Integer | 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.
@@ -2730,8 +3242,8 @@ Name | Type | Description | Notes
2730
3242
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2731
3243
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
2732
3244
  **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]
2733
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2734
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
3245
+ **created_before** | **DateTime**| 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]
3246
+ **created_after** | **DateTime**| 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]
2735
3247
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
2736
3248
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
2737
3249
  **referral_id** | **Integer**| 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]
@@ -2781,8 +3293,8 @@ opts = {
2781
3293
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2782
3294
  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.
2783
3295
  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.
2784
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
2785
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3296
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3297
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
2786
3298
  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.
2787
3299
  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`.
2788
3300
  referral_id: 56, # Integer | 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.
@@ -2811,8 +3323,8 @@ Name | Type | Description | Notes
2811
3323
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2812
3324
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
2813
3325
  **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]
2814
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
2815
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
3326
+ **created_before** | **DateTime**| 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]
3327
+ **created_after** | **DateTime**| 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]
2816
3328
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
2817
3329
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
2818
3330
  **referral_id** | **Integer**| 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]
@@ -3282,7 +3794,7 @@ Name | Type | Description | Notes
3282
3794
 
3283
3795
  ## get_event_types
3284
3796
 
3285
- > InlineResponse20025 get_event_types(opts)
3797
+ > InlineResponse20026 get_event_types(opts)
3286
3798
 
3287
3799
  List Event Types
3288
3800
 
@@ -3334,7 +3846,7 @@ Name | Type | Description | Notes
3334
3846
 
3335
3847
  ### Return type
3336
3848
 
3337
- [**InlineResponse20025**](InlineResponse20025.md)
3849
+ [**InlineResponse20026**](InlineResponse20026.md)
3338
3850
 
3339
3851
  ### Authorization
3340
3852
 
@@ -3348,7 +3860,7 @@ Name | Type | Description | Notes
3348
3860
 
3349
3861
  ## get_exports
3350
3862
 
3351
- > InlineResponse20028 get_exports(opts)
3863
+ > InlineResponse20029 get_exports(opts)
3352
3864
 
3353
3865
  Get Exports
3354
3866
 
@@ -3398,64 +3910,6 @@ Name | Type | Description | Notes
3398
3910
 
3399
3911
  ### Return type
3400
3912
 
3401
- [**InlineResponse20028**](InlineResponse20028.md)
3402
-
3403
- ### Authorization
3404
-
3405
- [manager_auth](../README.md#manager_auth)
3406
-
3407
- ### HTTP request headers
3408
-
3409
- - **Content-Type**: Not defined
3410
- - **Accept**: application/json
3411
-
3412
-
3413
- ## get_imports
3414
-
3415
- > InlineResponse20029 get_imports(opts)
3416
-
3417
- Get Imports
3418
-
3419
- Get a list of all past imports
3420
-
3421
- ### Example
3422
-
3423
- ```ruby
3424
- # load the gem
3425
- require 'talon_one'
3426
- # setup authorization
3427
- TalonOne.configure do |config|
3428
- # Configure API key authorization: manager_auth
3429
- config.api_key['Authorization'] = 'YOUR API KEY'
3430
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3431
- #config.api_key_prefix['Authorization'] = 'Bearer'
3432
- end
3433
-
3434
- api_instance = TalonOne::ManagementApi.new
3435
- opts = {
3436
- page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
3437
- skip: 56 # Integer | Skips the given number of items when paging through large result sets.
3438
- }
3439
-
3440
- begin
3441
- #Get Imports
3442
- result = api_instance.get_imports(opts)
3443
- p result
3444
- rescue TalonOne::ApiError => e
3445
- puts "Exception when calling ManagementApi->get_imports: #{e}"
3446
- end
3447
- ```
3448
-
3449
- ### Parameters
3450
-
3451
-
3452
- Name | Type | Description | Notes
3453
- ------------- | ------------- | ------------- | -------------
3454
- **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
3455
- **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
3456
-
3457
- ### Return type
3458
-
3459
3913
  [**InlineResponse20029**](InlineResponse20029.md)
3460
3914
 
3461
3915
  ### Authorization
@@ -3703,8 +4157,8 @@ opts = {
3703
4157
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
3704
4158
  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.
3705
4159
  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.
3706
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
3707
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
4160
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4161
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3708
4162
  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.
3709
4163
  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`.
3710
4164
  advocate: 'advocate_example' # String | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
@@ -3730,8 +4184,8 @@ Name | Type | Description | Notes
3730
4184
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
3731
4185
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
3732
4186
  **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]
3733
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
3734
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
4187
+ **created_before** | **DateTime**| 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]
4188
+ **created_after** | **DateTime**| 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]
3735
4189
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
3736
4190
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
3737
4191
  **advocate** | **String**| Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field | [optional]
@@ -3777,8 +4231,8 @@ opts = {
3777
4231
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
3778
4232
  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.
3779
4233
  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.
3780
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
3781
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
4234
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4235
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
3782
4236
  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.
3783
4237
  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`.
3784
4238
  advocate: 'advocate_example' # String | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
@@ -3804,8 +4258,8 @@ Name | Type | Description | Notes
3804
4258
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
3805
4259
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
3806
4260
  **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]
3807
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
3808
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. | [optional]
4261
+ **created_before** | **DateTime**| 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]
4262
+ **created_after** | **DateTime**| 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]
3809
4263
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
3810
4264
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
3811
4265
  **advocate** | **String**| Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field | [optional]
@@ -3828,7 +4282,7 @@ Name | Type | Description | Notes
3828
4282
 
3829
4283
  > Role get_role(role_id)
3830
4284
 
3831
- Get information for the specified role.
4285
+ Get information for the specified role
3832
4286
 
3833
4287
  ### Example
3834
4288
 
@@ -3847,7 +4301,7 @@ api_instance = TalonOne::ManagementApi.new
3847
4301
  role_id = 56 # Integer |
3848
4302
 
3849
4303
  begin
3850
- #Get information for the specified role.
4304
+ #Get information for the specified role
3851
4305
  result = api_instance.get_role(role_id)
3852
4306
  p result
3853
4307
  rescue TalonOne::ApiError => e
@@ -4050,7 +4504,7 @@ Name | Type | Description | Notes
4050
4504
 
4051
4505
  ## get_users
4052
4506
 
4053
- > InlineResponse20026 get_users(opts)
4507
+ > InlineResponse20027 get_users(opts)
4054
4508
 
4055
4509
  List Users in your account
4056
4510
 
@@ -4096,7 +4550,7 @@ Name | Type | Description | Notes
4096
4550
 
4097
4551
  ### Return type
4098
4552
 
4099
- [**InlineResponse20026**](InlineResponse20026.md)
4553
+ [**InlineResponse20027**](InlineResponse20027.md)
4100
4554
 
4101
4555
  ### Authorization
4102
4556
 
@@ -4164,7 +4618,7 @@ Name | Type | Description | Notes
4164
4618
 
4165
4619
  ## get_webhook_activation_logs
4166
4620
 
4167
- > InlineResponse20023 get_webhook_activation_logs(opts)
4621
+ > InlineResponse20024 get_webhook_activation_logs(opts)
4168
4622
 
4169
4623
  List Webhook activation Log Entries
4170
4624
 
@@ -4192,8 +4646,8 @@ opts = {
4192
4646
  webhook_id: 3.4, # Float | Filter results by Webhook.
4193
4647
  application_id: 3.4, # Float |
4194
4648
  campaign_id: 3.4, # Float | Filter results by campaign.
4195
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date.
4196
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
4649
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
4650
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | 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.
4197
4651
  }
4198
4652
 
4199
4653
  begin
@@ -4217,12 +4671,12 @@ Name | Type | Description | Notes
4217
4671
  **webhook_id** | **Float**| Filter results by Webhook. | [optional]
4218
4672
  **application_id** | **Float**| | [optional]
4219
4673
  **campaign_id** | **Float**| Filter results by campaign. | [optional]
4220
- **created_before** | **DateTime**| Only return events created before this date. | [optional]
4221
- **created_after** | **DateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. | [optional]
4674
+ **created_before** | **DateTime**| Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
4675
+ **created_after** | **DateTime**| 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]
4222
4676
 
4223
4677
  ### Return type
4224
4678
 
4225
- [**InlineResponse20023**](InlineResponse20023.md)
4679
+ [**InlineResponse20024**](InlineResponse20024.md)
4226
4680
 
4227
4681
  ### Authorization
4228
4682
 
@@ -4236,7 +4690,7 @@ Name | Type | Description | Notes
4236
4690
 
4237
4691
  ## get_webhook_logs
4238
4692
 
4239
- > InlineResponse20024 get_webhook_logs(opts)
4693
+ > InlineResponse20025 get_webhook_logs(opts)
4240
4694
 
4241
4695
  List Webhook Log Entries
4242
4696
 
@@ -4263,8 +4717,8 @@ opts = {
4263
4717
  application_id: 3.4, # Float |
4264
4718
  campaign_id: 3.4, # Float | Filter results by campaign.
4265
4719
  request_uuid: 'request_uuid_example', # String | Filter results by request UUID.
4266
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
4267
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
4720
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4721
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | 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.
4268
4722
  }
4269
4723
 
4270
4724
  begin
@@ -4289,12 +4743,12 @@ Name | Type | Description | Notes
4289
4743
  **application_id** | **Float**| | [optional]
4290
4744
  **campaign_id** | **Float**| Filter results by campaign. | [optional]
4291
4745
  **request_uuid** | **String**| Filter results by request UUID. | [optional]
4292
- **created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. | [optional]
4293
- **created_after** | **DateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. | [optional]
4746
+ **created_before** | **DateTime**| 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]
4747
+ **created_after** | **DateTime**| 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]
4294
4748
 
4295
4749
  ### Return type
4296
4750
 
4297
- [**InlineResponse20024**](InlineResponse20024.md)
4751
+ [**InlineResponse20025**](InlineResponse20025.md)
4298
4752
 
4299
4753
  ### Authorization
4300
4754
 
@@ -4308,7 +4762,7 @@ Name | Type | Description | Notes
4308
4762
 
4309
4763
  ## get_webhooks
4310
4764
 
4311
- > InlineResponse20022 get_webhooks(opts)
4765
+ > InlineResponse20023 get_webhooks(opts)
4312
4766
 
4313
4767
  List Webhooks
4314
4768
 
@@ -4354,7 +4808,7 @@ Name | Type | Description | Notes
4354
4808
 
4355
4809
  ### Return type
4356
4810
 
4357
- [**InlineResponse20022**](InlineResponse20022.md)
4811
+ [**InlineResponse20023**](InlineResponse20023.md)
4358
4812
 
4359
4813
  ### Authorization
4360
4814
 
@@ -4505,8 +4959,8 @@ opts = {
4505
4959
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
4506
4960
  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.
4507
4961
  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.
4508
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
4509
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
4962
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4963
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4510
4964
  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.
4511
4965
  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`.
4512
4966
  referral_id: 56, # Integer | 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.
@@ -4536,8 +4990,8 @@ Name | Type | Description | Notes
4536
4990
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
4537
4991
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
4538
4992
  **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]
4539
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
4540
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
4993
+ **created_before** | **DateTime**| 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]
4994
+ **created_after** | **DateTime**| 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]
4541
4995
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
4542
4996
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
4543
4997
  **referral_id** | **Integer**| 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]
@@ -4588,8 +5042,8 @@ opts = {
4588
5042
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
4589
5043
  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.
4590
5044
  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.
4591
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
4592
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5045
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
5046
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4593
5047
  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.
4594
5048
  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`.
4595
5049
  referral_id: 56, # Integer | 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.
@@ -4619,8 +5073,8 @@ Name | Type | Description | Notes
4619
5073
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
4620
5074
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
4621
5075
  **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]
4622
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
4623
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
5076
+ **created_before** | **DateTime**| 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]
5077
+ **created_after** | **DateTime**| 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]
4624
5078
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
4625
5079
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
4626
5080
  **referral_id** | **Integer**| 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]
@@ -4672,8 +5126,8 @@ opts = {
4672
5126
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
4673
5127
  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.
4674
5128
  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.
4675
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
4676
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5129
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
5130
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4677
5131
  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.
4678
5132
  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`.
4679
5133
  referral_id: 56, # Integer | 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.
@@ -4703,8 +5157,8 @@ Name | Type | Description | Notes
4703
5157
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
4704
5158
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
4705
5159
  **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]
4706
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
4707
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
5160
+ **created_before** | **DateTime**| 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]
5161
+ **created_after** | **DateTime**| 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]
4708
5162
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
4709
5163
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
4710
5164
  **referral_id** | **Integer**| 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]
@@ -4757,8 +5211,8 @@ opts = {
4757
5211
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
4758
5212
  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.
4759
5213
  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.
4760
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
4761
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5214
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
5215
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
4762
5216
  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.
4763
5217
  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`.
4764
5218
  referral_id: 56, # Integer | 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.
@@ -4788,8 +5242,8 @@ Name | Type | Description | Notes
4788
5242
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
4789
5243
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order. | [optional]
4790
5244
  **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]
4791
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
4792
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. | [optional]
5245
+ **created_before** | **DateTime**| 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]
5246
+ **created_after** | **DateTime**| 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]
4793
5247
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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]
4794
5248
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
4795
5249
  **referral_id** | **Integer**| 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]