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
@@ -41,6 +41,9 @@ module TalonOne
41
41
  # The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\"
42
42
  attr_accessor :exclusive_campaigns_strategy
43
43
 
44
+ # The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect.
45
+ attr_accessor :default_discount_scope
46
+
44
47
  # Flag indicating if discounts should cascade for this application
45
48
  attr_accessor :enable_cascading_discounts
46
49
 
@@ -86,6 +89,7 @@ module TalonOne
86
89
  :'limits' => :'limits',
87
90
  :'campaign_priority' => :'campaignPriority',
88
91
  :'exclusive_campaigns_strategy' => :'exclusiveCampaignsStrategy',
92
+ :'default_discount_scope' => :'defaultDiscountScope',
89
93
  :'enable_cascading_discounts' => :'enableCascadingDiscounts',
90
94
  :'enable_flattened_cart_items' => :'enableFlattenedCartItems',
91
95
  :'attributes_settings' => :'attributesSettings',
@@ -105,6 +109,7 @@ module TalonOne
105
109
  :'limits' => :'Array<LimitConfig>',
106
110
  :'campaign_priority' => :'String',
107
111
  :'exclusive_campaigns_strategy' => :'String',
112
+ :'default_discount_scope' => :'String',
108
113
  :'enable_cascading_discounts' => :'Boolean',
109
114
  :'enable_flattened_cart_items' => :'Boolean',
110
115
  :'attributes_settings' => :'AttributesSettings',
@@ -171,6 +176,10 @@ module TalonOne
171
176
  self.exclusive_campaigns_strategy = attributes[:'exclusive_campaigns_strategy']
172
177
  end
173
178
 
179
+ if attributes.key?(:'default_discount_scope')
180
+ self.default_discount_scope = attributes[:'default_discount_scope']
181
+ end
182
+
174
183
  if attributes.key?(:'enable_cascading_discounts')
175
184
  self.enable_cascading_discounts = attributes[:'enable_cascading_discounts']
176
185
  end
@@ -234,6 +243,8 @@ module TalonOne
234
243
  return false unless campaign_priority_validator.valid?(@campaign_priority)
235
244
  exclusive_campaigns_strategy_validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"])
236
245
  return false unless exclusive_campaigns_strategy_validator.valid?(@exclusive_campaigns_strategy)
246
+ default_discount_scope_validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
247
+ return false unless default_discount_scope_validator.valid?(@default_discount_scope)
237
248
  true
238
249
  end
239
250
 
@@ -309,6 +320,16 @@ module TalonOne
309
320
  @exclusive_campaigns_strategy = exclusive_campaigns_strategy
310
321
  end
311
322
 
323
+ # Custom attribute writer method checking allowed values (enum).
324
+ # @param [Object] default_discount_scope Object to be assigned
325
+ def default_discount_scope=(default_discount_scope)
326
+ validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
327
+ unless validator.valid?(default_discount_scope)
328
+ fail ArgumentError, "invalid value for \"default_discount_scope\", must be one of #{validator.allowable_values}."
329
+ end
330
+ @default_discount_scope = default_discount_scope
331
+ end
332
+
312
333
  # Checks equality by comparing each attribute.
313
334
  # @param [Object] Object to be compared
314
335
  def ==(o)
@@ -323,6 +344,7 @@ module TalonOne
323
344
  limits == o.limits &&
324
345
  campaign_priority == o.campaign_priority &&
325
346
  exclusive_campaigns_strategy == o.exclusive_campaigns_strategy &&
347
+ default_discount_scope == o.default_discount_scope &&
326
348
  enable_cascading_discounts == o.enable_cascading_discounts &&
327
349
  enable_flattened_cart_items == o.enable_flattened_cart_items &&
328
350
  attributes_settings == o.attributes_settings &&
@@ -338,7 +360,7 @@ module TalonOne
338
360
  # Calculates hash code according to all attributes.
339
361
  # @return [Integer] Hash code
340
362
  def hash
341
- [name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox].hash
363
+ [name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox].hash
342
364
  end
343
365
 
344
366
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
11
11
  =end
12
12
 
13
13
  module TalonOne
14
- VERSION = '2.2.0'
14
+ VERSION = '2.3.0'
15
15
  end
@@ -71,7 +71,7 @@ describe 'IntegrationApi' do
71
71
  end
72
72
 
73
73
  # unit tests for delete_customer_data
74
- # Delete the personal data of a customer.
74
+ # Delete the personal data of a customer
75
75
  # Delete all attributes on the customer profile and on entities that reference that customer profile.
76
76
  # @param integration_id The custom identifier for this profile, must be unique within the account.
77
77
  # @param [Hash] opts the optional parameters
@@ -83,7 +83,7 @@ describe 'IntegrationApi' do
83
83
  end
84
84
 
85
85
  # unit tests for get_customer_inventory
86
- # Get an inventory of all data associated with a specific customer profile.
86
+ # Get an inventory of all data associated with a specific customer profile
87
87
  # Get information regarding entities referencing this customer profile&#39;s integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
88
88
  # @param integration_id The custom identifier for this profile, must be unique within the account.
89
89
  # @param [Hash] opts the optional parameters
@@ -115,7 +115,7 @@ describe 'IntegrationApi' do
115
115
  # Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The &#x60;sessionId&#x60; body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same &#x60;profileId&#x60; or an error will be returned. As with customer sessions, you can use an empty string for &#x60;profileId&#x60; to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
116
116
  # @param body
117
117
  # @param [Hash] opts the optional parameters
118
- # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
118
+ # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
119
119
  # @return [IntegrationState]
120
120
  describe 'track_event test' do
121
121
  it 'should work' do
@@ -125,11 +125,11 @@ describe 'IntegrationApi' do
125
125
 
126
126
  # unit tests for update_customer_profile
127
127
  # Update a Customer Profile V1
128
- # ⚠️ 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 &#x60;integrationId&#x60; 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 &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;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
128
+ # ⚠️ 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 &#x60;integrationId&#x60; 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 &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;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
129
129
  # @param integration_id The custom identifier for this profile, must be unique within the account.
130
130
  # @param body
131
131
  # @param [Hash] opts the optional parameters
132
- # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
132
+ # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
133
133
  # @return [IntegrationState]
134
134
  describe 'update_customer_profile test' do
135
135
  it 'should work' do
@@ -151,12 +151,12 @@ describe 'IntegrationApi' do
151
151
 
152
152
  # unit tests for update_customer_profile_v2
153
153
  # Update a Customer Profile
154
- # Update (or create) a [Customer Profile][]. The &#x60;integrationId&#x60; 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 &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;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
155
- # @param integration_id The custom identifier for this profile, must be unique within the account.
154
+ # Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). The &#x60;integrationId&#x60; 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 &#x60;runRuleEngine&#x60; is set to &#x60;true&#x60;, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the &#x60;responseContent&#x60; request parameter.
155
+ # @param integration_id The custom identifier for this profile. Must be unique within the account.
156
156
  # @param body
157
157
  # @param [Hash] opts the optional parameters
158
- # @option opts [Boolean] :run_rule_engine Flag to indicate whether to run the rule engine (Defaults to false).
159
- # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;. Only used when &#39;runRuleEngine&#39; is set to &#39;true&#39;).
158
+ # @option opts [Boolean] :run_rule_engine Indicates whether to run the rule engine.
159
+ # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are persisted with &#x60;true&#x60;. Only used when &#x60;runRuleEngine&#x60; is set to &#x60;true&#x60;.
160
160
  # @return [IntegrationStateV2]
161
161
  describe 'update_customer_profile_v2 test' do
162
162
  it 'should work' do
@@ -166,10 +166,10 @@ describe 'IntegrationApi' do
166
166
 
167
167
  # unit tests for update_customer_profiles_v2
168
168
  # Update multiple Customer Profiles
169
- # Update (or create) up to 1000 [Customer Profiles][] in 1 request. The &#x60;integrationId&#x60; 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 &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;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
169
+ # Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request. The &#x60;integrationId&#x60; 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).
170
170
  # @param body
171
171
  # @param [Hash] opts the optional parameters
172
- # @option opts [String] :silent If set to &#39;yes&#39;, response will be an empty 204, otherwise a list of the IntegrationStateV2 generated.
172
+ # @option opts [String] :silent If set to &#x60;yes&#x60;, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
173
173
  # @return [MultipleCustomerProfileIntegrationResponseV2]
174
174
  describe 'update_customer_profiles_v2 test' do
175
175
  it 'should work' do
@@ -179,11 +179,11 @@ describe 'IntegrationApi' do
179
179
 
180
180
  # unit tests for update_customer_session
181
181
  # Update a Customer Session V1
182
- # ⚠️ 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&#39;s. The &#x60;profileId&#x60; parameter in the request body should correspond to an &#x60;integrationId&#x60; for a customer profile, to track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. 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
182
+ # ⚠️ 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&#39;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&#39;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&#39;s. To link a session to a customer profile, set the &#x60;profileId&#x60; parameter in the request body to a customer profile&#39;s &#x60;integrationId&#x60;. To track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. **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.
183
183
  # @param customer_session_id The custom identifier for this session, must be unique within the account.
184
184
  # @param body
185
185
  # @param [Hash] opts the optional parameters
186
- # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
186
+ # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
187
187
  # @return [IntegrationState]
188
188
  describe 'update_customer_session test' do
189
189
  it 'should work' do
@@ -193,11 +193,11 @@ describe 'IntegrationApi' do
193
193
 
194
194
  # unit tests for update_customer_session_v2
195
195
  # Update a Customer Session
196
- # 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&#39;s. The &#x60;profileId&#x60; parameter in the request body should correspond to an &#x60;integrationId&#x60; for a customer profile, to track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. 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 \&quot;responseContent\&quot;. 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
196
+ # 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&#39;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&#39;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&#39;s. To link a session to a customer profile, set the &#x60;profileId&#x60; parameter in the request body to a customer profile&#39;s &#x60;integrationId&#x60;. To track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. **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 &#x60;runRuleEngine&#x60; is set to &#x60;true&#x60;, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the &#x60;responseContent&#x60; 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.
197
197
  # @param customer_session_id The custom identifier for this session, must be unique within the account.
198
198
  # @param body
199
199
  # @param [Hash] opts the optional parameters
200
- # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
200
+ # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
201
201
  # @return [IntegrationStateV2]
202
202
  describe 'update_customer_session_v2 test' do
203
203
  it 'should work' do
@@ -110,6 +110,21 @@ describe 'ManagementApi' do
110
110
  end
111
111
  end
112
112
 
113
+ # unit tests for create_coupons_for_multiple_recipients
114
+ # Create Coupons for Multiple Recipients
115
+ # Create coupons according to some pattern for up to 1000 recipients.
116
+ # @param application_id
117
+ # @param campaign_id
118
+ # @param body
119
+ # @param [Hash] opts the optional parameters
120
+ # @option opts [String] :silent If set to &#39;yes&#39;, response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
121
+ # @return [InlineResponse2004]
122
+ describe 'create_coupons_for_multiple_recipients test' do
123
+ it 'should work' do
124
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
125
+ end
126
+ end
127
+
113
128
  # unit tests for create_password_recovery_email
114
129
  # Request a password reset
115
130
  # Sends an email with a password recovery link to the email of an existing account.
@@ -177,12 +192,12 @@ describe 'ManagementApi' do
177
192
  # @param campaign_id
178
193
  # @param [Hash] opts the optional parameters
179
194
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
180
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
181
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
182
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
183
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
184
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
185
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
195
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
196
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
197
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
198
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
199
+ # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
200
+ # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
186
201
  # @option opts [String] :valid 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.
187
202
  # @option opts [String] :batch_id Filter results by batches of coupons
188
203
  # @option opts [String] :usable 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;.
@@ -222,6 +237,102 @@ describe 'ManagementApi' do
222
237
  end
223
238
  end
224
239
 
240
+ # unit tests for destroy_session
241
+ # Destroy a Session
242
+ # @param [Hash] opts the optional parameters
243
+ # @return [nil]
244
+ describe 'destroy_session test' do
245
+ it 'should work' do
246
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
247
+ end
248
+ end
249
+
250
+ # unit tests for export_coupons
251
+ # Export Coupons to a CSV file
252
+ # Download a file with the coupons that match the given attributes.
253
+ # @param application_id
254
+ # @param [Hash] opts the optional parameters
255
+ # @option opts [Float] :campaign_id Filter results by campaign.
256
+ # @option opts [String] :sort 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.
257
+ # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
258
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
259
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
260
+ # @option opts [String] :valid 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.
261
+ # @option opts [String] :usable 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;.
262
+ # @option opts [Integer] :referral_id 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.
263
+ # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
264
+ # @option opts [String] :batch_id Filter results by batches of coupons
265
+ # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
266
+ # @option opts [String] :date_format Determines the format of dates in the export document.
267
+ # @option opts [String] :campaign_state Filter results by the state of the campaign.
268
+ # @return [String]
269
+ describe 'export_coupons test' do
270
+ it 'should work' do
271
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
272
+ end
273
+ end
274
+
275
+ # unit tests for export_customer_sessions
276
+ # Export Customer Sessions to a CSV file
277
+ # Download a file with the customer sessions that match the request.
278
+ # @param application_id
279
+ # @param [Hash] opts the optional parameters
280
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
281
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
282
+ # @option opts [String] :profile_integration_id Only return sessions for the customer that matches this customer integration ID.
283
+ # @option opts [String] :date_format Determines the format of dates in the export document.
284
+ # @option opts [String] :customer_session_state Filter results by state.
285
+ # @return [String]
286
+ describe 'export_customer_sessions test' do
287
+ it 'should work' do
288
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
289
+ end
290
+ end
291
+
292
+ # unit tests for export_effects
293
+ # Export triggered Effects to a CSV file
294
+ # Download a file with the triggered effects that match the given attributes.
295
+ # @param application_id
296
+ # @param [Hash] opts the optional parameters
297
+ # @option opts [Float] :campaign_id Filter results by campaign.
298
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
299
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
300
+ # @option opts [String] :date_format Determines the format of dates in the export document.
301
+ # @return [String]
302
+ describe 'export_effects test' do
303
+ it 'should work' do
304
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
305
+ end
306
+ end
307
+
308
+ # unit tests for export_loyalty_balance
309
+ # Export customer loyalty balance to a CSV file
310
+ # Download a file with the balance of each customer in the loyalty program
311
+ # @param program_id
312
+ # @param [Hash] opts the optional parameters
313
+ # @return [String]
314
+ describe 'export_loyalty_balance test' do
315
+ it 'should work' do
316
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
317
+ end
318
+ end
319
+
320
+ # unit tests for export_loyalty_ledger
321
+ # Export a customer&#39;s loyalty ledger log to a CSV file
322
+ # Download a file with a customer&#39;s ledger log in the loyalty program
323
+ # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
324
+ # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
325
+ # @param program_id
326
+ # @param integration_id
327
+ # @param [Hash] opts the optional parameters
328
+ # @option opts [String] :date_format Determines the format of dates in the export document.
329
+ # @return [String]
330
+ describe 'export_loyalty_ledger test' do
331
+ it 'should work' do
332
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
333
+ end
334
+ end
335
+
225
336
  # unit tests for get_access_logs
226
337
  # Get access logs for application (with total count)
227
338
  # @param application_id
@@ -303,7 +414,7 @@ describe 'ManagementApi' do
303
414
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
304
415
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
305
416
  # @option opts [String] :sort 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.
306
- # @return [InlineResponse20021]
417
+ # @return [InlineResponse20022]
307
418
  describe 'get_additional_costs test' do
308
419
  it 'should work' do
309
420
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -330,7 +441,7 @@ describe 'ManagementApi' do
330
441
  end
331
442
 
332
443
  # unit tests for get_all_roles
333
- # Get all roles.
444
+ # Get all roles
334
445
  # @param [Hash] opts the optional parameters
335
446
  # @return [InlineResponse20030]
336
447
  describe 'get_all_roles test' do
@@ -425,8 +536,8 @@ describe 'ManagementApi' do
425
536
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
426
537
  # @option opts [String] :sort 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.
427
538
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
428
- # @option opts [DateTime] :created_before Only return events created before this date
429
- # @option opts [DateTime] :created_after Only return events created after this date
539
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
540
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
430
541
  # @option opts [String] :session Session integration ID filter for events. Must be exact match.
431
542
  # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
432
543
  # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
@@ -451,8 +562,8 @@ describe 'ManagementApi' do
451
562
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
452
563
  # @option opts [String] :sort 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.
453
564
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
454
- # @option opts [DateTime] :created_before Only return events created before this date
455
- # @option opts [DateTime] :created_after Only return events created after this date
565
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
566
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
456
567
  # @option opts [String] :session Session integration ID filter for events. Must be exact match.
457
568
  # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
458
569
  # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
@@ -489,8 +600,8 @@ describe 'ManagementApi' do
489
600
  # @option opts [String] :sort 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.
490
601
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
491
602
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
492
- # @option opts [DateTime] :created_before Only return events created before this date
493
- # @option opts [DateTime] :created_after Only return events created after this date
603
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
604
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
494
605
  # @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
495
606
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
496
607
  # @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
@@ -534,13 +645,28 @@ describe 'ManagementApi' do
534
645
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
535
646
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
536
647
  # @option opts [String] :sort 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.
537
- # @return [InlineResponse20020]
648
+ # @return [InlineResponse20021]
538
649
  describe 'get_attributes test' do
539
650
  it 'should work' do
540
651
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
541
652
  end
542
653
  end
543
654
 
655
+ # unit tests for get_audiences
656
+ # Get all audiences
657
+ # Get All audiences created in the account.
658
+ # @param [Hash] opts the optional parameters
659
+ # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
660
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
661
+ # @option opts [String] :sort 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.
662
+ # @option opts [Boolean] :with_total_result_size 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.
663
+ # @return [InlineResponse20020]
664
+ describe 'get_audiences test' do
665
+ it 'should work' do
666
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
667
+ end
668
+ end
669
+
544
670
  # unit tests for get_campaign
545
671
  # Get a Campaign
546
672
  # @param application_id
@@ -595,8 +721,8 @@ describe 'ManagementApi' do
595
721
  # @option opts [String] :campaign_state Filter results by the state of the campaign.
596
722
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
597
723
  # @option opts [String] :tags 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
598
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
599
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
724
+ # @option opts [DateTime] :created_before 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.
725
+ # @option opts [DateTime] :created_after 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.
600
726
  # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
601
727
  # @return [InlineResponse2002]
602
728
  describe 'get_campaigns test' do
@@ -613,11 +739,13 @@ describe 'ManagementApi' do
613
739
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
614
740
  # @option opts [String] :sort 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.
615
741
  # @option opts [Integer] :application_id
616
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
617
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
742
+ # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
743
+ # @option opts [Integer] :user_id
744
+ # @option opts [DateTime] :created_before 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.
745
+ # @option opts [DateTime] :created_after 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.
618
746
  # @option opts [Boolean] :with_total_result_size 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.
619
747
  # @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
620
- # @return [InlineResponse20027]
748
+ # @return [InlineResponse20028]
621
749
  describe 'get_changes test' do
622
750
  it 'should work' do
623
751
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -633,12 +761,12 @@ describe 'ManagementApi' do
633
761
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
634
762
  # @option opts [String] :sort 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.
635
763
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
636
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
637
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
638
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
639
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
640
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
641
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
764
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
765
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
766
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
767
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
768
+ # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
769
+ # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
642
770
  # @option opts [String] :valid 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.
643
771
  # @option opts [String] :batch_id Filter results by batches of coupons
644
772
  # @option opts [String] :usable 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;.
@@ -663,8 +791,8 @@ describe 'ManagementApi' do
663
791
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
664
792
  # @option opts [String] :sort 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.
665
793
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
666
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
667
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
794
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, 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
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
668
796
  # @option opts [String] :valid 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.
669
797
  # @option opts [String] :usable 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;.
670
798
  # @option opts [Integer] :referral_id 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.
@@ -688,8 +816,8 @@ describe 'ManagementApi' do
688
816
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
689
817
  # @option opts [String] :sort 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.
690
818
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
691
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
692
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
819
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
820
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
693
821
  # @option opts [String] :valid 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.
694
822
  # @option opts [String] :usable 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;.
695
823
  # @option opts [Integer] :referral_id 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.
@@ -713,8 +841,8 @@ describe 'ManagementApi' do
713
841
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
714
842
  # @option opts [String] :sort 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.
715
843
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
716
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
717
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
844
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
845
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
718
846
  # @option opts [String] :valid 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.
719
847
  # @option opts [String] :usable 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;.
720
848
  # @option opts [Integer] :referral_id 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.
@@ -850,7 +978,7 @@ describe 'ManagementApi' do
850
978
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
851
979
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
852
980
  # @option opts [String] :sort 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.
853
- # @return [InlineResponse20025]
981
+ # @return [InlineResponse20026]
854
982
  describe 'get_event_types test' do
855
983
  it 'should work' do
856
984
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -866,21 +994,8 @@ describe 'ManagementApi' do
866
994
  # @option opts [Integer] :application_id
867
995
  # @option opts [Integer] :campaign_id
868
996
  # @option opts [String] :entity The name of the entity type that was exported.
869
- # @return [InlineResponse20028]
870
- describe 'get_exports test' do
871
- it 'should work' do
872
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
873
- end
874
- end
875
-
876
- # unit tests for get_imports
877
- # Get Imports
878
- # Get a list of all past imports
879
- # @param [Hash] opts the optional parameters
880
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
881
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
882
997
  # @return [InlineResponse20029]
883
- describe 'get_imports test' do
998
+ describe 'get_exports test' do
884
999
  it 'should work' do
885
1000
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
886
1001
  end
@@ -940,8 +1055,8 @@ describe 'ManagementApi' do
940
1055
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
941
1056
  # @option opts [String] :sort 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.
942
1057
  # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
943
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
944
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
1058
+ # @option opts [DateTime] :created_before 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.
1059
+ # @option opts [DateTime] :created_after 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.
945
1060
  # @option opts [String] :valid 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.
946
1061
  # @option opts [String] :usable 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;.
947
1062
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field
@@ -961,8 +1076,8 @@ describe 'ManagementApi' do
961
1076
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
962
1077
  # @option opts [String] :sort 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.
963
1078
  # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
964
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
965
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
1079
+ # @option opts [DateTime] :created_before 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.
1080
+ # @option opts [DateTime] :created_after 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.
966
1081
  # @option opts [String] :valid 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.
967
1082
  # @option opts [String] :usable 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;.
968
1083
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field
@@ -974,7 +1089,7 @@ describe 'ManagementApi' do
974
1089
  end
975
1090
 
976
1091
  # unit tests for get_role
977
- # Get information for the specified role.
1092
+ # Get information for the specified role
978
1093
  # @param role_id
979
1094
  # @param [Hash] opts the optional parameters
980
1095
  # @return [Role]
@@ -1031,7 +1146,7 @@ describe 'ManagementApi' do
1031
1146
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1032
1147
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1033
1148
  # @option opts [String] :sort 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.
1034
- # @return [InlineResponse20026]
1149
+ # @return [InlineResponse20027]
1035
1150
  describe 'get_users test' do
1036
1151
  it 'should work' do
1037
1152
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1061,9 +1176,9 @@ describe 'ManagementApi' do
1061
1176
  # @option opts [Float] :webhook_id Filter results by Webhook.
1062
1177
  # @option opts [Float] :application_id
1063
1178
  # @option opts [Float] :campaign_id Filter results by campaign.
1064
- # @option opts [DateTime] :created_before Only return events created before this date.
1065
- # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
1066
- # @return [InlineResponse20023]
1179
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
1180
+ # @option opts [DateTime] :created_after 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.
1181
+ # @return [InlineResponse20024]
1067
1182
  describe 'get_webhook_activation_logs test' do
1068
1183
  it 'should work' do
1069
1184
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1081,9 +1196,9 @@ describe 'ManagementApi' do
1081
1196
  # @option opts [Float] :application_id
1082
1197
  # @option opts [Float] :campaign_id Filter results by campaign.
1083
1198
  # @option opts [String] :request_uuid Filter results by request UUID.
1084
- # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
1085
- # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
1086
- # @return [InlineResponse20024]
1199
+ # @option opts [DateTime] :created_before 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.
1200
+ # @option opts [DateTime] :created_after 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.
1201
+ # @return [InlineResponse20025]
1087
1202
  describe 'get_webhook_logs test' do
1088
1203
  it 'should work' do
1089
1204
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1097,7 +1212,7 @@ describe 'ManagementApi' do
1097
1212
  # @option opts [String] :sort 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.
1098
1213
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1099
1214
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1100
- # @return [InlineResponse20022]
1215
+ # @return [InlineResponse20023]
1101
1216
  describe 'get_webhooks test' do
1102
1217
  it 'should work' do
1103
1218
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1140,8 +1255,8 @@ describe 'ManagementApi' do
1140
1255
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1141
1256
  # @option opts [String] :sort 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.
1142
1257
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1143
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1144
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1258
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1259
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1145
1260
  # @option opts [String] :valid 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.
1146
1261
  # @option opts [String] :usable 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;.
1147
1262
  # @option opts [Integer] :referral_id 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.
@@ -1165,8 +1280,8 @@ describe 'ManagementApi' do
1165
1280
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1166
1281
  # @option opts [String] :sort 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.
1167
1282
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1168
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1169
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1283
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1284
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1170
1285
  # @option opts [String] :valid 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.
1171
1286
  # @option opts [String] :usable 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;.
1172
1287
  # @option opts [Integer] :referral_id 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.
@@ -1191,8 +1306,8 @@ describe 'ManagementApi' do
1191
1306
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1192
1307
  # @option opts [String] :sort 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.
1193
1308
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1194
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1195
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1309
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1310
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1196
1311
  # @option opts [String] :valid 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.
1197
1312
  # @option opts [String] :usable 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;.
1198
1313
  # @option opts [Integer] :referral_id 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.
@@ -1218,8 +1333,8 @@ describe 'ManagementApi' do
1218
1333
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1219
1334
  # @option opts [String] :sort 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.
1220
1335
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1221
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1222
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
1336
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1337
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1223
1338
  # @option opts [String] :valid 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.
1224
1339
  # @option opts [String] :usable 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;.
1225
1340
  # @option opts [Integer] :referral_id 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.