Class: TalonOne::ManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/api/management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ManagementApi

Returns a new instance of ManagementApi.



19
20
21
 
# File 'lib/talon_one/api/management_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/talon_one/api/management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#activate_user_by_email(body, opts = {}) ⇒ nil

Enable user by email address Enable a [disabled user](docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.

Parameters:

  • body (DeleteUserRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/talon_one/api/management_api.rb', line 27

def activate_user_by_email(body, opts = {})
  activate_user_by_email_with_http_info(body, opts)
  nil
end

#activate_user_by_email_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Enable user by email address Enable a [disabled user](docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.

Parameters:

  • body (DeleteUserRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/talon_one/api/management_api.rb', line 37

def activate_user_by_email_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.activate_user_by_email ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.activate_user_by_email"
  end
  # resource path
  local_var_path = '/v1/users/activate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#activate_user_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_loyalty_card_points(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ nil

Add points to card Add points to the given loyalty card in the specified card-based loyalty program.

Parameters:

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/talon_one/api/management_api.rb', line 91

def add_loyalty_card_points(loyalty_program_id, loyalty_card_id, body, opts = {})
  add_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
  nil
end

#add_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add points to card Add points to the given loyalty card in the specified card-based loyalty program.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/talon_one/api/management_api.rb', line 103

def add_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.add_loyalty_card_points ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.add_loyalty_card_points"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.add_loyalty_card_points"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.add_loyalty_card_points, the character length must be smaller than or equal to 108.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.add_loyalty_card_points"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#add_loyalty_card_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_loyalty_points(loyalty_program_id, integration_id, body, opts = {}) ⇒ nil

Add points to customer profile Add points in the specified loyalty program for the given customer. To get the ‘integrationId` of the profile from a `sessionId`, use the [Update customer session](docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • body (AddLoyaltyPoints) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


171
172
173
174
 
# File 'lib/talon_one/api/management_api.rb', line 171

def add_loyalty_points(loyalty_program_id, integration_id, body, opts = {})
  add_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts)
  nil
end

#add_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add points to customer profile Add points in the specified loyalty program for the given customer. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • body (AddLoyaltyPoints) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/talon_one/api/management_api.rb', line 183

def add_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.add_loyalty_points ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.add_loyalty_points"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.add_loyalty_points"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.add_loyalty_points"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#add_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_campaign_to_applications(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2008

Copy the campaign into the specified Application Copy the campaign into all specified Applications.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (CampaignCopy) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



247
248
249
250
 
# File 'lib/talon_one/api/management_api.rb', line 247

def copy_campaign_to_applications(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts)
  data
end

#copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2008, Integer, Hash)>

Copy the campaign into the specified Application Copy the campaign into all specified Applications.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (CampaignCopy) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse2008, Integer, Hash)>) —

    InlineResponse2008 data, response status code and response headers



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/talon_one/api/management_api.rb', line 259

def copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.copy_campaign_to_applications ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.copy_campaign_to_applications"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.copy_campaign_to_applications"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.copy_campaign_to_applications"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/copy'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2008' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#copy_campaign_to_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_account_collection(body, opts = {}) ⇒ Collection

Create account-level collection Create an account-level collection.

Parameters:

  • body (NewCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



321
322
323
324
 
# File 'lib/talon_one/api/management_api.rb', line 321

def (body, opts = {})
  data, _status_code, _headers = (body, opts)
  data
end

#create_account_collection_with_http_info(body, opts = {}) ⇒ Array<(Collection, Integer, Hash)>

Create account-level collection Create an account-level collection.

Parameters:

  • body (NewCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Collection, Integer, Hash)>) —

    Collection data, response status code and response headers



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/talon_one/api/management_api.rb', line 331

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_account_collection ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_account_collection"
  end
  # resource path
  local_var_path = '/v1/collections'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Collection' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_account_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_achievement(application_id, campaign_id, body, opts = {}) ⇒ Achievement

Create achievement Create a new achievement in a specific campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (CreateAchievement) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



387
388
389
390
 
# File 'lib/talon_one/api/management_api.rb', line 387

def create_achievement(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = create_achievement_with_http_info(application_id, campaign_id, body, opts)
  data
end

#create_achievement_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(Achievement, Integer, Hash)>

Create achievement Create a new achievement in a specific campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (CreateAchievement) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Achievement, Integer, Hash)>) —

    Achievement data, response status code and response headers



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/talon_one/api/management_api.rb', line 399

def create_achievement_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_achievement ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_achievement"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_achievement"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_achievement"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/achievements'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Achievement' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_achievement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_additional_cost(body, opts = {}) ⇒ AccountAdditionalCost

Create additional cost Create an [additional cost](docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). These additional costs are shared across all applications in your account, and are never required.

Parameters:

  • body (NewAdditionalCost) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



461
462
463
464
 
# File 'lib/talon_one/api/management_api.rb', line 461

def create_additional_cost(body, opts = {})
  data, _status_code, _headers = create_additional_cost_with_http_info(body, opts)
  data
end

#create_additional_cost_with_http_info(body, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>

Create additional cost Create an [additional cost](docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). These additional costs are shared across all applications in your account, and are never required.

Parameters:

  • body (NewAdditionalCost) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AccountAdditionalCost, Integer, Hash)>) —

    AccountAdditionalCost data, response status code and response headers



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/talon_one/api/management_api.rb', line 471

def create_additional_cost_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_additional_cost ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_additional_cost"
  end
  # resource path
  local_var_path = '/v1/additional_costs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'AccountAdditionalCost' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_additional_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_attribute(body, opts = {}) ⇒ Attribute

Create custom attribute Create a _custom attribute_ in this account. [Custom attributes](docs.talon.one/docs/dev/concepts/attributes) allow you to add data to Talon.One domain entities like campaigns, coupons, customers and so on. These attributes can then be given values when creating/updating these entities, and these values can be used in your campaign rules. For example, you could define a ‘zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all Applications in your account and are never required.

Parameters:

  • body (NewAttribute) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



525
526
527
528
 
# File 'lib/talon_one/api/management_api.rb', line 525

def create_attribute(body, opts = {})
  data, _status_code, _headers = create_attribute_with_http_info(body, opts)
  data
end

#create_attribute_with_http_info(body, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>

Create custom attribute Create a _custom attribute_ in this account. [Custom attributes](docs.talon.one/docs/dev/concepts/attributes) allow you to add data to Talon.One domain entities like campaigns, coupons, customers and so on. These attributes can then be given values when creating/updating these entities, and these values can be used in your campaign rules. For example, you could define a &#x60;zipCode&#x60; field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all Applications in your account and are never required.

Parameters:

  • body (NewAttribute) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attribute, Integer, Hash)>) —

    Attribute data, response status code and response headers



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/talon_one/api/management_api.rb', line 535

def create_attribute_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_attribute ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_attribute"
  end
  # resource path
  local_var_path = '/v1/attributes'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attribute' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_batch_loyalty_cards(loyalty_program_id, body, opts = {}) ⇒ LoyaltyCardBatchResponse

Create loyalty cards Create a batch of loyalty cards in a specified [card-based loyalty program](docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. Important: - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a ‘400` status code.

Parameters:

Returns:



590
591
592
593
 
# File 'lib/talon_one/api/management_api.rb', line 590

def create_batch_loyalty_cards(loyalty_program_id, body, opts = {})
  data, _status_code, _headers = create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, opts)
  data
end

#create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, opts = {}) ⇒ Array<(LoyaltyCardBatchResponse, Integer, Hash)>

Create loyalty cards Create a batch of loyalty cards in a specified [card-based loyalty program](docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. Important: - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a &#x60;400&#x60; status code.

Parameters:

Returns:

  • (Array<(LoyaltyCardBatchResponse, Integer, Hash)>) —

    LoyaltyCardBatchResponse data, response status code and response headers



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/talon_one/api/management_api.rb', line 601

def create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_batch_loyalty_cards ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.create_batch_loyalty_cards"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_batch_loyalty_cards"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/batch'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'LoyaltyCardBatchResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_batch_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_campaign_from_template(application_id, body, opts = {}) ⇒ CreateTemplateCampaignResponse

Create campaign from campaign template Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing [campaign collections](docs.talon.one/docs/product/campaigns/managing-collections), the corresponding collections for the new campaign are created automatically.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (CreateTemplateCampaign) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



660
661
662
663
 
# File 'lib/talon_one/api/management_api.rb', line 660

def create_campaign_from_template(application_id, body, opts = {})
  data, _status_code, _headers = create_campaign_from_template_with_http_info(application_id, body, opts)
  data
end

#create_campaign_from_template_with_http_info(application_id, body, opts = {}) ⇒ Array<(CreateTemplateCampaignResponse, Integer, Hash)>

Create campaign from campaign template Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing [campaign collections](docs.talon.one/docs/product/campaigns/managing-collections), the corresponding collections for the new campaign are created automatically.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (CreateTemplateCampaign) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/talon_one/api/management_api.rb', line 671

def create_campaign_from_template_with_http_info(application_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_campaign_from_template ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_campaign_from_template"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_campaign_from_template"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/create_campaign_from_template'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'CreateTemplateCampaignResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_campaign_from_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_campaign_store_budget(application_id, campaign_id, body, opts = {}) ⇒ nil

Create campaign store budget Create a new store budget for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCampaignStoreBudget) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


731
732
733
734
 
# File 'lib/talon_one/api/management_api.rb', line 731

def create_campaign_store_budget(application_id, campaign_id, body, opts = {})
  create_campaign_store_budget_with_http_info(application_id, campaign_id, body, opts)
  nil
end

#create_campaign_store_budget_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create campaign store budget Create a new store budget for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCampaignStoreBudget) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/talon_one/api/management_api.rb', line 743

def create_campaign_store_budget_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_campaign_store_budget ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_campaign_store_budget"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_campaign_store_budget"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_campaign_store_budget"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_collection(application_id, campaign_id, body, opts = {}) ⇒ Collection

Create campaign-level collection Create a campaign-level collection in a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCampaignCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



807
808
809
810
 
# File 'lib/talon_one/api/management_api.rb', line 807

def create_collection(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = create_collection_with_http_info(application_id, campaign_id, body, opts)
  data
end

#create_collection_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(Collection, Integer, Hash)>

Create campaign-level collection Create a campaign-level collection in a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCampaignCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Collection, Integer, Hash)>) —

    Collection data, response status code and response headers



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/talon_one/api/management_api.rb', line 819

def create_collection_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_collection ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_collection"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_collection"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_collection"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/collections'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Collection' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_coupons(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse20010

Create coupons Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCoupons) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :silent (String) —

    Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. (default to ‘yes’)

Returns:



884
885
886
887
 
# File 'lib/talon_one/api/management_api.rb', line 884

def create_coupons(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = create_coupons_with_http_info(application_id, campaign_id, body, opts)
  data
end

#create_coupons_async(application_id, campaign_id, body, opts = {}) ⇒ AsyncCouponCreationResponse

Create coupons asynchronously Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete. If you want to create less than 20,001 coupons, you can use the [Create coupons](docs.talon.one/management-api#tag/Coupons/operation/createCoupons) endpoint.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCouponCreationJob) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



962
963
964
965
 
# File 'lib/talon_one/api/management_api.rb', line 962

def create_coupons_async(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = create_coupons_async_with_http_info(application_id, campaign_id, body, opts)
  data
end

#create_coupons_async_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(AsyncCouponCreationResponse, Integer, Hash)>

Create coupons asynchronously Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete. If you want to create less than 20,001 coupons, you can use the [Create coupons](docs.talon.one/management-api#tag/Coupons/operation/createCoupons) endpoint.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCouponCreationJob) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AsyncCouponCreationResponse, Integer, Hash)>) —

    AsyncCouponCreationResponse data, response status code and response headers



974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/talon_one/api/management_api.rb', line 974

def create_coupons_async_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_async ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons_async"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons_async"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons_async"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'AsyncCouponCreationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_coupons_async\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_coupons_deletion_job(application_id, campaign_id, body, opts = {}) ⇒ AsyncCouponDeletionJobResponse

Creates a coupon deletion job This endpoint handles creating a job to delete coupons asynchronously.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCouponDeletionJob) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1038
1039
1040
1041
 
# File 'lib/talon_one/api/management_api.rb', line 1038

def create_coupons_deletion_job(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = create_coupons_deletion_job_with_http_info(application_id, campaign_id, body, opts)
  data
end

#create_coupons_deletion_job_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(AsyncCouponDeletionJobResponse, Integer, Hash)>

Creates a coupon deletion job This endpoint handles creating a job to delete coupons asynchronously.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCouponDeletionJob) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
 
# File 'lib/talon_one/api/management_api.rb', line 1050

def create_coupons_deletion_job_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_deletion_job ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons_deletion_job"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons_deletion_job"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons_deletion_job"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'AsyncCouponDeletionJobResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_coupons_deletion_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse20010

Create coupons for multiple recipients Create coupons according to some pattern for up to 1000 recipients.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCouponsForMultipleRecipients) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :silent (String) —

    Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. (default to ‘yes’)

Returns:



1115
1116
1117
1118
 
# File 'lib/talon_one/api/management_api.rb', line 1115

def create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts)
  data
end

#create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse20010, Integer, Hash)>

Create coupons for multiple recipients Create coupons according to some pattern for up to 1000 recipients.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCouponsForMultipleRecipients) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :silent (String) —

    Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.

Returns:

  • (Array<(InlineResponse20010, Integer, Hash)>) —

    InlineResponse20010 data, response status code and response headers



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'lib/talon_one/api/management_api.rb', line 1128

def create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_for_multiple_recipients ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons_for_multiple_recipients"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons_for_multiple_recipients"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons_for_multiple_recipients"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'silent'] = opts[:'silent'] if !opts[:'silent'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20010' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_coupons_for_multiple_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_coupons_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse20010, Integer, Hash)>

Create coupons Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (NewCoupons) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :silent (String) —

    Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.

Returns:

  • (Array<(InlineResponse20010, Integer, Hash)>) —

    InlineResponse20010 data, response status code and response headers



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'lib/talon_one/api/management_api.rb', line 897

def create_coupons_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'silent'] = opts[:'silent'] if !opts[:'silent'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20010' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invite_email(body, opts = {}) ⇒ NewInviteEmail

Resend invitation email Resend an email invitation to an existing user. Note: The invitation token is valid for 24 hours after the email has been sent.

Parameters:

  • body (NewInviteEmail) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1191
1192
1193
1194
 
# File 'lib/talon_one/api/management_api.rb', line 1191

def create_invite_email(body, opts = {})
  data, _status_code, _headers = create_invite_email_with_http_info(body, opts)
  data
end

#create_invite_email_with_http_info(body, opts = {}) ⇒ Array<(NewInviteEmail, Integer, Hash)>

Resend invitation email Resend an email invitation to an existing user. Note: The invitation token is valid for 24 hours after the email has been sent.

Parameters:

  • body (NewInviteEmail) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NewInviteEmail, Integer, Hash)>) —

    NewInviteEmail data, response status code and response headers



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'lib/talon_one/api/management_api.rb', line 1201

def create_invite_email_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_invite_email ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_invite_email"
  end
  # resource path
  local_var_path = '/v1/invite_emails'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'NewInviteEmail' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_invite_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invite_v2(body, opts = {}) ⇒ User

Invite user Create a new user in the account and send an invitation to their email address. Note: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.

Parameters:

  • body (NewInvitation) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1255
1256
1257
1258
 
# File 'lib/talon_one/api/management_api.rb', line 1255

def create_invite_v2(body, opts = {})
  data, _status_code, _headers = create_invite_v2_with_http_info(body, opts)
  data
end

#create_invite_v2_with_http_info(body, opts = {}) ⇒ Array<(User, Integer, Hash)>

Invite user Create a new user in the account and send an invitation to their email address. Note: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.

Parameters:

  • body (NewInvitation) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/talon_one/api/management_api.rb', line 1265

def create_invite_v2_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_invite_v2 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_invite_v2"
  end
  # resource path
  local_var_path = '/v2/invites'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'User' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_invite_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_password_recovery_email(body, opts = {}) ⇒ NewPasswordEmail

Request a password reset Send an email with a password recovery link to the email address of an existing account. Note: The password recovery link expires 30 minutes after this endpoint is triggered.

Parameters:

  • body (NewPasswordEmail) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1319
1320
1321
1322
 
# File 'lib/talon_one/api/management_api.rb', line 1319

def create_password_recovery_email(body, opts = {})
  data, _status_code, _headers = create_password_recovery_email_with_http_info(body, opts)
  data
end

#create_password_recovery_email_with_http_info(body, opts = {}) ⇒ Array<(NewPasswordEmail, Integer, Hash)>

Request a password reset Send an email with a password recovery link to the email address of an existing account. Note: The password recovery link expires 30 minutes after this endpoint is triggered.

Parameters:

  • body (NewPasswordEmail) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NewPasswordEmail, Integer, Hash)>) —

    NewPasswordEmail data, response status code and response headers



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/talon_one/api/management_api.rb', line 1329

def create_password_recovery_email_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_password_recovery_email ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_password_recovery_email"
  end
  # resource path
  local_var_path = '/v1/password_recovery_emails'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'NewPasswordEmail' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_password_recovery_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_session(body, opts = {}) ⇒ Session

Create session Create a session to use the Management API endpoints. Use the value of the ‘token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do not regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class="redoc-section"> <p class="title">Granular API key</p> Instead of using a session, you can also use the <a href="docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>

Parameters:

  • body (LoginParams) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1383
1384
1385
1386
 
# File 'lib/talon_one/api/management_api.rb', line 1383

def create_session(body, opts = {})
  data, _status_code, _headers = create_session_with_http_info(body, opts)
  data
end

#create_session_with_http_info(body, opts = {}) ⇒ Array<(Session, Integer, Hash)>

Create session Create a session to use the Management API endpoints. Use the value of the &#x60;token&#x60; property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do not regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. &lt;div class&#x3D;&quot;redoc-section&quot;&gt; &lt;p class&#x3D;&quot;title&quot;&gt;Granular API key&lt;/p&gt; Instead of using a session, you can also use the &lt;a href&#x3D;&quot;docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys&quot;&gt;Management API key feature&lt;/a&gt; in the Campaign Manager to decide which endpoints can be used with a given key. &lt;/div&gt;

Parameters:

  • body (LoginParams) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Session, Integer, Hash)>) —

    Session data, response status code and response headers



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/talon_one/api/management_api.rb', line 1393

def create_session_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_session ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_session"
  end
  # resource path
  local_var_path = '/v1/sessions'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Session' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_store(application_id, body, opts = {}) ⇒ Store

Create store Create a new store in a specific Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (NewStore) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1448
1449
1450
1451
 
# File 'lib/talon_one/api/management_api.rb', line 1448

def create_store(application_id, body, opts = {})
  data, _status_code, _headers = create_store_with_http_info(application_id, body, opts)
  data
end

#create_store_with_http_info(application_id, body, opts = {}) ⇒ Array<(Store, Integer, Hash)>

Create store Create a new store in a specific Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (NewStore) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Store, Integer, Hash)>) —

    Store data, response status code and response headers



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/talon_one/api/management_api.rb', line 1459

def create_store_with_http_info(application_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_store ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_store"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_store"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/stores'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Store' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#create_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deactivate_user_by_email(body, opts = {}) ⇒ nil

Disable user by email address [Disable a specific user](docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.

Parameters:

  • body (DeleteUserRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1517
1518
1519
1520
 
# File 'lib/talon_one/api/management_api.rb', line 1517

def deactivate_user_by_email(body, opts = {})
  deactivate_user_by_email_with_http_info(body, opts)
  nil
end

#deactivate_user_by_email_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable user by email address [Disable a specific user](docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.

Parameters:

  • body (DeleteUserRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'lib/talon_one/api/management_api.rb', line 1527

def deactivate_user_by_email_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.deactivate_user_by_email ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.deactivate_user_by_email"
  end
  # resource path
  local_var_path = '/v1/users/deactivate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#deactivate_user_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deduct_loyalty_card_points(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ nil

Deduct points from card Deduct points from the given loyalty card in the specified card-based loyalty program.

Parameters:

Returns:

  • (nil) 


1581
1582
1583
1584
 
# File 'lib/talon_one/api/management_api.rb', line 1581

def deduct_loyalty_card_points(loyalty_program_id, loyalty_card_id, body, opts = {})
  deduct_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
  nil
end

#deduct_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deduct points from card Deduct points from the given loyalty card in the specified card-based loyalty program.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
 
# File 'lib/talon_one/api/management_api.rb', line 1593

def deduct_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.deduct_loyalty_card_points ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.deduct_loyalty_card_points"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.deduct_loyalty_card_points"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.deduct_loyalty_card_points, the character length must be smaller than or equal to 108.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.deduct_loyalty_card_points"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#deduct_loyalty_card_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_collection(collection_id, opts = {}) ⇒ nil

Delete account-level collection Delete a given account-level collection.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1659
1660
1661
1662
 
# File 'lib/talon_one/api/management_api.rb', line 1659

def (collection_id, opts = {})
  (collection_id, opts)
  nil
end

#delete_account_collection_with_http_info(collection_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete account-level collection Delete a given account-level collection.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
 
# File 'lib/talon_one/api/management_api.rb', line 1669

def (collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_account_collection ...'
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.delete_account_collection"
  end
  # resource path
  local_var_path = '/v1/collections/{collectionId}'.sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_account_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_achievement(application_id, campaign_id, achievement_id, opts = {}) ⇒ nil

Delete achievement Delete the specified achievement.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1723
1724
1725
1726
 
# File 'lib/talon_one/api/management_api.rb', line 1723

def delete_achievement(application_id, campaign_id, achievement_id, opts = {})
  delete_achievement_with_http_info(application_id, campaign_id, achievement_id, opts)
  nil
end

#delete_achievement_with_http_info(application_id, campaign_id, achievement_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete achievement Delete the specified achievement.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
 
# File 'lib/talon_one/api/management_api.rb', line 1735

def delete_achievement_with_http_info(application_id, campaign_id, achievement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_achievement ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_achievement"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_achievement"
  end
  # verify the required parameter 'achievement_id' is set
  if @api_client.config.client_side_validation && achievement_id.nil?
    fail ArgumentError, "Missing the required parameter 'achievement_id' when calling ManagementApi.delete_achievement"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'achievementId' + '}', CGI.escape(achievement_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_achievement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_campaign(application_id, campaign_id, opts = {}) ⇒ nil

Delete campaign Delete the given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1796
1797
1798
1799
 
# File 'lib/talon_one/api/management_api.rb', line 1796

def delete_campaign(application_id, campaign_id, opts = {})
  delete_campaign_with_http_info(application_id, campaign_id, opts)
  nil
end

#delete_campaign_store_budgets(application_id, campaign_id, opts = {}) ⇒ nil

Delete campaign store budgets Delete the store budgets for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

Returns:

  • (nil) 


1864
1865
1866
1867
 
# File 'lib/talon_one/api/management_api.rb', line 1864

def delete_campaign_store_budgets(application_id, campaign_id, opts = {})
  delete_campaign_store_budgets_with_http_info(application_id, campaign_id, opts)
  nil
end

#delete_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete campaign store budgets Delete the store budgets for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'lib/talon_one/api/management_api.rb', line 1877

def delete_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_campaign_store_budgets ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_campaign_store_budgets"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_campaign_store_budgets"
  end
  allowable_values = ["setDiscount"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
  if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
    fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_campaign_store_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_campaign_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete campaign Delete the given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
 
# File 'lib/talon_one/api/management_api.rb', line 1807

def delete_campaign_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_campaign ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_campaign"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_campaign"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_collection(application_id, campaign_id, collection_id, opts = {}) ⇒ nil

Delete campaign-level collection Delete a given campaign-level collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1945
1946
1947
1948
 
# File 'lib/talon_one/api/management_api.rb', line 1945

def delete_collection(application_id, campaign_id, collection_id, opts = {})
  delete_collection_with_http_info(application_id, campaign_id, collection_id, opts)
  nil
end

#delete_collection_with_http_info(application_id, campaign_id, collection_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete campaign-level collection Delete a given campaign-level collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
 
# File 'lib/talon_one/api/management_api.rb', line 1957

def delete_collection_with_http_info(application_id, campaign_id, collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_collection ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_collection"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_collection"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.delete_collection"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_coupon(application_id, campaign_id, coupon_id, opts = {}) ⇒ nil

Delete coupon Delete the specified coupon.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • coupon_id (String) —

    The internal ID of the coupon code. You can find this value in the &#x60;id&#x60; property from the [List coupons](docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2019
2020
2021
2022
 
# File 'lib/talon_one/api/management_api.rb', line 2019

def delete_coupon(application_id, campaign_id, coupon_id, opts = {})
  delete_coupon_with_http_info(application_id, campaign_id, coupon_id, opts)
  nil
end

#delete_coupon_with_http_info(application_id, campaign_id, coupon_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete coupon Delete the specified coupon.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • coupon_id (String) —

    The internal ID of the coupon code. You can find this value in the &#x60;id&#x60; property from the [List coupons](docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
 
# File 'lib/talon_one/api/management_api.rb', line 2031

def delete_coupon_with_http_info(application_id, campaign_id, coupon_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_coupon ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_coupon"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_coupon"
  end
  # verify the required parameter 'coupon_id' is set
  if @api_client.config.client_side_validation && coupon_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_id' when calling ManagementApi.delete_coupon"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'couponId' + '}', CGI.escape(coupon_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_coupons(application_id, campaign_id, opts = {}) ⇒ nil

Delete coupons Deletes all the coupons matching the specified criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :expires_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :expires_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    • &#x60;expired&#x60;: Matches coupons in which the expiration date is set and in the past. - &#x60;validNow&#x60;: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - &#x60;validFuture&#x60;: Matches coupons in which start date is set and in the future.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :usable (String) —

    • &#x60;true&#x60;: only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned. - &#x60;false&#x60;: only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60; will be returned.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s &#x60;RecipientIntegrationId&#x60; field.

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code (default to false)

Returns:

  • (nil) 


2103
2104
2105
2106
 
# File 'lib/talon_one/api/management_api.rb', line 2103

def delete_coupons(application_id, campaign_id, opts = {})
  delete_coupons_with_http_info(application_id, campaign_id, opts)
  nil
end

#delete_coupons_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete coupons Deletes all the coupons matching the specified criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :expires_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :expires_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    • &#x60;expired&#x60;: Matches coupons in which the expiration date is set and in the past. - &#x60;validNow&#x60;: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - &#x60;validFuture&#x60;: Matches coupons in which start date is set and in the future.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :usable (String) —

    • &#x60;true&#x60;: only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned. - &#x60;false&#x60;: only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60; will be returned.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s &#x60;RecipientIntegrationId&#x60; field.

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'lib/talon_one/api/management_api.rb', line 2127

def delete_coupons_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_coupons ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_coupons"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_coupons"
  end
  allowable_values = ["expired", "validNow", "validFuture"]
  if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
    fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
    fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'startsAfter'] = opts[:'starts_after'] if !opts[:'starts_after'].nil?
  query_params[:'startsBefore'] = opts[:'starts_before'] if !opts[:'starts_before'].nil?
  query_params[:'expiresAfter'] = opts[:'expires_after'] if !opts[:'expires_after'].nil?
  query_params[:'expiresBefore'] = opts[:'expires_before'] if !opts[:'expires_before'].nil?
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
  query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
  query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
  query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_loyalty_card(loyalty_program_id, loyalty_card_id, opts = {}) ⇒ nil

Delete loyalty card Delete the given loyalty card.

Parameters:

Returns:

  • (nil) 


2203
2204
2205
2206
 
# File 'lib/talon_one/api/management_api.rb', line 2203

def delete_loyalty_card(loyalty_program_id, loyalty_card_id, opts = {})
  delete_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts)
  nil
end

#delete_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete loyalty card Delete the given loyalty card.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
 
# File 'lib/talon_one/api/management_api.rb', line 2214

def delete_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_loyalty_card ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.delete_loyalty_card"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.delete_loyalty_card"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.delete_loyalty_card, the character length must be smaller than or equal to 108.'
  end

  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_loyalty_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_referral(application_id, campaign_id, referral_id, opts = {}) ⇒ nil

Delete referral Delete the specified referral.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • referral_id (String) —

    The ID of the referral code.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2276
2277
2278
2279
 
# File 'lib/talon_one/api/management_api.rb', line 2276

def delete_referral(application_id, campaign_id, referral_id, opts = {})
  delete_referral_with_http_info(application_id, campaign_id, referral_id, opts)
  nil
end

#delete_referral_with_http_info(application_id, campaign_id, referral_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete referral Delete the specified referral.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • referral_id (String) —

    The ID of the referral code.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
 
# File 'lib/talon_one/api/management_api.rb', line 2288

def delete_referral_with_http_info(application_id, campaign_id, referral_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_referral ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_referral"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_referral"
  end
  # verify the required parameter 'referral_id' is set
  if @api_client.config.client_side_validation && referral_id.nil?
    fail ArgumentError, "Missing the required parameter 'referral_id' when calling ManagementApi.delete_referral"
  end
  # resource path
  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))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_referral\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_store(application_id, store_id, opts = {}) ⇒ nil

Delete store Delete the specified store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • store_id (String) —

    The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2347
2348
2349
2350
 
# File 'lib/talon_one/api/management_api.rb', line 2347

def delete_store(application_id, store_id, opts = {})
  delete_store_with_http_info(application_id, store_id, opts)
  nil
end

#delete_store_with_http_info(application_id, store_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete store Delete the specified store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • store_id (String) —

    The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
 
# File 'lib/talon_one/api/management_api.rb', line 2358

def delete_store_with_http_info(application_id, store_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_store ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_store"
  end
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling ManagementApi.delete_store"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/stores/{storeId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'storeId' + '}', CGI.escape(store_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user(user_id, opts = {}) ⇒ nil

Delete user Delete a specific user.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2414
2415
2416
2417
 
# File 'lib/talon_one/api/management_api.rb', line 2414

def delete_user(user_id, opts = {})
  delete_user_with_http_info(user_id, opts)
  nil
end

#delete_user_by_email(body, opts = {}) ⇒ nil

Delete user by email address [Delete a specific user](docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.

Parameters:

  • body (DeleteUserRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2474
2475
2476
2477
 
# File 'lib/talon_one/api/management_api.rb', line 2474

def delete_user_by_email(body, opts = {})
  delete_user_by_email_with_http_info(body, opts)
  nil
end

#delete_user_by_email_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete user by email address [Delete a specific user](docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.

Parameters:

  • body (DeleteUserRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
 
# File 'lib/talon_one/api/management_api.rb', line 2484

def delete_user_by_email_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_user_by_email ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.delete_user_by_email"
  end
  # resource path
  local_var_path = '/v1/users/delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_user_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete user Delete a specific user.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/talon_one/api/management_api.rb', line 2424

def delete_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_user ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.delete_user"
  end
  # resource path
  local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#destroy_session(opts = {}) ⇒ nil

Destroy session Destroys the session.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2535
2536
2537
2538
 
# File 'lib/talon_one/api/management_api.rb', line 2535

def destroy_session(opts = {})
  destroy_session_with_http_info(opts)
  nil
end

#destroy_session_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Destroy session Destroys the session.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
 
# File 'lib/talon_one/api/management_api.rb', line 2544

def destroy_session_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.destroy_session ...'
  end
  # resource path
  local_var_path = '/v1/sessions'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#destroy_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#disconnect_campaign_stores(application_id, campaign_id, opts = {}) ⇒ nil

Disconnect stores Disconnect the stores linked to a specific campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2591
2592
2593
2594
 
# File 'lib/talon_one/api/management_api.rb', line 2591

def disconnect_campaign_stores(application_id, campaign_id, opts = {})
  disconnect_campaign_stores_with_http_info(application_id, campaign_id, opts)
  nil
end

#disconnect_campaign_stores_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disconnect stores Disconnect the stores linked to a specific campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
 
# File 'lib/talon_one/api/management_api.rb', line 2602

def disconnect_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.disconnect_campaign_stores ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.disconnect_campaign_stores"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.disconnect_campaign_stores"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#disconnect_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_account_collection_items(collection_id, opts = {}) ⇒ String

Export account-level collection’s items Download a CSV file containing items from a given account-level collection. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


2658
2659
2660
2661
 
# File 'lib/talon_one/api/management_api.rb', line 2658

def (collection_id, opts = {})
  data, _status_code, _headers = (collection_id, opts)
  data
end

#export_account_collection_items_with_http_info(collection_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export account-level collection&#39;s items Download a CSV file containing items from a given account-level collection. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
 
# File 'lib/talon_one/api/management_api.rb', line 2668

def (collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_account_collection_items ...'
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.export_account_collection_items"
  end
  # resource path
  local_var_path = '/v1/collections/{collectionId}/export'.sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_account_collection_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_achievements(application_id, campaign_id, achievement_id, opts = {}) ⇒ String

Export achievement customer data Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. The CSV file contains the following columns: - ‘profileIntegrationID`: The integration ID of the customer profile participating in the achievement. - `title`: The display name of the achievement in the Campaign Manager. - `target`: The required number of actions or the transactional milestone to complete the achievement. - `progress`: The current progress of the customer in the achievement. - `status`: The status of the achievement. Can be one of: [’inprogress’, ‘completed’, ‘expired’]. - ‘startDate`: The date on which the customer profile started the achievement in RFC3339. - `endDate`: The date on which the achievement ends and resets for the customer profile in RFC3339. - `completionDate`: The date on which the customer profile completed the achievement in RFC3339.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


2722
2723
2724
2725
 
# File 'lib/talon_one/api/management_api.rb', line 2722

def export_achievements(application_id, campaign_id, achievement_id, opts = {})
  data, _status_code, _headers = export_achievements_with_http_info(application_id, campaign_id, achievement_id, opts)
  data
end

#export_achievements_with_http_info(application_id, campaign_id, achievement_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export achievement customer data Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. The CSV file contains the following columns: - &#x60;profileIntegrationID&#x60;: The integration ID of the customer profile participating in the achievement. - &#x60;title&#x60;: The display name of the achievement in the Campaign Manager. - &#x60;target&#x60;: The required number of actions or the transactional milestone to complete the achievement. - &#x60;progress&#x60;: The current progress of the customer in the achievement. - &#x60;status&#x60;: The status of the achievement. Can be one of: [&#39;inprogress&#39;, &#39;completed&#39;, &#39;expired&#39;]. - &#x60;startDate&#x60;: The date on which the customer profile started the achievement in RFC3339. - &#x60;endDate&#x60;: The date on which the achievement ends and resets for the customer profile in RFC3339. - &#x60;completionDate&#x60;: The date on which the customer profile completed the achievement in RFC3339.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
 
# File 'lib/talon_one/api/management_api.rb', line 2734

def export_achievements_with_http_info(application_id, campaign_id, achievement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_achievements ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_achievements"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_achievements"
  end
  # verify the required parameter 'achievement_id' is set
  if @api_client.config.client_side_validation && achievement_id.nil?
    fail ArgumentError, "Missing the required parameter 'achievement_id' when calling ManagementApi.export_achievements"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'achievementId' + '}', CGI.escape(achievement_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_achievements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_audiences_memberships(audience_id, opts = {}) ⇒ String

Export audience members Download a CSV file containing the integration IDs of the members of an audience. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The file contains the following column: - ‘profileintegrationid`: The integration ID of the customer profile.

Parameters:

  • audience_id (Integer) —

    The ID of the audience.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


2794
2795
2796
2797
 
# File 'lib/talon_one/api/management_api.rb', line 2794

def export_audiences_memberships(audience_id, opts = {})
  data, _status_code, _headers = export_audiences_memberships_with_http_info(audience_id, opts)
  data
end

#export_audiences_memberships_with_http_info(audience_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export audience members Download a CSV file containing the integration IDs of the members of an audience. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The file contains the following column: - &#x60;profileintegrationid&#x60;: The integration ID of the customer profile.

Parameters:

  • audience_id (Integer) —

    The ID of the audience.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
 
# File 'lib/talon_one/api/management_api.rb', line 2804

def export_audiences_memberships_with_http_info(audience_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_audiences_memberships ...'
  end
  # verify the required parameter 'audience_id' is set
  if @api_client.config.client_side_validation && audience_id.nil?
    fail ArgumentError, "Missing the required parameter 'audience_id' when calling ManagementApi.export_audiences_memberships"
  end
  # resource path
  local_var_path = '/v1/audiences/{audienceId}/memberships/export'.sub('{' + 'audienceId' + '}', CGI.escape(audience_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_audiences_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_campaign_store_budgets(application_id, campaign_id, opts = {}) ⇒ String

Export campaign store budgets Download a CSV file containing the store budgets for a given campaign. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - ‘store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

Returns:

  • (String) 


2859
2860
2861
2862
 
# File 'lib/talon_one/api/management_api.rb', line 2859

def export_campaign_store_budgets(application_id, campaign_id, opts = {})
  data, _status_code, _headers = export_campaign_store_budgets_with_http_info(application_id, campaign_id, opts)
  data
end

#export_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export campaign store budgets Download a CSV file containing the store budgets for a given campaign. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - &#x60;store_integration_id&#x60;: The identifier of the store. - &#x60;limit&#x60;: The budget limit for the store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
 
# File 'lib/talon_one/api/management_api.rb', line 2872

def export_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_campaign_store_budgets ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_campaign_store_budgets"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_campaign_store_budgets"
  end
  allowable_values = ["setDiscount"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
  if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
    fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_campaign_store_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_campaign_stores(application_id, campaign_id, opts = {}) ⇒ String

Export stores Download a CSV file containing the stores linked to a specific campaign. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - ‘store_integration_id`: The identifier of the store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


2939
2940
2941
2942
 
# File 'lib/talon_one/api/management_api.rb', line 2939

def export_campaign_stores(application_id, campaign_id, opts = {})
  data, _status_code, _headers = export_campaign_stores_with_http_info(application_id, campaign_id, opts)
  data
end

#export_campaign_stores_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export stores Download a CSV file containing the stores linked to a specific campaign. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - &#x60;store_integration_id&#x60;: The identifier of the store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
 
# File 'lib/talon_one/api/management_api.rb', line 2950

def export_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_campaign_stores ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_campaign_stores"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_campaign_stores"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_collection_items(application_id, campaign_id, collection_id, opts = {}) ⇒ String

Export campaign-level collection’s items Download a CSV file containing items from a given campaign-level collection. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


3008
3009
3010
3011
 
# File 'lib/talon_one/api/management_api.rb', line 3008

def export_collection_items(application_id, campaign_id, collection_id, opts = {})
  data, _status_code, _headers = export_collection_items_with_http_info(application_id, campaign_id, collection_id, opts)
  data
end

#export_collection_items_with_http_info(application_id, campaign_id, collection_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export campaign-level collection&#39;s items Download a CSV file containing items from a given campaign-level collection. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/talon_one/api/management_api.rb', line 3020

def export_collection_items_with_http_info(application_id, campaign_id, collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_collection_items ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_collection_items"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_collection_items"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.export_collection_items"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_collection_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_coupons(application_id, opts = {}) ⇒ String

Export coupons Download a CSV file containing the coupons that match the given properties. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - ‘accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing custom referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code. (default to false)

  • :date_format (String) —

    Determines the format of dates in the export document.

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

  • :values_only (Boolean) —

    Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data. (default to false)

Returns:

  • (String) 


3094
3095
3096
3097
 
# File 'lib/talon_one/api/management_api.rb', line 3094

def export_coupons(application_id, opts = {})
  data, _status_code, _headers = export_coupons_with_http_info(application_id, opts)
  data
end

#export_coupons_with_http_info(application_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export coupons Download a CSV file containing the coupons that match the given properties. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - &#x60;accountid&#x60;: The ID of your deployment. - &#x60;applicationid&#x60;: The ID of the Application this coupon is related to. - &#x60;attributes&#x60;: A json object describing custom referral attribute names and their values. - &#x60;batchid&#x60;: The ID of the batch this coupon is part of. - &#x60;campaignid&#x60;: The ID of the campaign this coupon is related to. - &#x60;counter&#x60;: The number of times this coupon has been redeemed. - &#x60;created&#x60;: The creation date in RFC3339 of the coupon code. - &#x60;deleted&#x60;: Whether the coupon code is deleted. - &#x60;deleted_changelogid&#x60;: The ID of the delete event in the logs. - &#x60;discount_counter&#x60;: The amount of discount given by this coupon. - &#x60;discount_limitval&#x60;: The maximum discount amount that can be given be this coupon. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;id&#x60;: The internal ID of the coupon code. - &#x60;importid&#x60;: The ID of the import job that created this coupon. - &#x60;is_reservation_mandatory&#x60;: Whether this coupon requires a reservation to be redeemed. - &#x60;limits&#x60;: The limits set on this coupon. - &#x60;limitval&#x60;: The maximum number of redemptions of this code. - &#x60;recipientintegrationid&#x60;: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - &#x60;referralid&#x60;: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - &#x60;reservation&#x60;: Whether the coupon can be reserved for multiple customers. - &#x60;reservation_counter&#x60;: How many times this coupon has been reserved. - &#x60;reservation_limitval&#x60;: The maximum of number of reservations this coupon can have. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;value&#x60;: The coupon code.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code.

  • :date_format (String) —

    Determines the format of dates in the export document.

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

  • :values_only (Boolean) —

    Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'lib/talon_one/api/management_api.rb', line 3118

def export_coupons_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_coupons ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_coupons"
  end
  allowable_values = ["expired", "validNow", "validFuture"]
  if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
    fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
    fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
  end
  allowable_values = ["excel", "ISO8601"]
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
    fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
  end
  allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
    fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/export_coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
  query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
  query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
  query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
  query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil?
  query_params[:'valuesOnly'] = opts[:'values_only'] if !opts[:'values_only'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_customer_sessions(application_id, opts = {}) ⇒ String

Export customer sessions Download a CSV file containing the customer sessions that match the request. Important: Archived sessions cannot be exported. See the [retention policy](docs.talon.one/docs/dev/server-infrastructure-and-data-retention). Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - ‘id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

  • :profile_integration_id (String) —

    Only return sessions for the customer that matches this customer integration ID.

  • :date_format (String) —

    Determines the format of dates in the export document.

  • :customer_session_state (String) —

    Filter results by state.

Returns:

  • (String) 


3205
3206
3207
3208
 
# File 'lib/talon_one/api/management_api.rb', line 3205

def export_customer_sessions(application_id, opts = {})
  data, _status_code, _headers = export_customer_sessions_with_http_info(application_id, opts)
  data
end

#export_customer_sessions_with_http_info(application_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export customer sessions Download a CSV file containing the customer sessions that match the request. Important: Archived sessions cannot be exported. See the [retention policy](docs.talon.one/docs/dev/server-infrastructure-and-data-retention). Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - &#x60;id&#x60;: The internal ID of the session. - &#x60;firstsession&#x60;: Whether this is a first session. - &#x60;integrationid&#x60;: The integration ID of the session. - &#x60;applicationid&#x60;: The ID of the Application. - &#x60;profileid&#x60;: The internal ID of the customer profile. - &#x60;profileintegrationid&#x60;: The integration ID of the customer profile. - &#x60;created&#x60;: The timestamp when the session was created. - &#x60;state&#x60;: The [state](docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - &#x60;cartitems&#x60;: The cart items in the session. - &#x60;discounts&#x60;: The discounts in the session. - &#x60;total&#x60;: The total value of cart items and additional costs in the session, before any discounts are applied. - &#x60;attributes&#x60;: The attributes set in the session. - &#x60;closedat&#x60;: Timestamp when the session was closed. - &#x60;cancelledat&#x60;: Timestamp when the session was cancelled. - &#x60;referral&#x60;: The referral code in the session. - &#x60;identifiers&#x60;: The identifiers in the session. - &#x60;additional_costs&#x60;: The [additional costs](docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - &#x60;updated&#x60;: Timestamp of the last session update. - &#x60;store_integration_id&#x60;: The integration ID of the store. - &#x60;coupons&#x60;: Coupon codes in the session.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.

  • :profile_integration_id (String) —

    Only return sessions for the customer that matches this customer integration ID.

  • :date_format (String) —

    Determines the format of dates in the export document.

  • :customer_session_state (String) —

    Filter results by state.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
 
# File 'lib/talon_one/api/management_api.rb', line 3220

def export_customer_sessions_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_customer_sessions ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_customer_sessions"
  end
  allowable_values = ["excel", "ISO8601"]
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
    fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
  end
  allowable_values = ["open", "closed", "partially_returned", "cancelled"]
  if @api_client.config.client_side_validation && opts[:'customer_session_state'] && !allowable_values.include?(opts[:'customer_session_state'])
    fail ArgumentError, "invalid value for \"customer_session_state\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/export_customer_sessions'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'profileIntegrationId'] = opts[:'profile_integration_id'] if !opts[:'profile_integration_id'].nil?
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
  query_params[:'customerSessionState'] = opts[:'customer_session_state'] if !opts[:'customer_session_state'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_customer_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_customers_tiers(loyalty_program_id, opts = {}) ⇒ String

Export customers’ tier data Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - ‘programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerIds` (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierNames` (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :subledger_ids (Array<String>) —

    An array of subledgers IDs to filter the export by.

  • :tier_names (Array<String>) —

    An array of tier names to filter the export by.

Returns:

  • (String) 


3287
3288
3289
3290
 
# File 'lib/talon_one/api/management_api.rb', line 3287

def export_customers_tiers(loyalty_program_id, opts = {})
  data, _status_code, _headers = export_customers_tiers_with_http_info(loyalty_program_id, opts)
  data
end

#export_customers_tiers_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export customers&#39; tier data Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - &#x60;programid&#x60;: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - &#x60;subledgerid&#x60;: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - &#x60;customerprofileid&#x60;: The ID used to integrate customer profiles with the loyalty program. - &#x60;tiername&#x60;: The name of the tier. - &#x60;startdate&#x60;: The tier start date in RFC3339. - &#x60;expirydate&#x60;: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - &#x60;subledgerIds&#x60; (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. - &#x60;tierNames&#x60; (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :subledger_ids (Array<String>) —

    An array of subledgers IDs to filter the export by.

  • :tier_names (Array<String>) —

    An array of tier names to filter the export by.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
 
# File 'lib/talon_one/api/management_api.rb', line 3299

def export_customers_tiers_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_customers_tiers ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_customers_tiers"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subledgerIds'] = @api_client.build_collection_param(opts[:'subledger_ids'], :csv) if !opts[:'subledger_ids'].nil?
  query_params[:'tierNames'] = @api_client.build_collection_param(opts[:'tier_names'], :csv) if !opts[:'tier_names'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_customers_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_effects(application_id, opts = {}) ⇒ String

Export triggered effects Download a CSV file containing the triggered effects that match the given attributes. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - ‘applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


3357
3358
3359
3360
 
# File 'lib/talon_one/api/management_api.rb', line 3357

def export_effects(application_id, opts = {})
  data, _status_code, _headers = export_effects_with_http_info(application_id, opts)
  data
end

#export_effects_with_http_info(application_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export triggered effects Download a CSV file containing the triggered effects that match the given attributes. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - &#x60;applicationid&#x60;: The ID of the Application. - &#x60;campaignid&#x60;: The ID of the campaign. - &#x60;couponid&#x60;: The ID of the coupon, when applicable to the effect. - &#x60;created&#x60;: The timestamp of the effect. - &#x60;event_type&#x60;: The name of the event. See the [docs](docs.talon.one/docs/dev/concepts/entities/events). - &#x60;eventid&#x60;: The internal ID of the effect. - &#x60;name&#x60;: The effect name. See the [docs](docs.talon.one/docs/dev/integration-api/api-effects). - &#x60;profileintegrationid&#x60;: The ID of the customer profile, when applicable. - &#x60;props&#x60;: The [properties](docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - &#x60;ruleindex&#x60;: The index of the rule. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;sessionid&#x60;: The internal ID of the session that triggered the effect. - &#x60;profileid&#x60;: The internal ID of the customer profile. - &#x60;sessionintegrationid&#x60;: The integration ID of the session. - &#x60;total_revenue&#x60;: The total revenue. - &#x60;store_integration_id&#x60;: The integration ID of the store. You choose this ID when you create a store.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
 
# File 'lib/talon_one/api/management_api.rb', line 3371

def export_effects_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_effects ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_effects"
  end
  allowable_values = ["excel", "ISO8601"]
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
    fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/export_effects'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_effects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_loyalty_balance(loyalty_program_id, opts = {}) ⇒ String

Export customer loyalty balance to CSV ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime) —

    Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

Returns:

  • (String) 


3432
3433
3434
3435
 
# File 'lib/talon_one/api/management_api.rb', line 3432

def export_loyalty_balance(loyalty_program_id, opts = {})
  data, _status_code, _headers = export_loyalty_balance_with_http_info(loyalty_program_id, opts)
  data
end

#export_loyalty_balance_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export customer loyalty balance to CSV ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime) —

    Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
 
# File 'lib/talon_one/api/management_api.rb', line 3443

def export_loyalty_balance_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_balance ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_balance"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_loyalty_balances(loyalty_program_id, opts = {}) ⇒ String

Export customer loyalty balances Download a CSV file containing the balance of each customer in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - ‘loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime) —

    Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

Returns:

  • (String) 


3497
3498
3499
3500
 
# File 'lib/talon_one/api/management_api.rb', line 3497

def export_loyalty_balances(loyalty_program_id, opts = {})
  data, _status_code, _headers = export_loyalty_balances_with_http_info(loyalty_program_id, opts)
  data
end

#export_loyalty_balances_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export customer loyalty balances Download a CSV file containing the balance of each customer in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - &#x60;loyaltyProgramID&#x60;: The ID of the loyalty program. - &#x60;loyaltySubledger&#x60;: The name of the subdleger, when applicatble. - &#x60;profileIntegrationID&#x60;: The integration ID of the customer profile. - &#x60;currentBalance&#x60;: The current point balance. - &#x60;pendingBalance&#x60;: The number of pending points. - &#x60;expiredBalance&#x60;: The number of expired points. - &#x60;spentBalance&#x60;: The number of spent points. - &#x60;currentTier&#x60;: The tier that the customer is in at the time of the export.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime) —

    Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
 
# File 'lib/talon_one/api/management_api.rb', line 3508

def export_loyalty_balances_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_balances ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_balances"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_loyalty_card_balances(loyalty_program_id, opts = {}) ⇒ String

Export all card transaction logs Download a CSV file containing the balances of all cards in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - ‘loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.

Parameters:

Options Hash (opts):

  • :end_date (DateTime) —

    Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

Returns:

  • (String) 


3562
3563
3564
3565
 
# File 'lib/talon_one/api/management_api.rb', line 3562

def export_loyalty_card_balances(loyalty_program_id, opts = {})
  data, _status_code, _headers = export_loyalty_card_balances_with_http_info(loyalty_program_id, opts)
  data
end

#export_loyalty_card_balances_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export all card transaction logs Download a CSV file containing the balances of all cards in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - &#x60;loyaltyProgramID&#x60;: The ID of the loyalty program. - &#x60;loyaltySubledger&#x60;: The name of the subdleger, when applicatble. - &#x60;cardIdentifier&#x60;: The alphanumeric identifier of the loyalty card. - &#x60;cardState&#x60;:The state of the loyalty card. It can be &#x60;active&#x60; or &#x60;inactive&#x60;. - &#x60;currentBalance&#x60;: The current point balance. - &#x60;pendingBalance&#x60;: The number of pending points. - &#x60;expiredBalance&#x60;: The number of expired points. - &#x60;spentBalance&#x60;: The number of spent points.

Parameters:

Options Hash (opts):

  • :end_date (DateTime) —

    Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
 
# File 'lib/talon_one/api/management_api.rb', line 3573

def export_loyalty_card_balances_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_card_balances ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_card_balances"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/export_card_balances'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_card_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_loyalty_card_ledger(loyalty_program_id, loyalty_card_id, range_start, range_end, opts = {}) ⇒ String

Export card’s ledger log Download a CSV file containing a loyalty card ledger log of the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • loyalty_program_id (Integer) —

    Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.

  • loyalty_card_id (String) —

    Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


3630
3631
3632
3633
 
# File 'lib/talon_one/api/management_api.rb', line 3630

def export_loyalty_card_ledger(loyalty_program_id, loyalty_card_id, range_start, range_end, opts = {})
  data, _status_code, _headers = export_loyalty_card_ledger_with_http_info(loyalty_program_id, loyalty_card_id, range_start, range_end, opts)
  data
end

#export_loyalty_card_ledger_with_http_info(loyalty_program_id, loyalty_card_id, range_start, range_end, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export card&#39;s ledger log Download a CSV file containing a loyalty card ledger log of the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).

Parameters:

  • loyalty_program_id (Integer) —

    Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.

  • loyalty_card_id (String) —

    Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
 
# File 'lib/talon_one/api/management_api.rb', line 3644

def export_loyalty_card_ledger_with_http_info(loyalty_program_id, loyalty_card_id, range_start, range_end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_card_ledger ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_card_ledger"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.export_loyalty_card_ledger"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.export_loyalty_card_ledger, the character length must be smaller than or equal to 108.'
  end

  # verify the required parameter 'range_start' is set
  if @api_client.config.client_side_validation && range_start.nil?
    fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.export_loyalty_card_ledger"
  end
  # verify the required parameter 'range_end' is set
  if @api_client.config.client_side_validation && range_end.nil?
    fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.export_loyalty_card_ledger"
  end
  allowable_values = ["excel", "ISO8601"]
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
    fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rangeStart'] = range_start
  query_params[:'rangeEnd'] = range_end
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_card_ledger\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_loyalty_cards(loyalty_program_id, opts = {}) ⇒ String

Export loyalty cards Download a CSV file containing the loyalty cards from a specified loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - ‘identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.

Parameters:

Options Hash (opts):

  • :batch_id (String) —

    Filter results by loyalty card batch ID.

  • :created_before (DateTime) —

    Only return loyalty cards created before this timestamp. Note: - This must be an RFC3339 timestamp string.

  • :created_after (DateTime) —

    Only return loyalty cards created after this timestamp. Note: - This must be an RFC3339 timestamp string.

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


3723
3724
3725
3726
 
# File 'lib/talon_one/api/management_api.rb', line 3723

def export_loyalty_cards(loyalty_program_id, opts = {})
  data, _status_code, _headers = export_loyalty_cards_with_http_info(loyalty_program_id, opts)
  data
end

#export_loyalty_cards_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export loyalty cards Download a CSV file containing the loyalty cards from a specified loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - &#x60;identifier&#x60;: The unique identifier of the loyalty card. - &#x60;created&#x60;: The date and time the loyalty card was created. - &#x60;status&#x60;: The status of the loyalty card. - &#x60;userpercardlimit&#x60;: The maximum number of customer profiles that can be linked to the card. - &#x60;customerprofileids&#x60;: Integration IDs of the customer profiles linked to the card. - &#x60;blockreason&#x60;: The reason for transferring and blocking the loyalty card. - &#x60;generated&#x60;: An indicator of whether the loyalty card was generated. - &#x60;batchid&#x60;: The ID of the batch the loyalty card is in.

Parameters:

Options Hash (opts):

  • :batch_id (String) —

    Filter results by loyalty card batch ID.

  • :created_before (DateTime) —

    Only return loyalty cards created before this timestamp. Note: - This must be an RFC3339 timestamp string.

  • :created_after (DateTime) —

    Only return loyalty cards created after this timestamp. Note: - This must be an RFC3339 timestamp string.

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'lib/talon_one/api/management_api.rb', line 3737

def export_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_cards ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_cards"
  end
  allowable_values = ["excel", "ISO8601"]
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
    fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/export'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts = {}) ⇒ String

Export customer’s transaction logs Download a CSV file containing a customer’s transaction logs in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - ‘customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


3801
3802
3803
3804
 
# File 'lib/talon_one/api/management_api.rb', line 3801

def export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts = {})
  data, _status_code, _headers = export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts)
  data
end

#export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export customer&#39;s transaction logs Download a CSV file containing a customer&#39;s transaction logs in the loyalty program. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - &#x60;customerprofileid&#x60;: The ID of the profile. - &#x60;customersessionid&#x60;: The ID of the customer session. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;rulename&#x60;: The name of the rule. - &#x60;programid&#x60;: The ID of the loyalty program. - &#x60;type&#x60;: The transaction type, such as &#x60;addition&#x60; or &#x60;subtraction&#x60;. - &#x60;name&#x60;: The reason for the transaction. - &#x60;subledgerid&#x60;: The ID of the subledger, when applicable. - &#x60;startdate&#x60;: The start date of the program. - &#x60;expirydate&#x60;: The expiration date of the program. - &#x60;id&#x60;: The ID of the transaction. - &#x60;created&#x60;: The timestamp of the creation of the loyalty program. - &#x60;amount&#x60;: The number of points in that transaction. - &#x60;archived&#x60;: Whether the session related to the transaction is archived. - &#x60;campaignid&#x60;: The ID of the campaign. - &#x60;flags&#x60;: The flags of the transaction, when applicable. The &#x60;createsNegativeBalance&#x60; flag indicates whether the transaction results in a negative balance.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
 
# File 'lib/talon_one/api/management_api.rb', line 3815

def export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_ledger ...'
  end
  # verify the required parameter 'range_start' is set
  if @api_client.config.client_side_validation && range_start.nil?
    fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.export_loyalty_ledger"
  end
  # verify the required parameter 'range_end' is set
  if @api_client.config.client_side_validation && range_end.nil?
    fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.export_loyalty_ledger"
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_ledger"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.export_loyalty_ledger"
  end
  allowable_values = ["excel", "ISO8601"]
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
    fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rangeStart'] = range_start
  query_params[:'rangeEnd'] = range_end
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_ledger\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_pool_giveaways(pool_id, opts = {}) ⇒ String

Export giveaway codes of a giveaway pool Download a CSV file containing the giveaway codes of a specific giveaway pool. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - ‘id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.

Parameters:

  • pool_id (Integer) —

    The ID of the pool. You can find it in the Campaign Manager, in the Giveaways section.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :created_before (DateTime) —

    Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.

  • :created_after (DateTime) —

    Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.

Returns:

  • (String) 


3888
3889
3890
3891
 
# File 'lib/talon_one/api/management_api.rb', line 3888

def export_pool_giveaways(pool_id, opts = {})
  data, _status_code, _headers = export_pool_giveaways_with_http_info(pool_id, opts)
  data
end

#export_pool_giveaways_with_http_info(pool_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export giveaway codes of a giveaway pool Download a CSV file containing the giveaway codes of a specific giveaway pool. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - &#x60;id&#x60;: The internal ID of the giveaway. - &#x60;poolid&#x60;: The internal ID of the giveaway pool. - &#x60;code&#x60;: The giveaway code. - &#x60;startdate&#x60;: The validity start date in RFC3339 of the giveaway (can be empty). - &#x60;enddate&#x60;: The validity end date in RFC3339 of the giveaway (can be empty). - &#x60;attributes&#x60;: Any custom attributes associated with the giveaway code (can be empty). - &#x60;used&#x60;: An indication of whether the giveaway is already awarded. - &#x60;importid&#x60;: The ID of the import which created the giveaway. - &#x60;created&#x60;: The creation time of the giveaway code. - &#x60;profileintegrationid&#x60;: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - &#x60;profileid&#x60;: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.

Parameters:

  • pool_id (Integer) —

    The ID of the pool. You can find it in the Campaign Manager, in the Giveaways section.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :created_before (DateTime) —

    Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.

  • :created_after (DateTime) —

    Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'lib/talon_one/api/management_api.rb', line 3900

def export_pool_giveaways_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_pool_giveaways ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling ManagementApi.export_pool_giveaways"
  end
  # resource path
  local_var_path = '/v1/giveaways/pools/{poolId}/export'.sub('{' + 'poolId' + '}', CGI.escape(pool_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_pool_giveaways\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_referrals(application_id, opts = {}) ⇒ String

Export referrals Download a CSV file containing the referrals that match the given parameters. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - ‘code`: The referral code. - `advocateprofileintegrationid`: 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 number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing custom referral attribute names and their values.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    • &#x60;expired&#x60;: Matches referrals in which the expiration date is set and in the past. - &#x60;validNow&#x60;: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - &#x60;validFuture&#x60;: Matches referrals in which start date is set and in the future.

  • :usable (String) —

    • &#x60;true&#x60;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned. - &#x60;false&#x60;, only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60; will be returned.

  • :batch_id (String) —

    Filter results by batches of referrals

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


3961
3962
3963
3964
 
# File 'lib/talon_one/api/management_api.rb', line 3961

def export_referrals(application_id, opts = {})
  data, _status_code, _headers = export_referrals_with_http_info(application_id, opts)
  data
end

#export_referrals_with_http_info(application_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export referrals Download a CSV file containing the referrals that match the given parameters. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - &#x60;code&#x60;: The referral code. - &#x60;advocateprofileintegrationid&#x60;: The profile ID of the advocate. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;limitval&#x60;: The maximum number of redemptions of this code. Defaults to &#x60;1&#x60; when left blank. - &#x60;attributes&#x60;: A json object describing custom referral attribute names and their values.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    • &#x60;expired&#x60;: Matches referrals in which the expiration date is set and in the past. - &#x60;validNow&#x60;: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - &#x60;validFuture&#x60;: Matches referrals in which start date is set and in the future.

  • :usable (String) —

    • &#x60;true&#x60;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned. - &#x60;false&#x60;, only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60; will be returned.

  • :batch_id (String) —

    Filter results by batches of referrals

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
 
# File 'lib/talon_one/api/management_api.rb', line 3978

def export_referrals_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.export_referrals ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_referrals"
  end
  allowable_values = ["expired", "validNow", "validFuture"]
  if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
    fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
    fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
  end
  allowable_values = ["excel", "ISO8601"]
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
    fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/export_referrals'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/csv'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#export_referrals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_access_logs_without_total_count(application_id, range_start, range_end, opts = {}) ⇒ InlineResponse20022

Get access logs for Application Retrieve the list of API calls sent to the specified Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :path (String) —

    Only return results where the request path matches the given regular expression.

  • :method (String) —

    Only return results where the request method matches the given regular expression.

  • :status (String) —

    Filter results by HTTP status codes.

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



4057
4058
4059
4060
 
# File 'lib/talon_one/api/management_api.rb', line 4057

def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
  data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
  data
end

#get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20022, Integer, Hash)>

Get access logs for Application Retrieve the list of API calls sent to the specified Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :path (String) —

    Only return results where the request path matches the given regular expression.

  • :method (String) —

    Only return results where the request method matches the given regular expression.

  • :status (String) —

    Filter results by HTTP status codes.

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse20022, Integer, Hash)>) —

    InlineResponse20022 data, response status code and response headers



4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
 
# File 'lib/talon_one/api/management_api.rb', line 4075

def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs_without_total_count ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_access_logs_without_total_count"
  end
  # verify the required parameter 'range_start' is set
  if @api_client.config.client_side_validation && range_start.nil?
    fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_access_logs_without_total_count"
  end
  # verify the required parameter 'range_end' is set
  if @api_client.config.client_side_validation && range_end.nil?
    fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_access_logs_without_total_count"
  end
  allowable_values = ["get", "put", "post", "delete", "patch"]
  if @api_client.config.client_side_validation && opts[:'method'] && !allowable_values.include?(opts[:'method'])
    fail ArgumentError, "invalid value for \"method\", must be one of #{allowable_values}"
  end
  allowable_values = ["success", "error"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_access_logs_without_total_count, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_access_logs_without_total_count, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/access_logs/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rangeStart'] = range_start
  query_params[:'rangeEnd'] = range_end
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'method'] = opts[:'method'] if !opts[:'method'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20022' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_access_logs_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account(account_id, opts = {}) ⇒ Account

Get account details Return the details of your companies Talon.One account.

Parameters:

  • account_id (Integer) —

    The identifier of the account. Retrieve it via the [List users in account](docs.talon.one/management-api#operation/getUsers) endpoint in the &#x60;accountId&#x60; property.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4159
4160
4161
4162
 
# File 'lib/talon_one/api/management_api.rb', line 4159

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#get_account_analytics(account_id, opts = {}) ⇒ AccountAnalytics

Get account analytics Return the analytics of your Talon.One account.

Parameters:

  • account_id (Integer) —

    The identifier of the account. Retrieve it via the [List users in account](docs.talon.one/management-api#operation/getUsers) endpoint in the &#x60;accountId&#x60; property.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4221
4222
4223
4224
 
# File 'lib/talon_one/api/management_api.rb', line 4221

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#get_account_analytics_with_http_info(account_id, opts = {}) ⇒ Array<(AccountAnalytics, Integer, Hash)>

Get account analytics Return the analytics of your Talon.One account.

Parameters:

  • account_id (Integer) —

    The identifier of the account. Retrieve it via the [List users in account](docs.talon.one/management-api#operation/getUsers) endpoint in the &#x60;accountId&#x60; property.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AccountAnalytics, Integer, Hash)>) —

    AccountAnalytics data, response status code and response headers



4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
 
# File 'lib/talon_one/api/management_api.rb', line 4231

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_account_analytics ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ManagementApi.get_account_analytics"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/analytics'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AccountAnalytics' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_account_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_collection(collection_id, opts = {}) ⇒ Collection

Get account-level collection Retrieve a given account-level collection.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4283
4284
4285
4286
 
# File 'lib/talon_one/api/management_api.rb', line 4283

def (collection_id, opts = {})
  data, _status_code, _headers = (collection_id, opts)
  data
end

#get_account_collection_with_http_info(collection_id, opts = {}) ⇒ Array<(Collection, Integer, Hash)>

Get account-level collection Retrieve a given account-level collection.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Collection, Integer, Hash)>) —

    Collection data, response status code and response headers



4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
 
# File 'lib/talon_one/api/management_api.rb', line 4293

def (collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_account_collection ...'
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.get_account_collection"
  end
  # resource path
  local_var_path = '/v1/collections/{collectionId}'.sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Collection' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_account_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_with_http_info(account_id, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Get account details Return the details of your companies Talon.One account.

Parameters:

  • account_id (Integer) —

    The identifier of the account. Retrieve it via the [List users in account](docs.talon.one/management-api#operation/getUsers) endpoint in the &#x60;accountId&#x60; property.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Account, Integer, Hash)>) —

    Account data, response status code and response headers



4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
 
# File 'lib/talon_one/api/management_api.rb', line 4169

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_account ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ManagementApi.get_account"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Account' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_achievement(application_id, campaign_id, achievement_id, opts = {}) ⇒ Achievement

Get achievement Get the details of a specific achievement.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4347
4348
4349
4350
 
# File 'lib/talon_one/api/management_api.rb', line 4347

def get_achievement(application_id, campaign_id, achievement_id, opts = {})
  data, _status_code, _headers = get_achievement_with_http_info(application_id, campaign_id, achievement_id, opts)
  data
end

#get_achievement_with_http_info(application_id, campaign_id, achievement_id, opts = {}) ⇒ Array<(Achievement, Integer, Hash)>

Get achievement Get the details of a specific achievement.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Achievement, Integer, Hash)>) —

    Achievement data, response status code and response headers



4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
 
# File 'lib/talon_one/api/management_api.rb', line 4359

def get_achievement_with_http_info(application_id, campaign_id, achievement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_achievement ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_achievement"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_achievement"
  end
  # verify the required parameter 'achievement_id' is set
  if @api_client.config.client_side_validation && achievement_id.nil?
    fail ArgumentError, "Missing the required parameter 'achievement_id' when calling ManagementApi.get_achievement"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'achievementId' + '}', CGI.escape(achievement_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Achievement' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_achievement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_additional_cost(additional_cost_id, opts = {}) ⇒ AccountAdditionalCost

Get additional cost Returns the additional cost.

Parameters:

  • additional_cost_id (Integer) —

    The ID of the additional cost. You can find the ID the the Campaign Manager&#39;s URL when you display the details of the cost in Account &gt; Tools &gt; **Additional costs**.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4419
4420
4421
4422
 
# File 'lib/talon_one/api/management_api.rb', line 4419

def get_additional_cost(additional_cost_id, opts = {})
  data, _status_code, _headers = get_additional_cost_with_http_info(additional_cost_id, opts)
  data
end

#get_additional_cost_with_http_info(additional_cost_id, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>

Get additional cost Returns the additional cost.

Parameters:

  • additional_cost_id (Integer) —

    The ID of the additional cost. You can find the ID the the Campaign Manager&#39;s URL when you display the details of the cost in Account &gt; Tools &gt; **Additional costs**.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AccountAdditionalCost, Integer, Hash)>) —

    AccountAdditionalCost data, response status code and response headers



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
 
# File 'lib/talon_one/api/management_api.rb', line 4429

def get_additional_cost_with_http_info(additional_cost_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_cost ...'
  end
  # verify the required parameter 'additional_cost_id' is set
  if @api_client.config.client_side_validation && additional_cost_id.nil?
    fail ArgumentError, "Missing the required parameter 'additional_cost_id' when calling ManagementApi.get_additional_cost"
  end
  # resource path
  local_var_path = '/v1/additional_costs/{additionalCostId}'.sub('{' + 'additionalCostId' + '}', CGI.escape(additional_cost_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AccountAdditionalCost' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_additional_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_additional_costs(opts = {}) ⇒ InlineResponse20038

List additional costs Returns all the defined additional costs for the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



4483
4484
4485
4486
 
# File 'lib/talon_one/api/management_api.rb', line 4483

def get_additional_costs(opts = {})
  data, _status_code, _headers = get_additional_costs_with_http_info(opts)
  data
end

#get_additional_costs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20038, Integer, Hash)>

List additional costs Returns all the defined additional costs for the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse20038, Integer, Hash)>) —

    InlineResponse20038 data, response status code and response headers



4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
 
# File 'lib/talon_one/api/management_api.rb', line 4495

def get_additional_costs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_additional_costs, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_additional_costs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/additional_costs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20038' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_additional_costs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application(application_id, opts = {}) ⇒ Application

Get Application Get the application specified by the ID.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4554
4555
4556
4557
 
# File 'lib/talon_one/api/management_api.rb', line 4554

def get_application(application_id, opts = {})
  data, _status_code, _headers = get_application_with_http_info(application_id, opts)
  data
end

#get_application_api_health(application_id, opts = {}) ⇒ ApplicationApiHealth

Get Application health Display the health of the Application and show the last time the Application was used. You can also find this information in the Campaign Manager. In your Application, click Settings > **Integration API Keys**. See the [docs](docs.talon.one/docs/dev/tutorials/monitoring-integration-status).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4616
4617
4618
4619
 
# File 'lib/talon_one/api/management_api.rb', line 4616

def get_application_api_health(application_id, opts = {})
  data, _status_code, _headers = get_application_api_health_with_http_info(application_id, opts)
  data
end

#get_application_api_health_with_http_info(application_id, opts = {}) ⇒ Array<(ApplicationApiHealth, Integer, Hash)>

Get Application health Display the health of the Application and show the last time the Application was used. You can also find this information in the Campaign Manager. In your Application, click Settings &gt; **Integration API Keys**. See the [docs](docs.talon.one/docs/dev/tutorials/monitoring-integration-status).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicationApiHealth, Integer, Hash)>) —

    ApplicationApiHealth data, response status code and response headers



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
 
# File 'lib/talon_one/api/management_api.rb', line 4626

def get_application_api_health_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_api_health ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_api_health"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/health_report'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ApplicationApiHealth' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_api_health\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_customer(application_id, customer_id, opts = {}) ⇒ ApplicationCustomer

Get application’s customer Retrieve the customers of the specified application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • customer_id (Integer) —

    The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4679
4680
4681
4682
 
# File 'lib/talon_one/api/management_api.rb', line 4679

def get_application_customer(application_id, customer_id, opts = {})
  data, _status_code, _headers = get_application_customer_with_http_info(application_id, customer_id, opts)
  data
end

#get_application_customer_friends(application_id, integration_id, opts = {}) ⇒ InlineResponse20035

List friends referred by customer profile List the friends referred by the specified customer profile in this Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • integration_id (String) —

    The Integration ID of the Advocate&#39;s Profile.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:



4751
4752
4753
4754
 
# File 'lib/talon_one/api/management_api.rb', line 4751

def get_application_customer_friends(application_id, integration_id, opts = {})
  data, _status_code, _headers = get_application_customer_friends_with_http_info(application_id, integration_id, opts)
  data
end

#get_application_customer_friends_with_http_info(application_id, integration_id, opts = {}) ⇒ Array<(InlineResponse20035, Integer, Hash)>

List friends referred by customer profile List the friends referred by the specified customer profile in this Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • integration_id (String) —

    The Integration ID of the Advocate&#39;s Profile.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:

  • (Array<(InlineResponse20035, Integer, Hash)>) —

    InlineResponse20035 data, response status code and response headers



4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
 
# File 'lib/talon_one/api/management_api.rb', line 4766

def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer_friends ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_customer_friends"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.get_application_customer_friends"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_customer_friends, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_customer_friends, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/profile/{integrationId}/friends'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20035' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_customer_friends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_customer_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(ApplicationCustomer, Integer, Hash)>

Get application&#39;s customer Retrieve the customers of the specified application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • customer_id (Integer) —

    The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicationCustomer, Integer, Hash)>) —

    ApplicationCustomer data, response status code and response headers



4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
 
# File 'lib/talon_one/api/management_api.rb', line 4690

def get_application_customer_with_http_info(application_id, customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_customer"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_application_customer"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/customers/{customerId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ApplicationCustomer' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_customers(application_id, opts = {}) ⇒ InlineResponse20024

List application’s customers List all the customers of the specified application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Filter results performing an exact matching against the profile integration identifier.

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:



4838
4839
4840
4841
 
# File 'lib/talon_one/api/management_api.rb', line 4838

def get_application_customers(application_id, opts = {})
  data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts)
  data
end

#get_application_customers_by_attributes(application_id, body, opts = {}) ⇒ InlineResponse20025

List application customers matching the given attributes Get a list of the application customers matching the provided criteria. 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.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (CustomerProfileSearchQuery) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:



4920
4921
4922
4923
 
# File 'lib/talon_one/api/management_api.rb', line 4920

def get_application_customers_by_attributes(application_id, body, opts = {})
  data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(application_id, body, opts)
  data
end

#get_application_customers_by_attributes_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse20025, Integer, Hash)>

List application customers matching the given attributes Get a list of the application customers matching the provided criteria. 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.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (CustomerProfileSearchQuery) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:

  • (Array<(InlineResponse20025, Integer, Hash)>) —

    InlineResponse20025 data, response status code and response headers



4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
 
# File 'lib/talon_one/api/management_api.rb', line 4934

def get_application_customers_by_attributes_with_http_info(application_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_customers_by_attributes"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_application_customers_by_attributes"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_customers_by_attributes, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_customers_by_attributes, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/customer_search'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20025' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_customers_by_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_customers_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20024, Integer, Hash)>

List application&#39;s customers List all the customers of the specified application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Filter results performing an exact matching against the profile integration identifier.

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:

  • (Array<(InlineResponse20024, Integer, Hash)>) —

    InlineResponse20024 data, response status code and response headers



4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
 
# File 'lib/talon_one/api/management_api.rb', line 4852

def get_application_customers_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_customers"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_customers, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_customers, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/customers'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20024' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_event_types(application_id, opts = {}) ⇒ InlineResponse20031

List Applications event types Get all of the distinct values of the Event ‘type` property for events recorded in the application. See also: [Track an event](docs.talon.one/integration-api#tag/Events/operation/trackEventV2)

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



5006
5007
5008
5009
 
# File 'lib/talon_one/api/management_api.rb', line 5006

def get_application_event_types(application_id, opts = {})
  data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
  data
end

#get_application_event_types_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20031, Integer, Hash)>

List Applications event types Get all of the distinct values of the Event &#x60;type&#x60; property for events recorded in the application. See also: [Track an event](docs.talon.one/integration-api#tag/Events/operation/trackEventV2)

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse20031, Integer, Hash)>) —

    InlineResponse20031 data, response status code and response headers



5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
 
# File 'lib/talon_one/api/management_api.rb', line 5019

def get_application_event_types_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_event_types"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_event_types, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_event_types, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/event_types'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20031' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_event_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_events_without_total_count(application_id, opts = {}) ⇒ InlineResponse20030

List Applications events Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :type (String) —

    Comma-separated list of types by which to filter events. Must be exact match(es).

  • :created_before (DateTime) —

    Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :session (String) —

    Session integration ID filter for events. Must be exact match.

  • :profile (String) —

    Profile integration ID filter for events. Must be exact match.

  • :customer_name (String) —

    Customer name filter for events. Will match substrings case-insensitively.

  • :customer_email (String) —

    Customer e-mail address filter for events. Will match substrings case-insensitively.

  • :coupon_code (String) —

    Coupon code

  • :referral_code (String) —

    Referral code

  • :rule_query (String) —

    Rule name filter for events

  • :campaign_query (String) —

    Campaign name filter for events

Returns:



5096
5097
5098
5099
 
# File 'lib/talon_one/api/management_api.rb', line 5096

def get_application_events_without_total_count(application_id, opts = {})
  data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
  data
end

#get_application_events_without_total_count_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20030, Integer, Hash)>

List Applications events Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :type (String) —

    Comma-separated list of types by which to filter events. Must be exact match(es).

  • :created_before (DateTime) —

    Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :session (String) —

    Session integration ID filter for events. Must be exact match.

  • :profile (String) —

    Profile integration ID filter for events. Must be exact match.

  • :customer_name (String) —

    Customer name filter for events. Will match substrings case-insensitively.

  • :customer_email (String) —

    Customer e-mail address filter for events. Will match substrings case-insensitively.

  • :coupon_code (String) —

    Coupon code

  • :referral_code (String) —

    Referral code

  • :rule_query (String) —

    Rule name filter for events

  • :campaign_query (String) —

    Campaign name filter for events

Returns:

  • (Array<(InlineResponse20030, Integer, Hash)>) —

    InlineResponse20030 data, response status code and response headers



5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
 
# File 'lib/talon_one/api/management_api.rb', line 5120

def get_application_events_without_total_count_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_events_without_total_count"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_events_without_total_count, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_events_without_total_count, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'customer_name'].nil? && opts[:'customer_name'].to_s.length < 2
    fail ArgumentError, 'invalid value for "opts[:"customer_name"]" when calling ManagementApi.get_application_events_without_total_count, the character length must be great than or equal to 2.'
  end

  if @api_client.config.client_side_validation && !opts[:'customer_email'].nil? && opts[:'customer_email'].to_s.length < 2
    fail ArgumentError, 'invalid value for "opts[:"customer_email"]" when calling ManagementApi.get_application_events_without_total_count, the character length must be great than or equal to 2.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/events/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'session'] = opts[:'session'] if !opts[:'session'].nil?
  query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil?
  query_params[:'customerName'] = opts[:'customer_name'] if !opts[:'customer_name'].nil?
  query_params[:'customerEmail'] = opts[:'customer_email'] if !opts[:'customer_email'].nil?
  query_params[:'couponCode'] = opts[:'coupon_code'] if !opts[:'coupon_code'].nil?
  query_params[:'referralCode'] = opts[:'referral_code'] if !opts[:'referral_code'].nil?
  query_params[:'ruleQuery'] = opts[:'rule_query'] if !opts[:'rule_query'].nil?
  query_params[:'campaignQuery'] = opts[:'campaign_query'] if !opts[:'campaign_query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20030' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_events_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_session(application_id, session_id, opts = {}) ⇒ ApplicationSession

Get Application session Get the details of the given session. You can list the sessions with the [List Application sessions](docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.

Parameters:

Returns:



5203
5204
5205
5206
 
# File 'lib/talon_one/api/management_api.rb', line 5203

def get_application_session(application_id, session_id, opts = {})
  data, _status_code, _headers = get_application_session_with_http_info(application_id, session_id, opts)
  data
end

#get_application_session_with_http_info(application_id, session_id, opts = {}) ⇒ Array<(ApplicationSession, Integer, Hash)>

Get Application session Get the details of the given session. You can list the sessions with the [List Application sessions](docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.

Parameters:

Returns:

  • (Array<(ApplicationSession, Integer, Hash)>) —

    ApplicationSession data, response status code and response headers



5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
 
# File 'lib/talon_one/api/management_api.rb', line 5214

def get_application_session_with_http_info(application_id, session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_session ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_session"
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling ManagementApi.get_application_session"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/sessions/{sessionId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ApplicationSession' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_sessions(application_id, opts = {}) ⇒ InlineResponse20029

List Application sessions List all the sessions of the specified Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :profile (String) —

    Profile integration ID filter for sessions. Must be exact match.

  • :state (String) —

    Filter by sessions with this state. Must be exact match.

  • :created_before (DateTime) —

    Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :coupon (String) —

    Filter by sessions with this coupon. Must be exact match.

  • :referral (String) —

    Filter by sessions with this referral. Must be exact match.

  • :integration_id (String) —

    Filter by sessions with this integration ID. Must be exact match.

  • :store_integration_id (String) —

    The integration ID of the store. You choose this ID when you create a store.

Returns:



5281
5282
5283
5284
 
# File 'lib/talon_one/api/management_api.rb', line 5281

def get_application_sessions(application_id, opts = {})
  data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts)
  data
end

#get_application_sessions_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20029, Integer, Hash)>

List Application sessions List all the sessions of the specified Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :profile (String) —

    Profile integration ID filter for sessions. Must be exact match.

  • :state (String) —

    Filter by sessions with this state. Must be exact match.

  • :created_before (DateTime) —

    Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :coupon (String) —

    Filter by sessions with this coupon. Must be exact match.

  • :referral (String) —

    Filter by sessions with this referral. Must be exact match.

  • :integration_id (String) —

    Filter by sessions with this integration ID. Must be exact match.

  • :store_integration_id (String) —

    The integration ID of the store. You choose this ID when you create a store.

Returns:

  • (Array<(InlineResponse20029, Integer, Hash)>) —

    InlineResponse20029 data, response status code and response headers



5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
 
# File 'lib/talon_one/api/management_api.rb', line 5302

def get_application_sessions_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_sessions"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_sessions, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_application_sessions, must be greater than or equal to 1.'
  end

  allowable_values = ["open", "closed", "partially_returned", "cancelled"]
  if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
    fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/sessions'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'coupon'] = opts[:'coupon'] if !opts[:'coupon'].nil?
  query_params[:'referral'] = opts[:'referral'] if !opts[:'referral'].nil?
  query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'storeIntegrationId'] = opts[:'store_integration_id'] if !opts[:'store_integration_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20029' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_with_http_info(application_id, opts = {}) ⇒ Array<(Application, Integer, Hash)>

Get Application Get the application specified by the ID.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Application, Integer, Hash)>) —

    Application data, response status code and response headers



4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
 
# File 'lib/talon_one/api/management_api.rb', line 4564

def get_application_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_application ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Application' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_applications(opts = {}) ⇒ InlineResponse2007

List Applications List all applications in the current account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



5379
5380
5381
5382
 
# File 'lib/talon_one/api/management_api.rb', line 5379

def get_applications(opts = {})
  data, _status_code, _headers = get_applications_with_http_info(opts)
  data
end

#get_applications_with_http_info(opts = {}) ⇒ Array<(InlineResponse2007, Integer, Hash)>

List Applications List all applications in the current account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse2007, Integer, Hash)>) —

    InlineResponse2007 data, response status code and response headers



5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
 
# File 'lib/talon_one/api/management_api.rb', line 5391

def get_applications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_applications ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_applications, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_applications, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2007' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attribute(attribute_id, opts = {}) ⇒ Attribute

Get custom attribute Retrieve the specified custom attribute.

Parameters:

  • attribute_id (Integer) —

    The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in Account &gt; Tools &gt; Attributes.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5450
5451
5452
5453
 
# File 'lib/talon_one/api/management_api.rb', line 5450

def get_attribute(attribute_id, opts = {})
  data, _status_code, _headers = get_attribute_with_http_info(attribute_id, opts)
  data
end

#get_attribute_with_http_info(attribute_id, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>

Get custom attribute Retrieve the specified custom attribute.

Parameters:

  • attribute_id (Integer) —

    The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in Account &gt; Tools &gt; Attributes.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attribute, Integer, Hash)>) —

    Attribute data, response status code and response headers



5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
 
# File 'lib/talon_one/api/management_api.rb', line 5460

def get_attribute_with_http_info(attribute_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_attribute ...'
  end
  # verify the required parameter 'attribute_id' is set
  if @api_client.config.client_side_validation && attribute_id.nil?
    fail ArgumentError, "Missing the required parameter 'attribute_id' when calling ManagementApi.get_attribute"
  end
  # resource path
  local_var_path = '/v1/attributes/{attributeId}'.sub('{' + 'attributeId' + '}', CGI.escape(attribute_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attribute' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attributes(opts = {}) ⇒ InlineResponse20036

List custom attributes Return all the custom attributes for the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :entity (String) —

    Returned attributes will be filtered by supplied entity.

Returns:



5515
5516
5517
5518
 
# File 'lib/talon_one/api/management_api.rb', line 5515

def get_attributes(opts = {})
  data, _status_code, _headers = get_attributes_with_http_info(opts)
  data
end

#get_attributes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20036, Integer, Hash)>

List custom attributes Return all the custom attributes for the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :entity (String) —

    Returned attributes will be filtered by supplied entity.

Returns:

  • (Array<(InlineResponse20036, Integer, Hash)>) —

    InlineResponse20036 data, response status code and response headers



5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'lib/talon_one/api/management_api.rb', line 5528

def get_attributes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_attributes, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_attributes, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/attributes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20036' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_audience_memberships(audience_id, opts = {}) ⇒ InlineResponse20034

List audience members Get a paginated list of the customer profiles in a given audience. A maximum of 1000 customer profiles per page is allowed.

Parameters:

  • audience_id (Integer) —

    The ID of the audience.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :profile_query (String) —

    The filter to select a profile.

Returns:



5592
5593
5594
5595
 
# File 'lib/talon_one/api/management_api.rb', line 5592

def get_audience_memberships(audience_id, opts = {})
  data, _status_code, _headers = get_audience_memberships_with_http_info(audience_id, opts)
  data
end

#get_audience_memberships_with_http_info(audience_id, opts = {}) ⇒ Array<(InlineResponse20034, Integer, Hash)>

List audience members Get a paginated list of the customer profiles in a given audience. A maximum of 1000 customer profiles per page is allowed.

Parameters:

  • audience_id (Integer) —

    The ID of the audience.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :profile_query (String) —

    The filter to select a profile.

Returns:

  • (Array<(InlineResponse20034, Integer, Hash)>) —

    InlineResponse20034 data, response status code and response headers



5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
 
# File 'lib/talon_one/api/management_api.rb', line 5606

def get_audience_memberships_with_http_info(audience_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_audience_memberships ...'
  end
  # verify the required parameter 'audience_id' is set
  if @api_client.config.client_side_validation && audience_id.nil?
    fail ArgumentError, "Missing the required parameter 'audience_id' when calling ManagementApi.get_audience_memberships"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_audience_memberships, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_audience_memberships, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/audiences/{audienceId}/memberships'.sub('{' + 'audienceId' + '}', CGI.escape(audience_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'profileQuery'] = opts[:'profile_query'] if !opts[:'profile_query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20034' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_audience_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_audiences(opts = {}) ⇒ InlineResponse20032

List audiences Get all audiences created in the account. To create an audience, use [Create audience](docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:



5673
5674
5675
5676
 
# File 'lib/talon_one/api/management_api.rb', line 5673

def get_audiences(opts = {})
  data, _status_code, _headers = get_audiences_with_http_info(opts)
  data
end

#get_audiences_analytics(audience_ids, opts = {}) ⇒ InlineResponse20033

List audience analytics Get a list of audience IDs and their member count.

Parameters:

  • audience_ids (String) —

    The IDs of one or more audiences, separated by commas, by which to filter results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



5747
5748
5749
5750
 
# File 'lib/talon_one/api/management_api.rb', line 5747

def get_audiences_analytics(audience_ids, opts = {})
  data, _status_code, _headers = get_audiences_analytics_with_http_info(audience_ids, opts)
  data
end

#get_audiences_analytics_with_http_info(audience_ids, opts = {}) ⇒ Array<(InlineResponse20033, Integer, Hash)>

List audience analytics Get a list of audience IDs and their member count.

Parameters:

  • audience_ids (String) —

    The IDs of one or more audiences, separated by commas, by which to filter results.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse20033, Integer, Hash)>) —

    InlineResponse20033 data, response status code and response headers



5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'lib/talon_one/api/management_api.rb', line 5758

def get_audiences_analytics_with_http_info(audience_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences_analytics ...'
  end
  # verify the required parameter 'audience_ids' is set
  if @api_client.config.client_side_validation && audience_ids.nil?
    fail ArgumentError, "Missing the required parameter 'audience_ids' when calling ManagementApi.get_audiences_analytics"
  end
  # resource path
  local_var_path = '/v1/audiences/analytics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'audienceIds'] = audience_ids
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20033' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_audiences_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_audiences_with_http_info(opts = {}) ⇒ Array<(InlineResponse20032, Integer, Hash)>

List audiences Get all audiences created in the account. To create an audience, use [Create audience](docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

Returns:

  • (Array<(InlineResponse20032, Integer, Hash)>) —

    InlineResponse20032 data, response status code and response headers



5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'lib/talon_one/api/management_api.rb', line 5686

def get_audiences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_audiences, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_audiences, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/audiences'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20032' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_audiences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign(application_id, campaign_id, opts = {}) ⇒ Campaign

Get campaign Retrieve the given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5813
5814
5815
5816
 
# File 'lib/talon_one/api/management_api.rb', line 5813

def get_campaign(application_id, campaign_id, opts = {})
  data, _status_code, _headers = get_campaign_with_http_info(application_id, campaign_id, opts)
  data
end

#get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {}) ⇒ InlineResponse20023

Get analytics of campaigns Retrieve statistical data about the performance of the given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :granularity (String) —

    The time interval between the results in the returned time-series.

Returns:



5884
5885
5886
5887
 
# File 'lib/talon_one/api/management_api.rb', line 5884

def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {})
  data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts)
  data
end

#get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20023, Integer, Hash)>

Get analytics of campaigns Retrieve statistical data about the performance of the given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :granularity (String) —

    The time interval between the results in the returned time-series.

Returns:

  • (Array<(InlineResponse20023, Integer, Hash)>) —

    InlineResponse20023 data, response status code and response headers



5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
 
# File 'lib/talon_one/api/management_api.rb', line 5898

def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaign_analytics"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_campaign_analytics"
  end
  # verify the required parameter 'range_start' is set
  if @api_client.config.client_side_validation && range_start.nil?
    fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_campaign_analytics"
  end
  # verify the required parameter 'range_end' is set
  if @api_client.config.client_side_validation && range_end.nil?
    fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_campaign_analytics"
  end
  allowable_values = ["1 hour", "1 day", "1 week", "1 month", "1 year"]
  if @api_client.config.client_side_validation && opts[:'granularity'] && !allowable_values.include?(opts[:'granularity'])
    fail ArgumentError, "invalid value for \"granularity\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/analytics'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rangeStart'] = range_start
  query_params[:'rangeEnd'] = range_end
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20023' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_campaign_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_by_attributes(application_id, body, opts = {}) ⇒ InlineResponse2008

List campaigns that match the given attributes Get a list of all the campaigns that match a set of attributes.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (CampaignSearch) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

Returns:



5974
5975
5976
5977
 
# File 'lib/talon_one/api/management_api.rb', line 5974

def get_campaign_by_attributes(application_id, body, opts = {})
  data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts)
  data
end

#get_campaign_by_attributes_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2008, Integer, Hash)>

List campaigns that match the given attributes Get a list of all the campaigns that match a set of attributes.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (CampaignSearch) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

Returns:

  • (Array<(InlineResponse2008, Integer, Hash)>) —

    InlineResponse2008 data, response status code and response headers



5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
 
# File 'lib/talon_one/api/management_api.rb', line 5989

def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_by_attributes ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaign_by_attributes"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_campaign_by_attributes"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_by_attributes, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_by_attributes, must be greater than or equal to 1.'
  end

  allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
    fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns_search'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2008' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_campaign_by_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_group(campaign_group_id, opts = {}) ⇒ CampaignGroup

Get campaign access group Get a campaign access group specified by its ID.

Parameters:

  • campaign_group_id (Integer) —

    The ID of the campaign access group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6063
6064
6065
6066
 
# File 'lib/talon_one/api/management_api.rb', line 6063

def get_campaign_group(campaign_group_id, opts = {})
  data, _status_code, _headers = get_campaign_group_with_http_info(campaign_group_id, opts)
  data
end

#get_campaign_group_with_http_info(campaign_group_id, opts = {}) ⇒ Array<(CampaignGroup, Integer, Hash)>

Get campaign access group Get a campaign access group specified by its ID.

Parameters:

  • campaign_group_id (Integer) —

    The ID of the campaign access group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignGroup, Integer, Hash)>) —

    CampaignGroup data, response status code and response headers



6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
 
# File 'lib/talon_one/api/management_api.rb', line 6073

def get_campaign_group_with_http_info(campaign_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_group ...'
  end
  # verify the required parameter 'campaign_group_id' is set
  if @api_client.config.client_side_validation && campaign_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_group_id' when calling ManagementApi.get_campaign_group"
  end
  # resource path
  local_var_path = '/v1/campaign_groups/{campaignGroupId}'.sub('{' + 'campaignGroupId' + '}', CGI.escape(campaign_group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CampaignGroup' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_campaign_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_groups(opts = {}) ⇒ InlineResponse20013

List campaign access groups List the campaign access groups in the current account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



6127
6128
6129
6130
 
# File 'lib/talon_one/api/management_api.rb', line 6127

def get_campaign_groups(opts = {})
  data, _status_code, _headers = get_campaign_groups_with_http_info(opts)
  data
end

#get_campaign_groups_with_http_info(opts = {}) ⇒ Array<(InlineResponse20013, Integer, Hash)>

List campaign access groups List the campaign access groups in the current account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse20013, Integer, Hash)>) —

    InlineResponse20013 data, response status code and response headers



6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
 
# File 'lib/talon_one/api/management_api.rb', line 6139

def get_campaign_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_groups ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_groups, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_groups, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/campaign_groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20013' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_campaign_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_templates(opts = {}) ⇒ InlineResponse20014

List campaign templates Retrieve a list of campaign templates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :state (String) —

    Filter results by the state of the campaign template.

  • :name (String) —

    Filter results performing case-insensitive matching against the name of the campaign template.

  • :tags (String) —

    Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the &quot;name&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values.

  • :user_id (Integer) —

    Filter results by user ID.

Returns:



6204
6205
6206
6207
 
# File 'lib/talon_one/api/management_api.rb', line 6204

def get_campaign_templates(opts = {})
  data, _status_code, _headers = get_campaign_templates_with_http_info(opts)
  data
end

#get_campaign_templates_with_http_info(opts = {}) ⇒ Array<(InlineResponse20014, Integer, Hash)>

List campaign templates Retrieve a list of campaign templates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :state (String) —

    Filter results by the state of the campaign template.

  • :name (String) —

    Filter results performing case-insensitive matching against the name of the campaign template.

  • :tags (String) —

    Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the &quot;name&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values.

  • :user_id (Integer) —

    Filter results by user ID.

Returns:

  • (Array<(InlineResponse20014, Integer, Hash)>) —

    InlineResponse20014 data, response status code and response headers



6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
 
# File 'lib/talon_one/api/management_api.rb', line 6220

def get_campaign_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_templates ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_templates, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_templates, must be greater than or equal to 1.'
  end

  allowable_values = ["draft", "enabled", "disabled"]
  if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
    fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/campaign_templates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20014' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_campaign_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>

Get campaign Retrieve the given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Campaign, Integer, Hash)>) —

    Campaign data, response status code and response headers



5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
 
# File 'lib/talon_one/api/management_api.rb', line 5824

def get_campaign_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaign"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_campaign"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Campaign' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns(application_id, opts = {}) ⇒ InlineResponse2008

List campaigns List the campaigns of the specified application that match your filter criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

  • :name (String) —

    Filter results performing case-insensitive matching against the name of the campaign.

  • :tags (String) —

    Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the &quot;name&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :campaign_group_id (Integer) —

    Filter results to campaigns owned by the specified campaign access group ID.

  • :template_id (Integer) —

    The ID of the campaign template this campaign was created from.

  • :store_id (Integer) —

    Filter results to campaigns linked to the specified store ID.

Returns:



6298
6299
6300
6301
 
# File 'lib/talon_one/api/management_api.rb', line 6298

def get_campaigns(application_id, opts = {})
  data, _status_code, _headers = get_campaigns_with_http_info(application_id, opts)
  data
end

#get_campaigns_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse2008, Integer, Hash)>

List campaigns List the campaigns of the specified application that match your filter criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

  • :name (String) —

    Filter results performing case-insensitive matching against the name of the campaign.

  • :tags (String) —

    Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the &quot;name&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :campaign_group_id (Integer) —

    Filter results to campaigns owned by the specified campaign access group ID.

  • :template_id (Integer) —

    The ID of the campaign template this campaign was created from.

  • :store_id (Integer) —

    Filter results to campaigns linked to the specified store ID.

Returns:

  • (Array<(InlineResponse2008, Integer, Hash)>) —

    InlineResponse2008 data, response status code and response headers



6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
 
# File 'lib/talon_one/api/management_api.rb', line 6319

def get_campaigns_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaigns ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaigns"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaigns, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaigns, must be greater than or equal to 1.'
  end

  allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
    fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'campaignGroupId'] = opts[:'campaign_group_id'] if !opts[:'campaign_group_id'].nil?
  query_params[:'templateId'] = opts[:'template_id'] if !opts[:'template_id'].nil?
  query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2008' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_changes(opts = {}) ⇒ InlineResponse20044

Get audit logs for an account Retrieve the audit logs displayed in **Accounts > Audit logs**.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :application_id (Float) —

    Filter results by Application ID.

  • :entity_path (String) —

    Filter results on a case insensitive matching of the url path of the entity

  • :user_id (Integer) —

    Filter results by user ID.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :management_key_id (Integer) —

    Filter results that match the given management key ID.

  • :include_old (Boolean) —

    When this flag is set to false, the state without the change will not be returned. The default value is true.

Returns:



6404
6405
6406
6407
 
# File 'lib/talon_one/api/management_api.rb', line 6404

def get_changes(opts = {})
  data, _status_code, _headers = get_changes_with_http_info(opts)
  data
end

#get_changes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20044, Integer, Hash)>

Get audit logs for an account Retrieve the audit logs displayed in **Accounts &gt; Audit logs**.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :application_id (Float) —

    Filter results by Application ID.

  • :entity_path (String) —

    Filter results on a case insensitive matching of the url path of the entity

  • :user_id (Integer) —

    Filter results by user ID.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :management_key_id (Integer) —

    Filter results that match the given management key ID.

  • :include_old (Boolean) —

    When this flag is set to false, the state without the change will not be returned. The default value is true.

Returns:

  • (Array<(InlineResponse20044, Integer, Hash)>) —

    InlineResponse20044 data, response status code and response headers



6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
 
# File 'lib/talon_one/api/management_api.rb', line 6424

def get_changes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_changes, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_changes, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/changes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
  query_params[:'entityPath'] = opts[:'entity_path'] if !opts[:'entity_path'].nil?
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
  query_params[:'managementKeyId'] = opts[:'management_key_id'] if !opts[:'management_key_id'].nil?
  query_params[:'includeOld'] = opts[:'include_old'] if !opts[:'include_old'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20044' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_collection(application_id, campaign_id, collection_id, opts = {}) ⇒ Collection

Get campaign-level collection Retrieve a given campaign-level collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6493
6494
6495
6496
 
# File 'lib/talon_one/api/management_api.rb', line 6493

def get_collection(application_id, campaign_id, collection_id, opts = {})
  data, _status_code, _headers = get_collection_with_http_info(application_id, campaign_id, collection_id, opts)
  data
end

#get_collection_items(collection_id, opts = {}) ⇒ InlineResponse20021

Get collection items Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

Returns:



6567
6568
6569
6570
 
# File 'lib/talon_one/api/management_api.rb', line 6567

def get_collection_items(collection_id, opts = {})
  data, _status_code, _headers = get_collection_items_with_http_info(collection_id, opts)
  data
end

#get_collection_items_with_http_info(collection_id, opts = {}) ⇒ Array<(InlineResponse20021, Integer, Hash)>

Get collection items Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

Returns:

  • (Array<(InlineResponse20021, Integer, Hash)>) —

    InlineResponse20021 data, response status code and response headers



6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
 
# File 'lib/talon_one/api/management_api.rb', line 6579

def get_collection_items_with_http_info(collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_collection_items ...'
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.get_collection_items"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_collection_items, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_collection_items, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/collections/{collectionId}/items'.sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20021' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_collection_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_collection_with_http_info(application_id, campaign_id, collection_id, opts = {}) ⇒ Array<(Collection, Integer, Hash)>

Get campaign-level collection Retrieve a given campaign-level collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Collection, Integer, Hash)>) —

    Collection data, response status code and response headers



6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
 
# File 'lib/talon_one/api/management_api.rb', line 6505

def get_collection_with_http_info(application_id, campaign_id, collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_collection ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_collection"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_collection"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.get_collection"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Collection' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupons_without_total_count(application_id, campaign_id, opts = {}) ⇒ InlineResponse20011

List coupons List all the coupons matching the specified criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :redeemed (String) —

    • &#x60;true&#x60;: only coupons where &#x60;usageCounter &gt; 0&#x60; will be returned. - &#x60;false&#x60;: only coupons where &#x60;usageCounter &#x3D; 0&#x60; will be returned. - This field cannot be used in conjunction with the &#x60;usable&#x60; query parameter.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code. (default to false)

  • :expires_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :expires_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :values_only (Boolean) —

    Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data. (default to false)

Returns:



6660
6661
6662
6663
 
# File 'lib/talon_one/api/management_api.rb', line 6660

def get_coupons_without_total_count(application_id, campaign_id, opts = {})
  data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts)
  data
end

#get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse20011, Integer, Hash)>

List coupons List all the coupons matching the specified criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :redeemed (String) —

    • &#x60;true&#x60;: only coupons where &#x60;usageCounter &gt; 0&#x60; will be returned. - &#x60;false&#x60;: only coupons where &#x60;usageCounter &#x3D; 0&#x60; will be returned. - This field cannot be used in conjunction with the &#x60;usable&#x60; query parameter.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code.

  • :expires_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :expires_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :starts_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :values_only (Boolean) —

    Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data.

Returns:

  • (Array<(InlineResponse20011, Integer, Hash)>) —

    InlineResponse20011 data, response status code and response headers



6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
 
# File 'lib/talon_one/api/management_api.rb', line 6689

def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_without_total_count ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_coupons_without_total_count"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_coupons_without_total_count"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_coupons_without_total_count, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_coupons_without_total_count, must be greater than or equal to 1.'
  end

  allowable_values = ["expired", "validNow", "validFuture"]
  if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
    fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
    fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'redeemed'] && !allowable_values.include?(opts[:'redeemed'])
    fail ArgumentError, "invalid value for \"redeemed\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
  query_params[:'redeemed'] = opts[:'redeemed'] if !opts[:'redeemed'].nil?
  query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
  query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
  query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
  query_params[:'expiresBefore'] = opts[:'expires_before'] if !opts[:'expires_before'].nil?
  query_params[:'expiresAfter'] = opts[:'expires_after'] if !opts[:'expires_after'].nil?
  query_params[:'startsBefore'] = opts[:'starts_before'] if !opts[:'starts_before'].nil?
  query_params[:'startsAfter'] = opts[:'starts_after'] if !opts[:'starts_after'].nil?
  query_params[:'valuesOnly'] = opts[:'values_only'] if !opts[:'values_only'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20011' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_coupons_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_activity_report(range_start, range_end, application_id, customer_id, opts = {}) ⇒ CustomerActivityReport

Get customer’s activity report Fetch the summary report of a given customer in the given application, in a time range.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • customer_id (Integer) —

    The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

Returns:



6788
6789
6790
6791
 
# File 'lib/talon_one/api/management_api.rb', line 6788

def get_customer_activity_report(range_start, range_end, application_id, customer_id, opts = {})
  data, _status_code, _headers = get_customer_activity_report_with_http_info(range_start, range_end, application_id, customer_id, opts)
  data
end

#get_customer_activity_report_with_http_info(range_start, range_end, application_id, customer_id, opts = {}) ⇒ Array<(CustomerActivityReport, Integer, Hash)>

Get customer&#39;s activity report Fetch the summary report of a given customer in the given application, in a time range.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • customer_id (Integer) —

    The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

Returns:

  • (Array<(CustomerActivityReport, Integer, Hash)>) —

    CustomerActivityReport data, response status code and response headers



6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
 
# File 'lib/talon_one/api/management_api.rb', line 6803

def get_customer_activity_report_with_http_info(range_start, range_end, application_id, customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_report ...'
  end
  # verify the required parameter 'range_start' is set
  if @api_client.config.client_side_validation && range_start.nil?
    fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_customer_activity_report"
  end
  # verify the required parameter 'range_end' is set
  if @api_client.config.client_side_validation && range_end.nil?
    fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_customer_activity_report"
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_activity_report"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_customer_activity_report"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_activity_report, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_activity_report, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/customer_activity_reports/{customerId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rangeStart'] = range_start
  query_params[:'rangeEnd'] = range_end
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CustomerActivityReport' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_customer_activity_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {}) ⇒ InlineResponse20028

Get Activity Reports for Application Customers Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :name (String) —

    Only return reports matching the customer name.

  • :integration_id (String) —

    Filter results performing an exact matching against the profile integration identifier.

  • :campaign_name (String) —

    Only return reports matching the campaign name.

  • :advocate_name (String) —

    Only return reports matching the current customer referrer name.

Returns:



6888
6889
6890
6891
 
# File 'lib/talon_one/api/management_api.rb', line 6888

def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {})
  data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts)
  data
end

#get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {}) ⇒ Array<(InlineResponse20028, Integer, Hash)>

Get Activity Reports for Application Customers Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :name (String) —

    Only return reports matching the customer name.

  • :integration_id (String) —

    Filter results performing an exact matching against the profile integration identifier.

  • :campaign_name (String) —

    Only return reports matching the campaign name.

  • :advocate_name (String) —

    Only return reports matching the current customer referrer name.

Returns:

  • (Array<(InlineResponse20028, Integer, Hash)>) —

    InlineResponse20028 data, response status code and response headers



6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
 
# File 'lib/talon_one/api/management_api.rb', line 6907

def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...'
  end
  # verify the required parameter 'range_start' is set
  if @api_client.config.client_side_validation && range_start.nil?
    fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_customer_activity_reports_without_total_count"
  end
  # verify the required parameter 'range_end' is set
  if @api_client.config.client_side_validation && range_end.nil?
    fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_customer_activity_reports_without_total_count"
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_activity_reports_without_total_count"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_activity_reports_without_total_count, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_activity_reports_without_total_count, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/customer_activity_reports/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rangeStart'] = range_start
  query_params[:'rangeEnd'] = range_end
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'campaignName'] = opts[:'campaign_name'] if !opts[:'campaign_name'].nil?
  query_params[:'advocateName'] = opts[:'advocate_name'] if !opts[:'advocate_name'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20028' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_customer_activity_reports_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_analytics(application_id, customer_id, opts = {}) ⇒ CustomerAnalytics

Get customer’s analytics report Fetch analytics for a given customer in the given application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • customer_id (Integer) —

    The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



6988
6989
6990
6991
 
# File 'lib/talon_one/api/management_api.rb', line 6988

def get_customer_analytics(application_id, customer_id, opts = {})
  data, _status_code, _headers = get_customer_analytics_with_http_info(application_id, customer_id, opts)
  data
end

#get_customer_analytics_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(CustomerAnalytics, Integer, Hash)>

Get customer&#39;s analytics report Fetch analytics for a given customer in the given application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • customer_id (Integer) —

    The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(CustomerAnalytics, Integer, Hash)>) —

    CustomerAnalytics data, response status code and response headers



7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
 
# File 'lib/talon_one/api/management_api.rb', line 7002

def get_customer_analytics_with_http_info(application_id, customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_analytics ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_analytics"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_customer_analytics"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_analytics, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_analytics, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/customers/{customerId}/analytics'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CustomerAnalytics' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_customer_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_profile(customer_id, opts = {}) ⇒ CustomerProfile

Get customer profile Return the details of the specified customer profile. <div class="redoc-section"> <p class="title">Performance tips</p> You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with ‘runRuleEngine=false`. </div>

Parameters:

Returns:



7069
7070
7071
7072
 
# File 'lib/talon_one/api/management_api.rb', line 7069

def get_customer_profile(customer_id, opts = {})
  data, _status_code, _headers = get_customer_profile_with_http_info(customer_id, opts)
  data
end

#get_customer_profile_achievement_progress(application_id, integration_id, opts = {}) ⇒ InlineResponse20051

List customer achievements For the given customer profile, list all the achievements that match your filter criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 50)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • :title (String) —

    Filter results by the &#x60;title&#x60; of an achievement.

Returns:



7136
7137
7138
7139
 
# File 'lib/talon_one/api/management_api.rb', line 7136

def get_customer_profile_achievement_progress(application_id, integration_id, opts = {})
  data, _status_code, _headers = get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts)
  data
end

#get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts = {}) ⇒ Array<(InlineResponse20051, Integer, Hash)>

List customer achievements For the given customer profile, list all the achievements that match your filter criteria.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • :title (String) —

    Filter results by the &#x60;title&#x60; of an achievement.

Returns:

  • (Array<(InlineResponse20051, Integer, Hash)>) —

    InlineResponse20051 data, response status code and response headers



7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
 
# File 'lib/talon_one/api/management_api.rb', line 7151

def get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile_achievement_progress ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_profile_achievement_progress"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.get_customer_profile_achievement_progress"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_profile_achievement_progress, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_profile_achievement_progress, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/achievement_progress/{integrationId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'achievementId'] = opts[:'achievement_id'] if !opts[:'achievement_id'].nil?
  query_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20051' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_customer_profile_achievement_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_profile_with_http_info(customer_id, opts = {}) ⇒ Array<(CustomerProfile, Integer, Hash)>

Get customer profile Return the details of the specified customer profile. &lt;div class&#x3D;&quot;redoc-section&quot;&gt; &lt;p class&#x3D;&quot;title&quot;&gt;Performance tips&lt;/p&gt; You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with &#x60;runRuleEngine&#x3D;false&#x60;. &lt;/div&gt;

Parameters:

Returns:

  • (Array<(CustomerProfile, Integer, Hash)>) —

    CustomerProfile data, response status code and response headers



7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
 
# File 'lib/talon_one/api/management_api.rb', line 7079

def get_customer_profile_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_customer_profile"
  end
  # resource path
  local_var_path = '/v1/customers/{customerId}'.sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CustomerProfile' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_customer_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_profiles(opts = {}) ⇒ InlineResponse20027

List customer profiles List all customer profiles.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or live customer. (default to false)

Returns:



7221
7222
7223
7224
 
# File 'lib/talon_one/api/management_api.rb', line 7221

def get_customer_profiles(opts = {})
  data, _status_code, _headers = get_customer_profiles_with_http_info(opts)
  data
end

#get_customer_profiles_with_http_info(opts = {}) ⇒ Array<(InlineResponse20027, Integer, Hash)>

List customer profiles List all customer profiles.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or live customer.

Returns:

  • (Array<(InlineResponse20027, Integer, Hash)>) —

    InlineResponse20027 data, response status code and response headers



7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
 
# File 'lib/talon_one/api/management_api.rb', line 7233

def get_customer_profiles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_profiles, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customer_profiles, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/customers/no_total'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sandbox'] = opts[:'sandbox'] if !opts[:'sandbox'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20027' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_customer_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customers_by_attributes(body, opts = {}) ⇒ InlineResponse20026

List customer profiles matching the given attributes Get a list of the customer profiles matching the provided criteria. 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.

Parameters:

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or live customer. (default to false)

Returns:



7295
7296
7297
7298
 
# File 'lib/talon_one/api/management_api.rb', line 7295

def get_customers_by_attributes(body, opts = {})
  data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts)
  data
end

#get_customers_by_attributes_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20026, Integer, Hash)>

List customer profiles matching the given attributes Get a list of the customer profiles matching the provided criteria. 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.

Parameters:

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or live customer.

Returns:

  • (Array<(InlineResponse20026, Integer, Hash)>) —

    InlineResponse20026 data, response status code and response headers



7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
 
# File 'lib/talon_one/api/management_api.rb', line 7308

def get_customers_by_attributes_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_customers_by_attributes"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customers_by_attributes, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_customers_by_attributes, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/customer_search/no_total'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sandbox'] = opts[:'sandbox'] if !opts[:'sandbox'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20026' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_customers_by_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts = {}) ⇒ InlineResponse20016

Get statistics for loyalty dashboard Retrieve the statistics displayed on the specified loyalty program’s dashboard, such as the total active points, pending points, spent points, and expired points. Important: The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.

Parameters:

  • loyalty_program_id (Integer) —

    Identifier of the loyalty program. You can get the ID with the [List loyalty programs](docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

Returns:



7376
7377
7378
7379
 
# File 'lib/talon_one/api/management_api.rb', line 7376

def get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts = {})
  data, _status_code, _headers = get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts)
  data
end

#get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20016, Integer, Hash)>

Get statistics for loyalty dashboard Retrieve the statistics displayed on the specified loyalty program&#39;s dashboard, such as the total active points, pending points, spent points, and expired points. Important: The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.

Parameters:

  • loyalty_program_id (Integer) —

    Identifier of the loyalty program. You can get the ID with the [List loyalty programs](docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.

  • range_start (DateTime) —

    Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • range_end (DateTime) —

    Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

Returns:

  • (Array<(InlineResponse20016, Integer, Hash)>) —

    InlineResponse20016 data, response status code and response headers



7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
 
# File 'lib/talon_one/api/management_api.rb', line 7389

def get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_dashboard_statistics ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_dashboard_statistics"
  end
  # verify the required parameter 'range_start' is set
  if @api_client.config.client_side_validation && range_start.nil?
    fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_dashboard_statistics"
  end
  # verify the required parameter 'range_end' is set
  if @api_client.config.client_side_validation && range_end.nil?
    fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_dashboard_statistics"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/dashboard'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rangeStart'] = range_start
  query_params[:'rangeEnd'] = range_end
  query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20016' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_dashboard_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_event_types(opts = {}) ⇒ InlineResponse20042

List event types Fetch all event type definitions for your account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter results to event types with the given name. This parameter implies &#x60;includeOldVersions&#x60;.

  • :include_old_versions (Boolean) —

    Include all versions of every event type. (default to false)

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



7456
7457
7458
7459
 
# File 'lib/talon_one/api/management_api.rb', line 7456

def get_event_types(opts = {})
  data, _status_code, _headers = get_event_types_with_http_info(opts)
  data
end

#get_event_types_with_http_info(opts = {}) ⇒ Array<(InlineResponse20042, Integer, Hash)>

List event types Fetch all event type definitions for your account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter results to event types with the given name. This parameter implies &#x60;includeOldVersions&#x60;.

  • :include_old_versions (Boolean) —

    Include all versions of every event type.

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse20042, Integer, Hash)>) —

    InlineResponse20042 data, response status code and response headers



7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
 
# File 'lib/talon_one/api/management_api.rb', line 7470

def get_event_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_event_types, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_event_types, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/event_types'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'includeOldVersions'] = opts[:'include_old_versions'] if !opts[:'include_old_versions'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20042' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_event_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_exports(opts = {}) ⇒ InlineResponse20045

Get exports List all past exports

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Integer) —

    Filter by the campaign ID on which the limit counters are used.

  • :entity (String) —

    The name of the entity type that was exported.

Returns:



7535
7536
7537
7538
 
# File 'lib/talon_one/api/management_api.rb', line 7535

def get_exports(opts = {})
  data, _status_code, _headers = get_exports_with_http_info(opts)
  data
end

#get_exports_with_http_info(opts = {}) ⇒ Array<(InlineResponse20045, Integer, Hash)>

Get exports List all past exports

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Integer) —

    Filter by the campaign ID on which the limit counters are used.

  • :entity (String) —

    The name of the entity type that was exported.

Returns:

  • (Array<(InlineResponse20045, Integer, Hash)>) —

    InlineResponse20045 data, response status code and response headers



7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
 
# File 'lib/talon_one/api/management_api.rb', line 7549

def get_exports_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_exports, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_exports, must be greater than or equal to 1.'
  end

  allowable_values = ["Coupon", "Referral", "Effect", "CustomerSession", "LoyaltyLedger", "LoyaltyLedgerLog", "Collection", "AudienceMembership"]
  if @api_client.config.client_side_validation && opts[:'entity'] && !allowable_values.include?(opts[:'entity'])
    fail ArgumentError, "invalid value for \"entity\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/exports'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20045' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_card(loyalty_program_id, loyalty_card_id, opts = {}) ⇒ LoyaltyCard

Get loyalty card Get the given loyalty card.

Parameters:

Returns:



7615
7616
7617
7618
 
# File 'lib/talon_one/api/management_api.rb', line 7615

def get_loyalty_card(loyalty_program_id, loyalty_card_id, opts = {})
  data, _status_code, _headers = get_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts)
  data
end

#get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts = {}) ⇒ InlineResponse20019

List card’s transactions Retrieve the transaction logs for the given [loyalty card](docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.

Parameters:

Options Hash (opts):

  • :start_date (DateTime) —

    Date and time from which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :end_date (DateTime) —

    Date and time by which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

Returns:



7692
7693
7694
7695
 
# File 'lib/talon_one/api/management_api.rb', line 7692

def get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts = {})
  data, _status_code, _headers = get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts)
  data
end

#get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts = {}) ⇒ Array<(InlineResponse20019, Integer, Hash)>

List card&#39;s transactions Retrieve the transaction logs for the given [loyalty card](docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.

Parameters:

Options Hash (opts):

  • :start_date (DateTime) —

    Date and time from which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :end_date (DateTime) —

    Date and time by which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

Returns:

  • (Array<(InlineResponse20019, Integer, Hash)>) —

    InlineResponse20019 data, response status code and response headers



7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
 
# File 'lib/talon_one/api/management_api.rb', line 7708

def get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_card_transaction_logs ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_card_transaction_logs"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.get_loyalty_card_transaction_logs"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.get_loyalty_card_transaction_logs, the character length must be smaller than or equal to 108.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_card_transaction_logs, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_card_transaction_logs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20019' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_card_transaction_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts = {}) ⇒ Array<(LoyaltyCard, Integer, Hash)>

Get loyalty card Get the given loyalty card.

Parameters:

Returns:

  • (Array<(LoyaltyCard, Integer, Hash)>) —

    LoyaltyCard data, response status code and response headers



7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
 
# File 'lib/talon_one/api/management_api.rb', line 7626

def get_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_card ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_card"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.get_loyalty_card"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.get_loyalty_card, the character length must be smaller than or equal to 108.'
  end

  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'LoyaltyCard' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_cards(loyalty_program_id, opts = {}) ⇒ InlineResponse20018

List loyalty cards For the given card-based loyalty program, list the loyalty cards that match your filter criteria.

Parameters:

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :identifier (String) —

    The card code by which to filter loyalty cards in the response.

  • :profile_id (Integer) —

    Filter results by customer profile ID.

  • :batch_id (String) —

    Filter results by loyalty card batch ID.

Returns:



7787
7788
7789
7790
 
# File 'lib/talon_one/api/management_api.rb', line 7787

def get_loyalty_cards(loyalty_program_id, opts = {})
  data, _status_code, _headers = get_loyalty_cards_with_http_info(loyalty_program_id, opts)
  data
end

#get_loyalty_cards_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(InlineResponse20018, Integer, Hash)>

List loyalty cards For the given card-based loyalty program, list the loyalty cards that match your filter criteria.

Parameters:

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :identifier (String) —

    The card code by which to filter loyalty cards in the response.

  • :profile_id (Integer) —

    Filter results by customer profile ID.

  • :batch_id (String) —

    Filter results by loyalty card batch ID.

Returns:

  • (Array<(InlineResponse20018, Integer, Hash)>) —

    InlineResponse20018 data, response status code and response headers



7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
 
# File 'lib/talon_one/api/management_api.rb', line 7803

def get_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_cards ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_cards"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_cards, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_cards, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'identifier'].nil? && opts[:'identifier'].to_s.length < 4
    fail ArgumentError, 'invalid value for "opts[:"identifier"]" when calling ManagementApi.get_loyalty_cards, the character length must be great than or equal to 4.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'] < 1
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling ManagementApi.get_loyalty_cards, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20018' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_points(loyalty_program_id, integration_id, opts = {}) ⇒ LoyaltyLedger

Get customer’s full loyalty ledger Get the loyalty ledger for this profile integration ID. To get the ‘integrationId` of the profile from a `sessionId`, use the [Update customer session](docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. Important: To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API’s [Get customer’s loyalty logs](docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7878
7879
7880
7881
 
# File 'lib/talon_one/api/management_api.rb', line 7878

def get_loyalty_points(loyalty_program_id, integration_id, opts = {})
  data, _status_code, _headers = get_loyalty_points_with_http_info(loyalty_program_id, integration_id, opts)
  data
end

#get_loyalty_points_with_http_info(loyalty_program_id, integration_id, opts = {}) ⇒ Array<(LoyaltyLedger, Integer, Hash)>

Get customer&#39;s full loyalty ledger Get the loyalty ledger for this profile integration ID. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. Important: To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API&#39;s [Get customer&#39;s loyalty logs](docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LoyaltyLedger, Integer, Hash)>) —

    LoyaltyLedger data, response status code and response headers



7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
 
# File 'lib/talon_one/api/management_api.rb', line 7889

def get_loyalty_points_with_http_info(loyalty_program_id, integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_points ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_points"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.get_loyalty_points"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'LoyaltyLedger' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_program(loyalty_program_id, opts = {}) ⇒ LoyaltyProgram

Get loyalty program Get the specified [loyalty program](docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)

Parameters:

Returns:



7945
7946
7947
7948
 
# File 'lib/talon_one/api/management_api.rb', line 7945

def get_loyalty_program(loyalty_program_id, opts = {})
  data, _status_code, _headers = get_loyalty_program_with_http_info(loyalty_program_id, opts)
  data
end

#get_loyalty_program_transactions(loyalty_program_id, opts = {}) ⇒ InlineResponse20017

List loyalty program transactions Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. Note: If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. Important: To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API’s [Get customer’s loyalty logs](docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).

Parameters:

Options Hash (opts):

  • :loyalty_transaction_type (String) —

    Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file.

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

  • :start_date (DateTime) —

    Date and time from which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :end_date (DateTime) —

    Date and time by which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :page_size (Integer) —

    The number of items in the response. (default to 50)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

Returns:



8013
8014
8015
8016
 
# File 'lib/talon_one/api/management_api.rb', line 8013

def get_loyalty_program_transactions(loyalty_program_id, opts = {})
  data, _status_code, _headers = get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts)
  data
end

#get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(InlineResponse20017, Integer, Hash)>

List loyalty program transactions Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. Note: If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. Important: To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API&#39;s [Get customer&#39;s loyalty logs](docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).

Parameters:

Options Hash (opts):

  • :loyalty_transaction_type (String) —

    Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file.

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

  • :start_date (DateTime) —

    Date and time from which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :end_date (DateTime) —

    Date and time by which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

Returns:

  • (Array<(InlineResponse20017, Integer, Hash)>) —

    InlineResponse20017 data, response status code and response headers



8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
 
# File 'lib/talon_one/api/management_api.rb', line 8029

def get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_program_transactions ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_program_transactions"
  end
  allowable_values = ["manual", "session", "import"]
  if @api_client.config.client_side_validation && opts[:'loyalty_transaction_type'] && !allowable_values.include?(opts[:'loyalty_transaction_type'])
    fail ArgumentError, "invalid value for \"loyalty_transaction_type\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_program_transactions, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_loyalty_program_transactions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/transactions'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'loyaltyTransactionType'] = opts[:'loyalty_transaction_type'] if !opts[:'loyalty_transaction_type'].nil?
  query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20017' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_program_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_program_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(LoyaltyProgram, Integer, Hash)>

Get loyalty program Get the specified [loyalty program](docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)

Parameters:

Returns:

  • (Array<(LoyaltyProgram, Integer, Hash)>) —

    LoyaltyProgram data, response status code and response headers



7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
 
# File 'lib/talon_one/api/management_api.rb', line 7955

def get_loyalty_program_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_program ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_program"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'LoyaltyProgram' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_program\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_programs(opts = {}) ⇒ InlineResponse20015

List loyalty programs List the loyalty programs of the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8098
8099
8100
8101
 
# File 'lib/talon_one/api/management_api.rb', line 8098

def get_loyalty_programs(opts = {})
  data, _status_code, _headers = get_loyalty_programs_with_http_info(opts)
  data
end

#get_loyalty_programs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20015, Integer, Hash)>

List loyalty programs List the loyalty programs of the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20015, Integer, Hash)>) —

    InlineResponse20015 data, response status code and response headers



8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
 
# File 'lib/talon_one/api/management_api.rb', line 8107

def get_loyalty_programs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_programs ...'
  end
  # resource path
  local_var_path = '/v1/loyalty_programs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20015' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_programs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_loyalty_statistics(loyalty_program_id, opts = {}) ⇒ LoyaltyDashboardData

Get loyalty program statistics ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.

Parameters:

Returns:



8155
8156
8157
8158
 
# File 'lib/talon_one/api/management_api.rb', line 8155

def get_loyalty_statistics(loyalty_program_id, opts = {})
  data, _status_code, _headers = get_loyalty_statistics_with_http_info(loyalty_program_id, opts)
  data
end

#get_loyalty_statistics_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(LoyaltyDashboardData, Integer, Hash)>

Get loyalty program statistics ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.

Parameters:

Returns:

  • (Array<(LoyaltyDashboardData, Integer, Hash)>) —

    LoyaltyDashboardData data, response status code and response headers



8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
 
# File 'lib/talon_one/api/management_api.rb', line 8165

def get_loyalty_statistics_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_statistics ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_statistics"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/statistics'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'LoyaltyDashboardData' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_message_logs(entity_type, opts = {}) ⇒ MessageLogEntries

List message log entries Retrieve all message log entries.

Parameters:

  • entity_type (String) —

    The entity type the log is related to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :message_id (String) —

    Filter results by message ID.

  • :change_type (String) —

    Filter results by change type.

  • :notification_i_ds (String) —

    Filter results by notification ID (include up to 30 values, separated by a comma).

  • :created_before (DateTime) —

    Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :cursor (String) —

    A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.

  • :period (String) —

    Filter results by time period. Choose between the available relative time frames.

  • :is_successful (Boolean) —

    Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to&#x60;true&#x60;, only log entries with &#x60;2xx&#x60; response codes are returned. When set to &#x60;false&#x60;, only log entries with &#x60;4xx&#x60; and &#x60;5xx&#x60; response codes are returned.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :loyalty_program_id (Integer) —

    Identifier of the loyalty program.

  • :response_code (Integer) —

    Filter results by response status code.

  • :webhook_i_ds (String) —

    Filter results by webhook ID (include up to 30 values, separated by a comma).

Returns:



8230
8231
8232
8233
 
# File 'lib/talon_one/api/management_api.rb', line 8230

def get_message_logs(entity_type, opts = {})
  data, _status_code, _headers = get_message_logs_with_http_info(entity_type, opts)
  data
end

#get_message_logs_with_http_info(entity_type, opts = {}) ⇒ Array<(MessageLogEntries, Integer, Hash)>

List message log entries Retrieve all message log entries.

Parameters:

  • entity_type (String) —

    The entity type the log is related to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :message_id (String) —

    Filter results by message ID.

  • :change_type (String) —

    Filter results by change type.

  • :notification_i_ds (String) —

    Filter results by notification ID (include up to 30 values, separated by a comma).

  • :created_before (DateTime) —

    Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :cursor (String) —

    A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.

  • :period (String) —

    Filter results by time period. Choose between the available relative time frames.

  • :is_successful (Boolean) —

    Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to&#x60;true&#x60;, only log entries with &#x60;2xx&#x60; response codes are returned. When set to &#x60;false&#x60;, only log entries with &#x60;4xx&#x60; and &#x60;5xx&#x60; response codes are returned.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :loyalty_program_id (Integer) —

    Identifier of the loyalty program.

  • :response_code (Integer) —

    Filter results by response status code.

  • :webhook_i_ds (String) —

    Filter results by webhook ID (include up to 30 values, separated by a comma).

Returns:

  • (Array<(MessageLogEntries, Integer, Hash)>) —

    MessageLogEntries data, response status code and response headers



8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
 
# File 'lib/talon_one/api/management_api.rb', line 8253

def get_message_logs_with_http_info(entity_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_message_logs ...'
  end
  # verify the required parameter 'entity_type' is set
  if @api_client.config.client_side_validation && entity_type.nil?
    fail ArgumentError, "Missing the required parameter 'entity_type' when calling ManagementApi.get_message_logs"
  end
  # verify enum value
  allowable_values = ["application", "loyalty_program", "webhook"]
  if @api_client.config.client_side_validation && !allowable_values.include?(entity_type)
    fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["CampaignEvaluationTreeChanged", "CampaignNotification", "CouponCreated", "CouponUpdated", "CouponDeleted", "AsyncCouponsCreated", "CouponsDeleted", "CouponsUpdated", "CouponCodeExpiring", "StrikethroughPrice", "LoyaltyPointsAdded", "LoyaltyPointsDeducted", "LoyaltyPointsExpiring", "LoyaltyPointsPendingToActive", "LoyaltyAddedDeductedPointsBalances", "LoyaltyCardAddedDeductedPointsBalances", "TierWillDowngrade", "TierUpgrade", "TierDowngrade", "LoyaltyCardPointsAdded", "LoyaltyCardPointsDeducted", "LoyaltyCardPointsExpiring"]
  if @api_client.config.client_side_validation && opts[:'change_type'] && !allowable_values.include?(opts[:'change_type'])
    fail ArgumentError, "invalid value for \"change_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["15m", "30m", "1h", "4h", "1d", "2d"]
  if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
    fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/message_logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'entityType'] = entity_type
  query_params[:'messageID'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'changeType'] = opts[:'change_type'] if !opts[:'change_type'].nil?
  query_params[:'notificationIDs'] = opts[:'notification_i_ds'] if !opts[:'notification_i_ds'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'isSuccessful'] = opts[:'is_successful'] if !opts[:'is_successful'].nil?
  query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'loyaltyProgramId'] = opts[:'loyalty_program_id'] if !opts[:'loyalty_program_id'].nil?
  query_params[:'responseCode'] = opts[:'response_code'] if !opts[:'response_code'].nil?
  query_params[:'webhookIDs'] = opts[:'webhook_i_ds'] if !opts[:'webhook_i_ds'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'MessageLogEntries' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_message_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_referrals_without_total_count(application_id, campaign_id, opts = {}) ⇒ InlineResponse20012

List referrals List all referrals of the specified campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :code (String) —

    Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :advocate (String) —

    Filter results by match with a profile ID specified in the referral&#39;s AdvocateProfileIntegrationId field.

Returns:



8342
8343
8344
8345
 
# File 'lib/talon_one/api/management_api.rb', line 8342

def get_referrals_without_total_count(application_id, campaign_id, opts = {})
  data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts)
  data
end

#get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse20012, Integer, Hash)>

List referrals List all referrals of the specified campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :code (String) —

    Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :advocate (String) —

    Filter results by match with a profile ID specified in the referral&#39;s AdvocateProfileIntegrationId field.

Returns:

  • (Array<(InlineResponse20012, Integer, Hash)>) —

    InlineResponse20012 data, response status code and response headers



8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
 
# File 'lib/talon_one/api/management_api.rb', line 8362

def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals_without_total_count ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_referrals_without_total_count"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_referrals_without_total_count"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_referrals_without_total_count, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_referrals_without_total_count, must be greater than or equal to 1.'
  end

  allowable_values = ["expired", "validNow", "validFuture"]
  if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
    fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
    fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
  query_params[:'advocate'] = opts[:'advocate'] if !opts[:'advocate'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20012' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_referrals_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_role_v2(role_id, opts = {}) ⇒ RoleV2

Get role Get the details of a specific role. To see all the roles, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.

Parameters:

  • role_id (Integer) —

    The ID of role. Note: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8443
8444
8445
8446
 
# File 'lib/talon_one/api/management_api.rb', line 8443

def get_role_v2(role_id, opts = {})
  data, _status_code, _headers = get_role_v2_with_http_info(role_id, opts)
  data
end

#get_role_v2_with_http_info(role_id, opts = {}) ⇒ Array<(RoleV2, Integer, Hash)>

Get role Get the details of a specific role. To see all the roles, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.

Parameters:

  • role_id (Integer) —

    The ID of role. Note: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RoleV2, Integer, Hash)>) —

    RoleV2 data, response status code and response headers



8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
 
# File 'lib/talon_one/api/management_api.rb', line 8453

def get_role_v2_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_role_v2 ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling ManagementApi.get_role_v2"
  end
  # resource path
  local_var_path = '/v2/roles/{roleId}'.sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'RoleV2' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_role_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ruleset(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Ruleset

Get ruleset Retrieve the specified ruleset.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • ruleset_id (Integer) —

    The ID of the ruleset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8507
8508
8509
8510
 
# File 'lib/talon_one/api/management_api.rb', line 8507

def get_ruleset(application_id, campaign_id, ruleset_id, opts = {})
  data, _status_code, _headers = get_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts)
  data
end

#get_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Array<(Ruleset, Integer, Hash)>

Get ruleset Retrieve the specified ruleset.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • ruleset_id (Integer) —

    The ID of the ruleset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Ruleset, Integer, Hash)>) —

    Ruleset data, response status code and response headers



8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
 
# File 'lib/talon_one/api/management_api.rb', line 8519

def get_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_ruleset ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_ruleset"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_ruleset"
  end
  # verify the required parameter 'ruleset_id' is set
  if @api_client.config.client_side_validation && ruleset_id.nil?
    fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling ManagementApi.get_ruleset"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'rulesetId' + '}', CGI.escape(ruleset_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Ruleset' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rulesets(application_id, campaign_id, opts = {}) ⇒ InlineResponse2009

List campaign rulesets List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. Important: The response also includes deleted rules. You should only consider the latest revision of the returned rulesets.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



8583
8584
8585
8586
 
# File 'lib/talon_one/api/management_api.rb', line 8583

def get_rulesets(application_id, campaign_id, opts = {})
  data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts)
  data
end

#get_rulesets_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2009, Integer, Hash)>

List campaign rulesets List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. Important: The response also includes deleted rules. You should only consider the latest revision of the returned rulesets.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse2009, Integer, Hash)>) —

    InlineResponse2009 data, response status code and response headers



8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
 
# File 'lib/talon_one/api/management_api.rb', line 8597

def get_rulesets_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_rulesets ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_rulesets"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_rulesets"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_rulesets, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_rulesets, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2009' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_store(application_id, store_id, opts = {}) ⇒ Store

Get store Get store details for a specific store ID.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • store_id (String) —

    The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8665
8666
8667
8668
 
# File 'lib/talon_one/api/management_api.rb', line 8665

def get_store(application_id, store_id, opts = {})
  data, _status_code, _headers = get_store_with_http_info(application_id, store_id, opts)
  data
end

#get_store_with_http_info(application_id, store_id, opts = {}) ⇒ Array<(Store, Integer, Hash)>

Get store Get store details for a specific store ID.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • store_id (String) —

    The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Store, Integer, Hash)>) —

    Store data, response status code and response headers



8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
 
# File 'lib/talon_one/api/management_api.rb', line 8676

def get_store_with_http_info(application_id, store_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_store ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_store"
  end
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling ManagementApi.get_store"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/stores/{storeId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'storeId' + '}', CGI.escape(store_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Store' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user(user_id, opts = {}) ⇒ User

Get user Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8732
8733
8734
8735
 
# File 'lib/talon_one/api/management_api.rb', line 8732

def get_user(user_id, opts = {})
  data, _status_code, _headers = get_user_with_http_info(user_id, opts)
  data
end

#get_user_with_http_info(user_id, opts = {}) ⇒ Array<(User, Integer, Hash)>

Get user Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
 
# File 'lib/talon_one/api/management_api.rb', line 8742

def get_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_user ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.get_user"
  end
  # resource path
  local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'User' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_users(opts = {}) ⇒ InlineResponse20043

List users in account Retrieve all users in your account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:



8796
8797
8798
8799
 
# File 'lib/talon_one/api/management_api.rb', line 8796

def get_users(opts = {})
  data, _status_code, _headers = get_users_with_http_info(opts)
  data
end

#get_users_with_http_info(opts = {}) ⇒ Array<(InlineResponse20043, Integer, Hash)>

List users in account Retrieve all users in your account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Returns:

  • (Array<(InlineResponse20043, Integer, Hash)>) —

    InlineResponse20043 data, response status code and response headers



8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
 
# File 'lib/talon_one/api/management_api.rb', line 8808

def get_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_users, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_users, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20043' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook(webhook_id, opts = {}) ⇒ Webhook

Get webhook Returns a webhook by its id.

Parameters:

  • webhook_id (Integer) —

    The ID of the webhook. You can find the ID in the Campaign Manager&#39;s URL when you display the details of the webhook in Account &gt; Webhooks.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8867
8868
8869
8870
 
# File 'lib/talon_one/api/management_api.rb', line 8867

def get_webhook(webhook_id, opts = {})
  data, _status_code, _headers = get_webhook_with_http_info(webhook_id, opts)
  data
end

#get_webhook_activation_logs(opts = {}) ⇒ InlineResponse20040

List webhook activation log entries Webhook activation log entries are created as soon as an integration request triggers a webhook effect. See the [docs](docs.talon.one/docs/dev/getting-started/webhooks).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :integration_request_uuid (String) —

    Filter results by integration request UUID.

  • :webhook_id (Float) —

    Filter results by webhook id.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :created_before (DateTime) —

    Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

Returns:



8937
8938
8939
8940
 
# File 'lib/talon_one/api/management_api.rb', line 8937

def get_webhook_activation_logs(opts = {})
  data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
  data
end

#get_webhook_activation_logs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20040, Integer, Hash)>

List webhook activation log entries Webhook activation log entries are created as soon as an integration request triggers a webhook effect. See the [docs](docs.talon.one/docs/dev/getting-started/webhooks).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :integration_request_uuid (String) —

    Filter results by integration request UUID.

  • :webhook_id (Float) —

    Filter results by webhook id.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :created_before (DateTime) —

    Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

Returns:

  • (Array<(InlineResponse20040, Integer, Hash)>) —

    InlineResponse20040 data, response status code and response headers



8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
 
# File 'lib/talon_one/api/management_api.rb', line 8955

def get_webhook_activation_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhook_activation_logs, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhook_activation_logs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/webhook_activation_logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'integrationRequestUuid'] = opts[:'integration_request_uuid'] if !opts[:'integration_request_uuid'].nil?
  query_params[:'webhookId'] = opts[:'webhook_id'] if !opts[:'webhook_id'].nil?
  query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20040' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_webhook_activation_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_logs(opts = {}) ⇒ InlineResponse20041

List webhook log entries Retrieve all webhook log entries.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :status (String) —

    Filter results by HTTP status codes.

  • :webhook_id (Float) —

    Filter results by webhook id.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :request_uuid (String) —

    Filter results by request UUID.

  • :created_before (DateTime) —

    Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

Returns:



9029
9030
9031
9032
 
# File 'lib/talon_one/api/management_api.rb', line 9029

def get_webhook_logs(opts = {})
  data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
  data
end

#get_webhook_logs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20041, Integer, Hash)>

List webhook log entries Retrieve all webhook log entries.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :status (String) —

    Filter results by HTTP status codes.

  • :webhook_id (Float) —

    Filter results by webhook id.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :request_uuid (String) —

    Filter results by request UUID.

  • :created_before (DateTime) —

    Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

Returns:

  • (Array<(InlineResponse20041, Integer, Hash)>) —

    InlineResponse20041 data, response status code and response headers



9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
 
# File 'lib/talon_one/api/management_api.rb', line 9048

def get_webhook_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhook_logs, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhook_logs, must be greater than or equal to 1.'
  end

  allowable_values = ["success", "error"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/webhook_logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'webhookId'] = opts[:'webhook_id'] if !opts[:'webhook_id'].nil?
  query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'requestUuid'] = opts[:'request_uuid'] if !opts[:'request_uuid'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20041' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_webhook_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_with_http_info(webhook_id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Get webhook Returns a webhook by its id.

Parameters:

  • webhook_id (Integer) —

    The ID of the webhook. You can find the ID in the Campaign Manager&#39;s URL when you display the details of the webhook in Account &gt; Webhooks.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Webhook, Integer, Hash)>) —

    Webhook data, response status code and response headers



8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
 
# File 'lib/talon_one/api/management_api.rb', line 8877

def get_webhook_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling ManagementApi.get_webhook"
  end
  # resource path
  local_var_path = '/v1/webhooks/{webhookId}'.sub('{' + 'webhookId' + '}', CGI.escape(webhook_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Webhook' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhooks(opts = {}) ⇒ InlineResponse20039

List webhooks List all webhooks.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :application_ids (String) —

    Checks if the given catalog or its attributes are referenced in the specified Application ID. Note: If no Application ID is provided, we check for all connected Applications.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :creation_type (String) —

    Filter results by creation type.

  • :visibility (String) —

    Filter results by visibility.

  • :outgoing_integrations_type_id (Integer) —

    Filter results by outgoing integration type ID.

  • :title (String) —

    Filter results performing case-insensitive matching against the webhook title.

Returns:



9125
9126
9127
9128
 
# File 'lib/talon_one/api/management_api.rb', line 9125

def get_webhooks(opts = {})
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
  data
end

#get_webhooks_with_http_info(opts = {}) ⇒ Array<(InlineResponse20039, Integer, Hash)>

List webhooks List all webhooks.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :application_ids (String) —

    Checks if the given catalog or its attributes are referenced in the specified Application ID. Note: If no Application ID is provided, we check for all connected Applications.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :creation_type (String) —

    Filter results by creation type.

  • :visibility (String) —

    Filter results by visibility.

  • :outgoing_integrations_type_id (Integer) —

    Filter results by outgoing integration type ID.

  • :title (String) —

    Filter results performing case-insensitive matching against the webhook title.

Returns:

  • (Array<(InlineResponse20039, Integer, Hash)>) —

    InlineResponse20039 data, response status code and response headers



9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
 
# File 'lib/talon_one/api/management_api.rb', line 9142

def get_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhooks, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_webhooks, must be greater than or equal to 1.'
  end

  allowable_values = ["templateWebhooks", "webhooks"]
  if @api_client.config.client_side_validation && opts[:'creation_type'] && !allowable_values.include?(opts[:'creation_type'])
    fail ArgumentError, "invalid value for \"creation_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["visible", "hidden"]
  if @api_client.config.client_side_validation && opts[:'visibility'] && !allowable_values.include?(opts[:'visibility'])
    fail ArgumentError, "invalid value for \"visibility\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'applicationIds'] = opts[:'application_ids'] if !opts[:'application_ids'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'creationType'] = opts[:'creation_type'] if !opts[:'creation_type'].nil?
  query_params[:'visibility'] = opts[:'visibility'] if !opts[:'visibility'].nil?
  query_params[:'outgoingIntegrationsTypeId'] = opts[:'outgoing_integrations_type_id'] if !opts[:'outgoing_integrations_type_id'].nil?
  query_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20039' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#get_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_account_collection(collection_id, opts = {}) ⇒ Import

Import data into existing account-level collection Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import replaces the initial content of the collection. The CSV file must only contain the following column: - ‘item`: the values in your collection. A collection is limited to 500,000 items. Example: “` item Addidas Nike Asics “` Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9215
9216
9217
9218
 
# File 'lib/talon_one/api/management_api.rb', line 9215

def (collection_id, opts = {})
  data, _status_code, _headers = (collection_id, opts)
  data
end

#import_account_collection_with_http_info(collection_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import data into existing account-level collection Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import replaces the initial content of the collection. The CSV file must only contain the following column: - &#x60;item&#x60;: the values in your collection. A collection is limited to 500,000 items. Example: &#x60;&#x60;&#x60; item Addidas Nike Asics &#x60;&#x60;&#x60; Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
 
# File 'lib/talon_one/api/management_api.rb', line 9226

def (collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_account_collection ...'
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.import_account_collection"
  end
  # resource path
  local_var_path = '/v1/collections/{collectionId}/import'.sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_account_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_allowed_list(attribute_id, opts = {}) ⇒ Import

Import allowed values for attribute Upload a CSV file containing a list of [picklist values](docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import replaces the previous list of allowed values for this attribute, if any. The CSV file must only contain the following column: - ‘item` (required): the values in your allowed list, for example a list of SKU’s. An allowed list is limited to 500,000 items. Example: “‘text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 “`

Parameters:

  • attribute_id (Integer) —

    The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in Account &gt; Tools &gt; Attributes.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9282
9283
9284
9285
 
# File 'lib/talon_one/api/management_api.rb', line 9282

def import_allowed_list(attribute_id, opts = {})
  data, _status_code, _headers = import_allowed_list_with_http_info(attribute_id, opts)
  data
end

#import_allowed_list_with_http_info(attribute_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import allowed values for attribute Upload a CSV file containing a list of [picklist values](docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import replaces the previous list of allowed values for this attribute, if any. The CSV file must only contain the following column: - &#x60;item&#x60; (required): the values in your allowed list, for example a list of SKU&#39;s. An allowed list is limited to 500,000 items. Example: &#x60;&#x60;&#x60;text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 &#x60;&#x60;&#x60;

Parameters:

  • attribute_id (Integer) —

    The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in Account &gt; Tools &gt; Attributes.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
 
# File 'lib/talon_one/api/management_api.rb', line 9293

def import_allowed_list_with_http_info(attribute_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_allowed_list ...'
  end
  # verify the required parameter 'attribute_id' is set
  if @api_client.config.client_side_validation && attribute_id.nil?
    fail ArgumentError, "Missing the required parameter 'attribute_id' when calling ManagementApi.import_allowed_list"
  end
  # resource path
  local_var_path = '/v1/attributes/{attributeId}/allowed_list/import'.sub('{' + 'attributeId' + '}', CGI.escape(attribute_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_allowed_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_audiences_memberships(audience_id, opts = {}) ⇒ Import

Import audience members Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - ‘profileintegrationid`: The integration ID of the customer profile. The import replaces the previous list of audience members. Note: We recommend limiting your file size to 500MB. Example: “`text profileintegrationid charles alexa “`

Parameters:

  • audience_id (Integer) —

    The ID of the audience.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9349
9350
9351
9352
 
# File 'lib/talon_one/api/management_api.rb', line 9349

def import_audiences_memberships(audience_id, opts = {})
  data, _status_code, _headers = import_audiences_memberships_with_http_info(audience_id, opts)
  data
end

#import_audiences_memberships_with_http_info(audience_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import audience members Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - &#x60;profileintegrationid&#x60;: The integration ID of the customer profile. The import replaces the previous list of audience members. Note: We recommend limiting your file size to 500MB. Example: &#x60;&#x60;&#x60;text profileintegrationid charles alexa &#x60;&#x60;&#x60;

Parameters:

  • audience_id (Integer) —

    The ID of the audience.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
 
# File 'lib/talon_one/api/management_api.rb', line 9360

def import_audiences_memberships_with_http_info(audience_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_audiences_memberships ...'
  end
  # verify the required parameter 'audience_id' is set
  if @api_client.config.client_side_validation && audience_id.nil?
    fail ArgumentError, "Missing the required parameter 'audience_id' when calling ManagementApi.import_audiences_memberships"
  end
  # resource path
  local_var_path = '/v1/audiences/{audienceId}/memberships/import'.sub('{' + 'audienceId' + '}', CGI.escape(audience_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_audiences_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_campaign_store_budget(application_id, campaign_id, opts = {}) ⇒ Import

Import campaign store budgets Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file must only contain the following columns: - ‘store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import replaces the previous list of store budgets.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9419
9420
9421
9422
 
# File 'lib/talon_one/api/management_api.rb', line 9419

def import_campaign_store_budget(application_id, campaign_id, opts = {})
  data, _status_code, _headers = import_campaign_store_budget_with_http_info(application_id, campaign_id, opts)
  data
end

#import_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import campaign store budgets Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file must only contain the following columns: - &#x60;store_integration_id&#x60;: The identifier of the store. - &#x60;limit&#x60;: The budget limit for the store. The import replaces the previous list of store budgets.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
 
# File 'lib/talon_one/api/management_api.rb', line 9433

def import_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_store_budget ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_store_budget"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_store_budget"
  end
  allowable_values = ["setDiscount"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
  if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
    fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_campaign_stores(application_id, campaign_id, opts = {}) ⇒ Import

Import stores Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file must only contain the following column: - ‘store_integration_id`: The identifier of the store. The import replaces the previous list of stores linked to the campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9504
9505
9506
9507
 
# File 'lib/talon_one/api/management_api.rb', line 9504

def import_campaign_stores(application_id, campaign_id, opts = {})
  data, _status_code, _headers = import_campaign_stores_with_http_info(application_id, campaign_id, opts)
  data
end

#import_campaign_stores_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import stores Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file must only contain the following column: - &#x60;store_integration_id&#x60;: The identifier of the store. The import replaces the previous list of stores linked to the campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
 
# File 'lib/talon_one/api/management_api.rb', line 9516

def import_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_stores ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_stores"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_stores"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/import'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_collection(application_id, campaign_id, collection_id, opts = {}) ⇒ Import

Import data into existing campaign-level collection Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import replaces the initial content of the collection. The CSV file must only contain the following column: - ‘item`: the values in your collection. A collection is limited to 500,000 items. Example: “` item Addidas Nike Asics “` Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9578
9579
9580
9581
 
# File 'lib/talon_one/api/management_api.rb', line 9578

def import_collection(application_id, campaign_id, collection_id, opts = {})
  data, _status_code, _headers = import_collection_with_http_info(application_id, campaign_id, collection_id, opts)
  data
end

#import_collection_with_http_info(application_id, campaign_id, collection_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import data into existing campaign-level collection Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import replaces the initial content of the collection. The CSV file must only contain the following column: - &#x60;item&#x60;: the values in your collection. A collection is limited to 500,000 items. Example: &#x60;&#x60;&#x60; item Addidas Nike Asics &#x60;&#x60;&#x60; Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
 
# File 'lib/talon_one/api/management_api.rb', line 9591

def import_collection_with_http_info(application_id, campaign_id, collection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_collection ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_collection"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_collection"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.import_collection"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_coupons(application_id, campaign_id, opts = {}) ⇒ Import

Import coupons Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - ‘value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing custom coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `""10_off""`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: We recommend limiting your file size to 500MB. Example: “`text "value","expirydate","startdate","recipientintegrationid","limitval","attributes","discountlimit" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,"""10_off""",2.4 “` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :skip_duplicates (Boolean) —

    An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when &#x60;skipDuplicates&#x3D;true&#x60;.

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9657
9658
9659
9660
 
# File 'lib/talon_one/api/management_api.rb', line 9657

def import_coupons(application_id, campaign_id, opts = {})
  data, _status_code, _headers = import_coupons_with_http_info(application_id, campaign_id, opts)
  data
end

#import_coupons_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import coupons Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - &#x60;value&#x60; (required): The coupon code. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;recipientintegrationid&#x60;: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - &#x60;limitval&#x60;: The maximum number of redemptions of this code. For unlimited redemptions, use &#x60;0&#x60;. Defaults to &#x60;1&#x60; when not provided. - &#x60;discountlimit&#x60;: The total discount value that the code can give. This is typically used to represent a gift card value. - &#x60;attributes&#x60;: A JSON object describing custom coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;category&#x60; associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: &#x60;&quot;&quot;10_off&quot;&quot;&#x60;. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: We recommend limiting your file size to 500MB. Example: &#x60;&#x60;&#x60;text &quot;value&quot;,&quot;expirydate&quot;,&quot;startdate&quot;,&quot;recipientintegrationid&quot;,&quot;limitval&quot;,&quot;attributes&quot;,&quot;discountlimit&quot; COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,&quot;&quot;&quot;10_off&quot;&quot;&quot;,2.4 &#x60;&#x60;&#x60; Once imported, you can find the &#x60;batchId&#x60; in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :skip_duplicates (Boolean) —

    An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when &#x60;skipDuplicates&#x3D;true&#x60;.

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
 
# File 'lib/talon_one/api/management_api.rb', line 9670

def import_coupons_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_coupons ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_coupons"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_coupons"
  end
  # resource path
  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))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'skipDuplicates'] = opts[:'skip_duplicates'] if !opts[:'skip_duplicates'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_loyalty_cards(loyalty_program_id, opts = {}) ⇒ Import

Import loyalty cards Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - ‘identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). Note: We recommend limiting your file size to 500MB. Example: “`csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA “`

Parameters:

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9731
9732
9733
9734
 
# File 'lib/talon_one/api/management_api.rb', line 9731

def import_loyalty_cards(loyalty_program_id, opts = {})
  data, _status_code, _headers = import_loyalty_cards_with_http_info(loyalty_program_id, opts)
  data
end

#import_loyalty_cards_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import loyalty cards Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - &#x60;identifier&#x60; (required): The alphanumeric identifier of the loyalty card. - &#x60;state&#x60; (required): The state of the loyalty card. It can be &#x60;active&#x60; or &#x60;inactive&#x60;. - &#x60;customerprofileids&#x60; (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). Note: We recommend limiting your file size to 500MB. Example: &#x60;&#x60;&#x60;csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA &#x60;&#x60;&#x60;

Parameters:

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
 
# File 'lib/talon_one/api/management_api.rb', line 9742

def import_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_loyalty_cards ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.import_loyalty_cards"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/import_cards'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_loyalty_customers_tiers(loyalty_program_id, opts = {}) ⇒ Import

Import customers into loyalty tiers Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. Important: This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - ‘subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn’t already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that’s specified in the CSV file, only the expiration date is updated. Note: We recommend not using this endpoint to update the tier of a customer. To update a customer’s tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: We recommend limiting your file size to 500MB. Example: “‘csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z “`

Parameters:

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9798
9799
9800
9801
 
# File 'lib/talon_one/api/management_api.rb', line 9798

def import_loyalty_customers_tiers(loyalty_program_id, opts = {})
  data, _status_code, _headers = import_loyalty_customers_tiers_with_http_info(loyalty_program_id, opts)
  data
end

#import_loyalty_customers_tiers_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import customers into loyalty tiers Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. Important: This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - &#x60;subledgerid&#x60; (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - &#x60;customerprofileid&#x60;: The integration ID of the customer profile to whom the tier should be assigned. - &#x60;tiername&#x60;: The name of an existing tier to assign to the customer. - &#x60;expirydate&#x60;: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn&#39;t already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that&#39;s specified in the CSV file, only the expiration date is updated. Note: We recommend not using this endpoint to update the tier of a customer. To update a customer&#39;s tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: We recommend limiting your file size to 500MB. Example: &#x60;&#x60;&#x60;csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z &#x60;&#x60;&#x60;

Parameters:

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
 
# File 'lib/talon_one/api/management_api.rb', line 9809

def import_loyalty_customers_tiers_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_loyalty_customers_tiers ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.import_loyalty_customers_tiers"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_loyalty_customers_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_loyalty_points(loyalty_program_id, opts = {}) ⇒ Import

Import loyalty points Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - ‘customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. Note: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. Note: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. Note: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are active. If it is later, the points are pending until the date provided for `startdate` is reached. Note: We recommend limiting your file size to 500MB. **Example for profile-based programs:** “`text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement “` **Example for card-based programs:** “`text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement “`

Parameters:

Options Hash (opts):

  • :notifications_enabled (Boolean) —

    Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer&#39;s tier or offsets their negative points balance. This parameter is optional and defaults to &#x60;true&#x60;.

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9866
9867
9868
9869
 
# File 'lib/talon_one/api/management_api.rb', line 9866

def import_loyalty_points(loyalty_program_id, opts = {})
  data, _status_code, _headers = import_loyalty_points_with_http_info(loyalty_program_id, opts)
  data
end

#import_loyalty_points_with_http_info(loyalty_program_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import loyalty points Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - &#x60;customerprofileid&#x60; (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. Note: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - &#x60;identifier&#x60; (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - &#x60;amount&#x60;: The amount of points to award to the customer profile. - &#x60;startdate&#x60; (optional): The earliest date when the points can be redeemed. The points are &#x60;active&#x60; from this date until the expiration date. Note: It must be an RFC3339 timestamp string or string &#x60;immediate&#x60;. Empty or missing values are considered &#x60;immediate&#x60;. - &#x60;expirydate&#x60; (optional): The latest date when the points can be redeemed. The points are &#x60;expired&#x60; after this date. Note: It must be an RFC3339 timestamp string or string &#x60;unlimited&#x60;. Empty or missing values are considered &#x60;unlimited&#x60;. - &#x60;subledgerid&#x60; (optional): The ID of the subledger that should received the points. - &#x60;reason&#x60; (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for &#x60;startdate&#x60;. If &#x60;startdate&#x60; matches the current date, the imported points are active. If it is later, the points are pending until the date provided for &#x60;startdate&#x60; is reached. Note: We recommend limiting your file size to 500MB. **Example for profile-based programs:** &#x60;&#x60;&#x60;text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60; **Example for card-based programs:** &#x60;&#x60;&#x60;text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60;

Parameters:

Options Hash (opts):

  • :notifications_enabled (Boolean) —

    Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer&#39;s tier or offsets their negative points balance. This parameter is optional and defaults to &#x60;true&#x60;.

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
 
# File 'lib/talon_one/api/management_api.rb', line 9878

def import_loyalty_points_with_http_info(loyalty_program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_loyalty_points ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.import_loyalty_points"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/import_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'notificationsEnabled'] = opts[:'notifications_enabled'] if !opts[:'notifications_enabled'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_pool_giveaways(pool_id, opts = {}) ⇒ Import

Import giveaway codes into a giveaway pool Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains 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 giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `""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 time zone setting of your choice. The values are converted to UTC internally by Talon.One. Note: - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. Example: “`text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"""Amazon""" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,"""Amazon""" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,"""Aliexpress""" “`

Parameters:

  • pool_id (Integer) —

    The ID of the pool. You can find it in the Campaign Manager, in the Giveaways section.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



9935
9936
9937
9938
 
# File 'lib/talon_one/api/management_api.rb', line 9935

def import_pool_giveaways(pool_id, opts = {})
  data, _status_code, _headers = import_pool_giveaways_with_http_info(pool_id, opts)
  data
end

#import_pool_giveaways_with_http_info(pool_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import giveaway codes into a giveaway pool Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - &#x60;code&#x60; (required): The code of your giveaway, for instance, a gift card redemption code. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;enddate&#x60;: The last date in RFC3339 of the code redemption period. - &#x60;attributes&#x60;: A JSON object describing custom giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;provider&#x60; associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: &#x60;&quot;&quot;myPartnerCompany&quot;&quot;&#x60;. The &#x60;startdate&#x60; and &#x60;enddate&#x60; 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 time zone setting of your choice. The values are converted to UTC internally by Talon.One. Note: - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. Example: &#x60;&#x60;&#x60;text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,&quot;&quot;&quot;Amazon&quot;&quot;&quot; GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,&quot;&quot;&quot;Amazon&quot;&quot;&quot; GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,&quot;&quot;&quot;Aliexpress&quot;&quot;&quot; &#x60;&#x60;&#x60;

Parameters:

  • pool_id (Integer) —

    The ID of the pool. You can find it in the Campaign Manager, in the Giveaways section.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
 
# File 'lib/talon_one/api/management_api.rb', line 9946

def import_pool_giveaways_with_http_info(pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_pool_giveaways ...'
  end
  # verify the required parameter 'pool_id' is set
  if @api_client.config.client_side_validation && pool_id.nil?
    fail ArgumentError, "Missing the required parameter 'pool_id' when calling ManagementApi.import_pool_giveaways"
  end
  # resource path
  local_var_path = '/v1/giveaways/pools/{poolId}/import'.sub('{' + 'poolId' + '}', CGI.escape(pool_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_pool_giveaways\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_referrals(application_id, campaign_id, opts = {}) ⇒ Import

Import referrals Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - ‘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 number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing custom referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `""10_off""`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Important: When you import a CSV file with referrals, a [customer profile](docs.talon.one/docs/dev/concepts/entities/customer-profiles) is not automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. Note: We recommend limiting your file size to 500MB. Example: “`text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,"""10_off""" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,"""20_off""" “`

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:



10003
10004
10005
10006
 
# File 'lib/talon_one/api/management_api.rb', line 10003

def import_referrals(application_id, campaign_id, opts = {})
  data, _status_code, _headers = import_referrals_with_http_info(application_id, campaign_id, opts)
  data
end

#import_referrals_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(Import, Integer, Hash)>

Import referrals Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - &#x60;code&#x60; (required): The referral code. - &#x60;advocateprofileintegrationid&#x60; (required): The profile ID of the advocate. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;limitval&#x60;: The maximum number of redemptions of this code. Defaults to &#x60;1&#x60; when left blank. - &#x60;attributes&#x60;: A JSON object describing custom referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;category&#x60; associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: &#x60;&quot;&quot;10_off&quot;&quot;&#x60;. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Important: When you import a CSV file with referrals, a [customer profile](docs.talon.one/docs/dev/concepts/entities/customer-profiles) is not automatically created for each &#x60;advocateprofileintegrationid&#x60; column value. Use the [Update customer profile](docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. Note: We recommend limiting your file size to 500MB. Example: &#x60;&#x60;&#x60;text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,&quot;&quot;&quot;10_off&quot;&quot;&quot; REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,&quot;&quot;&quot;20_off&quot;&quot;&quot; &#x60;&#x60;&#x60;

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file containing the data that is being imported.

Returns:

  • (Array<(Import, Integer, Hash)>) —

    Import data, response status code and response headers



10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
 
# File 'lib/talon_one/api/management_api.rb', line 10015

def import_referrals_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.import_referrals ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_referrals"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_referrals"
  end
  # resource path
  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))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Import' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#import_referrals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invite_user_external(body, opts = {}) ⇒ nil

Invite user from identity provider [Invite a user](docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address.

Parameters:

Returns:

  • (nil) 


10074
10075
10076
10077
 
# File 'lib/talon_one/api/management_api.rb', line 10074

def invite_user_external(body, opts = {})
  invite_user_external_with_http_info(body, opts)
  nil
end

#invite_user_external_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Invite user from identity provider [Invite a user](docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
 
# File 'lib/talon_one/api/management_api.rb', line 10084

def invite_user_external_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.invite_user_external ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.invite_user_external"
  end
  # resource path
  local_var_path = '/v1/users/invite'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#invite_user_external\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_collections(opts = {}) ⇒ InlineResponse20020

List collections in account List account-level collections in the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :name (String) —

    Filter by collection name.

Returns:



10140
10141
10142
10143
 
# File 'lib/talon_one/api/management_api.rb', line 10140

def (opts = {})
  data, _status_code, _headers = (opts)
  data
end

#list_account_collections_with_http_info(opts = {}) ⇒ Array<(InlineResponse20020, Integer, Hash)>

List collections in account List account-level collections in the account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :name (String) —

    Filter by collection name.

Returns:

  • (Array<(InlineResponse20020, Integer, Hash)>) —

    InlineResponse20020 data, response status code and response headers



10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
 
# File 'lib/talon_one/api/management_api.rb', line 10154

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_account_collections ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_account_collections, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_account_collections, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/collections'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20020' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_account_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_achievements(application_id, campaign_id, opts = {}) ⇒ InlineResponse20050

List achievements List all the achievements for a specific campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 50)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :title (String) —

    Filter by the display name for the achievement in the campaign manager. Note: If no &#x60;title&#x60; is provided, all the achievements from the campaign are returned.

Returns:



10219
10220
10221
10222
 
# File 'lib/talon_one/api/management_api.rb', line 10219

def list_achievements(application_id, campaign_id, opts = {})
  data, _status_code, _headers = list_achievements_with_http_info(application_id, campaign_id, opts)
  data
end

#list_achievements_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse20050, Integer, Hash)>

List achievements List all the achievements for a specific campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :title (String) —

    Filter by the display name for the achievement in the campaign manager. Note: If no &#x60;title&#x60; is provided, all the achievements from the campaign are returned.

Returns:

  • (Array<(InlineResponse20050, Integer, Hash)>) —

    InlineResponse20050 data, response status code and response headers



10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
 
# File 'lib/talon_one/api/management_api.rb', line 10233

def list_achievements_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_achievements ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.list_achievements"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.list_achievements"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_achievements, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_achievements, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/achievements'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20050' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_achievements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_all_roles_v2(opts = {}) ⇒ InlineResponse20046

List roles List all roles.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10299
10300
10301
10302
 
# File 'lib/talon_one/api/management_api.rb', line 10299

def list_all_roles_v2(opts = {})
  data, _status_code, _headers = list_all_roles_v2_with_http_info(opts)
  data
end

#list_all_roles_v2_with_http_info(opts = {}) ⇒ Array<(InlineResponse20046, Integer, Hash)>

List roles List all roles.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20046, Integer, Hash)>) —

    InlineResponse20046 data, response status code and response headers



10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
 
# File 'lib/talon_one/api/management_api.rb', line 10308

def list_all_roles_v2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_all_roles_v2 ...'
  end
  # resource path
  local_var_path = '/v2/roles'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20046' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_all_roles_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_campaign_store_budget_limits(application_id, campaign_id, opts = {}) ⇒ InlineResponse20048

List campaign store budget limits Return the store budget limits for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

Returns:



10359
10360
10361
10362
 
# File 'lib/talon_one/api/management_api.rb', line 10359

def list_campaign_store_budget_limits(application_id, campaign_id, opts = {})
  data, _status_code, _headers = list_campaign_store_budget_limits_with_http_info(application_id, campaign_id, opts)
  data
end

#list_campaign_store_budget_limits_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse20048, Integer, Hash)>

List campaign store budget limits Return the store budget limits for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The action that this budget is limiting.

  • :period (String) —

    The period to which the limit applies. Note: For budgets with no period, set this to &#x60;overall&#x60;.

Returns:

  • (Array<(InlineResponse20048, Integer, Hash)>) —

    InlineResponse20048 data, response status code and response headers



10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
 
# File 'lib/talon_one/api/management_api.rb', line 10372

def list_campaign_store_budget_limits_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_campaign_store_budget_limits ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.list_campaign_store_budget_limits"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.list_campaign_store_budget_limits"
  end
  allowable_values = ["setDiscount"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
  if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
    fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20048' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_campaign_store_budget_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_catalog_items(catalog_id, opts = {}) ⇒ InlineResponse20037

List items in a catalog Return a paginated list of cart items in the given catalog.

Parameters:

  • catalog_id (Integer) —

    The ID of the catalog. You can find the ID in the Campaign Manager in Account &gt; Tools &gt; **Cart item catalogs**.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :sku (Array<String>) —

    Filter results by one or more SKUs. Must be exact match.

  • :product_names (Array<String>) —

    Filter results by one or more product names. Must be exact match.

Returns:



10443
10444
10445
10446
 
# File 'lib/talon_one/api/management_api.rb', line 10443

def list_catalog_items(catalog_id, opts = {})
  data, _status_code, _headers = list_catalog_items_with_http_info(catalog_id, opts)
  data
end

#list_catalog_items_with_http_info(catalog_id, opts = {}) ⇒ Array<(InlineResponse20037, Integer, Hash)>

List items in a catalog Return a paginated list of cart items in the given catalog.

Parameters:

  • catalog_id (Integer) —

    The ID of the catalog. You can find the ID in the Campaign Manager in Account &gt; Tools &gt; **Cart item catalogs**.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :sku (Array<String>) —

    Filter results by one or more SKUs. Must be exact match.

  • :product_names (Array<String>) —

    Filter results by one or more product names. Must be exact match.

Returns:

  • (Array<(InlineResponse20037, Integer, Hash)>) —

    InlineResponse20037 data, response status code and response headers



10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
 
# File 'lib/talon_one/api/management_api.rb', line 10458

def list_catalog_items_with_http_info(catalog_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_catalog_items ...'
  end
  # verify the required parameter 'catalog_id' is set
  if @api_client.config.client_side_validation && catalog_id.nil?
    fail ArgumentError, "Missing the required parameter 'catalog_id' when calling ManagementApi.list_catalog_items"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_catalog_items, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_catalog_items, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/catalogs/{catalogId}/items'.sub('{' + 'catalogId' + '}', CGI.escape(catalog_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
  query_params[:'sku'] = @api_client.build_collection_param(opts[:'sku'], :multi) if !opts[:'sku'].nil?
  query_params[:'productNames'] = @api_client.build_collection_param(opts[:'product_names'], :multi) if !opts[:'product_names'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20037' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_catalog_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_collections(application_id, campaign_id, opts = {}) ⇒ InlineResponse20020

List collections in campaign List collections in a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :name (String) —

    Filter by collection name.

Returns:



10529
10530
10531
10532
 
# File 'lib/talon_one/api/management_api.rb', line 10529

def list_collections(application_id, campaign_id, opts = {})
  data, _status_code, _headers = list_collections_with_http_info(application_id, campaign_id, opts)
  data
end

#list_collections_in_application(application_id, opts = {}) ⇒ InlineResponse20020

List collections in Application List campaign-level collections from all campaigns in a given Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :name (String) —

    Filter by collection name.

Returns:



10619
10620
10621
10622
 
# File 'lib/talon_one/api/management_api.rb', line 10619

def list_collections_in_application(application_id, opts = {})
  data, _status_code, _headers = list_collections_in_application_with_http_info(application_id, opts)
  data
end

#list_collections_in_application_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20020, Integer, Hash)>

List collections in Application List campaign-level collections from all campaigns in a given Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :name (String) —

    Filter by collection name.

Returns:

  • (Array<(InlineResponse20020, Integer, Hash)>) —

    InlineResponse20020 data, response status code and response headers



10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
 
# File 'lib/talon_one/api/management_api.rb', line 10634

def list_collections_in_application_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_collections_in_application ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.list_collections_in_application"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_collections_in_application, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_collections_in_application, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/collections'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20020' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_collections_in_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_collections_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse20020, Integer, Hash)>

List collections in campaign List collections in a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :name (String) —

    Filter by collection name.

Returns:

  • (Array<(InlineResponse20020, Integer, Hash)>) —

    InlineResponse20020 data, response status code and response headers



10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
 
# File 'lib/talon_one/api/management_api.rb', line 10545

def list_collections_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_collections ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.list_collections"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.list_collections"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_collections, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_collections, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/collections'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20020' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_stores(application_id, opts = {}) ⇒ InlineResponse20047

List stores List all stores for a specific Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :name (String) —

    The name of the store.

  • :integration_id (String) —

    The integration ID of the store.

  • :query (String) —

    Filter results by &#x60;name&#x60; or &#x60;integrationId&#x60;.

Returns:



10707
10708
10709
10710
 
# File 'lib/talon_one/api/management_api.rb', line 10707

def list_stores(application_id, opts = {})
  data, _status_code, _headers = list_stores_with_http_info(application_id, opts)
  data
end

#list_stores_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20047, Integer, Hash)>

List stores List all stores for a specific Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :with_total_result_size (Boolean) —

    When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.

  • :campaign_id (Float) —

    Filter results by campaign ID.

  • :name (String) —

    The name of the store.

  • :integration_id (String) —

    The integration ID of the store.

  • :query (String) —

    Filter results by &#x60;name&#x60; or &#x60;integrationId&#x60;.

Returns:

  • (Array<(InlineResponse20047, Integer, Hash)>) —

    InlineResponse20047 data, response status code and response headers



10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
 
# File 'lib/talon_one/api/management_api.rb', line 10725

def list_stores_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.list_stores ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.list_stores"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_stores, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.list_stores, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/applications/{applicationId}/stores'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20047' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#list_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#okta_event_handler_challenge(opts = {}) ⇒ nil

Validate Okta API ownership Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


10792
10793
10794
10795
 
# File 'lib/talon_one/api/management_api.rb', line 10792

def okta_event_handler_challenge(opts = {})
  okta_event_handler_challenge_with_http_info(opts)
  nil
end

#okta_event_handler_challenge_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Validate Okta API ownership Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
 
# File 'lib/talon_one/api/management_api.rb', line 10801

def okta_event_handler_challenge_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.okta_event_handler_challenge ...'
  end
  # resource path
  local_var_path = '/v1/provisioning/okta'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#okta_event_handler_challenge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_loyalty_points(loyalty_program_id, integration_id, body, opts = {}) ⇒ nil

Deduct points from customer profile Deduct points from the specified loyalty program and specified customer profile. Important: - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the ‘integrationId` of the profile from a `sessionId`, use the [Update customer session](docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • body (DeductLoyaltyPoints) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


10849
10850
10851
10852
 
# File 'lib/talon_one/api/management_api.rb', line 10849

def remove_loyalty_points(loyalty_program_id, integration_id, body, opts = {})
  remove_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts)
  nil
end

#remove_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deduct points from customer profile Deduct points from the specified loyalty program and specified customer profile. Important: - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.

Parameters:

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

  • body (DeductLoyaltyPoints) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
 
# File 'lib/talon_one/api/management_api.rb', line 10861

def remove_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.remove_loyalty_points ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.remove_loyalty_points"
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.remove_loyalty_points"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.remove_loyalty_points"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#remove_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reset_password(body, opts = {}) ⇒ NewPassword

Reset password Consumes the supplied password reset token and updates the password for the associated account.

Parameters:

  • body (NewPassword) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10923
10924
10925
10926
 
# File 'lib/talon_one/api/management_api.rb', line 10923

def reset_password(body, opts = {})
  data, _status_code, _headers = reset_password_with_http_info(body, opts)
  data
end

#reset_password_with_http_info(body, opts = {}) ⇒ Array<(NewPassword, Integer, Hash)>

Reset password Consumes the supplied password reset token and updates the password for the associated account.

Parameters:

  • body (NewPassword) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NewPassword, Integer, Hash)>) —

    NewPassword data, response status code and response headers



10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
 
# File 'lib/talon_one/api/management_api.rb', line 10933

def reset_password_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.reset_password ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.reset_password"
  end
  # resource path
  local_var_path = '/v1/reset_password'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'NewPassword' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#reset_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_create_group(body, opts = {}) ⇒ ScimGroup

Create SCIM group Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a ‘Group` corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • body (ScimBaseGroup) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10987
10988
10989
10990
 
# File 'lib/talon_one/api/management_api.rb', line 10987

def scim_create_group(body, opts = {})
  data, _status_code, _headers = scim_create_group_with_http_info(body, opts)
  data
end

#scim_create_group_with_http_info(body, opts = {}) ⇒ Array<(ScimGroup, Integer, Hash)>

Create SCIM group Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • body (ScimBaseGroup) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimGroup, Integer, Hash)>) —

    ScimGroup data, response status code and response headers



10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
 
# File 'lib/talon_one/api/management_api.rb', line 10997

def scim_create_group_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_group ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_group"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Groups'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'ScimGroup' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_create_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_create_user(body, opts = {}) ⇒ ScimUser

Create SCIM user Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • body (ScimNewUser) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11051
11052
11053
11054
 
# File 'lib/talon_one/api/management_api.rb', line 11051

def scim_create_user(body, opts = {})
  data, _status_code, _headers = scim_create_user_with_http_info(body, opts)
  data
end

#scim_create_user_with_http_info(body, opts = {}) ⇒ Array<(ScimUser, Integer, Hash)>

Create SCIM user Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • body (ScimNewUser) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimUser, Integer, Hash)>) —

    ScimUser data, response status code and response headers



11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
 
# File 'lib/talon_one/api/management_api.rb', line 11061

def scim_create_user_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_user ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_user"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Users'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'ScimUser' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_delete_group(group_id, opts = {}) ⇒ nil

Delete SCIM group Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a ‘Group` corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


11115
11116
11117
11118
 
# File 'lib/talon_one/api/management_api.rb', line 11115

def scim_delete_group(group_id, opts = {})
  scim_delete_group_with_http_info(group_id, opts)
  nil
end

#scim_delete_group_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete SCIM group Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
 
# File 'lib/talon_one/api/management_api.rb', line 11125

def scim_delete_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_delete_group"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_delete_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_delete_user(user_id, opts = {}) ⇒ nil

Delete SCIM user Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


11175
11176
11177
11178
 
# File 'lib/talon_one/api/management_api.rb', line 11175

def scim_delete_user(user_id, opts = {})
  scim_delete_user_with_http_info(user_id, opts)
  nil
end

#scim_delete_user_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete SCIM user Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
 
# File 'lib/talon_one/api/management_api.rb', line 11185

def scim_delete_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_user ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_delete_user"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_get_group(group_id, opts = {}) ⇒ ScimGroup

Get SCIM group Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a ‘Group` corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11235
11236
11237
11238
 
# File 'lib/talon_one/api/management_api.rb', line 11235

def scim_get_group(group_id, opts = {})
  data, _status_code, _headers = scim_get_group_with_http_info(group_id, opts)
  data
end

#scim_get_group_with_http_info(group_id, opts = {}) ⇒ Array<(ScimGroup, Integer, Hash)>

Get SCIM group Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimGroup, Integer, Hash)>) —

    ScimGroup data, response status code and response headers



11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
 
# File 'lib/talon_one/api/management_api.rb', line 11245

def scim_get_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_get_group"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ScimGroup' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_get_groups(opts = {}) ⇒ ScimGroupsListResponse

List SCIM groups Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a ‘Group` corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11296
11297
11298
11299
 
# File 'lib/talon_one/api/management_api.rb', line 11296

def scim_get_groups(opts = {})
  data, _status_code, _headers = scim_get_groups_with_http_info(opts)
  data
end

#scim_get_groups_with_http_info(opts = {}) ⇒ Array<(ScimGroupsListResponse, Integer, Hash)>

List SCIM groups Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimGroupsListResponse, Integer, Hash)>) —

    ScimGroupsListResponse data, response status code and response headers



11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
 
# File 'lib/talon_one/api/management_api.rb', line 11305

def scim_get_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_groups ...'
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Groups'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ScimGroupsListResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_get_resource_types(opts = {}) ⇒ ScimResourceTypesListResponse

List supported SCIM resource types Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11352
11353
11354
11355
 
# File 'lib/talon_one/api/management_api.rb', line 11352

def scim_get_resource_types(opts = {})
  data, _status_code, _headers = scim_get_resource_types_with_http_info(opts)
  data
end

#scim_get_resource_types_with_http_info(opts = {}) ⇒ Array<(ScimResourceTypesListResponse, Integer, Hash)>

List supported SCIM resource types Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
 
# File 'lib/talon_one/api/management_api.rb', line 11361

def scim_get_resource_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_resource_types ...'
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/ResourceTypes'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ScimResourceTypesListResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_get_resource_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_get_schemas(opts = {}) ⇒ ScimSchemasListResponse

List supported SCIM schemas Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11408
11409
11410
11411
 
# File 'lib/talon_one/api/management_api.rb', line 11408

def scim_get_schemas(opts = {})
  data, _status_code, _headers = scim_get_schemas_with_http_info(opts)
  data
end

#scim_get_schemas_with_http_info(opts = {}) ⇒ Array<(ScimSchemasListResponse, Integer, Hash)>

List supported SCIM schemas Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimSchemasListResponse, Integer, Hash)>) —

    ScimSchemasListResponse data, response status code and response headers



11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
 
# File 'lib/talon_one/api/management_api.rb', line 11417

def scim_get_schemas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_schemas ...'
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Schemas'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ScimSchemasListResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_get_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_get_service_provider_config(opts = {}) ⇒ ScimServiceProviderConfigResponse

Get SCIM service provider configuration Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11464
11465
11466
11467
 
# File 'lib/talon_one/api/management_api.rb', line 11464

def scim_get_service_provider_config(opts = {})
  data, _status_code, _headers = scim_get_service_provider_config_with_http_info(opts)
  data
end

#scim_get_service_provider_config_with_http_info(opts = {}) ⇒ Array<(ScimServiceProviderConfigResponse, Integer, Hash)>

Get SCIM service provider configuration Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
 
# File 'lib/talon_one/api/management_api.rb', line 11473

def scim_get_service_provider_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_service_provider_config ...'
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/ServiceProviderConfig'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ScimServiceProviderConfigResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_get_service_provider_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_get_user(user_id, opts = {}) ⇒ ScimUser

Get SCIM user Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11521
11522
11523
11524
 
# File 'lib/talon_one/api/management_api.rb', line 11521

def scim_get_user(user_id, opts = {})
  data, _status_code, _headers = scim_get_user_with_http_info(user_id, opts)
  data
end

#scim_get_user_with_http_info(user_id, opts = {}) ⇒ Array<(ScimUser, Integer, Hash)>

Get SCIM user Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimUser, Integer, Hash)>) —

    ScimUser data, response status code and response headers



11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
 
# File 'lib/talon_one/api/management_api.rb', line 11531

def scim_get_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_user ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_get_user"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ScimUser' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_get_users(opts = {}) ⇒ ScimUsersListResponse

List SCIM users Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11582
11583
11584
11585
 
# File 'lib/talon_one/api/management_api.rb', line 11582

def scim_get_users(opts = {})
  data, _status_code, _headers = scim_get_users_with_http_info(opts)
  data
end

#scim_get_users_with_http_info(opts = {}) ⇒ Array<(ScimUsersListResponse, Integer, Hash)>

List SCIM users Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimUsersListResponse, Integer, Hash)>) —

    ScimUsersListResponse data, response status code and response headers



11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
 
# File 'lib/talon_one/api/management_api.rb', line 11591

def scim_get_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_users ...'
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Users'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ScimUsersListResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_patch_group(group_id, body, opts = {}) ⇒ ScimGroup

Update SCIM group attributes Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a ‘Group` corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • body (ScimPatchRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11640
11641
11642
11643
 
# File 'lib/talon_one/api/management_api.rb', line 11640

def scim_patch_group(group_id, body, opts = {})
  data, _status_code, _headers = scim_patch_group_with_http_info(group_id, body, opts)
  data
end

#scim_patch_group_with_http_info(group_id, body, opts = {}) ⇒ Array<(ScimGroup, Integer, Hash)>

Update SCIM group attributes Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • body (ScimPatchRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimGroup, Integer, Hash)>) —

    ScimGroup data, response status code and response headers



11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
 
# File 'lib/talon_one/api/management_api.rb', line 11651

def scim_patch_group_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_patch_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_patch_group"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_patch_group"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'ScimGroup' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_patch_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_patch_user(user_id, body, opts = {}) ⇒ ScimUser

Update SCIM user attributes Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • body (ScimPatchRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11710
11711
11712
11713
 
# File 'lib/talon_one/api/management_api.rb', line 11710

def scim_patch_user(user_id, body, opts = {})
  data, _status_code, _headers = scim_patch_user_with_http_info(user_id, body, opts)
  data
end

#scim_patch_user_with_http_info(user_id, body, opts = {}) ⇒ Array<(ScimUser, Integer, Hash)>

Update SCIM user attributes Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • body (ScimPatchRequest) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimUser, Integer, Hash)>) —

    ScimUser data, response status code and response headers



11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
 
# File 'lib/talon_one/api/management_api.rb', line 11721

def scim_patch_user_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_patch_user ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_patch_user"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_patch_user"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'ScimUser' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_patch_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_replace_group_attributes(group_id, body, opts = {}) ⇒ ScimGroup

Update SCIM group Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a ‘Group` corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • body (ScimBaseGroup) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11780
11781
11782
11783
 
# File 'lib/talon_one/api/management_api.rb', line 11780

def scim_replace_group_attributes(group_id, body, opts = {})
  data, _status_code, _headers = scim_replace_group_attributes_with_http_info(group_id, body, opts)
  data
end

#scim_replace_group_attributes_with_http_info(group_id, body, opts = {}) ⇒ Array<(ScimGroup, Integer, Hash)>

Update SCIM group Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.

Parameters:

  • group_id (Integer) —

    The ID of the group.

  • body (ScimBaseGroup) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimGroup, Integer, Hash)>) —

    ScimGroup data, response status code and response headers



11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
 
# File 'lib/talon_one/api/management_api.rb', line 11791

def scim_replace_group_attributes_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_replace_group_attributes ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_replace_group_attributes"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_replace_group_attributes"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'ScimGroup' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_replace_group_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scim_replace_user_attributes(user_id, body, opts = {}) ⇒ ScimUser

Update SCIM user Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • body (ScimNewUser) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11850
11851
11852
11853
 
# File 'lib/talon_one/api/management_api.rb', line 11850

def scim_replace_user_attributes(user_id, body, opts = {})
  data, _status_code, _headers = scim_replace_user_attributes_with_http_info(user_id, body, opts)
  data
end

#scim_replace_user_attributes_with_http_info(user_id, body, opts = {}) ⇒ Array<(ScimUser, Integer, Hash)>

Update SCIM user Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • body (ScimNewUser) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScimUser, Integer, Hash)>) —

    ScimUser data, response status code and response headers



11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
 
# File 'lib/talon_one/api/management_api.rb', line 11861

def scim_replace_user_attributes_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.scim_replace_user_attributes ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_replace_user_attributes"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_replace_user_attributes"
  end
  # resource path
  local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'ScimUser' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#scim_replace_user_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {}) ⇒ InlineResponse20011

List coupons that match the given attributes (without total count) List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. Note: The total count is not included in the response.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (Object) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code. (default to false)

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

Returns:



11933
11934
11935
11936
 
# File 'lib/talon_one/api/management_api.rb', line 11933

def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
  data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
  data
end

#search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse20011, Integer, Hash)>

List coupons that match the given attributes (without total count) List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. Note: The total count is not included in the response.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • body (Object) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.

  • :batch_id (String) —

    Filter results by batches of coupons

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code.

  • :campaign_state (String) —

    Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.

Returns:

  • (Array<(InlineResponse20011, Integer, Hash)>) —

    InlineResponse20011 data, response status code and response headers



11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
 
# File 'lib/talon_one/api/management_api.rb', line 11957

def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide_without_total_count ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count, must be greater than or equal to 1.'
  end

  allowable_values = ["expired", "validNow", "validFuture"]
  if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
    fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
    fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
  end
  allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
    fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/coupons_search_advanced/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
  query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
  query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
  query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
  query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20011' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#search_coupons_advanced_application_wide_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse20011

List coupons that match the given attributes in campaign (without total count) List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. Note: The total count is not included in the response.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (Object) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response. (default to 1000)

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code. (default to false)

  • :batch_id (String) —

    Filter results by batches of coupons

Returns:



12062
12063
12064
12065
 
# File 'lib/talon_one/api/management_api.rb', line 12062

def search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts)
  data
end

#search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse20011, Integer, Hash)>

List coupons that match the given attributes in campaign (without total count) List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. Note: The total count is not included in the response.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (Object) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in the response.

  • :skip (Integer) —

    The number of items to skip when paging through large result sets.

  • :sort (String) —

    The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

  • :value (String) —

    Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

  • :created_before (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

  • :valid (String) —

    Either &quot;expired&quot;, &quot;validNow&quot;, or &quot;validFuture&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

  • :usable (String) —

    Either &quot;true&quot; or &quot;false&quot;. If &quot;true&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, &quot;false&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.

  • :referral_id (Integer) —

    Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

  • :recipient_integration_id (String) —

    Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.

  • :exact_match (Boolean) —

    Filter results to an exact case-insensitive matching against the coupon code.

  • :batch_id (String) —

    Filter results by batches of coupons

Returns:

  • (Array<(InlineResponse20011, Integer, Hash)>) —

    InlineResponse20011 data, response status code and response headers



12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
 
# File 'lib/talon_one/api/management_api.rb', line 12086

def search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_without_total_count ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced_without_total_count"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.search_coupons_advanced_without_total_count"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.search_coupons_advanced_without_total_count"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_without_total_count, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_without_total_count, must be greater than or equal to 1.'
  end

  allowable_values = ["expired", "validNow", "validFuture"]
  if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
    fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
    fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
  query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
  query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
  query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20011' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#search_coupons_advanced_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#summarize_campaign_store_budget(application_id, campaign_id, opts = {}) ⇒ InlineResponse20049

Get summary of campaign store budgets Fetch a summary of all store budget information for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12177
12178
12179
12180
 
# File 'lib/talon_one/api/management_api.rb', line 12177

def summarize_campaign_store_budget(application_id, campaign_id, opts = {})
  data, _status_code, _headers = summarize_campaign_store_budget_with_http_info(application_id, campaign_id, opts)
  data
end

#summarize_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse20049, Integer, Hash)>

Get summary of campaign store budgets Fetch a summary of all store budget information for a given campaign.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20049, Integer, Hash)>) —

    InlineResponse20049 data, response status code and response headers



12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
 
# File 'lib/talon_one/api/management_api.rb', line 12188

def summarize_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.summarize_campaign_store_budget ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.summarize_campaign_store_budget"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.summarize_campaign_store_budget"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20049' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#summarize_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ nil

Transfer card data Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. Important: - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is active.

Parameters:

Returns:

  • (nil) 


12246
12247
12248
12249
 
# File 'lib/talon_one/api/management_api.rb', line 12246

def transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body, opts = {})
  transfer_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
  nil
end

#transfer_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Transfer card data Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. Important: - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is active.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
 
# File 'lib/talon_one/api/management_api.rb', line 12258

def transfer_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.transfer_loyalty_card ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.transfer_loyalty_card"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.transfer_loyalty_card"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.transfer_loyalty_card, the character length must be smaller than or equal to 108.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.transfer_loyalty_card"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#transfer_loyalty_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_collection(collection_id, body, opts = {}) ⇒ Collection

Update account-level collection Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • body (UpdateCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12325
12326
12327
12328
 
# File 'lib/talon_one/api/management_api.rb', line 12325

def (collection_id, body, opts = {})
  data, _status_code, _headers = (collection_id, body, opts)
  data
end

#update_account_collection_with_http_info(collection_id, body, opts = {}) ⇒ Array<(Collection, Integer, Hash)>

Update account-level collection Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.

Parameters:

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.

  • body (UpdateCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Collection, Integer, Hash)>) —

    Collection data, response status code and response headers



12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
 
# File 'lib/talon_one/api/management_api.rb', line 12336

def (collection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_account_collection ...'
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.update_account_collection"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_account_collection"
  end
  # resource path
  local_var_path = '/v1/collections/{collectionId}'.sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Collection' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_account_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_achievement(application_id, campaign_id, achievement_id, body, opts = {}) ⇒ Achievement

Update achievement Update the details of a specific achievement.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • body (UpdateAchievement) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12397
12398
12399
12400
 
# File 'lib/talon_one/api/management_api.rb', line 12397

def update_achievement(application_id, campaign_id, achievement_id, body, opts = {})
  data, _status_code, _headers = update_achievement_with_http_info(application_id, campaign_id, achievement_id, body, opts)
  data
end

#update_achievement_with_http_info(application_id, campaign_id, achievement_id, body, opts = {}) ⇒ Array<(Achievement, Integer, Hash)>

Update achievement Update the details of a specific achievement.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • achievement_id (Integer) —

    The ID of the achievement. You can get this ID with the [List achievement](docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.

  • body (UpdateAchievement) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Achievement, Integer, Hash)>) —

    Achievement data, response status code and response headers



12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
 
# File 'lib/talon_one/api/management_api.rb', line 12410

def update_achievement_with_http_info(application_id, campaign_id, achievement_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_achievement ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_achievement"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_achievement"
  end
  # verify the required parameter 'achievement_id' is set
  if @api_client.config.client_side_validation && achievement_id.nil?
    fail ArgumentError, "Missing the required parameter 'achievement_id' when calling ManagementApi.update_achievement"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_achievement"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'achievementId' + '}', CGI.escape(achievement_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Achievement' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_achievement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_additional_cost(additional_cost_id, body, opts = {}) ⇒ AccountAdditionalCost

Update additional cost Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the ‘name` property (or **API name** in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations.

Parameters:

  • additional_cost_id (Integer) —

    The ID of the additional cost. You can find the ID the the Campaign Manager&#39;s URL when you display the details of the cost in Account &gt; Tools &gt; **Additional costs**.

  • body (NewAdditionalCost) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12477
12478
12479
12480
 
# File 'lib/talon_one/api/management_api.rb', line 12477

def update_additional_cost(additional_cost_id, body, opts = {})
  data, _status_code, _headers = update_additional_cost_with_http_info(additional_cost_id, body, opts)
  data
end

#update_additional_cost_with_http_info(additional_cost_id, body, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>

Update additional cost Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the &#x60;name&#x60; property (or **API name** in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations.

Parameters:

  • additional_cost_id (Integer) —

    The ID of the additional cost. You can find the ID the the Campaign Manager&#39;s URL when you display the details of the cost in Account &gt; Tools &gt; **Additional costs**.

  • body (NewAdditionalCost) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AccountAdditionalCost, Integer, Hash)>) —

    AccountAdditionalCost data, response status code and response headers



12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
 
# File 'lib/talon_one/api/management_api.rb', line 12488

def update_additional_cost_with_http_info(additional_cost_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_additional_cost ...'
  end
  # verify the required parameter 'additional_cost_id' is set
  if @api_client.config.client_side_validation && additional_cost_id.nil?
    fail ArgumentError, "Missing the required parameter 'additional_cost_id' when calling ManagementApi.update_additional_cost"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_additional_cost"
  end
  # resource path
  local_var_path = '/v1/additional_costs/{additionalCostId}'.sub('{' + 'additionalCostId' + '}', CGI.escape(additional_cost_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'AccountAdditionalCost' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_additional_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_attribute(attribute_id, body, opts = {}) ⇒ Attribute

Update custom attribute Update an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the description. To change the ‘type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute.

Parameters:

  • attribute_id (Integer) —

    The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in Account &gt; Tools &gt; Attributes.

  • body (NewAttribute) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12547
12548
12549
12550
 
# File 'lib/talon_one/api/management_api.rb', line 12547

def update_attribute(attribute_id, body, opts = {})
  data, _status_code, _headers = update_attribute_with_http_info(attribute_id, body, opts)
  data
end

#update_attribute_with_http_info(attribute_id, body, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>

Update custom attribute Update an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the description. To change the &#x60;type&#x60; or &#x60;name&#x60; property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute.

Parameters:

  • attribute_id (Integer) —

    The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in Account &gt; Tools &gt; Attributes.

  • body (NewAttribute) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attribute, Integer, Hash)>) —

    Attribute data, response status code and response headers



12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
 
# File 'lib/talon_one/api/management_api.rb', line 12558

def update_attribute_with_http_info(attribute_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_attribute ...'
  end
  # verify the required parameter 'attribute_id' is set
  if @api_client.config.client_side_validation && attribute_id.nil?
    fail ArgumentError, "Missing the required parameter 'attribute_id' when calling ManagementApi.update_attribute"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_attribute"
  end
  # resource path
  local_var_path = '/v1/attributes/{attributeId}'.sub('{' + 'attributeId' + '}', CGI.escape(attribute_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attribute' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_campaign(application_id, campaign_id, body, opts = {}) ⇒ Campaign

Update campaign Update the given campaign. Important: You cannot use this endpoint to update campaigns if [campaign staging and revisions](docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (UpdateCampaign) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12618
12619
12620
12621
 
# File 'lib/talon_one/api/management_api.rb', line 12618

def update_campaign(application_id, campaign_id, body, opts = {})
  data, _status_code, _headers = update_campaign_with_http_info(application_id, campaign_id, body, opts)
  data
end

#update_campaign_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>

Update campaign Update the given campaign. Important: You cannot use this endpoint to update campaigns if [campaign staging and revisions](docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (UpdateCampaign) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Campaign, Integer, Hash)>) —

    Campaign data, response status code and response headers



12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
 
# File 'lib/talon_one/api/management_api.rb', line 12630

def update_campaign_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_campaign ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_campaign"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_campaign"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_campaign"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Campaign' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_collection(application_id, campaign_id, collection_id, body, opts = {}) ⇒ Collection

Update campaign-level collection’s description Edit the description of a given campaign-level collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • body (UpdateCampaignCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12695
12696
12697
12698
 
# File 'lib/talon_one/api/management_api.rb', line 12695

def update_collection(application_id, campaign_id, collection_id, body, opts = {})
  data, _status_code, _headers = update_collection_with_http_info(application_id, campaign_id, collection_id, body, opts)
  data
end

#update_collection_with_http_info(application_id, campaign_id, collection_id, body, opts = {}) ⇒ Array<(Collection, Integer, Hash)>

Update campaign-level collection&#39;s description Edit the description of a given campaign-level collection.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • collection_id (Integer) —

    The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.

  • body (UpdateCampaignCollection) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Collection, Integer, Hash)>) —

    Collection data, response status code and response headers



12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
 
# File 'lib/talon_one/api/management_api.rb', line 12708

def update_collection_with_http_info(application_id, campaign_id, collection_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_collection ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_collection"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_collection"
  end
  # verify the required parameter 'collection_id' is set
  if @api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling ManagementApi.update_collection"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_collection"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'collectionId' + '}', CGI.escape(collection_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Collection' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_coupon(application_id, campaign_id, coupon_id, body, opts = {}) ⇒ Coupon

Update coupon Update the specified coupon. <div class="redoc-section"> <p class="title">Important</p> <p>With this PUT endpoint, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.</p> </div>

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • coupon_id (String) —

    The internal ID of the coupon code. You can find this value in the &#x60;id&#x60; property from the [List coupons](docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.

  • body (UpdateCoupon) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12777
12778
12779
12780
 
# File 'lib/talon_one/api/management_api.rb', line 12777

def update_coupon(application_id, campaign_id, coupon_id, body, opts = {})
  data, _status_code, _headers = update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, opts)
  data
end

#update_coupon_batch(application_id, campaign_id, body, opts = {}) ⇒ nil

Update coupons Update all coupons or a specific batch of coupons in the given campaign. You can find the ‘batchId` on the Coupons page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class="redoc-section"> <p class="title">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.</li> <li>With this PUT endpoint, if you do not explicitly set a value for the startDate and expiryDate properties in your request, it is automatically set to null.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (UpdateCouponBatch) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


12858
12859
12860
12861
 
# File 'lib/talon_one/api/management_api.rb', line 12858

def update_coupon_batch(application_id, campaign_id, body, opts = {})
  update_coupon_batch_with_http_info(application_id, campaign_id, body, opts)
  nil
end

#update_coupon_batch_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update coupons Update all coupons or a specific batch of coupons in the given campaign. You can find the &#x60;batchId&#x60; on the Coupons page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). &lt;div class&#x3D;&quot;redoc-section&quot;&gt; &lt;p class&#x3D;&quot;title&quot;&gt;Important&lt;/p&gt; &lt;ul&gt; &lt;li&gt;Only send sequential requests to this endpoint.&lt;/li&gt; &lt;li&gt;Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.&lt;/li&gt; &lt;li&gt;With this &lt;code&gt;PUT&lt;/code&gt; endpoint, if you do not explicitly set a value for the &lt;code&gt;startDate&lt;/code&gt; and &lt;code&gt;expiryDate&lt;/code&gt; properties in your request, it is automatically set to &lt;code&gt;null&lt;/code&gt;.&lt;/li&gt; &lt;/ul&gt; &lt;/div&gt; To update a specific coupon, use [Update coupon](#operation/updateCoupon).

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • body (UpdateCouponBatch) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
 
# File 'lib/talon_one/api/management_api.rb', line 12870

def update_coupon_batch_with_http_info(application_id, campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_coupon_batch ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_coupon_batch"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_coupon_batch"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_coupon_batch"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_coupon_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, opts = {}) ⇒ Array<(Coupon, Integer, Hash)>

Update coupon Update the specified coupon. &lt;div class&#x3D;&quot;redoc-section&quot;&gt; &lt;p class&#x3D;&quot;title&quot;&gt;Important&lt;/p&gt; &lt;p&gt;With this &lt;code&gt;PUT&lt;/code&gt; endpoint, if you do not explicitly set a value for the &lt;code&gt;startDate&lt;/code&gt;, &lt;code&gt;expiryDate&lt;/code&gt;, and &lt;code&gt;recipientIntegrationId&lt;/code&gt; properties in your request, it is automatically set to &lt;code&gt;null&lt;/code&gt;.&lt;/p&gt; &lt;/div&gt;

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • coupon_id (String) —

    The internal ID of the coupon code. You can find this value in the &#x60;id&#x60; property from the [List coupons](docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.

  • body (UpdateCoupon) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Coupon, Integer, Hash)>) —

    Coupon data, response status code and response headers



12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
 
# File 'lib/talon_one/api/management_api.rb', line 12790

def update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_coupon ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_coupon"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_coupon"
  end
  # verify the required parameter 'coupon_id' is set
  if @api_client.config.client_side_validation && coupon_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_id' when calling ManagementApi.update_coupon"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_coupon"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'couponId' + '}', CGI.escape(coupon_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Coupon' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_loyalty_card(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ LoyaltyCard

Update loyalty card status Update the status of the given loyalty card. A card can be active or inactive.

Parameters:

Returns:



12932
12933
12934
12935
 
# File 'lib/talon_one/api/management_api.rb', line 12932

def update_loyalty_card(loyalty_program_id, loyalty_card_id, body, opts = {})
  data, _status_code, _headers = update_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
  data
end

#update_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {}) ⇒ Array<(LoyaltyCard, Integer, Hash)>

Update loyalty card status Update the status of the given loyalty card. A card can be active or inactive.

Parameters:

Returns:

  • (Array<(LoyaltyCard, Integer, Hash)>) —

    LoyaltyCard data, response status code and response headers



12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
 
# File 'lib/talon_one/api/management_api.rb', line 12944

def update_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_loyalty_card ...'
  end
  # verify the required parameter 'loyalty_program_id' is set
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.update_loyalty_card"
  end
  # verify the required parameter 'loyalty_card_id' is set
  if @api_client.config.client_side_validation && loyalty_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.update_loyalty_card"
  end
  if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
    fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.update_loyalty_card, the character length must be smaller than or equal to 108.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_loyalty_card"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'LoyaltyCard' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_loyalty_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_referral(application_id, campaign_id, referral_id, body, opts = {}) ⇒ Referral

Update referral Update the specified referral.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • referral_id (String) —

    The ID of the referral code.

  • body (UpdateReferral) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



13013
13014
13015
13016
 
# File 'lib/talon_one/api/management_api.rb', line 13013

def update_referral(application_id, campaign_id, referral_id, body, opts = {})
  data, _status_code, _headers = update_referral_with_http_info(application_id, campaign_id, referral_id, body, opts)
  data
end

#update_referral_with_http_info(application_id, campaign_id, referral_id, body, opts = {}) ⇒ Array<(Referral, Integer, Hash)>

Update referral Update the specified referral.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • campaign_id (Integer) —

    The ID of the campaign. It is displayed in your Talon.One deployment URL.

  • referral_id (String) —

    The ID of the referral code.

  • body (UpdateReferral) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Referral, Integer, Hash)>) —

    Referral data, response status code and response headers



13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
 
# File 'lib/talon_one/api/management_api.rb', line 13026

def update_referral_with_http_info(application_id, campaign_id, referral_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_referral ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_referral"
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_referral"
  end
  # verify the required parameter 'referral_id' is set
  if @api_client.config.client_side_validation && referral_id.nil?
    fail ArgumentError, "Missing the required parameter 'referral_id' when calling ManagementApi.update_referral"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_referral"
  end
  # resource path
  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))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Referral' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_referral\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_role_v2(role_id, body, opts = {}) ⇒ RoleV2

Update role Update a specific role.

Parameters:

  • role_id (Integer) —

    The ID of role. Note: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.

  • body (RoleV2Base) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



13093
13094
13095
13096
 
# File 'lib/talon_one/api/management_api.rb', line 13093

def update_role_v2(role_id, body, opts = {})
  data, _status_code, _headers = update_role_v2_with_http_info(role_id, body, opts)
  data
end

#update_role_v2_with_http_info(role_id, body, opts = {}) ⇒ Array<(RoleV2, Integer, Hash)>

Update role Update a specific role.

Parameters:

  • role_id (Integer) —

    The ID of role. Note: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.

  • body (RoleV2Base) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RoleV2, Integer, Hash)>) —

    RoleV2 data, response status code and response headers



13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
 
# File 'lib/talon_one/api/management_api.rb', line 13104

def update_role_v2_with_http_info(role_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_role_v2 ...'
  end
  # verify the required parameter 'role_id' is set
  if @api_client.config.client_side_validation && role_id.nil?
    fail ArgumentError, "Missing the required parameter 'role_id' when calling ManagementApi.update_role_v2"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_role_v2"
  end
  # resource path
  local_var_path = '/v2/roles/{roleId}'.sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'RoleV2' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_role_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_store(application_id, store_id, body, opts = {}) ⇒ Store

Update store Update store details for a specific store ID.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • store_id (String) —

    The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.

  • body (NewStore) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



13164
13165
13166
13167
 
# File 'lib/talon_one/api/management_api.rb', line 13164

def update_store(application_id, store_id, body, opts = {})
  data, _status_code, _headers = update_store_with_http_info(application_id, store_id, body, opts)
  data
end

#update_store_with_http_info(application_id, store_id, body, opts = {}) ⇒ Array<(Store, Integer, Hash)>

Update store Update store details for a specific store ID.

Parameters:

  • application_id (Integer) —

    The ID of the Application. It is displayed in your Talon.One deployment URL.

  • store_id (String) —

    The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.

  • body (NewStore) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Store, Integer, Hash)>) —

    Store data, response status code and response headers



13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
 
# File 'lib/talon_one/api/management_api.rb', line 13176

def update_store_with_http_info(application_id, store_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_store ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_store"
  end
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling ManagementApi.update_store"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_store"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/stores/{storeId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'storeId' + '}', CGI.escape(store_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Store' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user(user_id, body, opts = {}) ⇒ User

Update user Update the details of a specific user.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • body (UpdateUser) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



13239
13240
13241
13242
 
# File 'lib/talon_one/api/management_api.rb', line 13239

def update_user(user_id, body, opts = {})
  data, _status_code, _headers = update_user_with_http_info(user_id, body, opts)
  data
end

#update_user_with_http_info(user_id, body, opts = {}) ⇒ Array<(User, Integer, Hash)>

Update user Update the details of a specific user.

Parameters:

  • user_id (Integer) —

    The ID of the user.

  • body (UpdateUser) —

    body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(User, Integer, Hash)>) —

    User data, response status code and response headers



13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
 
# File 'lib/talon_one/api/management_api.rb', line 13250

def update_user_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_user ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.update_user"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_user"
  end
  # resource path
  local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'User' 

  # auth_names
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManagementApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end