talon_one 2.3.0 → 2.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -5
  3. data/docs/ApplicationCampaignStats.md +27 -0
  4. data/docs/ApplicationReferee.md +27 -0
  5. data/docs/AwardGiveawayEffectProps.md +25 -0
  6. data/docs/Campaign.md +2 -0
  7. data/docs/Coupon.md +1 -1
  8. data/docs/CustomEffect.md +41 -0
  9. data/docs/CustomEffectProps.md +19 -0
  10. data/docs/CustomerInventory.md +4 -2
  11. data/docs/CustomerProfileIntegrationRequestV2.md +1 -1
  12. data/docs/Environment.md +10 -0
  13. data/docs/Giveaway.md +33 -0
  14. data/docs/GiveawaysPool.md +33 -0
  15. data/docs/ImportEntity.md +17 -0
  16. data/docs/InlineResponse20010.md +3 -3
  17. data/docs/InlineResponse20011.md +4 -2
  18. data/docs/InlineResponse20012.md +2 -4
  19. data/docs/InlineResponse20013.md +3 -3
  20. data/docs/InlineResponse20014.md +2 -2
  21. data/docs/InlineResponse20015.md +2 -2
  22. data/docs/InlineResponse20016.md +3 -3
  23. data/docs/InlineResponse20017.md +2 -2
  24. data/docs/InlineResponse20018.md +3 -3
  25. data/docs/InlineResponse20019.md +5 -3
  26. data/docs/InlineResponse20020.md +2 -2
  27. data/docs/InlineResponse20021.md +1 -1
  28. data/docs/InlineResponse20022.md +1 -1
  29. data/docs/InlineResponse20023.md +1 -1
  30. data/docs/InlineResponse20024.md +1 -1
  31. data/docs/InlineResponse20025.md +1 -1
  32. data/docs/InlineResponse20026.md +1 -1
  33. data/docs/InlineResponse20027.md +4 -2
  34. data/docs/InlineResponse20028.md +2 -4
  35. data/docs/InlineResponse20029.md +1 -1
  36. data/docs/InlineResponse2006.md +2 -2
  37. data/docs/InlineResponse2007.md +3 -3
  38. data/docs/InlineResponse2008.md +1 -1
  39. data/docs/InlineResponse2009.md +2 -2
  40. data/docs/{InlineResponse20030.md → InlineResponse201.md} +3 -3
  41. data/docs/IntegrationApi.md +77 -11
  42. data/docs/IntegrationRequest.md +1 -1
  43. data/docs/IntegrationStateV2.md +3 -1
  44. data/docs/InventoryCoupon.md +53 -0
  45. data/docs/LoyaltyProgram.md +3 -1
  46. data/docs/LoyaltyProgramEntity.md +17 -0
  47. data/docs/LoyaltyTier.md +25 -0
  48. data/docs/ManagementApi.md +370 -69
  49. data/docs/NewCustomEffect.md +29 -0
  50. data/docs/NewGiveawaysPool.md +21 -0
  51. data/docs/NewLoyaltyTier.md +19 -0
  52. data/docs/NewReferral.md +10 -6
  53. data/docs/NewReferralsForMultipleAdvocates.md +31 -0
  54. data/docs/NewRole.md +1 -1
  55. data/docs/Referral.md +13 -7
  56. data/docs/ReferralConstraints.md +21 -0
  57. data/docs/Role.md +8 -4
  58. data/docs/UpdateCustomEffect.md +29 -0
  59. data/docs/UpdateLoyaltyTier.md +19 -0
  60. data/docs/UpdateReferral.md +25 -0
  61. data/docs/UpdateRole.md +1 -1
  62. data/docs/WillAwardGiveawayEffectProps.md +21 -0
  63. data/lib/talon_one.rb +21 -1
  64. data/lib/talon_one/api/integration_api.rb +80 -10
  65. data/lib/talon_one/api/management_api.rb +460 -97
  66. data/lib/talon_one/models/application_campaign_stats.rb +288 -0
  67. data/lib/talon_one/models/application_referee.rb +288 -0
  68. data/lib/talon_one/models/attribute.rb +2 -2
  69. data/lib/talon_one/models/award_giveaway_effect_props.rb +273 -0
  70. data/lib/talon_one/models/campaign.rb +11 -1
  71. data/lib/talon_one/models/coupon.rb +1 -1
  72. data/lib/talon_one/models/custom_effect.rb +377 -0
  73. data/lib/talon_one/models/custom_effect_props.rb +228 -0
  74. data/lib/talon_one/models/customer_inventory.rb +15 -4
  75. data/lib/talon_one/models/customer_profile_integration_request_v2.rb +1 -1
  76. data/lib/talon_one/models/environment.rb +61 -1
  77. data/lib/talon_one/models/export.rb +2 -2
  78. data/lib/talon_one/models/giveaway.rb +308 -0
  79. data/lib/talon_one/models/giveaways_pool.rb +315 -0
  80. data/lib/talon_one/models/import_entity.rb +207 -0
  81. data/lib/talon_one/models/inline_response20010.rb +11 -11
  82. data/lib/talon_one/models/inline_response20011.rb +11 -7
  83. data/lib/talon_one/models/inline_response20012.rb +6 -10
  84. data/lib/talon_one/models/inline_response20013.rb +11 -11
  85. data/lib/talon_one/models/inline_response20014.rb +10 -10
  86. data/lib/talon_one/models/inline_response20015.rb +1 -6
  87. data/lib/talon_one/models/inline_response20016.rb +13 -8
  88. data/lib/talon_one/models/inline_response20017.rb +10 -10
  89. data/lib/talon_one/models/inline_response20018.rb +11 -11
  90. data/lib/talon_one/models/inline_response20019.rb +11 -7
  91. data/lib/talon_one/models/inline_response20020.rb +6 -1
  92. data/lib/talon_one/models/inline_response20021.rb +1 -1
  93. data/lib/talon_one/models/inline_response20022.rb +1 -1
  94. data/lib/talon_one/models/inline_response20023.rb +1 -1
  95. data/lib/talon_one/models/inline_response20024.rb +1 -1
  96. data/lib/talon_one/models/inline_response20025.rb +1 -1
  97. data/lib/talon_one/models/inline_response20026.rb +1 -1
  98. data/lib/talon_one/models/inline_response20027.rb +11 -7
  99. data/lib/talon_one/models/inline_response20028.rb +7 -11
  100. data/lib/talon_one/models/inline_response20029.rb +1 -1
  101. data/lib/talon_one/models/inline_response2006.rb +10 -10
  102. data/lib/talon_one/models/inline_response2007.rb +11 -11
  103. data/lib/talon_one/models/inline_response2008.rb +1 -1
  104. data/lib/talon_one/models/inline_response2009.rb +10 -10
  105. data/lib/talon_one/models/{inline_response20030.rb → inline_response201.rb} +4 -4
  106. data/lib/talon_one/models/integration_request.rb +1 -1
  107. data/lib/talon_one/models/integration_state_v2.rb +15 -4
  108. data/lib/talon_one/models/inventory_coupon.rb +499 -0
  109. data/lib/talon_one/models/loyalty_program.rb +16 -4
  110. data/lib/talon_one/models/loyalty_program_entity.rb +212 -0
  111. data/lib/talon_one/models/loyalty_tier.rb +301 -0
  112. data/lib/talon_one/models/new_attribute.rb +2 -2
  113. data/lib/talon_one/models/new_custom_effect.rb +291 -0
  114. data/lib/talon_one/models/new_giveaways_pool.rb +234 -0
  115. data/lib/talon_one/models/new_loyalty_tier.rb +256 -0
  116. data/lib/talon_one/models/new_referral.rb +64 -19
  117. data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +349 -0
  118. data/lib/talon_one/models/new_role.rb +1 -1
  119. data/lib/talon_one/models/referral.rb +86 -47
  120. data/lib/talon_one/models/referral_constraints.rb +251 -0
  121. data/lib/talon_one/models/role.rb +44 -4
  122. data/lib/talon_one/models/update_custom_effect.rb +292 -0
  123. data/lib/talon_one/models/update_loyalty_tier.rb +256 -0
  124. data/lib/talon_one/models/update_referral.rb +271 -0
  125. data/lib/talon_one/models/update_role.rb +1 -1
  126. data/lib/talon_one/models/will_award_giveaway_effect_props.rb +243 -0
  127. data/lib/talon_one/version.rb +1 -1
  128. data/spec/api/integration_api_spec.rb +19 -5
  129. data/spec/api/management_api_spec.rb +102 -33
  130. data/spec/models/application_campaign_stats_spec.rb +71 -0
  131. data/spec/models/application_referee_spec.rb +71 -0
  132. data/spec/models/attribute_spec.rb +1 -1
  133. data/spec/models/award_giveaway_effect_props_spec.rb +65 -0
  134. data/spec/models/campaign_spec.rb +7 -1
  135. data/spec/models/custom_effect_props_spec.rb +47 -0
  136. data/spec/models/custom_effect_spec.rb +113 -0
  137. data/spec/models/customer_inventory_spec.rb +6 -0
  138. data/spec/models/customer_profile_integration_request_v2_spec.rb +1 -1
  139. data/spec/models/environment_spec.rb +30 -0
  140. data/spec/models/export_spec.rb +1 -1
  141. data/spec/models/giveaway_spec.rb +89 -0
  142. data/spec/models/giveaways_pool_spec.rb +89 -0
  143. data/spec/models/import_entity_spec.rb +41 -0
  144. data/spec/models/inline_response20010_spec.rb +1 -1
  145. data/spec/models/inline_response20011_spec.rb +6 -0
  146. data/spec/models/inline_response20012_spec.rb +0 -6
  147. data/spec/models/inline_response20013_spec.rb +1 -1
  148. data/spec/models/inline_response20014_spec.rb +1 -1
  149. data/spec/models/inline_response20016_spec.rb +1 -1
  150. data/spec/models/inline_response20017_spec.rb +1 -1
  151. data/spec/models/inline_response20018_spec.rb +1 -1
  152. data/spec/models/inline_response20019_spec.rb +6 -0
  153. data/spec/models/inline_response20027_spec.rb +6 -0
  154. data/spec/models/inline_response20028_spec.rb +0 -6
  155. data/spec/models/inline_response2006_spec.rb +1 -1
  156. data/spec/models/inline_response2007_spec.rb +1 -1
  157. data/spec/models/inline_response2009_spec.rb +1 -1
  158. data/spec/models/{inline_response20030_spec.rb → inline_response201_spec.rb} +6 -6
  159. data/spec/models/integration_request_spec.rb +1 -1
  160. data/spec/models/integration_state_v2_spec.rb +6 -0
  161. data/spec/models/inventory_coupon_spec.rb +149 -0
  162. data/spec/models/loyalty_program_entity_spec.rb +41 -0
  163. data/spec/models/loyalty_program_spec.rb +6 -0
  164. data/spec/models/loyalty_tier_spec.rb +65 -0
  165. data/spec/models/new_attribute_spec.rb +1 -1
  166. data/spec/models/new_campaign_spec.rb +1 -1
  167. data/spec/models/new_custom_effect_spec.rb +77 -0
  168. data/spec/models/new_giveaways_pool_spec.rb +53 -0
  169. data/spec/models/new_loyalty_tier_spec.rb +47 -0
  170. data/spec/models/new_referral_spec.rb +17 -5
  171. data/spec/models/new_referrals_for_multiple_advocates_spec.rb +83 -0
  172. data/spec/models/referral_constraints_spec.rb +53 -0
  173. data/spec/models/referral_spec.rb +21 -3
  174. data/spec/models/role_spec.rb +12 -0
  175. data/spec/models/update_campaign_spec.rb +1 -1
  176. data/spec/models/update_custom_effect_spec.rb +77 -0
  177. data/spec/models/update_loyalty_tier_spec.rb +47 -0
  178. data/spec/models/update_referral_spec.rb +65 -0
  179. data/spec/models/will_award_giveaway_effect_props_spec.rb +53 -0
  180. metadata +86 -6
@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
11
11
  =end
12
12
 
13
13
  module TalonOne
14
- VERSION = '2.3.0'
14
+ VERSION = '2.4.0'
15
15
  end
@@ -57,6 +57,19 @@ describe 'IntegrationApi' do
57
57
  end
58
58
  end
59
59
 
60
+ # unit tests for create_referrals_for_multiple_advocates
61
+ # Create referral codes for multiple advocates
62
+ # Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
63
+ # @param body
64
+ # @param [Hash] opts the optional parameters
65
+ # @option opts [String] :silent If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
66
+ # @return [InlineResponse201]
67
+ describe 'create_referrals_for_multiple_advocates test' do
68
+ it 'should work' do
69
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
70
+ end
71
+ end
72
+
60
73
  # unit tests for delete_coupon_reservation
61
74
  # Delete coupon reservations
62
75
  # Removes all passed customer profiles reservation from this coupon
@@ -91,6 +104,7 @@ describe 'IntegrationApi' do
91
104
  # @option opts [Boolean] :referrals optional flag to decide if you would like referral information in the response
92
105
  # @option opts [Boolean] :coupons optional flag to decide if you would like coupon information in the response
93
106
  # @option opts [Boolean] :loyalty optional flag to decide if you would like loyalty information in the response
107
+ # @option opts [Boolean] :giveaways optional flag to decide if you would like giveaways information in the response
94
108
  # @return [CustomerInventory]
95
109
  describe 'get_customer_inventory test' do
96
110
  it 'should work' do
@@ -115,7 +129,7 @@ describe 'IntegrationApi' do
115
129
  # Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
116
130
  # @param body
117
131
  # @param [Hash] opts the optional parameters
118
- # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
132
+ # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
119
133
  # @return [IntegrationState]
120
134
  describe 'track_event test' do
121
135
  it 'should work' do
@@ -129,7 +143,7 @@ describe 'IntegrationApi' do
129
143
  # @param integration_id The custom identifier for this profile, must be unique within the account.
130
144
  # @param body
131
145
  # @param [Hash] opts the optional parameters
132
- # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
146
+ # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
133
147
  # @return [IntegrationState]
134
148
  describe 'update_customer_profile test' do
135
149
  it 'should work' do
@@ -156,7 +170,7 @@ describe 'IntegrationApi' do
156
170
  # @param body
157
171
  # @param [Hash] opts the optional parameters
158
172
  # @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 `true`. Only used when `runRuleEngine` is set to `true`.
173
+ # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`.
160
174
  # @return [IntegrationStateV2]
161
175
  describe 'update_customer_profile_v2 test' do
162
176
  it 'should work' do
@@ -183,7 +197,7 @@ describe 'IntegrationApi' do
183
197
  # @param customer_session_id The custom identifier for this session, must be unique within the account.
184
198
  # @param body
185
199
  # @param [Hash] opts the optional parameters
186
- # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
200
+ # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
187
201
  # @return [IntegrationState]
188
202
  describe 'update_customer_session test' do
189
203
  it 'should work' do
@@ -197,7 +211,7 @@ describe 'IntegrationApi' do
197
211
  # @param customer_session_id The custom identifier for this session, must be unique within the account.
198
212
  # @param body
199
213
  # @param [Hash] opts the optional parameters
200
- # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
214
+ # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
201
215
  # @return [IntegrationStateV2]
202
216
  describe 'update_customer_session_v2 test' do
203
217
  it 'should work' do
@@ -102,7 +102,7 @@ describe 'ManagementApi' do
102
102
  # @param campaign_id
103
103
  # @param body
104
104
  # @param [Hash] opts the optional parameters
105
- # @option opts [String] :silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
105
+ # @option opts [String] :silent If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
106
106
  # @return [InlineResponse2004]
107
107
  describe 'create_coupons test' do
108
108
  it 'should work' do
@@ -117,7 +117,7 @@ describe 'ManagementApi' do
117
117
  # @param campaign_id
118
118
  # @param body
119
119
  # @param [Hash] opts the optional parameters
120
- # @option opts [String] :silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
120
+ # @option opts [String] :silent If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
121
121
  # @return [InlineResponse2004]
122
122
  describe 'create_coupons_for_multiple_recipients test' do
123
123
  it 'should work' do
@@ -345,7 +345,7 @@ describe 'ManagementApi' do
345
345
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
346
346
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
347
347
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
348
- # @return [InlineResponse2009]
348
+ # @return [InlineResponse2008]
349
349
  describe 'get_access_logs test' do
350
350
  it 'should work' do
351
351
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -364,7 +364,7 @@ describe 'ManagementApi' do
364
364
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
365
365
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
366
366
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
367
- # @return [InlineResponse20010]
367
+ # @return [InlineResponse2009]
368
368
  describe 'get_access_logs_without_total_count test' do
369
369
  it 'should work' do
370
370
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -414,7 +414,7 @@ describe 'ManagementApi' do
414
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.
415
415
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
416
416
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
417
- # @return [InlineResponse20022]
417
+ # @return [InlineResponse20021]
418
418
  describe 'get_additional_costs test' do
419
419
  it 'should work' do
420
420
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -433,7 +433,7 @@ describe 'ManagementApi' do
433
433
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
434
434
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
435
435
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
436
- # @return [InlineResponse2009]
436
+ # @return [InlineResponse2008]
437
437
  describe 'get_all_access_logs test' do
438
438
  it 'should work' do
439
439
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -443,7 +443,7 @@ describe 'ManagementApi' do
443
443
  # unit tests for get_all_roles
444
444
  # Get all roles
445
445
  # @param [Hash] opts the optional parameters
446
- # @return [InlineResponse20030]
446
+ # @return [InlineResponse20029]
447
447
  describe 'get_all_roles test' do
448
448
  it 'should work' do
449
449
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -492,8 +492,8 @@ describe 'ManagementApi' do
492
492
  # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
493
493
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
494
494
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
495
- # @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.
496
- # @return [InlineResponse20012]
495
+ # @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 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.
496
+ # @return [InlineResponse20011]
497
497
  describe 'get_application_customers test' do
498
498
  it 'should work' do
499
499
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -505,7 +505,7 @@ describe 'ManagementApi' do
505
505
  # Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
506
506
  # @param body
507
507
  # @param [Hash] opts the optional parameters
508
- # @return [InlineResponse20013]
508
+ # @return [InlineResponse20012]
509
509
  describe 'get_application_customers_by_attributes test' do
510
510
  it 'should work' do
511
511
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -520,7 +520,7 @@ describe 'ManagementApi' do
520
520
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
521
521
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
522
522
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
523
- # @return [InlineResponse20019]
523
+ # @return [InlineResponse20018]
524
524
  describe 'get_application_event_types test' do
525
525
  it 'should work' do
526
526
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -546,7 +546,7 @@ describe 'ManagementApi' do
546
546
  # @option opts [String] :referral_code Referral code
547
547
  # @option opts [String] :rule_query Rule name filter for events
548
548
  # @option opts [String] :campaign_query Campaign name filter for events
549
- # @return [InlineResponse20017]
549
+ # @return [InlineResponse20016]
550
550
  describe 'get_application_events test' do
551
551
  it 'should work' do
552
552
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -572,7 +572,7 @@ describe 'ManagementApi' do
572
572
  # @option opts [String] :referral_code Referral code
573
573
  # @option opts [String] :rule_query Rule name filter for events
574
574
  # @option opts [String] :campaign_query Campaign name filter for events
575
- # @return [InlineResponse20018]
575
+ # @return [InlineResponse20017]
576
576
  describe 'get_application_events_without_total_count test' do
577
577
  it 'should work' do
578
578
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -605,7 +605,7 @@ describe 'ManagementApi' do
605
605
  # @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
606
606
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
607
607
  # @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
608
- # @return [InlineResponse20016]
608
+ # @return [InlineResponse20015]
609
609
  describe 'get_application_sessions test' do
610
610
  it 'should work' do
611
611
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -645,7 +645,8 @@ describe 'ManagementApi' do
645
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.
646
646
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
647
647
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
648
- # @return [InlineResponse20021]
648
+ # @option opts [String] :entity Returned attributes will be filtered by supplied entity
649
+ # @return [InlineResponse20020]
649
650
  describe 'get_attributes test' do
650
651
  it 'should work' do
651
652
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -659,8 +660,8 @@ describe 'ManagementApi' do
659
660
  # @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
661
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
661
662
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` 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]
663
+ # @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 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.
664
+ # @return [InlineResponse20019]
664
665
  describe 'get_audiences test' do
665
666
  it 'should work' do
666
667
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -687,7 +688,7 @@ describe 'ManagementApi' do
687
688
  # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
688
689
  # @param [Hash] opts the optional parameters
689
690
  # @option opts [String] :granularity The time interval between the results in the returned time-series.
690
- # @return [InlineResponse20011]
691
+ # @return [InlineResponse20010]
691
692
  describe 'get_campaign_analytics test' do
692
693
  it 'should work' do
693
694
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -743,9 +744,9 @@ describe 'ManagementApi' do
743
744
  # @option opts [Integer] :user_id
744
745
  # @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
746
  # @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.
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.
747
+ # @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 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.
747
748
  # @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.
748
- # @return [InlineResponse20028]
749
+ # @return [InlineResponse20027]
749
750
  describe 'get_changes test' do
750
751
  it 'should work' do
751
752
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -887,7 +888,7 @@ describe 'ManagementApi' do
887
888
  # @option opts [String] :integration_id Only return reports matching the integrationId
888
889
  # @option opts [String] :campaign_name Only return reports matching the campaignName
889
890
  # @option opts [String] :advocate_name Only return reports matching the current customer referrer name
890
- # @return [InlineResponse20014]
891
+ # @return [InlineResponse20013]
891
892
  describe 'get_customer_activity_reports test' do
892
893
  it 'should work' do
893
894
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -908,7 +909,7 @@ describe 'ManagementApi' do
908
909
  # @option opts [String] :integration_id Only return reports matching the integrationId
909
910
  # @option opts [String] :campaign_name Only return reports matching the campaignName
910
911
  # @option opts [String] :advocate_name Only return reports matching the current customer referrer name
911
- # @return [InlineResponse20015]
912
+ # @return [InlineResponse20014]
912
913
  describe 'get_customer_activity_reports_without_total_count test' do
913
914
  it 'should work' do
914
915
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -947,7 +948,7 @@ describe 'ManagementApi' do
947
948
  # @param [Hash] opts the optional parameters
948
949
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
949
950
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
950
- # @return [InlineResponse20013]
951
+ # @return [InlineResponse20012]
951
952
  describe 'get_customer_profiles test' do
952
953
  it 'should work' do
953
954
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -961,7 +962,7 @@ describe 'ManagementApi' do
961
962
  # @param [Hash] opts the optional parameters
962
963
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
963
964
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
964
- # @return [InlineResponse20013]
965
+ # @return [InlineResponse20012]
965
966
  describe 'get_customers_by_attributes test' do
966
967
  it 'should work' do
967
968
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -978,7 +979,7 @@ describe 'ManagementApi' do
978
979
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
979
980
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
980
981
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
981
- # @return [InlineResponse20026]
982
+ # @return [InlineResponse20025]
982
983
  describe 'get_event_types test' do
983
984
  it 'should work' do
984
985
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -994,7 +995,7 @@ describe 'ManagementApi' do
994
995
  # @option opts [Integer] :application_id
995
996
  # @option opts [Integer] :campaign_id
996
997
  # @option opts [String] :entity The name of the entity type that was exported.
997
- # @return [InlineResponse20029]
998
+ # @return [InlineResponse20028]
998
999
  describe 'get_exports test' do
999
1000
  it 'should work' do
1000
1001
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1028,7 +1029,7 @@ describe 'ManagementApi' do
1028
1029
  # unit tests for get_loyalty_programs
1029
1030
  # List all loyalty Programs
1030
1031
  # @param [Hash] opts the optional parameters
1031
- # @return [InlineResponse2008]
1032
+ # @return [InlineResponse2007]
1032
1033
  describe 'get_loyalty_programs test' do
1033
1034
  it 'should work' do
1034
1035
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1060,7 +1061,7 @@ describe 'ManagementApi' do
1060
1061
  # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
1061
1062
  # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
1062
1063
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
1063
- # @return [InlineResponse2006]
1064
+ # @return [InlineResponse201]
1064
1065
  describe 'get_referrals test' do
1065
1066
  it 'should work' do
1066
1067
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1081,7 +1082,7 @@ describe 'ManagementApi' do
1081
1082
  # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
1082
1083
  # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
1083
1084
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
1084
- # @return [InlineResponse2007]
1085
+ # @return [InlineResponse2006]
1085
1086
  describe 'get_referrals_without_total_count test' do
1086
1087
  it 'should work' do
1087
1088
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1146,7 +1147,7 @@ describe 'ManagementApi' do
1146
1147
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1147
1148
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1148
1149
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1149
- # @return [InlineResponse20027]
1150
+ # @return [InlineResponse20026]
1150
1151
  describe 'get_users test' do
1151
1152
  it 'should work' do
1152
1153
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1178,7 +1179,7 @@ describe 'ManagementApi' do
1178
1179
  # @option opts [Float] :campaign_id Filter results by campaign.
1179
1180
  # @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
1181
  # @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]
1182
+ # @return [InlineResponse20023]
1182
1183
  describe 'get_webhook_activation_logs test' do
1183
1184
  it 'should work' do
1184
1185
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1198,7 +1199,7 @@ describe 'ManagementApi' do
1198
1199
  # @option opts [String] :request_uuid Filter results by request UUID.
1199
1200
  # @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
1201
  # @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]
1202
+ # @return [InlineResponse20024]
1202
1203
  describe 'get_webhook_logs test' do
1203
1204
  it 'should work' do
1204
1205
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1212,13 +1213,67 @@ describe 'ManagementApi' do
1212
1213
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1213
1214
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1214
1215
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1215
- # @return [InlineResponse20023]
1216
+ # @return [InlineResponse20022]
1216
1217
  describe 'get_webhooks test' do
1217
1218
  it 'should work' do
1218
1219
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1219
1220
  end
1220
1221
  end
1221
1222
 
1223
+ # unit tests for import_coupons
1224
+ # Import coupons via CSV file
1225
+ # Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
1226
+ # @param application_id
1227
+ # @param campaign_id
1228
+ # @param [Hash] opts the optional parameters
1229
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1230
+ # @return [Import]
1231
+ describe 'import_coupons test' do
1232
+ it 'should work' do
1233
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1234
+ end
1235
+ end
1236
+
1237
+ # unit tests for import_loyalty_points
1238
+ # Import loyalty points via CSV file
1239
+ # Upload a CSV file containing the loyalty points that should be created. The file should be sent as multipart data.
1240
+ # @param program_id
1241
+ # @param [Hash] opts the optional parameters
1242
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1243
+ # @return [Import]
1244
+ describe 'import_loyalty_points test' do
1245
+ it 'should work' do
1246
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1247
+ end
1248
+ end
1249
+
1250
+ # unit tests for import_pool_giveaways
1251
+ # Import giveaways codes into a giveaways pool
1252
+ # Upload a CSV file containing the giveaways codes that should be created. Send the file as multipart data. The CSV file can contain the following columns: - `code` (required): the code of your giveaway, for instance, a gift card redemption code. - `startdate`: the start date in RFC3339 of the code redemption period. - `enddate`: the last date in RFC3339 of the code redemption period. - `attributes`: A json object describing _custom_ giveaways attribute names and their values. Double the double-quotes in the object. For example, if you created a custom attribute called `provider`, set it with `\"{\"\"provider\"\": \"\"myPartnerCompany\"\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the timezone of your choice. It is converted to UTC internally by Talon.One.
1253
+ # @param pool_id
1254
+ # @param [Hash] opts the optional parameters
1255
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1256
+ # @return [Import]
1257
+ describe 'import_pool_giveaways test' do
1258
+ it 'should work' do
1259
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1260
+ end
1261
+ end
1262
+
1263
+ # unit tests for import_referrals
1264
+ # Import referrals via CSV file
1265
+ # Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file can contain the following colums: - `code` (required): the referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: the start date in RFC3339 of the code redemption period. - `expirydate`: the end date in RFC3339 of the code redemption period. - `limitval`: The maximum amount of redemptions of this code. Unlimited (0) when blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. For example, if you created a custom attribute called `category`, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. You can use the timezone of your choice. It is converted to UTC internally by Talon.One.
1266
+ # @param application_id
1267
+ # @param campaign_id
1268
+ # @param [Hash] opts the optional parameters
1269
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1270
+ # @return [Import]
1271
+ describe 'import_referrals test' do
1272
+ it 'should work' do
1273
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1274
+ end
1275
+ end
1276
+
1222
1277
  # unit tests for remove_loyalty_points
1223
1278
  # Deduct points in a certain loyalty program for the specified customer
1224
1279
  # @param program_id
@@ -1414,6 +1469,20 @@ describe 'ManagementApi' do
1414
1469
  end
1415
1470
  end
1416
1471
 
1472
+ # unit tests for update_referral
1473
+ # Update one Referral
1474
+ # @param application_id
1475
+ # @param campaign_id
1476
+ # @param referral_id The ID of the referral code to delete
1477
+ # @param body
1478
+ # @param [Hash] opts the optional parameters
1479
+ # @return [Referral]
1480
+ describe 'update_referral test' do
1481
+ it 'should work' do
1482
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1483
+ end
1484
+ end
1485
+
1417
1486
  # unit tests for update_ruleset
1418
1487
  # Update a Ruleset
1419
1488
  # @param application_id
@@ -0,0 +1,71 @@
1
+ =begin
2
+ #Talon.One API
3
+
4
+ #The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for TalonOne::ApplicationCampaignStats
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe 'ApplicationCampaignStats' do
21
+ before do
22
+ # run before each test
23
+ @instance = TalonOne::ApplicationCampaignStats.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of ApplicationCampaignStats' do
31
+ it 'should create an instance of ApplicationCampaignStats' do
32
+ expect(@instance).to be_instance_of(TalonOne::ApplicationCampaignStats)
33
+ end
34
+ end
35
+ describe 'test attribute "draft"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "disabled"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ describe 'test attribute "scheduled"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ describe 'test attribute "running"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ describe 'test attribute "expired"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ end
63
+ end
64
+
65
+ describe 'test attribute "archived"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ end