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.
- checksums.yaml +4 -4
- data/README.md +31 -5
- data/docs/ApplicationCampaignStats.md +27 -0
- data/docs/ApplicationReferee.md +27 -0
- data/docs/AwardGiveawayEffectProps.md +25 -0
- data/docs/Campaign.md +2 -0
- data/docs/Coupon.md +1 -1
- data/docs/CustomEffect.md +41 -0
- data/docs/CustomEffectProps.md +19 -0
- data/docs/CustomerInventory.md +4 -2
- data/docs/CustomerProfileIntegrationRequestV2.md +1 -1
- data/docs/Environment.md +10 -0
- data/docs/Giveaway.md +33 -0
- data/docs/GiveawaysPool.md +33 -0
- data/docs/ImportEntity.md +17 -0
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +4 -2
- data/docs/InlineResponse20012.md +2 -4
- data/docs/InlineResponse20013.md +3 -3
- data/docs/InlineResponse20014.md +2 -2
- data/docs/InlineResponse20015.md +2 -2
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +5 -3
- data/docs/InlineResponse20020.md +2 -2
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +4 -2
- data/docs/InlineResponse20028.md +2 -4
- data/docs/InlineResponse20029.md +1 -1
- data/docs/InlineResponse2006.md +2 -2
- data/docs/InlineResponse2007.md +3 -3
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +2 -2
- data/docs/{InlineResponse20030.md → InlineResponse201.md} +3 -3
- data/docs/IntegrationApi.md +77 -11
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStateV2.md +3 -1
- data/docs/InventoryCoupon.md +53 -0
- data/docs/LoyaltyProgram.md +3 -1
- data/docs/LoyaltyProgramEntity.md +17 -0
- data/docs/LoyaltyTier.md +25 -0
- data/docs/ManagementApi.md +370 -69
- data/docs/NewCustomEffect.md +29 -0
- data/docs/NewGiveawaysPool.md +21 -0
- data/docs/NewLoyaltyTier.md +19 -0
- data/docs/NewReferral.md +10 -6
- data/docs/NewReferralsForMultipleAdvocates.md +31 -0
- data/docs/NewRole.md +1 -1
- data/docs/Referral.md +13 -7
- data/docs/ReferralConstraints.md +21 -0
- data/docs/Role.md +8 -4
- data/docs/UpdateCustomEffect.md +29 -0
- data/docs/UpdateLoyaltyTier.md +19 -0
- data/docs/UpdateReferral.md +25 -0
- data/docs/UpdateRole.md +1 -1
- data/docs/WillAwardGiveawayEffectProps.md +21 -0
- data/lib/talon_one.rb +21 -1
- data/lib/talon_one/api/integration_api.rb +80 -10
- data/lib/talon_one/api/management_api.rb +460 -97
- data/lib/talon_one/models/application_campaign_stats.rb +288 -0
- data/lib/talon_one/models/application_referee.rb +288 -0
- data/lib/talon_one/models/attribute.rb +2 -2
- data/lib/talon_one/models/award_giveaway_effect_props.rb +273 -0
- data/lib/talon_one/models/campaign.rb +11 -1
- data/lib/talon_one/models/coupon.rb +1 -1
- data/lib/talon_one/models/custom_effect.rb +377 -0
- data/lib/talon_one/models/custom_effect_props.rb +228 -0
- data/lib/talon_one/models/customer_inventory.rb +15 -4
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +1 -1
- data/lib/talon_one/models/environment.rb +61 -1
- data/lib/talon_one/models/export.rb +2 -2
- data/lib/talon_one/models/giveaway.rb +308 -0
- data/lib/talon_one/models/giveaways_pool.rb +315 -0
- data/lib/talon_one/models/import_entity.rb +207 -0
- data/lib/talon_one/models/inline_response20010.rb +11 -11
- data/lib/talon_one/models/inline_response20011.rb +11 -7
- data/lib/talon_one/models/inline_response20012.rb +6 -10
- data/lib/talon_one/models/inline_response20013.rb +11 -11
- data/lib/talon_one/models/inline_response20014.rb +10 -10
- data/lib/talon_one/models/inline_response20015.rb +1 -6
- data/lib/talon_one/models/inline_response20016.rb +13 -8
- data/lib/talon_one/models/inline_response20017.rb +10 -10
- data/lib/talon_one/models/inline_response20018.rb +11 -11
- data/lib/talon_one/models/inline_response20019.rb +11 -7
- data/lib/talon_one/models/inline_response20020.rb +6 -1
- data/lib/talon_one/models/inline_response20021.rb +1 -1
- data/lib/talon_one/models/inline_response20022.rb +1 -1
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +1 -1
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -1
- data/lib/talon_one/models/inline_response20027.rb +11 -7
- data/lib/talon_one/models/inline_response20028.rb +7 -11
- data/lib/talon_one/models/inline_response20029.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +10 -10
- data/lib/talon_one/models/inline_response2007.rb +11 -11
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +10 -10
- data/lib/talon_one/models/{inline_response20030.rb → inline_response201.rb} +4 -4
- data/lib/talon_one/models/integration_request.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +15 -4
- data/lib/talon_one/models/inventory_coupon.rb +499 -0
- data/lib/talon_one/models/loyalty_program.rb +16 -4
- data/lib/talon_one/models/loyalty_program_entity.rb +212 -0
- data/lib/talon_one/models/loyalty_tier.rb +301 -0
- data/lib/talon_one/models/new_attribute.rb +2 -2
- data/lib/talon_one/models/new_custom_effect.rb +291 -0
- data/lib/talon_one/models/new_giveaways_pool.rb +234 -0
- data/lib/talon_one/models/new_loyalty_tier.rb +256 -0
- data/lib/talon_one/models/new_referral.rb +64 -19
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +349 -0
- data/lib/talon_one/models/new_role.rb +1 -1
- data/lib/talon_one/models/referral.rb +86 -47
- data/lib/talon_one/models/referral_constraints.rb +251 -0
- data/lib/talon_one/models/role.rb +44 -4
- data/lib/talon_one/models/update_custom_effect.rb +292 -0
- data/lib/talon_one/models/update_loyalty_tier.rb +256 -0
- data/lib/talon_one/models/update_referral.rb +271 -0
- data/lib/talon_one/models/update_role.rb +1 -1
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +243 -0
- data/lib/talon_one/version.rb +1 -1
- data/spec/api/integration_api_spec.rb +19 -5
- data/spec/api/management_api_spec.rb +102 -33
- data/spec/models/application_campaign_stats_spec.rb +71 -0
- data/spec/models/application_referee_spec.rb +71 -0
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/award_giveaway_effect_props_spec.rb +65 -0
- data/spec/models/campaign_spec.rb +7 -1
- data/spec/models/custom_effect_props_spec.rb +47 -0
- data/spec/models/custom_effect_spec.rb +113 -0
- data/spec/models/customer_inventory_spec.rb +6 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +1 -1
- data/spec/models/environment_spec.rb +30 -0
- data/spec/models/export_spec.rb +1 -1
- data/spec/models/giveaway_spec.rb +89 -0
- data/spec/models/giveaways_pool_spec.rb +89 -0
- data/spec/models/import_entity_spec.rb +41 -0
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +6 -0
- data/spec/models/inline_response20012_spec.rb +0 -6
- data/spec/models/inline_response20013_spec.rb +1 -1
- data/spec/models/inline_response20014_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +1 -1
- data/spec/models/inline_response20017_spec.rb +1 -1
- data/spec/models/inline_response20018_spec.rb +1 -1
- data/spec/models/inline_response20019_spec.rb +6 -0
- data/spec/models/inline_response20027_spec.rb +6 -0
- data/spec/models/inline_response20028_spec.rb +0 -6
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/inline_response2009_spec.rb +1 -1
- data/spec/models/{inline_response20030_spec.rb → inline_response201_spec.rb} +6 -6
- data/spec/models/integration_request_spec.rb +1 -1
- data/spec/models/integration_state_v2_spec.rb +6 -0
- data/spec/models/inventory_coupon_spec.rb +149 -0
- data/spec/models/loyalty_program_entity_spec.rb +41 -0
- data/spec/models/loyalty_program_spec.rb +6 -0
- data/spec/models/loyalty_tier_spec.rb +65 -0
- data/spec/models/new_attribute_spec.rb +1 -1
- data/spec/models/new_campaign_spec.rb +1 -1
- data/spec/models/new_custom_effect_spec.rb +77 -0
- data/spec/models/new_giveaways_pool_spec.rb +53 -0
- data/spec/models/new_loyalty_tier_spec.rb +47 -0
- data/spec/models/new_referral_spec.rb +17 -5
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +83 -0
- data/spec/models/referral_constraints_spec.rb +53 -0
- data/spec/models/referral_spec.rb +21 -3
- data/spec/models/role_spec.rb +12 -0
- data/spec/models/update_campaign_spec.rb +1 -1
- data/spec/models/update_custom_effect_spec.rb +77 -0
- data/spec/models/update_loyalty_tier_spec.rb +47 -0
- data/spec/models/update_referral_spec.rb +65 -0
- data/spec/models/will_award_giveaway_effect_props_spec.rb +53 -0
- metadata +86 -6
@@ -153,6 +153,73 @@ module TalonOne
|
|
153
153
|
return data, status_code, headers
|
154
154
|
end
|
155
155
|
|
156
|
+
# Create referral codes for multiple advocates
|
157
|
+
# 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.
|
158
|
+
# @param body [NewReferralsForMultipleAdvocates]
|
159
|
+
# @param [Hash] opts the optional parameters
|
160
|
+
# @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).
|
161
|
+
# @return [InlineResponse201]
|
162
|
+
def create_referrals_for_multiple_advocates(body, opts = {})
|
163
|
+
data, _status_code, _headers = create_referrals_for_multiple_advocates_with_http_info(body, opts)
|
164
|
+
data
|
165
|
+
end
|
166
|
+
|
167
|
+
# Create referral codes for multiple advocates
|
168
|
+
# 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.
|
169
|
+
# @param body [NewReferralsForMultipleAdvocates]
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @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).
|
172
|
+
# @return [Array<(InlineResponse201, Integer, Hash)>] InlineResponse201 data, response status code and response headers
|
173
|
+
def create_referrals_for_multiple_advocates_with_http_info(body, opts = {})
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug 'Calling API: IntegrationApi.create_referrals_for_multiple_advocates ...'
|
176
|
+
end
|
177
|
+
# verify the required parameter 'body' is set
|
178
|
+
if @api_client.config.client_side_validation && body.nil?
|
179
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationApi.create_referrals_for_multiple_advocates"
|
180
|
+
end
|
181
|
+
# resource path
|
182
|
+
local_var_path = '/v1/referrals_for_multiple_advocates'
|
183
|
+
|
184
|
+
# query parameters
|
185
|
+
query_params = opts[:query_params] || {}
|
186
|
+
query_params[:'silent'] = opts[:'silent'] if !opts[:'silent'].nil?
|
187
|
+
|
188
|
+
# header parameters
|
189
|
+
header_params = opts[:header_params] || {}
|
190
|
+
# HTTP header 'Accept' (if needed)
|
191
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
192
|
+
# HTTP header 'Content-Type'
|
193
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
194
|
+
|
195
|
+
# form parameters
|
196
|
+
form_params = opts[:form_params] || {}
|
197
|
+
|
198
|
+
# http body (model)
|
199
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
200
|
+
|
201
|
+
# return_type
|
202
|
+
return_type = opts[:return_type] || 'InlineResponse201'
|
203
|
+
|
204
|
+
# auth_names
|
205
|
+
auth_names = opts[:auth_names] || ['api_key_v1', 'integration_auth']
|
206
|
+
|
207
|
+
new_options = opts.merge(
|
208
|
+
:header_params => header_params,
|
209
|
+
:query_params => query_params,
|
210
|
+
:form_params => form_params,
|
211
|
+
:body => post_body,
|
212
|
+
:auth_names => auth_names,
|
213
|
+
:return_type => return_type
|
214
|
+
)
|
215
|
+
|
216
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
217
|
+
if @api_client.config.debugging
|
218
|
+
@api_client.config.logger.debug "API called: IntegrationApi#create_referrals_for_multiple_advocates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
219
|
+
end
|
220
|
+
return data, status_code, headers
|
221
|
+
end
|
222
|
+
|
156
223
|
# Delete coupon reservations
|
157
224
|
# Removes all passed customer profiles reservation from this coupon
|
158
225
|
# @param coupon_value [String] The value of a coupon
|
@@ -289,6 +356,7 @@ module TalonOne
|
|
289
356
|
# @option opts [Boolean] :referrals optional flag to decide if you would like referral information in the response
|
290
357
|
# @option opts [Boolean] :coupons optional flag to decide if you would like coupon information in the response
|
291
358
|
# @option opts [Boolean] :loyalty optional flag to decide if you would like loyalty information in the response
|
359
|
+
# @option opts [Boolean] :giveaways optional flag to decide if you would like giveaways information in the response
|
292
360
|
# @return [CustomerInventory]
|
293
361
|
def get_customer_inventory(integration_id, opts = {})
|
294
362
|
data, _status_code, _headers = get_customer_inventory_with_http_info(integration_id, opts)
|
@@ -303,6 +371,7 @@ module TalonOne
|
|
303
371
|
# @option opts [Boolean] :referrals optional flag to decide if you would like referral information in the response
|
304
372
|
# @option opts [Boolean] :coupons optional flag to decide if you would like coupon information in the response
|
305
373
|
# @option opts [Boolean] :loyalty optional flag to decide if you would like loyalty information in the response
|
374
|
+
# @option opts [Boolean] :giveaways optional flag to decide if you would like giveaways information in the response
|
306
375
|
# @return [Array<(CustomerInventory, Integer, Hash)>] CustomerInventory data, response status code and response headers
|
307
376
|
def get_customer_inventory_with_http_info(integration_id, opts = {})
|
308
377
|
if @api_client.config.debugging
|
@@ -321,6 +390,7 @@ module TalonOne
|
|
321
390
|
query_params[:'referrals'] = opts[:'referrals'] if !opts[:'referrals'].nil?
|
322
391
|
query_params[:'coupons'] = opts[:'coupons'] if !opts[:'coupons'].nil?
|
323
392
|
query_params[:'loyalty'] = opts[:'loyalty'] if !opts[:'loyalty'].nil?
|
393
|
+
query_params[:'giveaways'] = opts[:'giveaways'] if !opts[:'giveaways'].nil?
|
324
394
|
|
325
395
|
# header parameters
|
326
396
|
header_params = opts[:header_params] || {}
|
@@ -421,7 +491,7 @@ module TalonOne
|
|
421
491
|
# 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.
|
422
492
|
# @param body [NewEvent]
|
423
493
|
# @param [Hash] opts the optional parameters
|
424
|
-
# @option opts [Boolean] :dry Indicates whether to
|
494
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
425
495
|
# @return [IntegrationState]
|
426
496
|
def track_event(body, opts = {})
|
427
497
|
data, _status_code, _headers = track_event_with_http_info(body, opts)
|
@@ -432,7 +502,7 @@ module TalonOne
|
|
432
502
|
# 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.
|
433
503
|
# @param body [NewEvent]
|
434
504
|
# @param [Hash] opts the optional parameters
|
435
|
-
# @option opts [Boolean] :dry Indicates whether to
|
505
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
436
506
|
# @return [Array<(IntegrationState, Integer, Hash)>] IntegrationState data, response status code and response headers
|
437
507
|
def track_event_with_http_info(body, opts = {})
|
438
508
|
if @api_client.config.debugging
|
@@ -489,7 +559,7 @@ module TalonOne
|
|
489
559
|
# @param integration_id [String] The custom identifier for this profile, must be unique within the account.
|
490
560
|
# @param body [NewCustomerProfile]
|
491
561
|
# @param [Hash] opts the optional parameters
|
492
|
-
# @option opts [Boolean] :dry Indicates whether to
|
562
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
493
563
|
# @return [IntegrationState]
|
494
564
|
def update_customer_profile(integration_id, body, opts = {})
|
495
565
|
data, _status_code, _headers = update_customer_profile_with_http_info(integration_id, body, opts)
|
@@ -501,7 +571,7 @@ module TalonOne
|
|
501
571
|
# @param integration_id [String] The custom identifier for this profile, must be unique within the account.
|
502
572
|
# @param body [NewCustomerProfile]
|
503
573
|
# @param [Hash] opts the optional parameters
|
504
|
-
# @option opts [Boolean] :dry Indicates whether to
|
574
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
505
575
|
# @return [Array<(IntegrationState, Integer, Hash)>] IntegrationState data, response status code and response headers
|
506
576
|
def update_customer_profile_with_http_info(integration_id, body, opts = {})
|
507
577
|
if @api_client.config.debugging
|
@@ -625,7 +695,7 @@ module TalonOne
|
|
625
695
|
# @param body [CustomerProfileIntegrationRequestV2]
|
626
696
|
# @param [Hash] opts the optional parameters
|
627
697
|
# @option opts [Boolean] :run_rule_engine Indicates whether to run the rule engine. (default to false)
|
628
|
-
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are
|
698
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`.
|
629
699
|
# @return [IntegrationStateV2]
|
630
700
|
def update_customer_profile_v2(integration_id, body, opts = {})
|
631
701
|
data, _status_code, _headers = update_customer_profile_v2_with_http_info(integration_id, body, opts)
|
@@ -638,7 +708,7 @@ module TalonOne
|
|
638
708
|
# @param body [CustomerProfileIntegrationRequestV2]
|
639
709
|
# @param [Hash] opts the optional parameters
|
640
710
|
# @option opts [Boolean] :run_rule_engine Indicates whether to run the rule engine.
|
641
|
-
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are
|
711
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`.
|
642
712
|
# @return [Array<(IntegrationStateV2, Integer, Hash)>] IntegrationStateV2 data, response status code and response headers
|
643
713
|
def update_customer_profile_v2_with_http_info(integration_id, body, opts = {})
|
644
714
|
if @api_client.config.debugging
|
@@ -767,7 +837,7 @@ module TalonOne
|
|
767
837
|
# @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
|
768
838
|
# @param body [NewCustomerSession]
|
769
839
|
# @param [Hash] opts the optional parameters
|
770
|
-
# @option opts [Boolean] :dry Indicates whether to
|
840
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
771
841
|
# @return [IntegrationState]
|
772
842
|
def update_customer_session(customer_session_id, body, opts = {})
|
773
843
|
data, _status_code, _headers = update_customer_session_with_http_info(customer_session_id, body, opts)
|
@@ -779,7 +849,7 @@ module TalonOne
|
|
779
849
|
# @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
|
780
850
|
# @param body [NewCustomerSession]
|
781
851
|
# @param [Hash] opts the optional parameters
|
782
|
-
# @option opts [Boolean] :dry Indicates whether to
|
852
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
783
853
|
# @return [Array<(IntegrationState, Integer, Hash)>] IntegrationState data, response status code and response headers
|
784
854
|
def update_customer_session_with_http_info(customer_session_id, body, opts = {})
|
785
855
|
if @api_client.config.debugging
|
@@ -840,7 +910,7 @@ module TalonOne
|
|
840
910
|
# @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
|
841
911
|
# @param body [IntegrationRequest]
|
842
912
|
# @param [Hash] opts the optional parameters
|
843
|
-
# @option opts [Boolean] :dry Indicates whether to
|
913
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
844
914
|
# @return [IntegrationStateV2]
|
845
915
|
def update_customer_session_v2(customer_session_id, body, opts = {})
|
846
916
|
data, _status_code, _headers = update_customer_session_v2_with_http_info(customer_session_id, body, opts)
|
@@ -852,7 +922,7 @@ module TalonOne
|
|
852
922
|
# @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
|
853
923
|
# @param body [IntegrationRequest]
|
854
924
|
# @param [Hash] opts the optional parameters
|
855
|
-
# @option opts [Boolean] :dry Indicates whether to
|
925
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
856
926
|
# @return [Array<(IntegrationStateV2, Integer, Hash)>] IntegrationStateV2 data, response status code and response headers
|
857
927
|
def update_customer_session_v2_with_http_info(customer_session_id, body, opts = {})
|
858
928
|
if @api_client.config.debugging
|
@@ -369,7 +369,7 @@ module TalonOne
|
|
369
369
|
# @param campaign_id [Integer]
|
370
370
|
# @param body [NewCoupons]
|
371
371
|
# @param [Hash] opts the optional parameters
|
372
|
-
# @option opts [String] :silent If set to &#
|
372
|
+
# @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).
|
373
373
|
# @return [InlineResponse2004]
|
374
374
|
def create_coupons(application_id, campaign_id, body, opts = {})
|
375
375
|
data, _status_code, _headers = create_coupons_with_http_info(application_id, campaign_id, body, opts)
|
@@ -382,7 +382,7 @@ module TalonOne
|
|
382
382
|
# @param campaign_id [Integer]
|
383
383
|
# @param body [NewCoupons]
|
384
384
|
# @param [Hash] opts the optional parameters
|
385
|
-
# @option opts [String] :silent If set to &#
|
385
|
+
# @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).
|
386
386
|
# @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
|
387
387
|
def create_coupons_with_http_info(application_id, campaign_id, body, opts = {})
|
388
388
|
if @api_client.config.debugging
|
@@ -448,7 +448,7 @@ module TalonOne
|
|
448
448
|
# @param campaign_id [Integer]
|
449
449
|
# @param body [NewCouponsForMultipleRecipients]
|
450
450
|
# @param [Hash] opts the optional parameters
|
451
|
-
# @option opts [String] :silent If set to &#
|
451
|
+
# @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).
|
452
452
|
# @return [InlineResponse2004]
|
453
453
|
def create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {})
|
454
454
|
data, _status_code, _headers = create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts)
|
@@ -461,7 +461,7 @@ module TalonOne
|
|
461
461
|
# @param campaign_id [Integer]
|
462
462
|
# @param body [NewCouponsForMultipleRecipients]
|
463
463
|
# @param [Hash] opts the optional parameters
|
464
|
-
# @option opts [String] :silent If set to &#
|
464
|
+
# @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).
|
465
465
|
# @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
|
466
466
|
def create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {})
|
467
467
|
if @api_client.config.debugging
|
@@ -1600,7 +1600,7 @@ module TalonOne
|
|
1600
1600
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1601
1601
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1602
1602
|
# @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.
|
1603
|
-
# @return [
|
1603
|
+
# @return [InlineResponse2008]
|
1604
1604
|
def get_access_logs(application_id, range_start, range_end, opts = {})
|
1605
1605
|
data, _status_code, _headers = get_access_logs_with_http_info(application_id, range_start, range_end, opts)
|
1606
1606
|
data
|
@@ -1617,7 +1617,7 @@ module TalonOne
|
|
1617
1617
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1618
1618
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1619
1619
|
# @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.
|
1620
|
-
# @return [Array<(
|
1620
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
1621
1621
|
def get_access_logs_with_http_info(application_id, range_start, range_end, opts = {})
|
1622
1622
|
if @api_client.config.debugging
|
1623
1623
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs ...'
|
@@ -1668,7 +1668,7 @@ module TalonOne
|
|
1668
1668
|
post_body = opts[:body]
|
1669
1669
|
|
1670
1670
|
# return_type
|
1671
|
-
return_type = opts[:return_type] || '
|
1671
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
1672
1672
|
|
1673
1673
|
# auth_names
|
1674
1674
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -1700,7 +1700,7 @@ module TalonOne
|
|
1700
1700
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1701
1701
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1702
1702
|
# @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.
|
1703
|
-
# @return [
|
1703
|
+
# @return [InlineResponse2009]
|
1704
1704
|
def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
|
1705
1705
|
data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
|
1706
1706
|
data
|
@@ -1717,7 +1717,7 @@ module TalonOne
|
|
1717
1717
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1718
1718
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1719
1719
|
# @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.
|
1720
|
-
# @return [Array<(
|
1720
|
+
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
1721
1721
|
def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
|
1722
1722
|
if @api_client.config.debugging
|
1723
1723
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs_without_total_count ...'
|
@@ -1768,7 +1768,7 @@ module TalonOne
|
|
1768
1768
|
post_body = opts[:body]
|
1769
1769
|
|
1770
1770
|
# return_type
|
1771
|
-
return_type = opts[:return_type] || '
|
1771
|
+
return_type = opts[:return_type] || 'InlineResponse2009'
|
1772
1772
|
|
1773
1773
|
# auth_names
|
1774
1774
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -1981,7 +1981,7 @@ module TalonOne
|
|
1981
1981
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1982
1982
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1983
1983
|
# @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.
|
1984
|
-
# @return [
|
1984
|
+
# @return [InlineResponse20021]
|
1985
1985
|
def get_additional_costs(opts = {})
|
1986
1986
|
data, _status_code, _headers = get_additional_costs_with_http_info(opts)
|
1987
1987
|
data
|
@@ -1993,7 +1993,7 @@ module TalonOne
|
|
1993
1993
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1994
1994
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1995
1995
|
# @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.
|
1996
|
-
# @return [Array<(
|
1996
|
+
# @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
|
1997
1997
|
def get_additional_costs_with_http_info(opts = {})
|
1998
1998
|
if @api_client.config.debugging
|
1999
1999
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
|
@@ -2019,7 +2019,7 @@ module TalonOne
|
|
2019
2019
|
post_body = opts[:body]
|
2020
2020
|
|
2021
2021
|
# return_type
|
2022
|
-
return_type = opts[:return_type] || '
|
2022
|
+
return_type = opts[:return_type] || 'InlineResponse20021'
|
2023
2023
|
|
2024
2024
|
# auth_names
|
2025
2025
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -2051,7 +2051,7 @@ module TalonOne
|
|
2051
2051
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2052
2052
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2053
2053
|
# @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.
|
2054
|
-
# @return [
|
2054
|
+
# @return [InlineResponse2008]
|
2055
2055
|
def get_all_access_logs(range_start, range_end, opts = {})
|
2056
2056
|
data, _status_code, _headers = get_all_access_logs_with_http_info(range_start, range_end, opts)
|
2057
2057
|
data
|
@@ -2068,7 +2068,7 @@ module TalonOne
|
|
2068
2068
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2069
2069
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2070
2070
|
# @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.
|
2071
|
-
# @return [Array<(
|
2071
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
2072
2072
|
def get_all_access_logs_with_http_info(range_start, range_end, opts = {})
|
2073
2073
|
if @api_client.config.debugging
|
2074
2074
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_all_access_logs ...'
|
@@ -2115,7 +2115,7 @@ module TalonOne
|
|
2115
2115
|
post_body = opts[:body]
|
2116
2116
|
|
2117
2117
|
# return_type
|
2118
|
-
return_type = opts[:return_type] || '
|
2118
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
2119
2119
|
|
2120
2120
|
# auth_names
|
2121
2121
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -2138,7 +2138,7 @@ module TalonOne
|
|
2138
2138
|
|
2139
2139
|
# Get all roles
|
2140
2140
|
# @param [Hash] opts the optional parameters
|
2141
|
-
# @return [
|
2141
|
+
# @return [InlineResponse20029]
|
2142
2142
|
def get_all_roles(opts = {})
|
2143
2143
|
data, _status_code, _headers = get_all_roles_with_http_info(opts)
|
2144
2144
|
data
|
@@ -2146,7 +2146,7 @@ module TalonOne
|
|
2146
2146
|
|
2147
2147
|
# Get all roles
|
2148
2148
|
# @param [Hash] opts the optional parameters
|
2149
|
-
# @return [Array<(
|
2149
|
+
# @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
|
2150
2150
|
def get_all_roles_with_http_info(opts = {})
|
2151
2151
|
if @api_client.config.debugging
|
2152
2152
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_all_roles ...'
|
@@ -2169,7 +2169,7 @@ module TalonOne
|
|
2169
2169
|
post_body = opts[:body]
|
2170
2170
|
|
2171
2171
|
# return_type
|
2172
|
-
return_type = opts[:return_type] || '
|
2172
|
+
return_type = opts[:return_type] || 'InlineResponse20029'
|
2173
2173
|
|
2174
2174
|
# auth_names
|
2175
2175
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -2384,8 +2384,8 @@ module TalonOne
|
|
2384
2384
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
2385
2385
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2386
2386
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2387
|
-
# @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
|
2388
|
-
# @return [
|
2387
|
+
# @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.
|
2388
|
+
# @return [InlineResponse20011]
|
2389
2389
|
def get_application_customers(application_id, opts = {})
|
2390
2390
|
data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts)
|
2391
2391
|
data
|
@@ -2397,8 +2397,8 @@ module TalonOne
|
|
2397
2397
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
2398
2398
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2399
2399
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2400
|
-
# @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
|
2401
|
-
# @return [Array<(
|
2400
|
+
# @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.
|
2401
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
2402
2402
|
def get_application_customers_with_http_info(application_id, opts = {})
|
2403
2403
|
if @api_client.config.debugging
|
2404
2404
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...'
|
@@ -2429,7 +2429,7 @@ module TalonOne
|
|
2429
2429
|
post_body = opts[:body]
|
2430
2430
|
|
2431
2431
|
# return_type
|
2432
|
-
return_type = opts[:return_type] || '
|
2432
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
2433
2433
|
|
2434
2434
|
# auth_names
|
2435
2435
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -2454,7 +2454,7 @@ module TalonOne
|
|
2454
2454
|
# 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
|
2455
2455
|
# @param body [ApplicationCustomerSearch]
|
2456
2456
|
# @param [Hash] opts the optional parameters
|
2457
|
-
# @return [
|
2457
|
+
# @return [InlineResponse20012]
|
2458
2458
|
def get_application_customers_by_attributes(body, opts = {})
|
2459
2459
|
data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(body, opts)
|
2460
2460
|
data
|
@@ -2464,7 +2464,7 @@ module TalonOne
|
|
2464
2464
|
# 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
|
2465
2465
|
# @param body [ApplicationCustomerSearch]
|
2466
2466
|
# @param [Hash] opts the optional parameters
|
2467
|
-
# @return [Array<(
|
2467
|
+
# @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
|
2468
2468
|
def get_application_customers_by_attributes_with_http_info(body, opts = {})
|
2469
2469
|
if @api_client.config.debugging
|
2470
2470
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...'
|
@@ -2493,7 +2493,7 @@ module TalonOne
|
|
2493
2493
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
2494
2494
|
|
2495
2495
|
# return_type
|
2496
|
-
return_type = opts[:return_type] || '
|
2496
|
+
return_type = opts[:return_type] || 'InlineResponse20012'
|
2497
2497
|
|
2498
2498
|
# auth_names
|
2499
2499
|
auth_names = opts[:auth_names] || ['integration_auth']
|
@@ -2521,7 +2521,7 @@ module TalonOne
|
|
2521
2521
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2522
2522
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2523
2523
|
# @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.
|
2524
|
-
# @return [
|
2524
|
+
# @return [InlineResponse20018]
|
2525
2525
|
def get_application_event_types(application_id, opts = {})
|
2526
2526
|
data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
|
2527
2527
|
data
|
@@ -2534,7 +2534,7 @@ module TalonOne
|
|
2534
2534
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2535
2535
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2536
2536
|
# @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.
|
2537
|
-
# @return [Array<(
|
2537
|
+
# @return [Array<(InlineResponse20018, Integer, Hash)>] InlineResponse20018 data, response status code and response headers
|
2538
2538
|
def get_application_event_types_with_http_info(application_id, opts = {})
|
2539
2539
|
if @api_client.config.debugging
|
2540
2540
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...'
|
@@ -2564,7 +2564,7 @@ module TalonOne
|
|
2564
2564
|
post_body = opts[:body]
|
2565
2565
|
|
2566
2566
|
# return_type
|
2567
|
-
return_type = opts[:return_type] || '
|
2567
|
+
return_type = opts[:return_type] || 'InlineResponse20018'
|
2568
2568
|
|
2569
2569
|
# auth_names
|
2570
2570
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -2603,7 +2603,7 @@ module TalonOne
|
|
2603
2603
|
# @option opts [String] :referral_code Referral code
|
2604
2604
|
# @option opts [String] :rule_query Rule name filter for events
|
2605
2605
|
# @option opts [String] :campaign_query Campaign name filter for events
|
2606
|
-
# @return [
|
2606
|
+
# @return [InlineResponse20016]
|
2607
2607
|
def get_application_events(application_id, opts = {})
|
2608
2608
|
data, _status_code, _headers = get_application_events_with_http_info(application_id, opts)
|
2609
2609
|
data
|
@@ -2627,7 +2627,7 @@ module TalonOne
|
|
2627
2627
|
# @option opts [String] :referral_code Referral code
|
2628
2628
|
# @option opts [String] :rule_query Rule name filter for events
|
2629
2629
|
# @option opts [String] :campaign_query Campaign name filter for events
|
2630
|
-
# @return [Array<(
|
2630
|
+
# @return [Array<(InlineResponse20016, Integer, Hash)>] InlineResponse20016 data, response status code and response headers
|
2631
2631
|
def get_application_events_with_http_info(application_id, opts = {})
|
2632
2632
|
if @api_client.config.debugging
|
2633
2633
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events ...'
|
@@ -2676,7 +2676,7 @@ module TalonOne
|
|
2676
2676
|
post_body = opts[:body]
|
2677
2677
|
|
2678
2678
|
# return_type
|
2679
|
-
return_type = opts[:return_type] || '
|
2679
|
+
return_type = opts[:return_type] || 'InlineResponse20016'
|
2680
2680
|
|
2681
2681
|
# auth_names
|
2682
2682
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -2715,7 +2715,7 @@ module TalonOne
|
|
2715
2715
|
# @option opts [String] :referral_code Referral code
|
2716
2716
|
# @option opts [String] :rule_query Rule name filter for events
|
2717
2717
|
# @option opts [String] :campaign_query Campaign name filter for events
|
2718
|
-
# @return [
|
2718
|
+
# @return [InlineResponse20017]
|
2719
2719
|
def get_application_events_without_total_count(application_id, opts = {})
|
2720
2720
|
data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
|
2721
2721
|
data
|
@@ -2739,7 +2739,7 @@ module TalonOne
|
|
2739
2739
|
# @option opts [String] :referral_code Referral code
|
2740
2740
|
# @option opts [String] :rule_query Rule name filter for events
|
2741
2741
|
# @option opts [String] :campaign_query Campaign name filter for events
|
2742
|
-
# @return [Array<(
|
2742
|
+
# @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
|
2743
2743
|
def get_application_events_without_total_count_with_http_info(application_id, opts = {})
|
2744
2744
|
if @api_client.config.debugging
|
2745
2745
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...'
|
@@ -2788,7 +2788,7 @@ module TalonOne
|
|
2788
2788
|
post_body = opts[:body]
|
2789
2789
|
|
2790
2790
|
# return_type
|
2791
|
-
return_type = opts[:return_type] || '
|
2791
|
+
return_type = opts[:return_type] || 'InlineResponse20017'
|
2792
2792
|
|
2793
2793
|
# auth_names
|
2794
2794
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -2888,7 +2888,7 @@ module TalonOne
|
|
2888
2888
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
2889
2889
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
2890
2890
|
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
2891
|
-
# @return [
|
2891
|
+
# @return [InlineResponse20015]
|
2892
2892
|
def get_application_sessions(application_id, opts = {})
|
2893
2893
|
data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts)
|
2894
2894
|
data
|
@@ -2907,7 +2907,7 @@ module TalonOne
|
|
2907
2907
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
2908
2908
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
2909
2909
|
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
2910
|
-
# @return [Array<(
|
2910
|
+
# @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
|
2911
2911
|
def get_application_sessions_with_http_info(application_id, opts = {})
|
2912
2912
|
if @api_client.config.debugging
|
2913
2913
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...'
|
@@ -2948,7 +2948,7 @@ module TalonOne
|
|
2948
2948
|
post_body = opts[:body]
|
2949
2949
|
|
2950
2950
|
# return_type
|
2951
|
-
return_type = opts[:return_type] || '
|
2951
|
+
return_type = opts[:return_type] || 'InlineResponse20015'
|
2952
2952
|
|
2953
2953
|
# auth_names
|
2954
2954
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -3102,7 +3102,8 @@ module TalonOne
|
|
3102
3102
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3103
3103
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3104
3104
|
# @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.
|
3105
|
-
# @
|
3105
|
+
# @option opts [String] :entity Returned attributes will be filtered by supplied entity
|
3106
|
+
# @return [InlineResponse20020]
|
3106
3107
|
def get_attributes(opts = {})
|
3107
3108
|
data, _status_code, _headers = get_attributes_with_http_info(opts)
|
3108
3109
|
data
|
@@ -3114,7 +3115,8 @@ module TalonOne
|
|
3114
3115
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3115
3116
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3116
3117
|
# @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.
|
3117
|
-
# @
|
3118
|
+
# @option opts [String] :entity Returned attributes will be filtered by supplied entity
|
3119
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
3118
3120
|
def get_attributes_with_http_info(opts = {})
|
3119
3121
|
if @api_client.config.debugging
|
3120
3122
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
|
@@ -3127,6 +3129,7 @@ module TalonOne
|
|
3127
3129
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
3128
3130
|
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
3129
3131
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3132
|
+
query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?
|
3130
3133
|
|
3131
3134
|
# header parameters
|
3132
3135
|
header_params = opts[:header_params] || {}
|
@@ -3140,7 +3143,7 @@ module TalonOne
|
|
3140
3143
|
post_body = opts[:body]
|
3141
3144
|
|
3142
3145
|
# return_type
|
3143
|
-
return_type = opts[:return_type] || '
|
3146
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
3144
3147
|
|
3145
3148
|
# auth_names
|
3146
3149
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -3167,8 +3170,8 @@ module TalonOne
|
|
3167
3170
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3168
3171
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3169
3172
|
# @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.
|
3170
|
-
# @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
|
3171
|
-
# @return [
|
3173
|
+
# @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.
|
3174
|
+
# @return [InlineResponse20019]
|
3172
3175
|
def get_audiences(opts = {})
|
3173
3176
|
data, _status_code, _headers = get_audiences_with_http_info(opts)
|
3174
3177
|
data
|
@@ -3180,8 +3183,8 @@ module TalonOne
|
|
3180
3183
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3181
3184
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3182
3185
|
# @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.
|
3183
|
-
# @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
|
3184
|
-
# @return [Array<(
|
3186
|
+
# @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.
|
3187
|
+
# @return [Array<(InlineResponse20019, Integer, Hash)>] InlineResponse20019 data, response status code and response headers
|
3185
3188
|
def get_audiences_with_http_info(opts = {})
|
3186
3189
|
if @api_client.config.debugging
|
3187
3190
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
|
@@ -3208,7 +3211,7 @@ module TalonOne
|
|
3208
3211
|
post_body = opts[:body]
|
3209
3212
|
|
3210
3213
|
# return_type
|
3211
|
-
return_type = opts[:return_type] || '
|
3214
|
+
return_type = opts[:return_type] || 'InlineResponse20019'
|
3212
3215
|
|
3213
3216
|
# auth_names
|
3214
3217
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -3302,7 +3305,7 @@ module TalonOne
|
|
3302
3305
|
# @param range_end [DateTime] Only return results from before this timestamp, must be an RFC3339 timestamp string
|
3303
3306
|
# @param [Hash] opts the optional parameters
|
3304
3307
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
3305
|
-
# @return [
|
3308
|
+
# @return [InlineResponse20010]
|
3306
3309
|
def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {})
|
3307
3310
|
data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts)
|
3308
3311
|
data
|
@@ -3315,7 +3318,7 @@ module TalonOne
|
|
3315
3318
|
# @param range_end [DateTime] Only return results from before this timestamp, must be an RFC3339 timestamp string
|
3316
3319
|
# @param [Hash] opts the optional parameters
|
3317
3320
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
3318
|
-
# @return [Array<(
|
3321
|
+
# @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
|
3319
3322
|
def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {})
|
3320
3323
|
if @api_client.config.debugging
|
3321
3324
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...'
|
@@ -3361,7 +3364,7 @@ module TalonOne
|
|
3361
3364
|
post_body = opts[:body]
|
3362
3365
|
|
3363
3366
|
# return_type
|
3364
|
-
return_type = opts[:return_type] || '
|
3367
|
+
return_type = opts[:return_type] || 'InlineResponse20010'
|
3365
3368
|
|
3366
3369
|
# auth_names
|
3367
3370
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -3570,9 +3573,9 @@ module TalonOne
|
|
3570
3573
|
# @option opts [Integer] :user_id
|
3571
3574
|
# @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.
|
3572
3575
|
# @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.
|
3573
|
-
# @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
|
3576
|
+
# @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.
|
3574
3577
|
# @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.
|
3575
|
-
# @return [
|
3578
|
+
# @return [InlineResponse20027]
|
3576
3579
|
def get_changes(opts = {})
|
3577
3580
|
data, _status_code, _headers = get_changes_with_http_info(opts)
|
3578
3581
|
data
|
@@ -3589,9 +3592,9 @@ module TalonOne
|
|
3589
3592
|
# @option opts [Integer] :user_id
|
3590
3593
|
# @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.
|
3591
3594
|
# @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.
|
3592
|
-
# @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
|
3595
|
+
# @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.
|
3593
3596
|
# @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.
|
3594
|
-
# @return [Array<(
|
3597
|
+
# @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
|
3595
3598
|
def get_changes_with_http_info(opts = {})
|
3596
3599
|
if @api_client.config.debugging
|
3597
3600
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
|
@@ -3624,7 +3627,7 @@ module TalonOne
|
|
3624
3627
|
post_body = opts[:body]
|
3625
3628
|
|
3626
3629
|
# return_type
|
3627
|
-
return_type = opts[:return_type] || '
|
3630
|
+
return_type = opts[:return_type] || 'InlineResponse20027'
|
3628
3631
|
|
3629
3632
|
# auth_names
|
3630
3633
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -4219,7 +4222,7 @@ module TalonOne
|
|
4219
4222
|
# @option opts [String] :integration_id Only return reports matching the integrationId
|
4220
4223
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
4221
4224
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
4222
|
-
# @return [
|
4225
|
+
# @return [InlineResponse20013]
|
4223
4226
|
def get_customer_activity_reports(range_start, range_end, application_id, opts = {})
|
4224
4227
|
data, _status_code, _headers = get_customer_activity_reports_with_http_info(range_start, range_end, application_id, opts)
|
4225
4228
|
data
|
@@ -4238,7 +4241,7 @@ module TalonOne
|
|
4238
4241
|
# @option opts [String] :integration_id Only return reports matching the integrationId
|
4239
4242
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
4240
4243
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
4241
|
-
# @return [Array<(
|
4244
|
+
# @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
|
4242
4245
|
def get_customer_activity_reports_with_http_info(range_start, range_end, application_id, opts = {})
|
4243
4246
|
if @api_client.config.debugging
|
4244
4247
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports ...'
|
@@ -4282,7 +4285,7 @@ module TalonOne
|
|
4282
4285
|
post_body = opts[:body]
|
4283
4286
|
|
4284
4287
|
# return_type
|
4285
|
-
return_type = opts[:return_type] || '
|
4288
|
+
return_type = opts[:return_type] || 'InlineResponse20013'
|
4286
4289
|
|
4287
4290
|
# auth_names
|
4288
4291
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -4316,7 +4319,7 @@ module TalonOne
|
|
4316
4319
|
# @option opts [String] :integration_id Only return reports matching the integrationId
|
4317
4320
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
4318
4321
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
4319
|
-
# @return [
|
4322
|
+
# @return [InlineResponse20014]
|
4320
4323
|
def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {})
|
4321
4324
|
data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts)
|
4322
4325
|
data
|
@@ -4335,7 +4338,7 @@ module TalonOne
|
|
4335
4338
|
# @option opts [String] :integration_id Only return reports matching the integrationId
|
4336
4339
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
4337
4340
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
4338
|
-
# @return [Array<(
|
4341
|
+
# @return [Array<(InlineResponse20014, Integer, Hash)>] InlineResponse20014 data, response status code and response headers
|
4339
4342
|
def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {})
|
4340
4343
|
if @api_client.config.debugging
|
4341
4344
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...'
|
@@ -4379,7 +4382,7 @@ module TalonOne
|
|
4379
4382
|
post_body = opts[:body]
|
4380
4383
|
|
4381
4384
|
# return_type
|
4382
|
-
return_type = opts[:return_type] || '
|
4385
|
+
return_type = opts[:return_type] || 'InlineResponse20014'
|
4383
4386
|
|
4384
4387
|
# auth_names
|
4385
4388
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -4541,7 +4544,7 @@ module TalonOne
|
|
4541
4544
|
# @param [Hash] opts the optional parameters
|
4542
4545
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4543
4546
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4544
|
-
# @return [
|
4547
|
+
# @return [InlineResponse20012]
|
4545
4548
|
def get_customer_profiles(opts = {})
|
4546
4549
|
data, _status_code, _headers = get_customer_profiles_with_http_info(opts)
|
4547
4550
|
data
|
@@ -4551,7 +4554,7 @@ module TalonOne
|
|
4551
4554
|
# @param [Hash] opts the optional parameters
|
4552
4555
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4553
4556
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4554
|
-
# @return [Array<(
|
4557
|
+
# @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
|
4555
4558
|
def get_customer_profiles_with_http_info(opts = {})
|
4556
4559
|
if @api_client.config.debugging
|
4557
4560
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...'
|
@@ -4576,7 +4579,7 @@ module TalonOne
|
|
4576
4579
|
post_body = opts[:body]
|
4577
4580
|
|
4578
4581
|
# return_type
|
4579
|
-
return_type = opts[:return_type] || '
|
4582
|
+
return_type = opts[:return_type] || 'InlineResponse20012'
|
4580
4583
|
|
4581
4584
|
# auth_names
|
4582
4585
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -4603,7 +4606,7 @@ module TalonOne
|
|
4603
4606
|
# @param [Hash] opts the optional parameters
|
4604
4607
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4605
4608
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4606
|
-
# @return [
|
4609
|
+
# @return [InlineResponse20012]
|
4607
4610
|
def get_customers_by_attributes(body, opts = {})
|
4608
4611
|
data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts)
|
4609
4612
|
data
|
@@ -4615,7 +4618,7 @@ module TalonOne
|
|
4615
4618
|
# @param [Hash] opts the optional parameters
|
4616
4619
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4617
4620
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4618
|
-
# @return [Array<(
|
4621
|
+
# @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
|
4619
4622
|
def get_customers_by_attributes_with_http_info(body, opts = {})
|
4620
4623
|
if @api_client.config.debugging
|
4621
4624
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...'
|
@@ -4646,7 +4649,7 @@ module TalonOne
|
|
4646
4649
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
4647
4650
|
|
4648
4651
|
# return_type
|
4649
|
-
return_type = opts[:return_type] || '
|
4652
|
+
return_type = opts[:return_type] || 'InlineResponse20012'
|
4650
4653
|
|
4651
4654
|
# auth_names
|
4652
4655
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -4676,7 +4679,7 @@ module TalonOne
|
|
4676
4679
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4677
4680
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4678
4681
|
# @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.
|
4679
|
-
# @return [
|
4682
|
+
# @return [InlineResponse20025]
|
4680
4683
|
def get_event_types(opts = {})
|
4681
4684
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
4682
4685
|
data
|
@@ -4691,7 +4694,7 @@ module TalonOne
|
|
4691
4694
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4692
4695
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4693
4696
|
# @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.
|
4694
|
-
# @return [Array<(
|
4697
|
+
# @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
|
4695
4698
|
def get_event_types_with_http_info(opts = {})
|
4696
4699
|
if @api_client.config.debugging
|
4697
4700
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
|
@@ -4720,7 +4723,7 @@ module TalonOne
|
|
4720
4723
|
post_body = opts[:body]
|
4721
4724
|
|
4722
4725
|
# return_type
|
4723
|
-
return_type = opts[:return_type] || '
|
4726
|
+
return_type = opts[:return_type] || 'InlineResponse20025'
|
4724
4727
|
|
4725
4728
|
# auth_names
|
4726
4729
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -4749,7 +4752,7 @@ module TalonOne
|
|
4749
4752
|
# @option opts [Integer] :application_id
|
4750
4753
|
# @option opts [Integer] :campaign_id
|
4751
4754
|
# @option opts [String] :entity The name of the entity type that was exported.
|
4752
|
-
# @return [
|
4755
|
+
# @return [InlineResponse20028]
|
4753
4756
|
def get_exports(opts = {})
|
4754
4757
|
data, _status_code, _headers = get_exports_with_http_info(opts)
|
4755
4758
|
data
|
@@ -4763,12 +4766,12 @@ module TalonOne
|
|
4763
4766
|
# @option opts [Integer] :application_id
|
4764
4767
|
# @option opts [Integer] :campaign_id
|
4765
4768
|
# @option opts [String] :entity The name of the entity type that was exported.
|
4766
|
-
# @return [Array<(
|
4769
|
+
# @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
|
4767
4770
|
def get_exports_with_http_info(opts = {})
|
4768
4771
|
if @api_client.config.debugging
|
4769
4772
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
|
4770
4773
|
end
|
4771
|
-
allowable_values = ["Coupon", "Effect", "CustomerSession"]
|
4774
|
+
allowable_values = ["Coupon", "Effect", "CustomerSession", "LoyaltyLedger", "LoyaltyLedgerLog"]
|
4772
4775
|
if @api_client.config.client_side_validation && opts[:'entity'] && !allowable_values.include?(opts[:'entity'])
|
4773
4776
|
fail ArgumentError, "invalid value for \"entity\", must be one of #{allowable_values}"
|
4774
4777
|
end
|
@@ -4795,7 +4798,7 @@ module TalonOne
|
|
4795
4798
|
post_body = opts[:body]
|
4796
4799
|
|
4797
4800
|
# return_type
|
4798
|
-
return_type = opts[:return_type] || '
|
4801
|
+
return_type = opts[:return_type] || 'InlineResponse20028'
|
4799
4802
|
|
4800
4803
|
# auth_names
|
4801
4804
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -4885,7 +4888,7 @@ module TalonOne
|
|
4885
4888
|
end
|
4886
4889
|
|
4887
4890
|
# Get a loyalty program
|
4888
|
-
# @param program_id [
|
4891
|
+
# @param program_id [Integer]
|
4889
4892
|
# @param [Hash] opts the optional parameters
|
4890
4893
|
# @return [LoyaltyProgram]
|
4891
4894
|
def get_loyalty_program(program_id, opts = {})
|
@@ -4894,7 +4897,7 @@ module TalonOne
|
|
4894
4897
|
end
|
4895
4898
|
|
4896
4899
|
# Get a loyalty program
|
4897
|
-
# @param program_id [
|
4900
|
+
# @param program_id [Integer]
|
4898
4901
|
# @param [Hash] opts the optional parameters
|
4899
4902
|
# @return [Array<(LoyaltyProgram, Integer, Hash)>] LoyaltyProgram data, response status code and response headers
|
4900
4903
|
def get_loyalty_program_with_http_info(program_id, opts = {})
|
@@ -4946,7 +4949,7 @@ module TalonOne
|
|
4946
4949
|
|
4947
4950
|
# List all loyalty Programs
|
4948
4951
|
# @param [Hash] opts the optional parameters
|
4949
|
-
# @return [
|
4952
|
+
# @return [InlineResponse2007]
|
4950
4953
|
def get_loyalty_programs(opts = {})
|
4951
4954
|
data, _status_code, _headers = get_loyalty_programs_with_http_info(opts)
|
4952
4955
|
data
|
@@ -4954,7 +4957,7 @@ module TalonOne
|
|
4954
4957
|
|
4955
4958
|
# List all loyalty Programs
|
4956
4959
|
# @param [Hash] opts the optional parameters
|
4957
|
-
# @return [Array<(
|
4960
|
+
# @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
|
4958
4961
|
def get_loyalty_programs_with_http_info(opts = {})
|
4959
4962
|
if @api_client.config.debugging
|
4960
4963
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_programs ...'
|
@@ -4977,7 +4980,7 @@ module TalonOne
|
|
4977
4980
|
post_body = opts[:body]
|
4978
4981
|
|
4979
4982
|
# return_type
|
4980
|
-
return_type = opts[:return_type] || '
|
4983
|
+
return_type = opts[:return_type] || 'InlineResponse2007'
|
4981
4984
|
|
4982
4985
|
# auth_names
|
4983
4986
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -5071,7 +5074,7 @@ module TalonOne
|
|
5071
5074
|
# @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.
|
5072
5075
|
# @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`.
|
5073
5076
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
5074
|
-
# @return [
|
5077
|
+
# @return [InlineResponse201]
|
5075
5078
|
def get_referrals(application_id, campaign_id, opts = {})
|
5076
5079
|
data, _status_code, _headers = get_referrals_with_http_info(application_id, campaign_id, opts)
|
5077
5080
|
data
|
@@ -5090,7 +5093,7 @@ module TalonOne
|
|
5090
5093
|
# @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.
|
5091
5094
|
# @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`.
|
5092
5095
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
5093
|
-
# @return [Array<(
|
5096
|
+
# @return [Array<(InlineResponse201, Integer, Hash)>] InlineResponse201 data, response status code and response headers
|
5094
5097
|
def get_referrals_with_http_info(application_id, campaign_id, opts = {})
|
5095
5098
|
if @api_client.config.debugging
|
5096
5099
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals ...'
|
@@ -5138,7 +5141,7 @@ module TalonOne
|
|
5138
5141
|
post_body = opts[:body]
|
5139
5142
|
|
5140
5143
|
# return_type
|
5141
|
-
return_type = opts[:return_type] || '
|
5144
|
+
return_type = opts[:return_type] || 'InlineResponse201'
|
5142
5145
|
|
5143
5146
|
# auth_names
|
5144
5147
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -5172,7 +5175,7 @@ module TalonOne
|
|
5172
5175
|
# @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.
|
5173
5176
|
# @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`.
|
5174
5177
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
5175
|
-
# @return [
|
5178
|
+
# @return [InlineResponse2006]
|
5176
5179
|
def get_referrals_without_total_count(application_id, campaign_id, opts = {})
|
5177
5180
|
data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts)
|
5178
5181
|
data
|
@@ -5191,7 +5194,7 @@ module TalonOne
|
|
5191
5194
|
# @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.
|
5192
5195
|
# @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`.
|
5193
5196
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
5194
|
-
# @return [Array<(
|
5197
|
+
# @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
|
5195
5198
|
def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
5196
5199
|
if @api_client.config.debugging
|
5197
5200
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals_without_total_count ...'
|
@@ -5239,7 +5242,7 @@ module TalonOne
|
|
5239
5242
|
post_body = opts[:body]
|
5240
5243
|
|
5241
5244
|
# return_type
|
5242
|
-
return_type = opts[:return_type] || '
|
5245
|
+
return_type = opts[:return_type] || 'InlineResponse2006'
|
5243
5246
|
|
5244
5247
|
# auth_names
|
5245
5248
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -5535,7 +5538,7 @@ module TalonOne
|
|
5535
5538
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
5536
5539
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5537
5540
|
# @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.
|
5538
|
-
# @return [
|
5541
|
+
# @return [InlineResponse20026]
|
5539
5542
|
def get_users(opts = {})
|
5540
5543
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
5541
5544
|
data
|
@@ -5547,7 +5550,7 @@ module TalonOne
|
|
5547
5550
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
5548
5551
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5549
5552
|
# @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.
|
5550
|
-
# @return [Array<(
|
5553
|
+
# @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
|
5551
5554
|
def get_users_with_http_info(opts = {})
|
5552
5555
|
if @api_client.config.debugging
|
5553
5556
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
|
@@ -5573,7 +5576,7 @@ module TalonOne
|
|
5573
5576
|
post_body = opts[:body]
|
5574
5577
|
|
5575
5578
|
# return_type
|
5576
|
-
return_type = opts[:return_type] || '
|
5579
|
+
return_type = opts[:return_type] || 'InlineResponse20026'
|
5577
5580
|
|
5578
5581
|
# auth_names
|
5579
5582
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -5668,7 +5671,7 @@ module TalonOne
|
|
5668
5671
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
5669
5672
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
5670
5673
|
# @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.
|
5671
|
-
# @return [
|
5674
|
+
# @return [InlineResponse20023]
|
5672
5675
|
def get_webhook_activation_logs(opts = {})
|
5673
5676
|
data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
|
5674
5677
|
data
|
@@ -5686,7 +5689,7 @@ module TalonOne
|
|
5686
5689
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
5687
5690
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
5688
5691
|
# @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.
|
5689
|
-
# @return [Array<(
|
5692
|
+
# @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
|
5690
5693
|
def get_webhook_activation_logs_with_http_info(opts = {})
|
5691
5694
|
if @api_client.config.debugging
|
5692
5695
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
|
@@ -5718,7 +5721,7 @@ module TalonOne
|
|
5718
5721
|
post_body = opts[:body]
|
5719
5722
|
|
5720
5723
|
# return_type
|
5721
|
-
return_type = opts[:return_type] || '
|
5724
|
+
return_type = opts[:return_type] || 'InlineResponse20023'
|
5722
5725
|
|
5723
5726
|
# auth_names
|
5724
5727
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -5751,7 +5754,7 @@ module TalonOne
|
|
5751
5754
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
5752
5755
|
# @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.
|
5753
5756
|
# @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.
|
5754
|
-
# @return [
|
5757
|
+
# @return [InlineResponse20024]
|
5755
5758
|
def get_webhook_logs(opts = {})
|
5756
5759
|
data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
|
5757
5760
|
data
|
@@ -5769,7 +5772,7 @@ module TalonOne
|
|
5769
5772
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
5770
5773
|
# @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.
|
5771
5774
|
# @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.
|
5772
|
-
# @return [Array<(
|
5775
|
+
# @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
|
5773
5776
|
def get_webhook_logs_with_http_info(opts = {})
|
5774
5777
|
if @api_client.config.debugging
|
5775
5778
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
|
@@ -5806,7 +5809,7 @@ module TalonOne
|
|
5806
5809
|
post_body = opts[:body]
|
5807
5810
|
|
5808
5811
|
# return_type
|
5809
|
-
return_type = opts[:return_type] || '
|
5812
|
+
return_type = opts[:return_type] || 'InlineResponse20024'
|
5810
5813
|
|
5811
5814
|
# auth_names
|
5812
5815
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -5833,7 +5836,7 @@ module TalonOne
|
|
5833
5836
|
# @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.
|
5834
5837
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
5835
5838
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5836
|
-
# @return [
|
5839
|
+
# @return [InlineResponse20022]
|
5837
5840
|
def get_webhooks(opts = {})
|
5838
5841
|
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
5839
5842
|
data
|
@@ -5845,7 +5848,7 @@ module TalonOne
|
|
5845
5848
|
# @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.
|
5846
5849
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
5847
5850
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5848
|
-
# @return [Array<(
|
5851
|
+
# @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
|
5849
5852
|
def get_webhooks_with_http_info(opts = {})
|
5850
5853
|
if @api_client.config.debugging
|
5851
5854
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
@@ -5872,7 +5875,7 @@ module TalonOne
|
|
5872
5875
|
post_body = opts[:body]
|
5873
5876
|
|
5874
5877
|
# return_type
|
5875
|
-
return_type = opts[:return_type] || '
|
5878
|
+
return_type = opts[:return_type] || 'InlineResponse20022'
|
5876
5879
|
|
5877
5880
|
# auth_names
|
5878
5881
|
auth_names = opts[:auth_names] || ['manager_auth']
|
@@ -5893,6 +5896,286 @@ module TalonOne
|
|
5893
5896
|
return data, status_code, headers
|
5894
5897
|
end
|
5895
5898
|
|
5899
|
+
# Import coupons via CSV file
|
5900
|
+
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
|
5901
|
+
# @param application_id [Integer]
|
5902
|
+
# @param campaign_id [Integer]
|
5903
|
+
# @param [Hash] opts the optional parameters
|
5904
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
5905
|
+
# @return [Import]
|
5906
|
+
def import_coupons(application_id, campaign_id, opts = {})
|
5907
|
+
data, _status_code, _headers = import_coupons_with_http_info(application_id, campaign_id, opts)
|
5908
|
+
data
|
5909
|
+
end
|
5910
|
+
|
5911
|
+
# Import coupons via CSV file
|
5912
|
+
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
|
5913
|
+
# @param application_id [Integer]
|
5914
|
+
# @param campaign_id [Integer]
|
5915
|
+
# @param [Hash] opts the optional parameters
|
5916
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
5917
|
+
# @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
|
5918
|
+
def import_coupons_with_http_info(application_id, campaign_id, opts = {})
|
5919
|
+
if @api_client.config.debugging
|
5920
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.import_coupons ...'
|
5921
|
+
end
|
5922
|
+
# verify the required parameter 'application_id' is set
|
5923
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
5924
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_coupons"
|
5925
|
+
end
|
5926
|
+
# verify the required parameter 'campaign_id' is set
|
5927
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
5928
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_coupons"
|
5929
|
+
end
|
5930
|
+
# resource path
|
5931
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
5932
|
+
|
5933
|
+
# query parameters
|
5934
|
+
query_params = opts[:query_params] || {}
|
5935
|
+
|
5936
|
+
# header parameters
|
5937
|
+
header_params = opts[:header_params] || {}
|
5938
|
+
# HTTP header 'Accept' (if needed)
|
5939
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5940
|
+
# HTTP header 'Content-Type'
|
5941
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
5942
|
+
|
5943
|
+
# form parameters
|
5944
|
+
form_params = opts[:form_params] || {}
|
5945
|
+
form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
|
5946
|
+
|
5947
|
+
# http body (model)
|
5948
|
+
post_body = opts[:body]
|
5949
|
+
|
5950
|
+
# return_type
|
5951
|
+
return_type = opts[:return_type] || 'Import'
|
5952
|
+
|
5953
|
+
# auth_names
|
5954
|
+
auth_names = opts[:auth_names] || ['manager_auth']
|
5955
|
+
|
5956
|
+
new_options = opts.merge(
|
5957
|
+
:header_params => header_params,
|
5958
|
+
:query_params => query_params,
|
5959
|
+
:form_params => form_params,
|
5960
|
+
:body => post_body,
|
5961
|
+
:auth_names => auth_names,
|
5962
|
+
:return_type => return_type
|
5963
|
+
)
|
5964
|
+
|
5965
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5966
|
+
if @api_client.config.debugging
|
5967
|
+
@api_client.config.logger.debug "API called: ManagementApi#import_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5968
|
+
end
|
5969
|
+
return data, status_code, headers
|
5970
|
+
end
|
5971
|
+
|
5972
|
+
# Import loyalty points via CSV file
|
5973
|
+
# Upload a CSV file containing the loyalty points that should be created. The file should be sent as multipart data.
|
5974
|
+
# @param program_id [Integer]
|
5975
|
+
# @param [Hash] opts the optional parameters
|
5976
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
5977
|
+
# @return [Import]
|
5978
|
+
def import_loyalty_points(program_id, opts = {})
|
5979
|
+
data, _status_code, _headers = import_loyalty_points_with_http_info(program_id, opts)
|
5980
|
+
data
|
5981
|
+
end
|
5982
|
+
|
5983
|
+
# Import loyalty points via CSV file
|
5984
|
+
# Upload a CSV file containing the loyalty points that should be created. The file should be sent as multipart data.
|
5985
|
+
# @param program_id [Integer]
|
5986
|
+
# @param [Hash] opts the optional parameters
|
5987
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
5988
|
+
# @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
|
5989
|
+
def import_loyalty_points_with_http_info(program_id, opts = {})
|
5990
|
+
if @api_client.config.debugging
|
5991
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.import_loyalty_points ...'
|
5992
|
+
end
|
5993
|
+
# verify the required parameter 'program_id' is set
|
5994
|
+
if @api_client.config.client_side_validation && program_id.nil?
|
5995
|
+
fail ArgumentError, "Missing the required parameter 'program_id' when calling ManagementApi.import_loyalty_points"
|
5996
|
+
end
|
5997
|
+
# resource path
|
5998
|
+
local_var_path = '/v1/loyalty_programs/{programID}/import_points'.sub('{' + 'programID' + '}', CGI.escape(program_id.to_s))
|
5999
|
+
|
6000
|
+
# query parameters
|
6001
|
+
query_params = opts[:query_params] || {}
|
6002
|
+
|
6003
|
+
# header parameters
|
6004
|
+
header_params = opts[:header_params] || {}
|
6005
|
+
# HTTP header 'Accept' (if needed)
|
6006
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6007
|
+
# HTTP header 'Content-Type'
|
6008
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
6009
|
+
|
6010
|
+
# form parameters
|
6011
|
+
form_params = opts[:form_params] || {}
|
6012
|
+
form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
|
6013
|
+
|
6014
|
+
# http body (model)
|
6015
|
+
post_body = opts[:body]
|
6016
|
+
|
6017
|
+
# return_type
|
6018
|
+
return_type = opts[:return_type] || 'Import'
|
6019
|
+
|
6020
|
+
# auth_names
|
6021
|
+
auth_names = opts[:auth_names] || ['manager_auth']
|
6022
|
+
|
6023
|
+
new_options = opts.merge(
|
6024
|
+
:header_params => header_params,
|
6025
|
+
:query_params => query_params,
|
6026
|
+
:form_params => form_params,
|
6027
|
+
:body => post_body,
|
6028
|
+
:auth_names => auth_names,
|
6029
|
+
:return_type => return_type
|
6030
|
+
)
|
6031
|
+
|
6032
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6033
|
+
if @api_client.config.debugging
|
6034
|
+
@api_client.config.logger.debug "API called: ManagementApi#import_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6035
|
+
end
|
6036
|
+
return data, status_code, headers
|
6037
|
+
end
|
6038
|
+
|
6039
|
+
# Import giveaways codes into a giveaways pool
|
6040
|
+
# 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.
|
6041
|
+
# @param pool_id [Integer]
|
6042
|
+
# @param [Hash] opts the optional parameters
|
6043
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
6044
|
+
# @return [Import]
|
6045
|
+
def import_pool_giveaways(pool_id, opts = {})
|
6046
|
+
data, _status_code, _headers = import_pool_giveaways_with_http_info(pool_id, opts)
|
6047
|
+
data
|
6048
|
+
end
|
6049
|
+
|
6050
|
+
# Import giveaways codes into a giveaways pool
|
6051
|
+
# 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.
|
6052
|
+
# @param pool_id [Integer]
|
6053
|
+
# @param [Hash] opts the optional parameters
|
6054
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
6055
|
+
# @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
|
6056
|
+
def import_pool_giveaways_with_http_info(pool_id, opts = {})
|
6057
|
+
if @api_client.config.debugging
|
6058
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.import_pool_giveaways ...'
|
6059
|
+
end
|
6060
|
+
# verify the required parameter 'pool_id' is set
|
6061
|
+
if @api_client.config.client_side_validation && pool_id.nil?
|
6062
|
+
fail ArgumentError, "Missing the required parameter 'pool_id' when calling ManagementApi.import_pool_giveaways"
|
6063
|
+
end
|
6064
|
+
# resource path
|
6065
|
+
local_var_path = '/v1/giveaways/pools/{poolId}/import'.sub('{' + 'poolId' + '}', CGI.escape(pool_id.to_s))
|
6066
|
+
|
6067
|
+
# query parameters
|
6068
|
+
query_params = opts[:query_params] || {}
|
6069
|
+
|
6070
|
+
# header parameters
|
6071
|
+
header_params = opts[:header_params] || {}
|
6072
|
+
# HTTP header 'Accept' (if needed)
|
6073
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6074
|
+
# HTTP header 'Content-Type'
|
6075
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
6076
|
+
|
6077
|
+
# form parameters
|
6078
|
+
form_params = opts[:form_params] || {}
|
6079
|
+
form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
|
6080
|
+
|
6081
|
+
# http body (model)
|
6082
|
+
post_body = opts[:body]
|
6083
|
+
|
6084
|
+
# return_type
|
6085
|
+
return_type = opts[:return_type] || 'Import'
|
6086
|
+
|
6087
|
+
# auth_names
|
6088
|
+
auth_names = opts[:auth_names] || ['manager_auth']
|
6089
|
+
|
6090
|
+
new_options = opts.merge(
|
6091
|
+
:header_params => header_params,
|
6092
|
+
:query_params => query_params,
|
6093
|
+
:form_params => form_params,
|
6094
|
+
:body => post_body,
|
6095
|
+
:auth_names => auth_names,
|
6096
|
+
:return_type => return_type
|
6097
|
+
)
|
6098
|
+
|
6099
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6100
|
+
if @api_client.config.debugging
|
6101
|
+
@api_client.config.logger.debug "API called: ManagementApi#import_pool_giveaways\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6102
|
+
end
|
6103
|
+
return data, status_code, headers
|
6104
|
+
end
|
6105
|
+
|
6106
|
+
# Import referrals via CSV file
|
6107
|
+
# 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.
|
6108
|
+
# @param application_id [Integer]
|
6109
|
+
# @param campaign_id [Integer]
|
6110
|
+
# @param [Hash] opts the optional parameters
|
6111
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
6112
|
+
# @return [Import]
|
6113
|
+
def import_referrals(application_id, campaign_id, opts = {})
|
6114
|
+
data, _status_code, _headers = import_referrals_with_http_info(application_id, campaign_id, opts)
|
6115
|
+
data
|
6116
|
+
end
|
6117
|
+
|
6118
|
+
# Import referrals via CSV file
|
6119
|
+
# 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.
|
6120
|
+
# @param application_id [Integer]
|
6121
|
+
# @param campaign_id [Integer]
|
6122
|
+
# @param [Hash] opts the optional parameters
|
6123
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
6124
|
+
# @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
|
6125
|
+
def import_referrals_with_http_info(application_id, campaign_id, opts = {})
|
6126
|
+
if @api_client.config.debugging
|
6127
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.import_referrals ...'
|
6128
|
+
end
|
6129
|
+
# verify the required parameter 'application_id' is set
|
6130
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
6131
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_referrals"
|
6132
|
+
end
|
6133
|
+
# verify the required parameter 'campaign_id' is set
|
6134
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
6135
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_referrals"
|
6136
|
+
end
|
6137
|
+
# resource path
|
6138
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
6139
|
+
|
6140
|
+
# query parameters
|
6141
|
+
query_params = opts[:query_params] || {}
|
6142
|
+
|
6143
|
+
# header parameters
|
6144
|
+
header_params = opts[:header_params] || {}
|
6145
|
+
# HTTP header 'Accept' (if needed)
|
6146
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6147
|
+
# HTTP header 'Content-Type'
|
6148
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
6149
|
+
|
6150
|
+
# form parameters
|
6151
|
+
form_params = opts[:form_params] || {}
|
6152
|
+
form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
|
6153
|
+
|
6154
|
+
# http body (model)
|
6155
|
+
post_body = opts[:body]
|
6156
|
+
|
6157
|
+
# return_type
|
6158
|
+
return_type = opts[:return_type] || 'Import'
|
6159
|
+
|
6160
|
+
# auth_names
|
6161
|
+
auth_names = opts[:auth_names] || ['manager_auth']
|
6162
|
+
|
6163
|
+
new_options = opts.merge(
|
6164
|
+
:header_params => header_params,
|
6165
|
+
:query_params => query_params,
|
6166
|
+
:form_params => form_params,
|
6167
|
+
:body => post_body,
|
6168
|
+
:auth_names => auth_names,
|
6169
|
+
:return_type => return_type
|
6170
|
+
)
|
6171
|
+
|
6172
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6173
|
+
if @api_client.config.debugging
|
6174
|
+
@api_client.config.logger.debug "API called: ManagementApi#import_referrals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6175
|
+
end
|
6176
|
+
return data, status_code, headers
|
6177
|
+
end
|
6178
|
+
|
5896
6179
|
# Deduct points in a certain loyalty program for the specified customer
|
5897
6180
|
# @param program_id [String]
|
5898
6181
|
# @param integration_id [String]
|
@@ -6877,6 +7160,86 @@ module TalonOne
|
|
6877
7160
|
return data, status_code, headers
|
6878
7161
|
end
|
6879
7162
|
|
7163
|
+
# Update one Referral
|
7164
|
+
# @param application_id [Integer]
|
7165
|
+
# @param campaign_id [Integer]
|
7166
|
+
# @param referral_id [String] The ID of the referral code to delete
|
7167
|
+
# @param body [UpdateReferral]
|
7168
|
+
# @param [Hash] opts the optional parameters
|
7169
|
+
# @return [Referral]
|
7170
|
+
def update_referral(application_id, campaign_id, referral_id, body, opts = {})
|
7171
|
+
data, _status_code, _headers = update_referral_with_http_info(application_id, campaign_id, referral_id, body, opts)
|
7172
|
+
data
|
7173
|
+
end
|
7174
|
+
|
7175
|
+
# Update one Referral
|
7176
|
+
# @param application_id [Integer]
|
7177
|
+
# @param campaign_id [Integer]
|
7178
|
+
# @param referral_id [String] The ID of the referral code to delete
|
7179
|
+
# @param body [UpdateReferral]
|
7180
|
+
# @param [Hash] opts the optional parameters
|
7181
|
+
# @return [Array<(Referral, Integer, Hash)>] Referral data, response status code and response headers
|
7182
|
+
def update_referral_with_http_info(application_id, campaign_id, referral_id, body, opts = {})
|
7183
|
+
if @api_client.config.debugging
|
7184
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.update_referral ...'
|
7185
|
+
end
|
7186
|
+
# verify the required parameter 'application_id' is set
|
7187
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
7188
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_referral"
|
7189
|
+
end
|
7190
|
+
# verify the required parameter 'campaign_id' is set
|
7191
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
7192
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_referral"
|
7193
|
+
end
|
7194
|
+
# verify the required parameter 'referral_id' is set
|
7195
|
+
if @api_client.config.client_side_validation && referral_id.nil?
|
7196
|
+
fail ArgumentError, "Missing the required parameter 'referral_id' when calling ManagementApi.update_referral"
|
7197
|
+
end
|
7198
|
+
# verify the required parameter 'body' is set
|
7199
|
+
if @api_client.config.client_side_validation && body.nil?
|
7200
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_referral"
|
7201
|
+
end
|
7202
|
+
# resource path
|
7203
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'referralId' + '}', CGI.escape(referral_id.to_s))
|
7204
|
+
|
7205
|
+
# query parameters
|
7206
|
+
query_params = opts[:query_params] || {}
|
7207
|
+
|
7208
|
+
# header parameters
|
7209
|
+
header_params = opts[:header_params] || {}
|
7210
|
+
# HTTP header 'Accept' (if needed)
|
7211
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7212
|
+
# HTTP header 'Content-Type'
|
7213
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7214
|
+
|
7215
|
+
# form parameters
|
7216
|
+
form_params = opts[:form_params] || {}
|
7217
|
+
|
7218
|
+
# http body (model)
|
7219
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
7220
|
+
|
7221
|
+
# return_type
|
7222
|
+
return_type = opts[:return_type] || 'Referral'
|
7223
|
+
|
7224
|
+
# auth_names
|
7225
|
+
auth_names = opts[:auth_names] || ['manager_auth']
|
7226
|
+
|
7227
|
+
new_options = opts.merge(
|
7228
|
+
:header_params => header_params,
|
7229
|
+
:query_params => query_params,
|
7230
|
+
:form_params => form_params,
|
7231
|
+
:body => post_body,
|
7232
|
+
:auth_names => auth_names,
|
7233
|
+
:return_type => return_type
|
7234
|
+
)
|
7235
|
+
|
7236
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
7237
|
+
if @api_client.config.debugging
|
7238
|
+
@api_client.config.logger.debug "API called: ManagementApi#update_referral\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7239
|
+
end
|
7240
|
+
return data, status_code, headers
|
7241
|
+
end
|
7242
|
+
|
6880
7243
|
# Update a Ruleset
|
6881
7244
|
# @param application_id [Integer]
|
6882
7245
|
# @param campaign_id [Integer]
|