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
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
8
8
  [**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
9
+ [**create_referrals_for_multiple_advocates**](IntegrationApi.md#create_referrals_for_multiple_advocates) | **POST** /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates
9
10
  [**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
10
11
  [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
11
12
  [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
@@ -140,6 +141,69 @@ Name | Type | Description | Notes
140
141
  - **Accept**: application/json
141
142
 
142
143
 
144
+ ## create_referrals_for_multiple_advocates
145
+
146
+ > InlineResponse201 create_referrals_for_multiple_advocates(body, opts)
147
+
148
+ Create referral codes for multiple advocates
149
+
150
+ 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.
151
+
152
+ ### Example
153
+
154
+ ```ruby
155
+ # load the gem
156
+ require 'talon_one'
157
+ # setup authorization
158
+ TalonOne.configure do |config|
159
+ # Configure API key authorization: api_key_v1
160
+ config.api_key['Authorization'] = 'YOUR API KEY'
161
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
162
+ #config.api_key_prefix['Authorization'] = 'Bearer'
163
+
164
+ # Configure API key authorization: integration_auth
165
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
166
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
167
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
168
+ end
169
+
170
+ api_instance = TalonOne::IntegrationApi.new
171
+ body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates |
172
+ opts = {
173
+ silent: 'silent_example' # String | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
174
+ }
175
+
176
+ begin
177
+ #Create referral codes for multiple advocates
178
+ result = api_instance.create_referrals_for_multiple_advocates(body, opts)
179
+ p result
180
+ rescue TalonOne::ApiError => e
181
+ puts "Exception when calling IntegrationApi->create_referrals_for_multiple_advocates: #{e}"
182
+ end
183
+ ```
184
+
185
+ ### Parameters
186
+
187
+
188
+ Name | Type | Description | Notes
189
+ ------------- | ------------- | ------------- | -------------
190
+ **body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md)| |
191
+ **silent** | **String**| If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | [optional]
192
+
193
+ ### Return type
194
+
195
+ [**InlineResponse201**](InlineResponse201.md)
196
+
197
+ ### Authorization
198
+
199
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
200
+
201
+ ### HTTP request headers
202
+
203
+ - **Content-Type**: application/json
204
+ - **Accept**: application/json
205
+
206
+
143
207
  ## delete_coupon_reservation
144
208
 
145
209
  > delete_coupon_reservation(coupon_value, body)
@@ -290,7 +354,8 @@ opts = {
290
354
  profile: true, # Boolean | optional flag to decide if you would like customer profile information in the response
291
355
  referrals: true, # Boolean | optional flag to decide if you would like referral information in the response
292
356
  coupons: true, # Boolean | optional flag to decide if you would like coupon information in the response
293
- loyalty: true # Boolean | optional flag to decide if you would like loyalty information in the response
357
+ loyalty: true, # Boolean | optional flag to decide if you would like loyalty information in the response
358
+ giveaways: true # Boolean | optional flag to decide if you would like giveaways information in the response
294
359
  }
295
360
 
296
361
  begin
@@ -312,6 +377,7 @@ Name | Type | Description | Notes
312
377
  **referrals** | **Boolean**| optional flag to decide if you would like referral information in the response | [optional]
313
378
  **coupons** | **Boolean**| optional flag to decide if you would like coupon information in the response | [optional]
314
379
  **loyalty** | **Boolean**| optional flag to decide if you would like loyalty information in the response | [optional]
380
+ **giveaways** | **Boolean**| optional flag to decide if you would like giveaways information in the response | [optional]
315
381
 
316
382
  ### Return type
317
383
 
@@ -415,7 +481,7 @@ end
415
481
  api_instance = TalonOne::IntegrationApi.new
416
482
  body = TalonOne::NewEvent.new # NewEvent |
417
483
  opts = {
418
- dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
484
+ dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
419
485
  }
420
486
 
421
487
  begin
@@ -433,7 +499,7 @@ end
433
499
  Name | Type | Description | Notes
434
500
  ------------- | ------------- | ------------- | -------------
435
501
  **body** | [**NewEvent**](NewEvent.md)| |
436
- **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
502
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
437
503
 
438
504
  ### Return type
439
505
 
@@ -479,7 +545,7 @@ api_instance = TalonOne::IntegrationApi.new
479
545
  integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
480
546
  body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
481
547
  opts = {
482
- dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
548
+ dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
483
549
  }
484
550
 
485
551
  begin
@@ -498,7 +564,7 @@ Name | Type | Description | Notes
498
564
  ------------- | ------------- | ------------- | -------------
499
565
  **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
500
566
  **body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
501
- **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
567
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
502
568
 
503
569
  ### Return type
504
570
 
@@ -593,7 +659,7 @@ integration_id = 'integration_id_example' # String | The custom identifier for t
593
659
  body = TalonOne::CustomerProfileIntegrationRequestV2.new # CustomerProfileIntegrationRequestV2 |
594
660
  opts = {
595
661
  run_rule_engine: false, # Boolean | Indicates whether to run the rule engine.
596
- dry: true # Boolean | Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`.
662
+ dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`.
597
663
  }
598
664
 
599
665
  begin
@@ -613,7 +679,7 @@ Name | Type | Description | Notes
613
679
  **integration_id** | **String**| The custom identifier for this profile. Must be unique within the account. |
614
680
  **body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md)| |
615
681
  **run_rule_engine** | **Boolean**| Indicates whether to run the rule engine. | [optional] [default to false]
616
- **dry** | **Boolean**| Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`. | [optional]
682
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`. | [optional]
617
683
 
618
684
  ### Return type
619
685
 
@@ -717,7 +783,7 @@ api_instance = TalonOne::IntegrationApi.new
717
783
  customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
718
784
  body = TalonOne::NewCustomerSession.new # NewCustomerSession |
719
785
  opts = {
720
- dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
786
+ dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
721
787
  }
722
788
 
723
789
  begin
@@ -736,7 +802,7 @@ Name | Type | Description | Notes
736
802
  ------------- | ------------- | ------------- | -------------
737
803
  **customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
738
804
  **body** | [**NewCustomerSession**](NewCustomerSession.md)| |
739
- **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
805
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
740
806
 
741
807
  ### Return type
742
808
 
@@ -777,7 +843,7 @@ api_instance = TalonOne::IntegrationApi.new
777
843
  customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
778
844
  body = TalonOne::IntegrationRequest.new # IntegrationRequest |
779
845
  opts = {
780
- dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
846
+ dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
781
847
  }
782
848
 
783
849
  begin
@@ -796,7 +862,7 @@ Name | Type | Description | Notes
796
862
  ------------- | ------------- | ------------- | -------------
797
863
  **customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
798
864
  **body** | [**IntegrationRequest**](IntegrationRequest.md)| |
799
- **dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
865
+ **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
800
866
 
801
867
  ### Return type
802
868
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **customer_session** | [**NewCustomerSessionV2**](NewCustomerSessionV2.md) | |
8
- **response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\", \"event\" and \"ruleFailureReasons\". | [optional]
8
+ **response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\", \"event\", \"awardedGiveaways\" and \"ruleFailureReasons\". | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
15
15
  **rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | | [optional]
16
16
  **created_coupons** | [**Array<Coupon>**](Coupon.md) | |
17
17
  **created_referrals** | [**Array<Referral>**](Referral.md) | |
18
+ **awarded_giveaways** | [**Array<Giveaway>**](Giveaway.md) | | [optional]
18
19
 
19
20
  ## Code Sample
20
21
 
@@ -31,7 +32,8 @@ instance = TalonOne::IntegrationStateV2.new(customer_session: null,
31
32
  effects: null,
32
33
  rule_failure_reasons: null,
33
34
  created_coupons: null,
34
- created_referrals: null)
35
+ created_referrals: null,
36
+ awarded_giveaways: null)
35
37
  ```
36
38
 
37
39
 
@@ -0,0 +1,53 @@
1
+ # TalonOne::InventoryCoupon
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | Unique ID for this entity. |
8
+ **created** | **DateTime** | The exact moment this entity was created. |
9
+ **campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
10
+ **value** | **String** | The actual coupon code. |
11
+ **usage_limit** | **Integer** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. |
12
+ **discount_limit** | **Float** | The amount of discounts that can be given with this coupon code. | [optional]
13
+ **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
14
+ **expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
15
+ **usage_counter** | **Integer** | The number of times this coupon has been successfully used. |
16
+ **discount_counter** | **Float** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional]
17
+ **discount_remainder** | **Float** | The remaining discount this coupon can give. | [optional]
18
+ **attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
19
+ **referral_id** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional]
20
+ **recipient_integration_id** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional]
21
+ **import_id** | **Integer** | The ID of the Import which created this coupon. | [optional]
22
+ **reservation** | **Boolean** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional]
23
+ **batch_id** | **String** | The id of the batch the coupon belongs to. | [optional]
24
+ **profile_redemption_count** | **Integer** | The number of times the coupon was redeemed by the profile. |
25
+ **state** | **String** | Can be either active, used, expired, or pending. active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter. used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration. expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile. pending: coupons that have a start date in the future. |
26
+
27
+ ## Code Sample
28
+
29
+ ```ruby
30
+ require 'TalonOne'
31
+
32
+ instance = TalonOne::InventoryCoupon.new(id: null,
33
+ created: null,
34
+ campaign_id: null,
35
+ value: null,
36
+ usage_limit: null,
37
+ discount_limit: null,
38
+ start_date: null,
39
+ expiry_date: null,
40
+ usage_counter: null,
41
+ discount_counter: null,
42
+ discount_remainder: null,
43
+ attributes: null,
44
+ referral_id: null,
45
+ recipient_integration_id: null,
46
+ import_id: null,
47
+ reservation: null,
48
+ batch_id: null,
49
+ profile_redemption_count: null,
50
+ state: null)
51
+ ```
52
+
53
+
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **default_validity** | **String** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. |
14
14
  **default_pending** | **String** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. |
15
15
  **allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program |
16
+ **tiers** | [**Array<LoyaltyTier>**](LoyaltyTier.md) | The tiers in this loyalty program | [optional]
16
17
 
17
18
  ## Code Sample
18
19
 
@@ -27,7 +28,8 @@ instance = TalonOne::LoyaltyProgram.new(id: null,
27
28
  subscribed_applications: null,
28
29
  default_validity: null,
29
30
  default_pending: null,
30
- allow_subledger: null)
31
+ allow_subledger: null,
32
+ tiers: null)
31
33
  ```
32
34
 
33
35
 
@@ -0,0 +1,17 @@
1
+ # TalonOne::LoyaltyProgramEntity
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **program_id** | **Integer** | The ID of the loyalty program that owns this entity. |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'TalonOne'
13
+
14
+ instance = TalonOne::LoyaltyProgramEntity.new(program_id: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,25 @@
1
+ # TalonOne::LoyaltyTier
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | Unique ID for this entity. |
8
+ **created** | **DateTime** | The exact moment this entity was created. |
9
+ **program_id** | **Integer** | The ID of the loyalty program that owns this entity. |
10
+ **name** | **String** | The name of the tier |
11
+ **min_points** | **Float** | The minimum amount of points required to be eligible for the tier |
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'TalonOne'
17
+
18
+ instance = TalonOne::LoyaltyTier.new(id: null,
19
+ created: null,
20
+ program_id: null,
21
+ name: null,
22
+ min_points: null)
23
+ ```
24
+
25
+
@@ -80,6 +80,10 @@ Method | HTTP request | Description
80
80
  [**get_webhook_activation_logs**](ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List Webhook activation Log Entries
81
81
  [**get_webhook_logs**](ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List Webhook Log Entries
82
82
  [**get_webhooks**](ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List Webhooks
83
+ [**import_coupons**](ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons via CSV file
84
+ [**import_loyalty_points**](ManagementApi.md#import_loyalty_points) | **POST** /v1/loyalty_programs/{programID}/import_points | Import loyalty points via CSV file
85
+ [**import_pool_giveaways**](ManagementApi.md#import_pool_giveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaways codes into a giveaways pool
86
+ [**import_referrals**](ManagementApi.md#import_referrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals via CSV file
83
87
  [**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in a certain loyalty program for the specified customer
84
88
  [**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
85
89
  [**search_coupons_advanced**](ManagementApi.md#search_coupons_advanced) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes (with total count)
@@ -91,6 +95,7 @@ Method | HTTP request | Description
91
95
  [**update_campaign**](ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
92
96
  [**update_coupon**](ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
93
97
  [**update_coupon_batch**](ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons
98
+ [**update_referral**](ManagementApi.md#update_referral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update one Referral
94
99
  [**update_ruleset**](ManagementApi.md#update_ruleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset
95
100
 
96
101
 
@@ -396,7 +401,7 @@ application_id = 56 # Integer |
396
401
  campaign_id = 56 # Integer |
397
402
  body = TalonOne::NewCoupons.new # NewCoupons |
398
403
  opts = {
399
- silent: 'silent_example' # String | If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
404
+ silent: 'silent_example' # String | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
400
405
  }
401
406
 
402
407
  begin
@@ -416,7 +421,7 @@ Name | Type | Description | Notes
416
421
  **application_id** | **Integer**| |
417
422
  **campaign_id** | **Integer**| |
418
423
  **body** | [**NewCoupons**](NewCoupons.md)| |
419
- **silent** | **String**| If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000). | [optional]
424
+ **silent** | **String**| If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | [optional]
420
425
 
421
426
  ### Return type
422
427
 
@@ -458,7 +463,7 @@ application_id = 56 # Integer |
458
463
  campaign_id = 56 # Integer |
459
464
  body = TalonOne::NewCouponsForMultipleRecipients.new # NewCouponsForMultipleRecipients |
460
465
  opts = {
461
- silent: 'silent_example' # String | If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
466
+ silent: 'silent_example' # String | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
462
467
  }
463
468
 
464
469
  begin
@@ -478,7 +483,7 @@ Name | Type | Description | Notes
478
483
  **application_id** | **Integer**| |
479
484
  **campaign_id** | **Integer**| |
480
485
  **body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md)| |
481
- **silent** | **String**| If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000). | [optional]
486
+ **silent** | **String**| If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | [optional]
482
487
 
483
488
  ### Return type
484
489
 
@@ -1334,7 +1339,7 @@ Name | Type | Description | Notes
1334
1339
 
1335
1340
  ## get_access_logs
1336
1341
 
1337
- > InlineResponse2009 get_access_logs(application_id, range_start, range_end, opts)
1342
+ > InlineResponse2008 get_access_logs(application_id, range_start, range_end, opts)
1338
1343
 
1339
1344
  Get access logs for application (with total count)
1340
1345
 
@@ -1390,7 +1395,7 @@ Name | Type | Description | Notes
1390
1395
 
1391
1396
  ### Return type
1392
1397
 
1393
- [**InlineResponse2009**](InlineResponse2009.md)
1398
+ [**InlineResponse2008**](InlineResponse2008.md)
1394
1399
 
1395
1400
  ### Authorization
1396
1401
 
@@ -1404,7 +1409,7 @@ Name | Type | Description | Notes
1404
1409
 
1405
1410
  ## get_access_logs_without_total_count
1406
1411
 
1407
- > InlineResponse20010 get_access_logs_without_total_count(application_id, range_start, range_end, opts)
1412
+ > InlineResponse2009 get_access_logs_without_total_count(application_id, range_start, range_end, opts)
1408
1413
 
1409
1414
  Get access logs for application
1410
1415
 
@@ -1460,7 +1465,7 @@ Name | Type | Description | Notes
1460
1465
 
1461
1466
  ### Return type
1462
1467
 
1463
- [**InlineResponse20010**](InlineResponse20010.md)
1468
+ [**InlineResponse2009**](InlineResponse2009.md)
1464
1469
 
1465
1470
  ### Authorization
1466
1471
 
@@ -1636,7 +1641,7 @@ Name | Type | Description | Notes
1636
1641
 
1637
1642
  ## get_additional_costs
1638
1643
 
1639
- > InlineResponse20022 get_additional_costs(opts)
1644
+ > InlineResponse20021 get_additional_costs(opts)
1640
1645
 
1641
1646
  List additional costs
1642
1647
 
@@ -1682,7 +1687,7 @@ Name | Type | Description | Notes
1682
1687
 
1683
1688
  ### Return type
1684
1689
 
1685
- [**InlineResponse20022**](InlineResponse20022.md)
1690
+ [**InlineResponse20021**](InlineResponse20021.md)
1686
1691
 
1687
1692
  ### Authorization
1688
1693
 
@@ -1696,7 +1701,7 @@ Name | Type | Description | Notes
1696
1701
 
1697
1702
  ## get_all_access_logs
1698
1703
 
1699
- > InlineResponse2009 get_all_access_logs(range_start, range_end, opts)
1704
+ > InlineResponse2008 get_all_access_logs(range_start, range_end, opts)
1700
1705
 
1701
1706
  Get all access logs
1702
1707
 
@@ -1752,7 +1757,7 @@ Name | Type | Description | Notes
1752
1757
 
1753
1758
  ### Return type
1754
1759
 
1755
- [**InlineResponse2009**](InlineResponse2009.md)
1760
+ [**InlineResponse2008**](InlineResponse2008.md)
1756
1761
 
1757
1762
  ### Authorization
1758
1763
 
@@ -1766,7 +1771,7 @@ Name | Type | Description | Notes
1766
1771
 
1767
1772
  ## get_all_roles
1768
1773
 
1769
- > InlineResponse20030 get_all_roles
1774
+ > InlineResponse20029 get_all_roles
1770
1775
 
1771
1776
  Get all roles
1772
1777
 
@@ -1800,7 +1805,7 @@ This endpoint does not need any parameter.
1800
1805
 
1801
1806
  ### Return type
1802
1807
 
1803
- [**InlineResponse20030**](InlineResponse20030.md)
1808
+ [**InlineResponse20029**](InlineResponse20029.md)
1804
1809
 
1805
1810
  ### Authorization
1806
1811
 
@@ -1974,7 +1979,7 @@ Name | Type | Description | Notes
1974
1979
 
1975
1980
  ## get_application_customers
1976
1981
 
1977
- > InlineResponse20012 get_application_customers(application_id, opts)
1982
+ > InlineResponse20011 get_application_customers(application_id, opts)
1978
1983
 
1979
1984
  List Application Customers
1980
1985
 
@@ -1997,7 +2002,7 @@ opts = {
1997
2002
  integration_id: 'integration_id_example', # String | Filter results performing an exact matching against the profile integration identifier.
1998
2003
  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1999
2004
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2000
- with_total_result_size: true # Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
2005
+ with_total_result_size: true # Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be 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.
2001
2006
  }
2002
2007
 
2003
2008
  begin
@@ -2018,11 +2023,11 @@ Name | Type | Description | Notes
2018
2023
  **integration_id** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
2019
2024
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
2020
2025
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2021
- **with_total_result_size** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. | [optional]
2026
+ **with_total_result_size** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | [optional]
2022
2027
 
2023
2028
  ### Return type
2024
2029
 
2025
- [**InlineResponse20012**](InlineResponse20012.md)
2030
+ [**InlineResponse20011**](InlineResponse20011.md)
2026
2031
 
2027
2032
  ### Authorization
2028
2033
 
@@ -2036,7 +2041,7 @@ Name | Type | Description | Notes
2036
2041
 
2037
2042
  ## get_application_customers_by_attributes
2038
2043
 
2039
- > InlineResponse20013 get_application_customers_by_attributes(body)
2044
+ > InlineResponse20012 get_application_customers_by_attributes(body)
2040
2045
 
2041
2046
  Get a list of the customer profiles that match the given attributes (with total count)
2042
2047
 
@@ -2076,7 +2081,7 @@ Name | Type | Description | Notes
2076
2081
 
2077
2082
  ### Return type
2078
2083
 
2079
- [**InlineResponse20013**](InlineResponse20013.md)
2084
+ [**InlineResponse20012**](InlineResponse20012.md)
2080
2085
 
2081
2086
  ### Authorization
2082
2087
 
@@ -2090,7 +2095,7 @@ Name | Type | Description | Notes
2090
2095
 
2091
2096
  ## get_application_event_types
2092
2097
 
2093
- > InlineResponse20019 get_application_event_types(application_id, opts)
2098
+ > InlineResponse20018 get_application_event_types(application_id, opts)
2094
2099
 
2095
2100
  List Applications Event Types
2096
2101
 
@@ -2138,7 +2143,7 @@ Name | Type | Description | Notes
2138
2143
 
2139
2144
  ### Return type
2140
2145
 
2141
- [**InlineResponse20019**](InlineResponse20019.md)
2146
+ [**InlineResponse20018**](InlineResponse20018.md)
2142
2147
 
2143
2148
  ### Authorization
2144
2149
 
@@ -2152,7 +2157,7 @@ Name | Type | Description | Notes
2152
2157
 
2153
2158
  ## get_application_events
2154
2159
 
2155
- > InlineResponse20017 get_application_events(application_id, opts)
2160
+ > InlineResponse20016 get_application_events(application_id, opts)
2156
2161
 
2157
2162
  List Applications Events (with total count)
2158
2163
 
@@ -2222,7 +2227,7 @@ Name | Type | Description | Notes
2222
2227
 
2223
2228
  ### Return type
2224
2229
 
2225
- [**InlineResponse20017**](InlineResponse20017.md)
2230
+ [**InlineResponse20016**](InlineResponse20016.md)
2226
2231
 
2227
2232
  ### Authorization
2228
2233
 
@@ -2236,7 +2241,7 @@ Name | Type | Description | Notes
2236
2241
 
2237
2242
  ## get_application_events_without_total_count
2238
2243
 
2239
- > InlineResponse20018 get_application_events_without_total_count(application_id, opts)
2244
+ > InlineResponse20017 get_application_events_without_total_count(application_id, opts)
2240
2245
 
2241
2246
  List Applications Events
2242
2247
 
@@ -2306,7 +2311,7 @@ Name | Type | Description | Notes
2306
2311
 
2307
2312
  ### Return type
2308
2313
 
2309
- [**InlineResponse20018**](InlineResponse20018.md)
2314
+ [**InlineResponse20017**](InlineResponse20017.md)
2310
2315
 
2311
2316
  ### Authorization
2312
2317
 
@@ -2374,7 +2379,7 @@ Name | Type | Description | Notes
2374
2379
 
2375
2380
  ## get_application_sessions
2376
2381
 
2377
- > InlineResponse20016 get_application_sessions(application_id, opts)
2382
+ > InlineResponse20015 get_application_sessions(application_id, opts)
2378
2383
 
2379
2384
  List Application Sessions
2380
2385
 
@@ -2434,7 +2439,7 @@ Name | Type | Description | Notes
2434
2439
 
2435
2440
  ### Return type
2436
2441
 
2437
- [**InlineResponse20016**](InlineResponse20016.md)
2442
+ [**InlineResponse20015**](InlineResponse20015.md)
2438
2443
 
2439
2444
  ### Authorization
2440
2445
 
@@ -2562,7 +2567,7 @@ Name | Type | Description | Notes
2562
2567
 
2563
2568
  ## get_attributes
2564
2569
 
2565
- > InlineResponse20021 get_attributes(opts)
2570
+ > InlineResponse20020 get_attributes(opts)
2566
2571
 
2567
2572
  List custom attributes
2568
2573
 
@@ -2585,7 +2590,8 @@ api_instance = TalonOne::ManagementApi.new
2585
2590
  opts = {
2586
2591
  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
2587
2592
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2588
- sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
2593
+ sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
2594
+ entity: 'entity_example' # String | Returned attributes will be filtered by supplied entity
2589
2595
  }
2590
2596
 
2591
2597
  begin
@@ -2605,10 +2611,11 @@ Name | Type | Description | Notes
2605
2611
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
2606
2612
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2607
2613
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
2614
+ **entity** | **String**| Returned attributes will be filtered by supplied entity | [optional]
2608
2615
 
2609
2616
  ### Return type
2610
2617
 
2611
- [**InlineResponse20021**](InlineResponse20021.md)
2618
+ [**InlineResponse20020**](InlineResponse20020.md)
2612
2619
 
2613
2620
  ### Authorization
2614
2621
 
@@ -2622,7 +2629,7 @@ Name | Type | Description | Notes
2622
2629
 
2623
2630
  ## get_audiences
2624
2631
 
2625
- > InlineResponse20020 get_audiences(opts)
2632
+ > InlineResponse20019 get_audiences(opts)
2626
2633
 
2627
2634
  Get all audiences
2628
2635
 
@@ -2646,7 +2653,7 @@ opts = {
2646
2653
  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
2647
2654
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2648
2655
  sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
2649
- with_total_result_size: true # Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
2656
+ with_total_result_size: true # Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query.
2650
2657
  }
2651
2658
 
2652
2659
  begin
@@ -2666,11 +2673,11 @@ Name | Type | Description | Notes
2666
2673
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
2667
2674
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2668
2675
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
2669
- **with_total_result_size** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. | [optional]
2676
+ **with_total_result_size** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | [optional]
2670
2677
 
2671
2678
  ### Return type
2672
2679
 
2673
- [**InlineResponse20020**](InlineResponse20020.md)
2680
+ [**InlineResponse20019**](InlineResponse20019.md)
2674
2681
 
2675
2682
  ### Authorization
2676
2683
 
@@ -2738,7 +2745,7 @@ Name | Type | Description | Notes
2738
2745
 
2739
2746
  ## get_campaign_analytics
2740
2747
 
2741
- > InlineResponse20011 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
2748
+ > InlineResponse20010 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
2742
2749
 
2743
2750
  Get analytics of campaigns
2744
2751
 
@@ -2786,7 +2793,7 @@ Name | Type | Description | Notes
2786
2793
 
2787
2794
  ### Return type
2788
2795
 
2789
- [**InlineResponse20011**](InlineResponse20011.md)
2796
+ [**InlineResponse20010**](InlineResponse20010.md)
2790
2797
 
2791
2798
  ### Authorization
2792
2799
 
@@ -2938,7 +2945,7 @@ Name | Type | Description | Notes
2938
2945
 
2939
2946
  ## get_changes
2940
2947
 
2941
- > InlineResponse20028 get_changes(opts)
2948
+ > InlineResponse20027 get_changes(opts)
2942
2949
 
2943
2950
  Get audit log for an account
2944
2951
 
@@ -2967,7 +2974,7 @@ opts = {
2967
2974
  user_id: 56, # Integer |
2968
2975
  created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
2969
2976
  created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
2970
- with_total_result_size: true, # Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
2977
+ with_total_result_size: true, # Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be 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.
2971
2978
  include_old: true # Boolean | When this flag is set to false, the state without the change will not be returned. The default value is true.
2972
2979
  }
2973
2980
 
@@ -2993,12 +3000,12 @@ Name | Type | Description | Notes
2993
3000
  **user_id** | **Integer**| | [optional]
2994
3001
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
2995
3002
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | [optional]
2996
- **with_total_result_size** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. | [optional]
3003
+ **with_total_result_size** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | [optional]
2997
3004
  **include_old** | **Boolean**| When this flag is set to false, the state without the change will not be returned. The default value is true. | [optional]
2998
3005
 
2999
3006
  ### Return type
3000
3007
 
3001
- [**InlineResponse20028**](InlineResponse20028.md)
3008
+ [**InlineResponse20027**](InlineResponse20027.md)
3002
3009
 
3003
3010
  ### Authorization
3004
3011
 
@@ -3414,7 +3421,7 @@ Name | Type | Description | Notes
3414
3421
 
3415
3422
  ## get_customer_activity_reports
3416
3423
 
3417
- > InlineResponse20014 get_customer_activity_reports(range_start, range_end, application_id, opts)
3424
+ > InlineResponse20013 get_customer_activity_reports(range_start, range_end, application_id, opts)
3418
3425
 
3419
3426
  Get Activity Reports for Application Customers (with total count)
3420
3427
 
@@ -3474,7 +3481,7 @@ Name | Type | Description | Notes
3474
3481
 
3475
3482
  ### Return type
3476
3483
 
3477
- [**InlineResponse20014**](InlineResponse20014.md)
3484
+ [**InlineResponse20013**](InlineResponse20013.md)
3478
3485
 
3479
3486
  ### Authorization
3480
3487
 
@@ -3488,7 +3495,7 @@ Name | Type | Description | Notes
3488
3495
 
3489
3496
  ## get_customer_activity_reports_without_total_count
3490
3497
 
3491
- > InlineResponse20015 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
3498
+ > InlineResponse20014 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
3492
3499
 
3493
3500
  Get Activity Reports for Application Customers
3494
3501
 
@@ -3548,7 +3555,7 @@ Name | Type | Description | Notes
3548
3555
 
3549
3556
  ### Return type
3550
3557
 
3551
- [**InlineResponse20015**](InlineResponse20015.md)
3558
+ [**InlineResponse20014**](InlineResponse20014.md)
3552
3559
 
3553
3560
  ### Authorization
3554
3561
 
@@ -3678,7 +3685,7 @@ Name | Type | Description | Notes
3678
3685
 
3679
3686
  ## get_customer_profiles
3680
3687
 
3681
- > InlineResponse20013 get_customer_profiles(opts)
3688
+ > InlineResponse20012 get_customer_profiles(opts)
3682
3689
 
3683
3690
  List Customer Profiles
3684
3691
 
@@ -3720,7 +3727,7 @@ Name | Type | Description | Notes
3720
3727
 
3721
3728
  ### Return type
3722
3729
 
3723
- [**InlineResponse20013**](InlineResponse20013.md)
3730
+ [**InlineResponse20012**](InlineResponse20012.md)
3724
3731
 
3725
3732
  ### Authorization
3726
3733
 
@@ -3734,7 +3741,7 @@ Name | Type | Description | Notes
3734
3741
 
3735
3742
  ## get_customers_by_attributes
3736
3743
 
3737
- > InlineResponse20013 get_customers_by_attributes(body, opts)
3744
+ > InlineResponse20012 get_customers_by_attributes(body, opts)
3738
3745
 
3739
3746
  Get a list of the customer profiles that match the given attributes
3740
3747
 
@@ -3780,7 +3787,7 @@ Name | Type | Description | Notes
3780
3787
 
3781
3788
  ### Return type
3782
3789
 
3783
- [**InlineResponse20013**](InlineResponse20013.md)
3790
+ [**InlineResponse20012**](InlineResponse20012.md)
3784
3791
 
3785
3792
  ### Authorization
3786
3793
 
@@ -3794,7 +3801,7 @@ Name | Type | Description | Notes
3794
3801
 
3795
3802
  ## get_event_types
3796
3803
 
3797
- > InlineResponse20026 get_event_types(opts)
3804
+ > InlineResponse20025 get_event_types(opts)
3798
3805
 
3799
3806
  List Event Types
3800
3807
 
@@ -3846,7 +3853,7 @@ Name | Type | Description | Notes
3846
3853
 
3847
3854
  ### Return type
3848
3855
 
3849
- [**InlineResponse20026**](InlineResponse20026.md)
3856
+ [**InlineResponse20025**](InlineResponse20025.md)
3850
3857
 
3851
3858
  ### Authorization
3852
3859
 
@@ -3860,7 +3867,7 @@ Name | Type | Description | Notes
3860
3867
 
3861
3868
  ## get_exports
3862
3869
 
3863
- > InlineResponse20029 get_exports(opts)
3870
+ > InlineResponse20028 get_exports(opts)
3864
3871
 
3865
3872
  Get Exports
3866
3873
 
@@ -3910,7 +3917,7 @@ Name | Type | Description | Notes
3910
3917
 
3911
3918
  ### Return type
3912
3919
 
3913
- [**InlineResponse20029**](InlineResponse20029.md)
3920
+ [**InlineResponse20028**](InlineResponse20028.md)
3914
3921
 
3915
3922
  ### Authorization
3916
3923
 
@@ -3998,7 +4005,7 @@ TalonOne.configure do |config|
3998
4005
  end
3999
4006
 
4000
4007
  api_instance = TalonOne::ManagementApi.new
4001
- program_id = 'program_id_example' # String |
4008
+ program_id = 56 # Integer |
4002
4009
 
4003
4010
  begin
4004
4011
  #Get a loyalty program
@@ -4014,7 +4021,7 @@ end
4014
4021
 
4015
4022
  Name | Type | Description | Notes
4016
4023
  ------------- | ------------- | ------------- | -------------
4017
- **program_id** | **String**| |
4024
+ **program_id** | **Integer**| |
4018
4025
 
4019
4026
  ### Return type
4020
4027
 
@@ -4032,7 +4039,7 @@ Name | Type | Description | Notes
4032
4039
 
4033
4040
  ## get_loyalty_programs
4034
4041
 
4035
- > InlineResponse2008 get_loyalty_programs
4042
+ > InlineResponse2007 get_loyalty_programs
4036
4043
 
4037
4044
  List all loyalty Programs
4038
4045
 
@@ -4066,7 +4073,7 @@ This endpoint does not need any parameter.
4066
4073
 
4067
4074
  ### Return type
4068
4075
 
4069
- [**InlineResponse2008**](InlineResponse2008.md)
4076
+ [**InlineResponse2007**](InlineResponse2007.md)
4070
4077
 
4071
4078
  ### Authorization
4072
4079
 
@@ -4132,7 +4139,7 @@ Name | Type | Description | Notes
4132
4139
 
4133
4140
  ## get_referrals
4134
4141
 
4135
- > InlineResponse2006 get_referrals(application_id, campaign_id, opts)
4142
+ > InlineResponse201 get_referrals(application_id, campaign_id, opts)
4136
4143
 
4137
4144
  List Referrals (with total count)
4138
4145
 
@@ -4192,7 +4199,7 @@ Name | Type | Description | Notes
4192
4199
 
4193
4200
  ### Return type
4194
4201
 
4195
- [**InlineResponse2006**](InlineResponse2006.md)
4202
+ [**InlineResponse201**](InlineResponse201.md)
4196
4203
 
4197
4204
  ### Authorization
4198
4205
 
@@ -4206,7 +4213,7 @@ Name | Type | Description | Notes
4206
4213
 
4207
4214
  ## get_referrals_without_total_count
4208
4215
 
4209
- > InlineResponse2007 get_referrals_without_total_count(application_id, campaign_id, opts)
4216
+ > InlineResponse2006 get_referrals_without_total_count(application_id, campaign_id, opts)
4210
4217
 
4211
4218
  List Referrals
4212
4219
 
@@ -4266,7 +4273,7 @@ Name | Type | Description | Notes
4266
4273
 
4267
4274
  ### Return type
4268
4275
 
4269
- [**InlineResponse2007**](InlineResponse2007.md)
4276
+ [**InlineResponse2006**](InlineResponse2006.md)
4270
4277
 
4271
4278
  ### Authorization
4272
4279
 
@@ -4504,7 +4511,7 @@ Name | Type | Description | Notes
4504
4511
 
4505
4512
  ## get_users
4506
4513
 
4507
- > InlineResponse20027 get_users(opts)
4514
+ > InlineResponse20026 get_users(opts)
4508
4515
 
4509
4516
  List Users in your account
4510
4517
 
@@ -4550,7 +4557,7 @@ Name | Type | Description | Notes
4550
4557
 
4551
4558
  ### Return type
4552
4559
 
4553
- [**InlineResponse20027**](InlineResponse20027.md)
4560
+ [**InlineResponse20026**](InlineResponse20026.md)
4554
4561
 
4555
4562
  ### Authorization
4556
4563
 
@@ -4618,7 +4625,7 @@ Name | Type | Description | Notes
4618
4625
 
4619
4626
  ## get_webhook_activation_logs
4620
4627
 
4621
- > InlineResponse20024 get_webhook_activation_logs(opts)
4628
+ > InlineResponse20023 get_webhook_activation_logs(opts)
4622
4629
 
4623
4630
  List Webhook activation Log Entries
4624
4631
 
@@ -4676,7 +4683,7 @@ Name | Type | Description | Notes
4676
4683
 
4677
4684
  ### Return type
4678
4685
 
4679
- [**InlineResponse20024**](InlineResponse20024.md)
4686
+ [**InlineResponse20023**](InlineResponse20023.md)
4680
4687
 
4681
4688
  ### Authorization
4682
4689
 
@@ -4690,7 +4697,7 @@ Name | Type | Description | Notes
4690
4697
 
4691
4698
  ## get_webhook_logs
4692
4699
 
4693
- > InlineResponse20025 get_webhook_logs(opts)
4700
+ > InlineResponse20024 get_webhook_logs(opts)
4694
4701
 
4695
4702
  List Webhook Log Entries
4696
4703
 
@@ -4748,7 +4755,7 @@ Name | Type | Description | Notes
4748
4755
 
4749
4756
  ### Return type
4750
4757
 
4751
- [**InlineResponse20025**](InlineResponse20025.md)
4758
+ [**InlineResponse20024**](InlineResponse20024.md)
4752
4759
 
4753
4760
  ### Authorization
4754
4761
 
@@ -4762,7 +4769,7 @@ Name | Type | Description | Notes
4762
4769
 
4763
4770
  ## get_webhooks
4764
4771
 
4765
- > InlineResponse20023 get_webhooks(opts)
4772
+ > InlineResponse20022 get_webhooks(opts)
4766
4773
 
4767
4774
  List Webhooks
4768
4775
 
@@ -4808,7 +4815,7 @@ Name | Type | Description | Notes
4808
4815
 
4809
4816
  ### Return type
4810
4817
 
4811
- [**InlineResponse20023**](InlineResponse20023.md)
4818
+ [**InlineResponse20022**](InlineResponse20022.md)
4812
4819
 
4813
4820
  ### Authorization
4814
4821
 
@@ -4820,6 +4827,242 @@ Name | Type | Description | Notes
4820
4827
  - **Accept**: application/json
4821
4828
 
4822
4829
 
4830
+ ## import_coupons
4831
+
4832
+ > Import import_coupons(application_id, campaign_id, opts)
4833
+
4834
+ Import coupons via CSV file
4835
+
4836
+ Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
4837
+
4838
+ ### Example
4839
+
4840
+ ```ruby
4841
+ # load the gem
4842
+ require 'talon_one'
4843
+ # setup authorization
4844
+ TalonOne.configure do |config|
4845
+ # Configure API key authorization: manager_auth
4846
+ config.api_key['Authorization'] = 'YOUR API KEY'
4847
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4848
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4849
+ end
4850
+
4851
+ api_instance = TalonOne::ManagementApi.new
4852
+ application_id = 56 # Integer |
4853
+ campaign_id = 56 # Integer |
4854
+ opts = {
4855
+ up_file: 'up_file_example' # String | The file with the information about the data that should be imported.
4856
+ }
4857
+
4858
+ begin
4859
+ #Import coupons via CSV file
4860
+ result = api_instance.import_coupons(application_id, campaign_id, opts)
4861
+ p result
4862
+ rescue TalonOne::ApiError => e
4863
+ puts "Exception when calling ManagementApi->import_coupons: #{e}"
4864
+ end
4865
+ ```
4866
+
4867
+ ### Parameters
4868
+
4869
+
4870
+ Name | Type | Description | Notes
4871
+ ------------- | ------------- | ------------- | -------------
4872
+ **application_id** | **Integer**| |
4873
+ **campaign_id** | **Integer**| |
4874
+ **up_file** | **String**| The file with the information about the data that should be imported. | [optional]
4875
+
4876
+ ### Return type
4877
+
4878
+ [**Import**](Import.md)
4879
+
4880
+ ### Authorization
4881
+
4882
+ [manager_auth](../README.md#manager_auth)
4883
+
4884
+ ### HTTP request headers
4885
+
4886
+ - **Content-Type**: multipart/form-data
4887
+ - **Accept**: application/json
4888
+
4889
+
4890
+ ## import_loyalty_points
4891
+
4892
+ > Import import_loyalty_points(program_id, opts)
4893
+
4894
+ Import loyalty points via CSV file
4895
+
4896
+ Upload a CSV file containing the loyalty points that should be created. The file should be sent as multipart data.
4897
+
4898
+ ### Example
4899
+
4900
+ ```ruby
4901
+ # load the gem
4902
+ require 'talon_one'
4903
+ # setup authorization
4904
+ TalonOne.configure do |config|
4905
+ # Configure API key authorization: manager_auth
4906
+ config.api_key['Authorization'] = 'YOUR API KEY'
4907
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4908
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4909
+ end
4910
+
4911
+ api_instance = TalonOne::ManagementApi.new
4912
+ program_id = 56 # Integer |
4913
+ opts = {
4914
+ up_file: 'up_file_example' # String | The file with the information about the data that should be imported.
4915
+ }
4916
+
4917
+ begin
4918
+ #Import loyalty points via CSV file
4919
+ result = api_instance.import_loyalty_points(program_id, opts)
4920
+ p result
4921
+ rescue TalonOne::ApiError => e
4922
+ puts "Exception when calling ManagementApi->import_loyalty_points: #{e}"
4923
+ end
4924
+ ```
4925
+
4926
+ ### Parameters
4927
+
4928
+
4929
+ Name | Type | Description | Notes
4930
+ ------------- | ------------- | ------------- | -------------
4931
+ **program_id** | **Integer**| |
4932
+ **up_file** | **String**| The file with the information about the data that should be imported. | [optional]
4933
+
4934
+ ### Return type
4935
+
4936
+ [**Import**](Import.md)
4937
+
4938
+ ### Authorization
4939
+
4940
+ [manager_auth](../README.md#manager_auth)
4941
+
4942
+ ### HTTP request headers
4943
+
4944
+ - **Content-Type**: multipart/form-data
4945
+ - **Accept**: application/json
4946
+
4947
+
4948
+ ## import_pool_giveaways
4949
+
4950
+ > Import import_pool_giveaways(pool_id, opts)
4951
+
4952
+ Import giveaways codes into a giveaways pool
4953
+
4954
+ 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.
4955
+
4956
+ ### Example
4957
+
4958
+ ```ruby
4959
+ # load the gem
4960
+ require 'talon_one'
4961
+ # setup authorization
4962
+ TalonOne.configure do |config|
4963
+ # Configure API key authorization: manager_auth
4964
+ config.api_key['Authorization'] = 'YOUR API KEY'
4965
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4966
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4967
+ end
4968
+
4969
+ api_instance = TalonOne::ManagementApi.new
4970
+ pool_id = 56 # Integer |
4971
+ opts = {
4972
+ up_file: 'up_file_example' # String | The file with the information about the data that should be imported.
4973
+ }
4974
+
4975
+ begin
4976
+ #Import giveaways codes into a giveaways pool
4977
+ result = api_instance.import_pool_giveaways(pool_id, opts)
4978
+ p result
4979
+ rescue TalonOne::ApiError => e
4980
+ puts "Exception when calling ManagementApi->import_pool_giveaways: #{e}"
4981
+ end
4982
+ ```
4983
+
4984
+ ### Parameters
4985
+
4986
+
4987
+ Name | Type | Description | Notes
4988
+ ------------- | ------------- | ------------- | -------------
4989
+ **pool_id** | **Integer**| |
4990
+ **up_file** | **String**| The file with the information about the data that should be imported. | [optional]
4991
+
4992
+ ### Return type
4993
+
4994
+ [**Import**](Import.md)
4995
+
4996
+ ### Authorization
4997
+
4998
+ [manager_auth](../README.md#manager_auth)
4999
+
5000
+ ### HTTP request headers
5001
+
5002
+ - **Content-Type**: multipart/form-data
5003
+ - **Accept**: application/json
5004
+
5005
+
5006
+ ## import_referrals
5007
+
5008
+ > Import import_referrals(application_id, campaign_id, opts)
5009
+
5010
+ Import referrals via CSV file
5011
+
5012
+ 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.
5013
+
5014
+ ### Example
5015
+
5016
+ ```ruby
5017
+ # load the gem
5018
+ require 'talon_one'
5019
+ # setup authorization
5020
+ TalonOne.configure do |config|
5021
+ # Configure API key authorization: manager_auth
5022
+ config.api_key['Authorization'] = 'YOUR API KEY'
5023
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5024
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5025
+ end
5026
+
5027
+ api_instance = TalonOne::ManagementApi.new
5028
+ application_id = 56 # Integer |
5029
+ campaign_id = 56 # Integer |
5030
+ opts = {
5031
+ up_file: 'up_file_example' # String | The file with the information about the data that should be imported.
5032
+ }
5033
+
5034
+ begin
5035
+ #Import referrals via CSV file
5036
+ result = api_instance.import_referrals(application_id, campaign_id, opts)
5037
+ p result
5038
+ rescue TalonOne::ApiError => e
5039
+ puts "Exception when calling ManagementApi->import_referrals: #{e}"
5040
+ end
5041
+ ```
5042
+
5043
+ ### Parameters
5044
+
5045
+
5046
+ Name | Type | Description | Notes
5047
+ ------------- | ------------- | ------------- | -------------
5048
+ **application_id** | **Integer**| |
5049
+ **campaign_id** | **Integer**| |
5050
+ **up_file** | **String**| The file with the information about the data that should be imported. | [optional]
5051
+
5052
+ ### Return type
5053
+
5054
+ [**Import**](Import.md)
5055
+
5056
+ ### Authorization
5057
+
5058
+ [manager_auth](../README.md#manager_auth)
5059
+
5060
+ ### HTTP request headers
5061
+
5062
+ - **Content-Type**: multipart/form-data
5063
+ - **Accept**: application/json
5064
+
5065
+
4823
5066
  ## remove_loyalty_points
4824
5067
 
4825
5068
  > remove_loyalty_points(program_id, integration_id, body)
@@ -5546,6 +5789,64 @@ nil (empty response body)
5546
5789
  - **Accept**: Not defined
5547
5790
 
5548
5791
 
5792
+ ## update_referral
5793
+
5794
+ > Referral update_referral(application_id, campaign_id, referral_id, body)
5795
+
5796
+ Update one Referral
5797
+
5798
+ ### Example
5799
+
5800
+ ```ruby
5801
+ # load the gem
5802
+ require 'talon_one'
5803
+ # setup authorization
5804
+ TalonOne.configure do |config|
5805
+ # Configure API key authorization: manager_auth
5806
+ config.api_key['Authorization'] = 'YOUR API KEY'
5807
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5808
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5809
+ end
5810
+
5811
+ api_instance = TalonOne::ManagementApi.new
5812
+ application_id = 56 # Integer |
5813
+ campaign_id = 56 # Integer |
5814
+ referral_id = 'referral_id_example' # String | The ID of the referral code to delete
5815
+ body = TalonOne::UpdateReferral.new # UpdateReferral |
5816
+
5817
+ begin
5818
+ #Update one Referral
5819
+ result = api_instance.update_referral(application_id, campaign_id, referral_id, body)
5820
+ p result
5821
+ rescue TalonOne::ApiError => e
5822
+ puts "Exception when calling ManagementApi->update_referral: #{e}"
5823
+ end
5824
+ ```
5825
+
5826
+ ### Parameters
5827
+
5828
+
5829
+ Name | Type | Description | Notes
5830
+ ------------- | ------------- | ------------- | -------------
5831
+ **application_id** | **Integer**| |
5832
+ **campaign_id** | **Integer**| |
5833
+ **referral_id** | **String**| The ID of the referral code to delete |
5834
+ **body** | [**UpdateReferral**](UpdateReferral.md)| |
5835
+
5836
+ ### Return type
5837
+
5838
+ [**Referral**](Referral.md)
5839
+
5840
+ ### Authorization
5841
+
5842
+ [manager_auth](../README.md#manager_auth)
5843
+
5844
+ ### HTTP request headers
5845
+
5846
+ - **Content-Type**: application/json
5847
+ - **Accept**: application/json
5848
+
5849
+
5549
5850
  ## update_ruleset
5550
5851
 
5551
5852
  > Ruleset update_ruleset(application_id, campaign_id, ruleset_id, body)