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

#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) 


29
30
31
32
 
# File 'lib/talon_one/api/management_api.rb', line 29

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



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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/talon_one/api/management_api.rb', line 41

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 identifier of the profile.

  • body (AddLoyaltyPoints) —

    body

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

    the optional parameters

Returns:

  • (nil) 


109
110
111
112
 
# File 'lib/talon_one/api/management_api.rb', line 109

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 identifier of the profile.

  • body (AddLoyaltyPoints) —

    body

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/talon_one/api/management_api.rb', line 121

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 = {}) ⇒ InlineResponse2004

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:



185
186
187
188
 
# File 'lib/talon_one/api/management_api.rb', line 185

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<(InlineResponse2004, 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<(InlineResponse2004, Integer, Hash)>) —

    InlineResponse2004 data, response status code and response headers



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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/talon_one/api/management_api.rb', line 197

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] || 'InlineResponse2004' 

  # 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 account-level collection.

Parameters:

  • body (NewCollection) —

    body

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

    the optional parameters

Returns:



259
260
261
262
 
# File 'lib/talon_one/api/management_api.rb', line 259

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 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



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
315
316
 
# File 'lib/talon_one/api/management_api.rb', line 269

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_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:



323
324
325
326
 
# File 'lib/talon_one/api/management_api.rb', line 323

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



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
379
380
 
# File 'lib/talon_one/api/management_api.rb', line 333

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:



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

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



397
398
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
 
# File 'lib/talon_one/api/management_api.rb', line 397

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_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:



452
453
454
455
 
# File 'lib/talon_one/api/management_api.rb', line 452

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:



463
464
465
466
467
468
469
470
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
 
# File 'lib/talon_one/api/management_api.rb', line 463

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_collection(application_id, campaign_id, body, opts = {}) ⇒ Collection

Create collection Create a 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.

  • body (NewCampaignCollection) —

    body

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

    the optional parameters

Returns:



523
524
525
526
 
# File 'lib/talon_one/api/management_api.rb', line 523

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 collection Create a 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.

  • body (NewCampaignCollection) —

    body

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

    the optional parameters

Returns:

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

    Collection 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
583
584
585
586
587
588
589
590
 
# File 'lib/talon_one/api/management_api.rb', line 535

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 = {}) ⇒ InlineResponse2007

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 perfomance 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:



600
601
602
603
 
# File 'lib/talon_one/api/management_api.rb', line 600

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:



678
679
680
681
 
# File 'lib/talon_one/api/management_api.rb', line 678

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



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
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/talon_one/api/management_api.rb', line 690

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_for_multiple_recipients(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2007

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 perfomance 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:



755
756
757
758
 
# File 'lib/talon_one/api/management_api.rb', line 755

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<(InlineResponse2007, 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 perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.

Returns:

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

    InlineResponse2007 data, response status code and response headers



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
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/talon_one/api/management_api.rb', line 768

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] || '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(: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<(InlineResponse2007, 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 perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.

Returns:

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

    InlineResponse2007 data, response status code and response headers



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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/talon_one/api/management_api.rb', line 613

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] || '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(: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_notification_webhook(application_id, body, opts = {}) ⇒ NotificationWebhook

Create notification about campaign-related changes Create a [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications). A notification about campaign-related changes is different from regular webhooks in that it is Application-scoped and has a predefined payload. [Regular webhooks](docs.talon.one/docs/dev/getting-started/webhooks) have user-definable payloads. Tip: - You can create these notifications using the Campaign Manager. See [Managing notifications](docs.talon.one/docs/product/applications/outbound-notifications). - You can review the payload you will receive in the [specs](docs.talon.one/outbound-notifications#/paths/campaign_created/post).

Parameters:

  • application_id (Integer) —

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

  • body (NewNotificationWebhook) —

    body

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

    the optional parameters

Returns:



832
833
834
835
 
# File 'lib/talon_one/api/management_api.rb', line 832

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

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

Create notification about campaign-related changes Create a [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications). A notification about campaign-related changes is different from regular webhooks in that it is Application-scoped and has a predefined payload. [Regular webhooks](docs.talon.one/docs/dev/getting-started/webhooks) have user-definable payloads. Tip: - You can create these notifications using the Campaign Manager. See [Managing notifications](docs.talon.one/docs/product/applications/outbound-notifications). - You can review the payload you will receive in the [specs](docs.talon.one/outbound-notifications#/paths/campaign_created/post).

Parameters:

  • application_id (Integer) —

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

  • body (NewNotificationWebhook) —

    body

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

    the optional parameters

Returns:

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

    NotificationWebhook data, response status code and response headers



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
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/talon_one/api/management_api.rb', line 843

def create_notification_webhook_with_http_info(application_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.create_notification_webhook ...'
  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_notification_webhook"
  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_notification_webhook"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/notification_webhooks'.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] || 'NotificationWebhook' 

  # 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_notification_webhook\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:



901
902
903
904
 
# File 'lib/talon_one/api/management_api.rb', line 901

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



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
954
955
956
957
958
 
# File 'lib/talon_one/api/management_api.rb', line 911

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:



965
966
967
968
 
# File 'lib/talon_one/api/management_api.rb', line 965

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



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
 
# File 'lib/talon_one/api/management_api.rb', line 975

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

#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) 


1031
1032
1033
1034
 
# File 'lib/talon_one/api/management_api.rb', line 1031

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



1043
1044
1045
1046
1047
1048
1049
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
 
# File 'lib/talon_one/api/management_api.rb', line 1043

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 the given account-level collection.

Parameters:

  • collection_id (Integer) —

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

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

    the optional parameters

Returns:

  • (nil) 


1109
1110
1111
1112
 
# File 'lib/talon_one/api/management_api.rb', line 1109

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 the given account-level collection.

Parameters:

  • collection_id (Integer) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1119
1120
1121
1122
1123
1124
1125
1126
1127
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
 
# File 'lib/talon_one/api/management_api.rb', line 1119

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_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) 


1172
1173
1174
1175
 
# File 'lib/talon_one/api/management_api.rb', line 1172

def delete_campaign(application_id, campaign_id, opts = {})
  delete_campaign_with_http_info(application_id, campaign_id, opts)
  nil
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



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
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
 
# File 'lib/talon_one/api/management_api.rb', line 1183

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 collection Delete the given 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

  • (nil) 


1239
1240
1241
1242
 
# File 'lib/talon_one/api/management_api.rb', line 1239

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 collection Delete the given 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
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
 
# File 'lib/talon_one/api/management_api.rb', line 1251

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) 


1313
1314
1315
1316
 
# File 'lib/talon_one/api/management_api.rb', line 1313

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



1325
1326
1327
1328
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 1325

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 timezone. 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 timezone. 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 creation timestamp. You can use any timezone. 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 creation timestamp. You can use any timezone. 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 creation timestamp. You can use any timezone. 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 creation timestamp. You can use any timezone. 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) 


1397
1398
1399
1400
 
# File 'lib/talon_one/api/management_api.rb', line 1397

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 timezone. 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 timezone. 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 creation timestamp. You can use any timezone. 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 creation timestamp. You can use any timezone. 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 creation timestamp. You can use any timezone. 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 creation timestamp. You can use any timezone. 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



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
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
 
# File 'lib/talon_one/api/management_api.rb', line 1421

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) 


1497
1498
1499
1500
 
# File 'lib/talon_one/api/management_api.rb', line 1497

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



1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
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
 
# File 'lib/talon_one/api/management_api.rb', line 1508

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_notification_webhook(application_id, notification_webhook_id, opts = {}) ⇒ nil

Delete notification about campaign-related changes Remove the given existing [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications).

Parameters:

  • application_id (Integer) —

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

  • notification_webhook_id (Integer) —

    The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.

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

    the optional parameters

Returns:

  • (nil) 


1569
1570
1571
1572
 
# File 'lib/talon_one/api/management_api.rb', line 1569

def delete_notification_webhook(application_id, notification_webhook_id, opts = {})
  delete_notification_webhook_with_http_info(application_id, notification_webhook_id, opts)
  nil
end

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

Delete notification about campaign-related changes Remove the given existing [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications).

Parameters:

  • application_id (Integer) —

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

  • notification_webhook_id (Integer) —

    The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
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
 
# File 'lib/talon_one/api/management_api.rb', line 1580

def delete_notification_webhook_with_http_info(application_id, notification_webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.delete_notification_webhook ...'
  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_notification_webhook"
  end
  # verify the required parameter 'notification_webhook_id' is set
  if @api_client.config.client_side_validation && notification_webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_webhook_id' when calling ManagementApi.delete_notification_webhook"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'notificationWebhookId' + '}', CGI.escape(notification_webhook_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_notification_webhook\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) 


1636
1637
1638
1639
 
# File 'lib/talon_one/api/management_api.rb', line 1636

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



1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
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
 
# File 'lib/talon_one/api/management_api.rb', line 1648

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

#destroy_session(opts = {}) ⇒ nil

Destroy session Destroys the session.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1705
1706
1707
1708
 
# File 'lib/talon_one/api/management_api.rb', line 1705

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



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'lib/talon_one/api/management_api.rb', line 1714

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

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

Export account-level collection’s items Download a CSV file containing items from an 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

  • (String) 


1760
1761
1762
1763
 
# File 'lib/talon_one/api/management_api.rb', line 1760

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 an 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
 
# File 'lib/talon_one/api/management_api.rb', line 1770

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_collection_items(application_id, campaign_id, collection_id, opts = {}) ⇒ String

Export a collection’s items Download a CSV file containing a collection’s items. 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

  • (String) 


1824
1825
1826
1827
 
# File 'lib/talon_one/api/management_api.rb', line 1824

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 a collection&#39;s items Download a CSV file containing a collection&#39;s items. 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
 
# File 'lib/talon_one/api/management_api.rb', line 1836

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 contains 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 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 customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon is reserved. - `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.

  • :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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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. - &#x60;draft&#x60;: Campaigns that are drafts.

Returns:

  • (String) 


1909
1910
1911
1912
 
# File 'lib/talon_one/api/management_api.rb', line 1909

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 contains 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 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 customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - &#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 is reserved. - &#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.

  • :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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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. - &#x60;draft&#x60;: Campaigns that are drafts.

Returns:

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

    String data, response status code and response headers



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
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
 
# File 'lib/talon_one/api/management_api.rb', line 1932

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", "draft", "scheduled", "running", "expired"]
  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?

  # 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/product/server-infrastructure-and-data-retention#data-retention-policy). 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-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of the session. - `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. - `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) 


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

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/product/server-infrastructure-and-data-retention#data-retention-policy). 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-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 the session. - &#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;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



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
2083
2084
2085
2086
2087
2088
2089
2090
2091
 
# File 'lib/talon_one/api/management_api.rb', line 2033

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_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/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.

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.

  • :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 timezone. 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 timezone. Talon.One will convert to UTC internally.

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


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

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/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.

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.

  • :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 timezone. 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 timezone. 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



2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
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
 
# File 'lib/talon_one/api/management_api.rb', line 2116

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 balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. Note: It must be an RFC3339 timestamp string.

Returns:

  • (String) 


2177
2178
2179
2180
 
# File 'lib/talon_one/api/management_api.rb', line 2177

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 balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. Note: It must be an RFC3339 timestamp string.

Returns:

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

    String data, response status code and response headers



2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
 
# File 'lib/talon_one/api/management_api.rb', line 2188

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 balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. Note: It must be an RFC3339 timestamp string.

Returns:

  • (String) 


2242
2243
2244
2245
 
# File 'lib/talon_one/api/management_api.rb', line 2242

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 balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. Note: It must be an RFC3339 timestamp string.

Returns:

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

    String data, response status code and response headers



2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
 
# File 'lib/talon_one/api/management_api.rb', line 2253

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 balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. Note: It must be an RFC3339 timestamp string.

Returns:

  • (String) 


2307
2308
2309
2310
 
# File 'lib/talon_one/api/management_api.rb', line 2307

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 balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. Note: It must be an RFC3339 timestamp string.

Returns:

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

    String data, response status code and response headers



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
 
# File 'lib/talon_one/api/management_api.rb', line 2318

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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

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

    the optional parameters

Options Hash (opts):

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


2375
2376
2377
2378
 
# File 'lib/talon_one/api/management_api.rb', line 2375

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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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



2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
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
 
# File 'lib/talon_one/api/management_api.rb', line 2389

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_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 type of the loyalty program. - `name`: The name of the loyalty program. - `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.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The identifier of the profile.

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

    the optional parameters

Options Hash (opts):

  • :date_format (String) —

    Determines the format of dates in the export document.

Returns:

  • (String) 


2468
2469
2470
2471
 
# File 'lib/talon_one/api/management_api.rb', line 2468

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 type of the loyalty program. - &#x60;name&#x60;: The name of the loyalty program. - &#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.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • loyalty_program_id (String) —

    The identifier for the loyalty program.

  • integration_id (String) —

    The identifier of the profile.

  • 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



2482
2483
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
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
 
# File 'lib/talon_one/api/management_api.rb', line 2482

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_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.

  • :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 timezone. 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 timezone. 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) 


2560
2561
2562
2563
 
# File 'lib/talon_one/api/management_api.rb', line 2560

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.

  • :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 timezone. 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 timezone. 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



2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
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
 
# File 'lib/talon_one/api/management_api.rb', line 2577

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 = {}) ⇒ InlineResponse20018

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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



2656
2657
2658
2659
 
# File 'lib/talon_one/api/management_api.rb', line 2656

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<(InlineResponse20018, 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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse20018 data, response status code and response headers



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
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
 
# File 'lib/talon_one/api/management_api.rb', line 2674

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] || '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_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:



2758
2759
2760
2761
 
# File 'lib/talon_one/api/management_api.rb', line 2758

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:



2820
2821
2822
2823
 
# File 'lib/talon_one/api/management_api.rb', line 2820

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



2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
 
# File 'lib/talon_one/api/management_api.rb', line 2830

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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:



2882
2883
2884
2885
 
# File 'lib/talon_one/api/management_api.rb', line 2882

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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

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

    Collection data, response status code and response headers



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
2932
2933
2934
2935
2936
2937
 
# File 'lib/talon_one/api/management_api.rb', line 2892

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



2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
 
# File 'lib/talon_one/api/management_api.rb', line 2768

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_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:



2944
2945
2946
2947
 
# File 'lib/talon_one/api/management_api.rb', line 2944

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



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 2954

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 = {}) ⇒ InlineResponse20032

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



3008
3009
3010
3011
 
# File 'lib/talon_one/api/management_api.rb', line 3008

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<(InlineResponse20032, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse20032 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
 
# File 'lib/talon_one/api/management_api.rb', line 3020

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] || '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_additional_costs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_access_logs(range_start, range_end, opts = {}) ⇒ InlineResponse20019

List access logs Fetches the access logs for the entire account. Sensitive requests (logins) are always filtered from the logs.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



3086
3087
3088
3089
 
# File 'lib/talon_one/api/management_api.rb', line 3086

def get_all_access_logs(range_start, range_end, opts = {})
  data, _status_code, _headers = get_all_access_logs_with_http_info(range_start, range_end, opts)
  data
end

#get_all_access_logs_with_http_info(range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20019, Integer, Hash)>

List access logs Fetches the access logs for the entire account. Sensitive requests (logins) are always filtered from the logs.

Parameters:

  • range_start (DateTime) —

    Only return results from after this timestamp. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse20019 data, response status code and response headers



3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
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
 
# File 'lib/talon_one/api/management_api.rb', line 3103

def get_all_access_logs_with_http_info(range_start, range_end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_all_access_logs ...'
  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_all_access_logs"
  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_all_access_logs"
  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_all_access_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_all_access_logs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/access_logs'

  # 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] || '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_all_access_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_roles(opts = {}) ⇒ InlineResponse20040

List roles List all roles.

Parameters:

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

    the optional parameters

Returns:



3182
3183
3184
3185
 
# File 'lib/talon_one/api/management_api.rb', line 3182

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

#get_all_roles_with_http_info(opts = {}) ⇒ Array<(InlineResponse20040, Integer, Hash)>

List roles List all roles.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20040 data, response status code and response headers



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
 
# File 'lib/talon_one/api/management_api.rb', line 3191

def get_all_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_all_roles ...'
  end
  # resource path
  local_var_path = '/v1/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] || '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_all_roles\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:



3239
3240
3241
3242
 
# File 'lib/talon_one/api/management_api.rb', line 3239

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 display this information from the Settings of an Application, in the **Developer Settings** menu. 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:



3301
3302
3303
3304
 
# File 'lib/talon_one/api/management_api.rb', line 3301

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 display this information from the Settings of an Application, in the **Developer Settings** menu. 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



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
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
 
# File 'lib/talon_one/api/management_api.rb', line 3311

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:



3364
3365
3366
3367
 
# File 'lib/talon_one/api/management_api.rb', line 3364

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 = {}) ⇒ InlineResponse20030

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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:



3436
3437
3438
3439
 
# File 'lib/talon_one/api/management_api.rb', line 3436

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<(InlineResponse20030, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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<(InlineResponse20030, Integer, Hash)>) —

    InlineResponse20030 data, response status code and response headers



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
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
 
# File 'lib/talon_one/api/management_api.rb', line 3451

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] || '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_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



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 3375

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 = {}) ⇒ InlineResponse20021

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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:



3523
3524
3525
3526
 
# File 'lib/talon_one/api/management_api.rb', line 3523

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 = {}) ⇒ InlineResponse20022

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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:



3605
3606
3607
3608
 
# File 'lib/talon_one/api/management_api.rb', line 3605

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<(InlineResponse20022, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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<(InlineResponse20022, Integer, Hash)>) —

    InlineResponse20022 data, response status code and response headers



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
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
 
# File 'lib/talon_one/api/management_api.rb', line 3619

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] || '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(: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<(InlineResponse20021, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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<(InlineResponse20021, Integer, Hash)>) —

    InlineResponse20021 data, response status code and response headers



3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
 
# File 'lib/talon_one/api/management_api.rb', line 3537

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] || '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_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 = {}) ⇒ InlineResponse20028

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#operation/trackEvent)

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



3691
3692
3693
3694
 
# File 'lib/talon_one/api/management_api.rb', line 3691

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<(InlineResponse20028, 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#operation/trackEvent)

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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse20028 data, response status code and response headers



3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'lib/talon_one/api/management_api.rb', line 3704

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] || '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_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 = {}) ⇒ InlineResponse20027

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any timezone. 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:



3781
3782
3783
3784
 
# File 'lib/talon_one/api/management_api.rb', line 3781

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<(InlineResponse20027, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any timezone. 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<(InlineResponse20027, Integer, Hash)>) —

    InlineResponse20027 data, response status code and response headers



3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
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
3880
 
# File 'lib/talon_one/api/management_api.rb', line 3805

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] || '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_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:



3888
3889
3890
3891
 
# File 'lib/talon_one/api/management_api.rb', line 3888

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



3899
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
3948
 
# File 'lib/talon_one/api/management_api.rb', line 3899

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 = {}) ⇒ InlineResponse20026

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any timezone. 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 integrationId. Must be exact match.

Returns:



3965
3966
3967
3968
 
# File 'lib/talon_one/api/management_api.rb', line 3965

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<(InlineResponse20026, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any timezone. 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 integrationId. Must be exact match.

Returns:

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

    InlineResponse20026 data, response status code and response headers



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
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
 
# File 'lib/talon_one/api/management_api.rb', line 3985

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?

  # 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] || '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(: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



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
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
 
# File 'lib/talon_one/api/management_api.rb', line 3249

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 = {}) ⇒ InlineResponse2003

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



4061
4062
4063
4064
 
# File 'lib/talon_one/api/management_api.rb', line 4061

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

#get_applications_with_http_info(opts = {}) ⇒ Array<(InlineResponse2003, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse2003 data, response status code and response headers



4073
4074
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
 
# File 'lib/talon_one/api/management_api.rb', line 4073

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] || 'InlineResponse2003' 

  # 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:



4132
4133
4134
4135
 
# File 'lib/talon_one/api/management_api.rb', line 4132

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



4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
 
# File 'lib/talon_one/api/management_api.rb', line 4142

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 = {}) ⇒ InlineResponse20031

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :entity (String) —

    Returned attributes will be filtered by supplied entity.

Returns:



4197
4198
4199
4200
 
# File 'lib/talon_one/api/management_api.rb', line 4197

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

#get_attributes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20031, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :entity (String) —

    Returned attributes will be filtered by supplied entity.

Returns:

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

    InlineResponse20031 data, response status code and response headers



4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
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
 
# File 'lib/talon_one/api/management_api.rb', line 4210

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] || '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_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_audiences(opts = {}) ⇒ InlineResponse20029

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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:



4273
4274
4275
4276
 
# File 'lib/talon_one/api/management_api.rb', line 4273

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

#get_audiences_with_http_info(opts = {}) ⇒ Array<(InlineResponse20029, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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<(InlineResponse20029, Integer, Hash)>) —

    InlineResponse20029 data, response status code and response headers



4286
4287
4288
4289
4290
4291
4292
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
4339
 
# File 'lib/talon_one/api/management_api.rb', line 4286

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] || '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_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:



4347
4348
4349
4350
 
# File 'lib/talon_one/api/management_api.rb', line 4347

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 = {}) ⇒ InlineResponse20020

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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

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

    the optional parameters

Options Hash (opts):

  • :granularity (String) —

    The time interval between the results in the returned time-series.

Returns:



4418
4419
4420
4421
 
# File 'lib/talon_one/api/management_api.rb', line 4418

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<(InlineResponse20020, 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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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<(InlineResponse20020, Integer, Hash)>) —

    InlineResponse20020 data, response status code and response headers



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
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
 
# File 'lib/talon_one/api/management_api.rb', line 4432

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] || '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#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 = {}) ⇒ InlineResponse2004

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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. - &#x60;draft&#x60;: Campaigns that are drafts.

Returns:



4508
4509
4510
4511
 
# File 'lib/talon_one/api/management_api.rb', line 4508

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<(InlineResponse2004, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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. - &#x60;draft&#x60;: Campaigns that are drafts.

Returns:

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

    InlineResponse2004 data, response status code and response headers



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
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
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
 
# File 'lib/talon_one/api/management_api.rb', line 4523

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", "draft", "scheduled", "running", "expired"]
  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] || 'InlineResponse2004' 

  # 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_templates(opts = {}) ⇒ InlineResponse20010

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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:



4603
4604
4605
4606
 
# File 'lib/talon_one/api/management_api.rb', line 4603

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<(InlineResponse20010, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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<(InlineResponse20010, Integer, Hash)>) —

    InlineResponse20010 data, response status code and response headers



4619
4620
4621
4622
4623
4624
4625
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
4672
4673
4674
4675
4676
4677
4678
4679
 
# File 'lib/talon_one/api/management_api.rb', line 4619

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 = ["enabled", "disabled", "draft"]
  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] || '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(: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



4358
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
 
# File 'lib/talon_one/api/management_api.rb', line 4358

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 = {}) ⇒ InlineResponse2004

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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. - &#x60;draft&#x60;: Campaigns that are drafts.

  • :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 timezone. 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 timezone. Talon.One will convert to UTC internally.

  • :campaign_group_id (Integer) —

    Filter results to campaigns owned by the specified campaign group ID.

  • :template_id (Integer) —

    The ID of the Campaign Template this Campaign was created from.

Returns:



4696
4697
4698
4699
 
# File 'lib/talon_one/api/management_api.rb', line 4696

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<(InlineResponse2004, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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. - &#x60;draft&#x60;: Campaigns that are drafts.

  • :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 timezone. 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 timezone. Talon.One will convert to UTC internally.

  • :campaign_group_id (Integer) —

    Filter results to campaigns owned by the specified campaign group ID.

  • :template_id (Integer) —

    The ID of the Campaign Template this Campaign was created from.

Returns:

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

    InlineResponse2004 data, response status code and response headers



4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
 
# File 'lib/talon_one/api/management_api.rb', line 4716

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", "draft", "scheduled", "running", "expired"]
  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?

  # 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] || 'InlineResponse2004' 

  # 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 = {}) ⇒ InlineResponse20038

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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:



4800
4801
4802
4803
 
# File 'lib/talon_one/api/management_api.rb', line 4800

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

#get_changes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20038, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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<(InlineResponse20038, Integer, Hash)>) —

    InlineResponse20038 data, response status code and response headers



4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
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
 
# File 'lib/talon_one/api/management_api.rb', line 4820

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] || '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_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 collection Retrieve a given 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:



4889
4890
4891
4892
 
# File 'lib/talon_one/api/management_api.rb', line 4889

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 = {}) ⇒ InlineResponse20016

Get collection items Retrieve the items from the given collection.

Parameters:

  • collection_id (Integer) —

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

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:



4963
4964
4965
4966
 
# File 'lib/talon_one/api/management_api.rb', line 4963

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<(InlineResponse20016, Integer, Hash)>

Get collection items Retrieve the items from the given collection.

Parameters:

  • collection_id (Integer) —

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

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in this response.

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:

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

    InlineResponse20016 data, response status code and response headers



4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
 
# File 'lib/talon_one/api/management_api.rb', line 4975

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] || '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_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 collection Retrieve a given 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Returns:

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

    Collection data, response status code and response headers



4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
 
# File 'lib/talon_one/api/management_api.rb', line 4901

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 = {}) ⇒ InlineResponse2008

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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)

Returns:



5050
5051
5052
5053
 
# File 'lib/talon_one/api/management_api.rb', line 5050

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<(InlineResponse2008, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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

Returns:

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

    InlineResponse2008 data, response status code and response headers



5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
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
 
# File 'lib/talon_one/api/management_api.rb', line 5073

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
  # 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[:'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?

  # 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_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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:



5162
5163
5164
5165
 
# File 'lib/talon_one/api/management_api.rb', line 5162

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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response.

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:

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

    CustomerActivityReport data, response status code and response headers



5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
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
 
# File 'lib/talon_one/api/management_api.rb', line 5177

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 = {}) ⇒ InlineResponse20025

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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 campaignName

  • :advocate_name (String) —

    Only return reports matching the current customer referrer name

Returns:



5262
5263
5264
5265
 
# File 'lib/talon_one/api/management_api.rb', line 5262

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<(InlineResponse20025, 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. This must be an RFC3339 timestamp string.

  • range_end (DateTime) —

    Only return results from before this timestamp. This must be an RFC3339 timestamp string.

  • 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 campaignName

  • :advocate_name (String) —

    Only return reports matching the current customer referrer name

Returns:

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

    InlineResponse20025 data, response status code and response headers



5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
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
 
# File 'lib/talon_one/api/management_api.rb', line 5281

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] || '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(: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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



5362
5363
5364
5365
 
# File 'lib/talon_one/api/management_api.rb', line 5362

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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    CustomerAnalytics data, response status code and response headers



5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
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
 
# File 'lib/talon_one/api/management_api.rb', line 5376

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:



5443
5444
5445
5446
 
# File 'lib/talon_one/api/management_api.rb', line 5443

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_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



5453
5454
5455
5456
5457
5458
5459
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
 
# File 'lib/talon_one/api/management_api.rb', line 5453

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 = {}) ⇒ InlineResponse20024

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or Live customer. (default to false)

Returns:



5507
5508
5509
5510
 
# File 'lib/talon_one/api/management_api.rb', line 5507

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<(InlineResponse20024, 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 this response.

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or Live customer.

Returns:

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

    InlineResponse20024 data, response status code and response headers



5519
5520
5521
5522
5523
5524
5525
5526
5527
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
 
# File 'lib/talon_one/api/management_api.rb', line 5519

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] || '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_customer_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customers_by_attributes(body, opts = {}) ⇒ InlineResponse20023

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or Live customer. (default to false)

Returns:



5581
5582
5583
5584
 
# File 'lib/talon_one/api/management_api.rb', line 5581

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<(InlineResponse20023, 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 this response.

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

  • :sandbox (Boolean) —

    Indicates whether you are pointing to a sandbox or Live customer.

Returns:

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

    InlineResponse20023 data, response status code and response headers



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
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
 
# File 'lib/talon_one/api/management_api.rb', line 5594

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] || '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(: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_event_types(opts = {}) ⇒ InlineResponse20036

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



5663
5664
5665
5666
 
# File 'lib/talon_one/api/management_api.rb', line 5663

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<(InlineResponse20036, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse20036 data, response status code and response headers



5677
5678
5679
5680
5681
5682
5683
5684
5685
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
 
# File 'lib/talon_one/api/management_api.rb', line 5677

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] || '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_event_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_exports(opts = {}) ⇒ InlineResponse20039

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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:



5742
5743
5744
5745
 
# File 'lib/talon_one/api/management_api.rb', line 5742

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

#get_exports_with_http_info(opts = {}) ⇒ Array<(InlineResponse20039, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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<(InlineResponse20039, Integer, Hash)>) —

    InlineResponse20039 data, response status code and response headers



5756
5757
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
5806
5807
5808
5809
5810
5811
5812
5813
5814
 
# File 'lib/talon_one/api/management_api.rb', line 5756

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] || '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_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:



5822
5823
5824
5825
 
# File 'lib/talon_one/api/management_api.rb', line 5822

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 = {}) ⇒ InlineResponse20014

List card’s transactions Retrieve the transaction logs for the given [loyalty card](docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-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.

  • :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.

  • :page_size (Integer) —

    The number of items in this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

Returns:



5899
5900
5901
5902
 
# File 'lib/talon_one/api/management_api.rb', line 5899

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<(InlineResponse20014, Integer, Hash)>

List card&#39;s transactions Retrieve the transaction logs for the given [loyalty card](docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-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.

  • :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.

  • :page_size (Integer) —

    The number of items in this response.

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

  • :subledger_id (String) —

    The ID of the subledger by which we filter the data.

Returns:

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

    InlineResponse20014 data, response status code and response headers



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
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
 
# File 'lib/talon_one/api/management_api.rb', line 5915

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] || '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_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



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
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
 
# File 'lib/talon_one/api/management_api.rb', line 5833

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 = {}) ⇒ InlineResponse20013

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :identifier (String) —

    Optional query parameter to search cards by identifier.

  • :profile_id (Integer) —

    Filter by the profile ID.

Returns:



5993
5994
5995
5996
 
# File 'lib/talon_one/api/management_api.rb', line 5993

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<(InlineResponse20013, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :identifier (String) —

    Optional query parameter to search cards by identifier.

  • :profile_id (Integer) —

    Filter by the profile ID.

Returns:

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

    InlineResponse20013 data, response status code and response headers



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
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
 
# File 'lib/talon_one/api/management_api.rb', line 6008

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?

  # 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_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 identifier of the profile.

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

    the optional parameters

Returns:



6082
6083
6084
6085
 
# File 'lib/talon_one/api/management_api.rb', line 6082

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 identifier of the profile.

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

    the optional parameters

Returns:

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

    LoyaltyLedger data, response status code and response headers



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
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
 
# File 'lib/talon_one/api/management_api.rb', line 6093

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:



6149
6150
6151
6152
 
# File 'lib/talon_one/api/management_api.rb', line 6149

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 = {}) ⇒ InlineResponse20012

List loyalty program transactions Retrieve all loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. 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.

  • :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.

  • :page_size (Integer) —

    The number of items in this response. (default to 50)

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:



6217
6218
6219
6220
 
# File 'lib/talon_one/api/management_api.rb', line 6217

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<(InlineResponse20012, Integer, Hash)>

List loyalty program transactions Retrieve all loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. 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.

  • :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.

  • :page_size (Integer) —

    The number of items in this response.

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:

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

    InlineResponse20012 data, response status code and response headers



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
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
 
# File 'lib/talon_one/api/management_api.rb', line 6233

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[:'loyalty_transaction_type'].nil? && opts[:'loyalty_transaction_type'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"loyalty_transaction_type"]" when calling ManagementApi.get_loyalty_program_transactions, the character length must be smaller than or equal to 255.'
  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] || '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_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



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
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
 
# File 'lib/talon_one/api/management_api.rb', line 6159

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 = {}) ⇒ InlineResponse20011

List loyalty programs List the loyalty programs of the account.

Parameters:

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

    the optional parameters

Returns:



6306
6307
6308
6309
 
# File 'lib/talon_one/api/management_api.rb', line 6306

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<(InlineResponse20011, Integer, Hash)>

List loyalty programs List the loyalty programs of the account.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20011 data, response status code and response headers



6315
6316
6317
6318
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
 
# File 'lib/talon_one/api/management_api.rb', line 6315

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] || '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_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 = {}) ⇒ LoyaltyStatistics

Get loyalty program statistics Retrieve the statistics of the specified loyalty program 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:

Returns:



6363
6364
6365
6366
 
# File 'lib/talon_one/api/management_api.rb', line 6363

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<(LoyaltyStatistics, Integer, Hash)>

Get loyalty program statistics Retrieve the statistics of the specified loyalty program 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:

Returns:

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

    LoyaltyStatistics data, response status code and response headers



6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
 
# File 'lib/talon_one/api/management_api.rb', line 6373

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] || 'LoyaltyStatistics' 

  # 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_notification_webhook(application_id, notification_webhook_id, opts = {}) ⇒ NotificationWebhook

Get notification about campaign-related changes Return the given [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications).

Parameters:

  • application_id (Integer) —

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

  • notification_webhook_id (Integer) —

    The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.

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

    the optional parameters

Returns:



6426
6427
6428
6429
 
# File 'lib/talon_one/api/management_api.rb', line 6426

def get_notification_webhook(application_id, notification_webhook_id, opts = {})
  data, _status_code, _headers = get_notification_webhook_with_http_info(application_id, notification_webhook_id, opts)
  data
end

#get_notification_webhook_with_http_info(application_id, notification_webhook_id, opts = {}) ⇒ Array<(NotificationWebhook, Integer, Hash)>

Get notification about campaign-related changes Return the given [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications).

Parameters:

  • application_id (Integer) —

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

  • notification_webhook_id (Integer) —

    The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.

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

    the optional parameters

Returns:

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

    NotificationWebhook data, response status code and response headers



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
6485
6486
 
# File 'lib/talon_one/api/management_api.rb', line 6437

def get_notification_webhook_with_http_info(application_id, notification_webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_notification_webhook ...'
  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_notification_webhook"
  end
  # verify the required parameter 'notification_webhook_id' is set
  if @api_client.config.client_side_validation && notification_webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_webhook_id' when calling ManagementApi.get_notification_webhook"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'notificationWebhookId' + '}', CGI.escape(notification_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] || 'NotificationWebhook' 

  # 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_notification_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_webhooks(application_id, opts = {}) ⇒ InlineResponse2005

List notifications about campaign-related changes List all [notifications about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications) for the 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

Returns:



6493
6494
6495
6496
 
# File 'lib/talon_one/api/management_api.rb', line 6493

def get_notification_webhooks(application_id, opts = {})
  data, _status_code, _headers = get_notification_webhooks_with_http_info(application_id, opts)
  data
end

#get_notification_webhooks_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>

List notifications about campaign-related changes List all [notifications about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications) for the 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

Returns:

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

    InlineResponse2005 data, response status code and response headers



6503
6504
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
 
# File 'lib/talon_one/api/management_api.rb', line 6503

def get_notification_webhooks_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_notification_webhooks ...'
  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_notification_webhooks"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/notification_webhooks'.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] || 'InlineResponse2005' 

  # 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_notification_webhooks\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 = {}) ⇒ InlineResponse2009

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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:



6565
6566
6567
6568
 
# File 'lib/talon_one/api/management_api.rb', line 6565

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<(InlineResponse2009, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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<(InlineResponse2009, Integer, Hash)>) —

    InlineResponse2009 data, response status code and response headers



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
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
 
# File 'lib/talon_one/api/management_api.rb', line 6585

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] || '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_referrals_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_role(role_id, opts = {}) ⇒ Role

Get role Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles).

Parameters:

  • role_id (Integer) —

    The Id of role.

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

    the optional parameters

Returns:



6666
6667
6668
6669
 
# File 'lib/talon_one/api/management_api.rb', line 6666

def get_role(role_id, opts = {})
  data, _status_code, _headers = get_role_with_http_info(role_id, opts)
  data
end

#get_role_with_http_info(role_id, opts = {}) ⇒ Array<(Role, Integer, Hash)>

Get role Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles).

Parameters:

  • role_id (Integer) —

    The Id of role.

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

    the optional parameters

Returns:

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

    Role data, response status code and response headers



6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
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
 
# File 'lib/talon_one/api/management_api.rb', line 6676

def get_role_with_http_info(role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.get_role ...'
  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"
  end
  # resource path
  local_var_path = '/v1/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] || 'Role' 

  # 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\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:



6730
6731
6732
6733
 
# File 'lib/talon_one/api/management_api.rb', line 6730

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



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
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
 
# File 'lib/talon_one/api/management_api.rb', line 6742

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 = {}) ⇒ InlineResponse2006

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



6806
6807
6808
6809
 
# File 'lib/talon_one/api/management_api.rb', line 6806

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<(InlineResponse2006, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse2006 data, response status code and response headers



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
6873
6874
6875
6876
6877
6878
6879
6880
 
# File 'lib/talon_one/api/management_api.rb', line 6820

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] || 'InlineResponse2006' 

  # 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_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:



6887
6888
6889
6890
 
# File 'lib/talon_one/api/management_api.rb', line 6887

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



6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
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
 
# File 'lib/talon_one/api/management_api.rb', line 6897

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 = {}) ⇒ InlineResponse20037

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:



6951
6952
6953
6954
 
# File 'lib/talon_one/api/management_api.rb', line 6951

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

#get_users_with_http_info(opts = {}) ⇒ Array<(InlineResponse20037, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

Returns:

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

    InlineResponse20037 data, response status code and response headers



6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
 
# File 'lib/talon_one/api/management_api.rb', line 6963

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] || '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#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:



7022
7023
7024
7025
 
# File 'lib/talon_one/api/management_api.rb', line 7022

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 = {}) ⇒ InlineResponse20034

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :integration_request_uuid (String) —

    Filter results by integration request UUID.

  • :webhook_id (Float) —

    Filter results by Webhook.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign.

  • :created_before (DateTime) —

    Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.

Returns:



7092
7093
7094
7095
 
# File 'lib/talon_one/api/management_api.rb', line 7092

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<(InlineResponse20034, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :integration_request_uuid (String) —

    Filter results by integration request UUID.

  • :webhook_id (Float) —

    Filter results by Webhook.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign.

  • :created_before (DateTime) —

    Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.

  • :created_after (DateTime) —

    Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.

Returns:

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

    InlineResponse20034 data, response status code and response headers



7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
 
# File 'lib/talon_one/api/management_api.rb', line 7110

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] || '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_webhook_activation_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_logs(opts = {}) ⇒ InlineResponse20035

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :status (String) —

    Filter results by HTTP status codes.

  • :webhook_id (Float) —

    Filter results by Webhook.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign.

  • :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 timezone. 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 timezone. Talon.One will convert to UTC internally.

Returns:



7184
7185
7186
7187
 
# File 'lib/talon_one/api/management_api.rb', line 7184

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<(InlineResponse20035, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :status (String) —

    Filter results by HTTP status codes.

  • :webhook_id (Float) —

    Filter results by Webhook.

  • :application_id (Float) —

    Filter results by Application ID.

  • :campaign_id (Float) —

    Filter results by campaign.

  • :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 timezone. 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 timezone. Talon.One will convert to UTC internally.

Returns:

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

    InlineResponse20035 data, response status code and response headers



7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
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
 
# File 'lib/talon_one/api/management_api.rb', line 7203

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] || '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_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



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
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
 
# File 'lib/talon_one/api/management_api.rb', line 7032

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 = {}) ⇒ InlineResponse20033

List webhooks List all webhooks.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :application_ids (String) —

    Filter by one or more application IDs separated by a comma.

  • :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: This parameter works only with numeric fields.

  • :page_size (Integer) —

    The number of items in this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:



7276
7277
7278
7279
 
# File 'lib/talon_one/api/management_api.rb', line 7276

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

#get_webhooks_with_http_info(opts = {}) ⇒ Array<(InlineResponse20033, Integer, Hash)>

List webhooks List all webhooks.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :application_ids (String) —

    Filter by one or more application IDs separated by a comma.

  • :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: This parameter works only with numeric fields.

  • :page_size (Integer) —

    The number of items in this response.

  • :skip (Integer) —

    Skips the given number of items when paging through large result sets.

Returns:

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

    InlineResponse20033 data, response status code and response headers



7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
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
 
# File 'lib/talon_one/api/management_api.rb', line 7289

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

  # 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?

  # 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_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 in 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:



7350
7351
7352
7353
 
# File 'lib/talon_one/api/management_api.rb', line 7350

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 in 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
 
# File 'lib/talon_one/api/management_api.rb', line 7361

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 with the information about the data that should be imported.

Returns:



7417
7418
7419
7420
 
# File 'lib/talon_one/api/management_api.rb', line 7417

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 with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
 
# File 'lib/talon_one/api/management_api.rb', line 7428

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_collection(application_id, campaign_id, collection_id, opts = {}) ⇒ Import

Import data in existing 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:



7486
7487
7488
7489
 
# File 'lib/talon_one/api/management_api.rb', line 7486

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 in existing 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 collection in account](#operation/listCollectionsInApplication) endpoint.

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

    the optional parameters

Options Hash (opts):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



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
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
 
# File 'lib/talon_one/api/management_api.rb', line 7499

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 customer who receives the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `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 referral attribute names and their values. Double the double-quotes in the object. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the coupon entity, set it with `"""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):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:



7564
7565
7566
7567
 
# File 'lib/talon_one/api/management_api.rb', line 7564

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 customer who receives the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - &#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 referral attribute names and their values. Double the double-quotes in the object. For example, if you created a [custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;category&#x60; associated to the coupon entity, set it with &#x60;&quot;&quot;&quot;10_off&quot;&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):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



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
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
 
# File 'lib/talon_one/api/management_api.rb', line 7576

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] || {}

  # 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. 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 with the information about the data that should be imported.

Returns:



7636
7637
7638
7639
 
# File 'lib/talon_one/api/management_api.rb', line 7636

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. 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 with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



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
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
 
# File 'lib/talon_one/api/management_api.rb', line 7647

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_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 loyalty program type, you can import the points into a given customer profile or into a given active 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. - `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`: The earliest date when the points can be redeemed. On this date and until the expiration date, the points are `active`. - `expirydate`: The latest date when the points can be redeemed. After this date, the points are `expired`. - `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):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:



7703
7704
7705
7706
 
# File 'lib/talon_one/api/management_api.rb', line 7703

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 loyalty program type, you can import the points into a given customer profile or into a given active 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. - &#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;: The earliest date when the points can be redeemed. On this date and until the expiration date, the points are &#x60;active&#x60;. - &#x60;expirydate&#x60;: The latest date when the points can be redeemed. After this date, the points are &#x60;expired&#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):

  • :up_file (String) —

    The file with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



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
 
# File 'lib/talon_one/api/management_api.rb', line 7714

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] || {}

  # 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. Double the double-quotes in the object. For example, if you [created a custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated to the giveaway entity, set it with `"""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 of your choice. It is converted to UTC internally by Talon.One. Note: We recommend limiting your file size to 500MB. 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 with the information about the data that should be imported.

Returns:



7770
7771
7772
7773
 
# File 'lib/talon_one/api/management_api.rb', line 7770

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. Double the double-quotes in the object. For example, if you [created a custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;provider&#x60; associated to the giveaway entity, set it with &#x60;&quot;&quot;&quot;myPartnerCompany&quot;&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 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 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 with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
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
 
# File 'lib/talon_one/api/management_api.rb', line 7781

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. Double the double-quotes in the object. For example, if you [created a custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the referral entity, set it with `"""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 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 with the information about the data that should be imported.

Returns:



7838
7839
7840
7841
 
# File 'lib/talon_one/api/management_api.rb', line 7838

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. Double the double-quotes in the object. For example, if you [created a custom attribute](docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;category&#x60; associated to the referral entity, set it with &#x60;&quot;&quot;&quot;10_off&quot;&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 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 with the information about the data that should be imported.

Returns:

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

    Import data, response status code and response headers



7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
 
# File 'lib/talon_one/api/management_api.rb', line 7850

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

#list_account_collections(opts = {}) ⇒ InlineResponse20015

List collections in account List collections in account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 the name of the Collection.

Returns:



7913
7914
7915
7916
 
# File 'lib/talon_one/api/management_api.rb', line 7913

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

#list_account_collections_with_http_info(opts = {}) ⇒ Array<(InlineResponse20015, Integer, Hash)>

List collections in account List collections in account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of items in this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 the name of the Collection.

Returns:

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

    InlineResponse20015 data, response status code and response headers



7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
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
 
# File 'lib/talon_one/api/management_api.rb', line 7927

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] || '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#list_account_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_collections(application_id, campaign_id, opts = {}) ⇒ InlineResponse20017

List collections List collections in 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):

  • :page_size (Integer) —

    The number of items in this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 the name of the Collection.

Returns:



7994
7995
7996
7997
 
# File 'lib/talon_one/api/management_api.rb', line 7994

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 = {}) ⇒ InlineResponse20017

List collections in application List collections from all campaigns in the 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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 the name of the Collection.

Returns:



8084
8085
8086
8087
 
# File 'lib/talon_one/api/management_api.rb', line 8084

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<(InlineResponse20017, Integer, Hash)>

List collections in application List collections from all campaigns in the 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 the name of the Collection.

Returns:

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

    InlineResponse20017 data, response status code and response headers



8099
8100
8101
8102
8103
8104
8105
8106
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
8149
8150
8151
8152
8153
8154
8155
8156
8157
 
# File 'lib/talon_one/api/management_api.rb', line 8099

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] || '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#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<(InlineResponse20017, Integer, Hash)>

List collections List collections in 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):

  • :page_size (Integer) —

    The number of items in this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 the name of the Collection.

Returns:

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

    InlineResponse20017 data, response status code and response headers



8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
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
 
# File 'lib/talon_one/api/management_api.rb', line 8010

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] || '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#list_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_added_deducted_points_notification(loyalty_program_id, body, opts = {}) ⇒ BaseNotification

Create notification about added or deducted loyalty points Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing notifications](docs.talon.one/docs/product/loyalty-programs/managing-notifications).

Parameters:

Returns:



8165
8166
8167
8168
 
# File 'lib/talon_one/api/management_api.rb', line 8165

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

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

Create notification about added or deducted loyalty points Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing notifications](docs.talon.one/docs/product/loyalty-programs/managing-notifications).

Parameters:

Returns:

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

    BaseNotification data, response status code and response headers



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
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
 
# File 'lib/talon_one/api/management_api.rb', line 8176

def post_added_deducted_points_notification_with_http_info(loyalty_program_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.post_added_deducted_points_notification ...'
  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.post_added_deducted_points_notification"
  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.post_added_deducted_points_notification"
  end
  # resource path
  local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points'.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] || 'BaseNotification' 

  # 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#post_added_deducted_points_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_catalogs_strikethrough_notification(application_id, body, opts = {}) ⇒ BaseNotification

Create strikethrough notification Create a notification for the in the given Application. For more information, see [Managing notifications](docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](docs.talon.one/outbound-notifications) you will receive.

Parameters:

  • application_id (Integer) —

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

  • body (NewBaseNotification) —

    body

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

    the optional parameters

Returns:



8235
8236
8237
8238
 
# File 'lib/talon_one/api/management_api.rb', line 8235

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

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

Create strikethrough notification Create a notification for the in the given Application. For more information, see [Managing notifications](docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](docs.talon.one/outbound-notifications) you will receive.

Parameters:

  • application_id (Integer) —

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

  • body (NewBaseNotification) —

    body

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

    the optional parameters

Returns:

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

    BaseNotification data, response status code and response headers



8246
8247
8248
8249
8250
8251
8252
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
 
# File 'lib/talon_one/api/management_api.rb', line 8246

def post_catalogs_strikethrough_notification_with_http_info(application_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.post_catalogs_strikethrough_notification ...'
  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.post_catalogs_strikethrough_notification"
  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.post_catalogs_strikethrough_notification"
  end
  # resource path
  local_var_path = '/v1/catalogs/{applicationId}/notifications/strikethrough'.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] || 'BaseNotification' 

  # 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#post_catalogs_strikethrough_notification\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. 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 identifier of the profile.

  • body (DeductLoyaltyPoints) —

    body

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

    the optional parameters

Returns:

  • (nil) 


8306
8307
8308
8309
 
# File 'lib/talon_one/api/management_api.rb', line 8306

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. 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 identifier of the profile.

  • body (DeductLoyaltyPoints) —

    body

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
 
# File 'lib/talon_one/api/management_api.rb', line 8318

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:



8380
8381
8382
8383
 
# File 'lib/talon_one/api/management_api.rb', line 8380

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



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
8437
 
# File 'lib/talon_one/api/management_api.rb', line 8390

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

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

List coupons that match the given attributes (without total count) List the coupons whose attributes match the query criteria in all active 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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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. - &#x60;draft&#x60;: Campaigns that are drafts.

Returns:



8458
8459
8460
8461
 
# File 'lib/talon_one/api/management_api.rb', line 8458

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<(InlineResponse2008, Integer, Hash)>

List coupons that match the given attributes (without total count) List the coupons whose attributes match the query criteria in all active 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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. - &#x60;draft&#x60;: Campaigns that are drafts.

Returns:

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

    InlineResponse2008 data, response status code and response headers



8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
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
 
# File 'lib/talon_one/api/management_api.rb', line 8482

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", "draft", "scheduled", "running", "expired"]
  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] || '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#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 = {}) ⇒ InlineResponse2008

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 this response. (default to 1000)

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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:



8587
8588
8589
8590
 
# File 'lib/talon_one/api/management_api.rb', line 8587

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<(InlineResponse2008, 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 this response.

  • :skip (Integer) —

    Skips the given number of items 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: This parameter works only with numeric fields.

  • :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 timezone. 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 timezone. 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<(InlineResponse2008, Integer, Hash)>) —

    InlineResponse2008 data, response status code and response headers



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
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
 
# File 'lib/talon_one/api/management_api.rb', line 8611

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] || '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#search_coupons_advanced_without_total_count\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) 


8703
8704
8705
8706
 
# File 'lib/talon_one/api/management_api.rb', line 8703

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



8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
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
 
# File 'lib/talon_one/api/management_api.rb', line 8715

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 the 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 collection in account](#operation/listCollectionsInApplication) endpoint.

  • body (UpdateCollection) —

    body

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

    the optional parameters

Returns:



8782
8783
8784
8785
 
# File 'lib/talon_one/api/management_api.rb', line 8782

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 the 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 collection in account](#operation/listCollectionsInApplication) endpoint.

  • body (UpdateCollection) —

    body

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

    the optional parameters

Returns:

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

    Collection data, response status code and response headers



8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
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
 
# File 'lib/talon_one/api/management_api.rb', line 8793

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_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 can be changed is the title (human readable description). 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:



8852
8853
8854
8855
 
# File 'lib/talon_one/api/management_api.rb', line 8852

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 can be changed is the title (human readable description). 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



8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
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
 
# File 'lib/talon_one/api/management_api.rb', line 8863

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:



8922
8923
8924
8925
 
# File 'lib/talon_one/api/management_api.rb', line 8922

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



8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
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
 
# File 'lib/talon_one/api/management_api.rb', line 8933

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.

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:



8993
8994
8995
8996
 
# File 'lib/talon_one/api/management_api.rb', line 8993

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.

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



9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
 
# File 'lib/talon_one/api/management_api.rb', line 9005

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 collection description Edit the description of 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 collection in account](#operation/listCollectionsInApplication) endpoint.

  • body (UpdateCampaignCollection) —

    body

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

    the optional parameters

Returns:



9070
9071
9072
9073
 
# File 'lib/talon_one/api/management_api.rb', line 9070

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 collection description Edit the description of 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 collection in account](#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



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
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
 
# File 'lib/talon_one/api/management_api.rb', line 9083

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 only, any property you do not explicitly set in your request will be 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:



9152
9153
9154
9155
 
# File 'lib/talon_one/api/management_api.rb', line 9152

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 a campaign. You can find the ‘batchId` in the Coupons view of your Application 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 timeout after 30 minutes. If you hit a timeout, reach out to our support team.</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) 


9233
9234
9235
9236
 
# File 'lib/talon_one/api/management_api.rb', line 9233

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 a campaign. You can find the &#x60;batchId&#x60; in the Coupons view of your Application 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 timeout after 30 minutes. If you hit a timeout, reach out to our support team.&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



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
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
 
# File 'lib/talon_one/api/management_api.rb', line 9245

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 PUT endpoint only, any property you do not explicitly set in your request will be 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



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
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
 
# File 'lib/talon_one/api/management_api.rb', line 9165

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:



9307
9308
9309
9310
 
# File 'lib/talon_one/api/management_api.rb', line 9307

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



9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
 
# File 'lib/talon_one/api/management_api.rb', line 9319

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_notification_webhook(application_id, notification_webhook_id, body, opts = {}) ⇒ NotificationWebhook

Update notification about campaign-related changes Update the given [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications). Tip: You can review the payload you will receive in the [specs](docs.talon.one/outbound-notifications#/paths/campaign_edited/post).

Parameters:

  • application_id (Integer) —

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

  • notification_webhook_id (Integer) —

    The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.

  • body (NewNotificationWebhook) —

    body

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

    the optional parameters

Returns:



9387
9388
9389
9390
 
# File 'lib/talon_one/api/management_api.rb', line 9387

def update_notification_webhook(application_id, notification_webhook_id, body, opts = {})
  data, _status_code, _headers = update_notification_webhook_with_http_info(application_id, notification_webhook_id, body, opts)
  data
end

#update_notification_webhook_with_http_info(application_id, notification_webhook_id, body, opts = {}) ⇒ Array<(NotificationWebhook, Integer, Hash)>

Update notification about campaign-related changes Update the given [notification about campaign-related changes](docs.talon.one/docs/product/applications/outbound-notifications). Tip: You can review the payload you will receive in the [specs](docs.talon.one/outbound-notifications#/paths/campaign_edited/post).

Parameters:

  • application_id (Integer) —

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

  • notification_webhook_id (Integer) —

    The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.

  • body (NewNotificationWebhook) —

    body

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

    the optional parameters

Returns:

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

    NotificationWebhook data, response status code and response headers



9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
 
# File 'lib/talon_one/api/management_api.rb', line 9399

def update_notification_webhook_with_http_info(application_id, notification_webhook_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManagementApi.update_notification_webhook ...'
  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_notification_webhook"
  end
  # verify the required parameter 'notification_webhook_id' is set
  if @api_client.config.client_side_validation && notification_webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'notification_webhook_id' when calling ManagementApi.update_notification_webhook"
  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_notification_webhook"
  end
  # resource path
  local_var_path = '/v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'notificationWebhookId' + '}', CGI.escape(notification_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'])
  # 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] || 'NotificationWebhook' 

  # 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_notification_webhook\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:



9464
9465
9466
9467
 
# File 'lib/talon_one/api/management_api.rb', line 9464

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



9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
 
# File 'lib/talon_one/api/management_api.rb', line 9477

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