Class: CropwisePlatformSdk::CampaignsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cropwise-platform-sdk/api/campaigns_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CampaignsApi

Returns a new instance of CampaignsApi.



19
20
21
 
# File 'lib/cropwise-platform-sdk/api/campaigns_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/cropwise-platform-sdk/api/campaigns_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_campaigns_campaign_id(campaign_id, opts = {}) ⇒ DeleteCampaignsCampaignId200Response

Delete Campaign Removes a single campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to remove

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 27

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

#delete_campaigns_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(DeleteCampaignsCampaignId200Response, Integer, Hash)>

Delete Campaign Removes a single campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to remove

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

    the optional parameters

Returns:



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

def delete_campaigns_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.delete_campaigns_campaign_id ...'
  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 CampaignsApi.delete_campaigns_campaign_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}'.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteCampaignsCampaignId200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.delete_campaigns_campaign_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#delete_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_v2_campaigns_campaign_id_shareable_link_link_id(campaign_id, link_id, opts = {}) ⇒ DeleteV2CampaignsCampaignIdShareableLinkLinkId200Response

Delete a Campaign Link by LinkId Removes a campaign link

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign

  • link_id (String) —

    Numeric ID of the campaign link to update

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 91

def delete_v2_campaigns_campaign_id_shareable_link_link_id(campaign_id, link_id, opts = {})
  data, _status_code, _headers = delete_v2_campaigns_campaign_id_shareable_link_link_id_with_http_info(campaign_id, link_id, opts)
  data
end

#delete_v2_campaigns_campaign_id_shareable_link_link_id_with_http_info(campaign_id, link_id, opts = {}) ⇒ Array<(DeleteV2CampaignsCampaignIdShareableLinkLinkId200Response, Integer, Hash)>

Delete a Campaign Link by LinkId Removes a campaign link

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign

  • link_id (String) —

    Numeric ID of the campaign link to update

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

    the optional parameters

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 102

def delete_v2_campaigns_campaign_id_shareable_link_link_id_with_http_info(campaign_id, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.delete_v2_campaigns_campaign_id_shareable_link_link_id ...'
  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 CampaignsApi.delete_v2_campaigns_campaign_id_shareable_link_link_id"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling CampaignsApi.delete_v2_campaigns_campaign_id_shareable_link_link_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/shareable-link/{linkId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'linkId' + '}', CGI.escape(link_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteV2CampaignsCampaignIdShareableLinkLinkId200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.delete_v2_campaigns_campaign_id_shareable_link_link_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#delete_v2_campaigns_campaign_id_shareable_link_link_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_plans_campaign_id(campaign_id, opts = {}) ⇒ Campaign

Add Plans to Campaigns Add a plan to a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to toggle activation

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

    the optional parameters

Options Hash (opts):

Returns:



160
161
162
163
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 160

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

#get_campaign_plans_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>

Add Plans to Campaigns Add a plan to a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to toggle activation

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Campaign data, response status code and response headers



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 171

def get_campaign_plans_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_plans_campaign_id ...'
  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 CampaignsApi.get_campaign_plans_campaign_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/plans'.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Campaign'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.get_campaign_plans_campaign_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#get_campaign_plans_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_vouchers_campaign_id(campaign_id, opts = {}) ⇒ PageableVouchers

Get Campaign Vouchers Get all vouchers from a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to get

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    Number of vouchers to return

  • :last_key (String) —

    Id of the last voucher returned by the previous query

Returns:



231
232
233
234
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 231

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

#get_campaign_vouchers_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(PageableVouchers, Integer, Hash)>

Get Campaign Vouchers Get all vouchers from a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to get

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    Number of vouchers to return

  • :last_key (String) —

    Id of the last voucher returned by the previous query

Returns:

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

    PageableVouchers data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 243

def get_campaign_vouchers_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_vouchers_campaign_id ...'
  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 CampaignsApi.get_campaign_vouchers_campaign_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/vouchers'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'last_key'] = opts[:'last_key'] if !opts[:'last_key'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageableVouchers'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.get_campaign_vouchers_campaign_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#get_campaign_vouchers_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns(opts = {}) ⇒ PageableCampaigns

Get all campaigns Get all campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    Number of campaigns to return

  • :last_key (String) —

    Id of the last campaign returned by the previous query

  • :name (String) —

    Name or name fragment of campaign name to filter

Returns:



300
301
302
303
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 300

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

#get_campaigns_campaign_id(campaign_id, opts = {}) ⇒ CampaignData

Get Campaign By Id Get a single campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to get

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

    the optional parameters

Returns:



364
365
366
367
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 364

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

#get_campaigns_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignData, Integer, Hash)>

Get Campaign By Id Get a single campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to get

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

    the optional parameters

Returns:

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

    CampaignData data, response status code and response headers



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 374

def get_campaigns_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns_campaign_id ...'
  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 CampaignsApi.get_campaigns_campaign_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}'.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CampaignData'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.get_campaigns_campaign_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#get_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns_with_http_info(opts = {}) ⇒ Array<(PageableCampaigns, Integer, Hash)>

Get all campaigns Get all campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    Number of campaigns to return

  • :last_key (String) —

    Id of the last campaign returned by the previous query

  • :name (String) —

    Name or name fragment of campaign name to filter

Returns:

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

    PageableCampaigns data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 312

def get_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns ...'
  end
  # resource path
  local_var_path = '/v2/campaigns'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'last_key'] = opts[:'last_key'] if !opts[:'last_key'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageableCampaigns'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.get_campaigns",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info(campaign_id, link_id, opts = {}) ⇒ RedeemInfoAppResponse

Get a redeem info from campaignId and shareable-link

Parameters:

  • campaign_id (String) —

    Campaign Id of the Campaign

  • link_id (String) —

    Shareable link Id

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

    the optional parameters

Returns:



427
428
429
430
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 427

def get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info(campaign_id, link_id, opts = {})
  data, _status_code, _headers = get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info_with_http_info(campaign_id, link_id, opts)
  data
end

#get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info_with_http_info(campaign_id, link_id, opts = {}) ⇒ Array<(RedeemInfoAppResponse, Integer, Hash)>

Get a redeem info from campaignId and shareable-link

Parameters:

  • campaign_id (String) —

    Campaign Id of the Campaign

  • link_id (String) —

    Shareable link Id

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

    the optional parameters

Returns:

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

    RedeemInfoAppResponse data, response status code and response headers



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
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
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 437

def get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info_with_http_info(campaign_id, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info ...'
  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 CampaignsApi.get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling CampaignsApi.get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/shareable-link/{linkId}/redeem-info'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'linkId' + '}', CGI.escape(link_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RedeemInfoAppResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#get_v2_campaigns_campaign_id_shareable_link_link_id_redeem_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_campaign_vouchers_campaign_id(campaign_id, post_campaign_vouchers_campaign_id_request, opts = {}) ⇒ Array<Voucher>

Add Vouchers to Campaign Add vouchers to a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to toggle activation

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

    the optional parameters

Returns:



495
496
497
498
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 495

def post_campaign_vouchers_campaign_id(campaign_id, post_campaign_vouchers_campaign_id_request, opts = {})
  data, _status_code, _headers = post_campaign_vouchers_campaign_id_with_http_info(campaign_id, post_campaign_vouchers_campaign_id_request, opts)
  data
end

#post_campaign_vouchers_campaign_id_with_http_info(campaign_id, post_campaign_vouchers_campaign_id_request, opts = {}) ⇒ Array<(Array<Voucher>, Integer, Hash)>

Add Vouchers to Campaign Add vouchers to a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to toggle activation

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

    the optional parameters

Returns:

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

    Array<Voucher> data, response status code and response headers



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
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
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 506

def post_campaign_vouchers_campaign_id_with_http_info(campaign_id, post_campaign_vouchers_campaign_id_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.post_campaign_vouchers_campaign_id ...'
  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 CampaignsApi.post_campaign_vouchers_campaign_id"
  end
  # verify the required parameter 'post_campaign_vouchers_campaign_id_request' is set
  if @api_client.config.client_side_validation && post_campaign_vouchers_campaign_id_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_campaign_vouchers_campaign_id_request' when calling CampaignsApi.post_campaign_vouchers_campaign_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/vouchers'.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Voucher>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.post_campaign_vouchers_campaign_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#post_campaign_vouchers_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_campaigns(post_campaigns_request, opts = {}) ⇒ Campaign

Create Campaign Creates a new campaign

Parameters:

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

    the optional parameters

Returns:



568
569
570
571
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 568

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

#post_campaigns_with_http_info(post_campaigns_request, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>

Create Campaign Creates a new campaign

Parameters:

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 578

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

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Campaign'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.post_campaigns",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#post_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_v2_campaigns_campaign_id_shareable_link(campaign_id, opts = {}) ⇒ PutV2CampaignsCampaignIdShareableLinkLinkId200Response

Create a Campaign Link Create a new Campaign Link to a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign where a new Campaign Link will be created

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

    the optional parameters

Options Hash (opts):

Returns:



637
638
639
640
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 637

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

#post_v2_campaigns_campaign_id_shareable_link_with_http_info(campaign_id, opts = {}) ⇒ Array<(PutV2CampaignsCampaignIdShareableLinkLinkId200Response, Integer, Hash)>

Create a Campaign Link Create a new Campaign Link to a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign where a new Campaign Link will be created

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

    the optional parameters

Options Hash (opts):

Returns:



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 648

def post_v2_campaigns_campaign_id_shareable_link_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.post_v2_campaigns_campaign_id_shareable_link ...'
  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 CampaignsApi.post_v2_campaigns_campaign_id_shareable_link"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/shareable-link'.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PutV2CampaignsCampaignIdShareableLinkLinkId200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.post_v2_campaigns_campaign_id_shareable_link",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#post_v2_campaigns_campaign_id_shareable_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_v2_vouchers_campaign_id_redeem_link_link_id(campaign_id, link_id, opts = {}) ⇒ RedeemVoucherResponse

Redeem Voucher Using a Campaign Link Redeem a voucher using a campaign link

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign

  • link_id (String) —

    Numeric ID of the campaign link used to redeem a voucher

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

    the optional parameters

Options Hash (opts):

Returns:



708
709
710
711
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 708

def post_v2_vouchers_campaign_id_redeem_link_link_id(campaign_id, link_id, opts = {})
  data, _status_code, _headers = post_v2_vouchers_campaign_id_redeem_link_link_id_with_http_info(campaign_id, link_id, opts)
  data
end

#post_v2_vouchers_campaign_id_redeem_link_link_id_with_http_info(campaign_id, link_id, opts = {}) ⇒ Array<(RedeemVoucherResponse, Integer, Hash)>

Redeem Voucher Using a Campaign Link Redeem a voucher using a campaign link

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign

  • link_id (String) —

    Numeric ID of the campaign link used to redeem a voucher

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RedeemVoucherResponse data, response status code and response headers



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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 720

def post_v2_vouchers_campaign_id_redeem_link_link_id_with_http_info(campaign_id, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.post_v2_vouchers_campaign_id_redeem_link_link_id ...'
  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 CampaignsApi.post_v2_vouchers_campaign_id_redeem_link_link_id"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling CampaignsApi.post_v2_vouchers_campaign_id_redeem_link_link_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/redeem-link/{linkId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'linkId' + '}', CGI.escape(link_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'RedeemVoucherResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.post_v2_vouchers_campaign_id_redeem_link_link_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#post_v2_vouchers_campaign_id_redeem_link_link_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_campaigns_campaign_id(campaign_id, put_campaigns_campaign_id_request, opts = {}) ⇒ Campaign

Edit Campaign Updates a single campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to update

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

    the optional parameters

Returns:



783
784
785
786
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 783

def put_campaigns_campaign_id(campaign_id, put_campaigns_campaign_id_request, opts = {})
  data, _status_code, _headers = put_campaigns_campaign_id_with_http_info(campaign_id, put_campaigns_campaign_id_request, opts)
  data
end

#put_campaigns_campaign_id_with_http_info(campaign_id, put_campaigns_campaign_id_request, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>

Edit Campaign Updates a single campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to update

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



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
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 794

def put_campaigns_campaign_id_with_http_info(campaign_id, put_campaigns_campaign_id_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.put_campaigns_campaign_id ...'
  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 CampaignsApi.put_campaigns_campaign_id"
  end
  # verify the required parameter 'put_campaigns_campaign_id_request' is set
  if @api_client.config.client_side_validation && put_campaigns_campaign_id_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_campaigns_campaign_id_request' when calling CampaignsApi.put_campaigns_campaign_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}'.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Campaign'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.put_campaigns_campaign_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#put_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_v2_campaigns_campaign_id_shareable_link_link_id(campaign_id, link_id, opts = {}) ⇒ PutV2CampaignsCampaignIdShareableLinkLinkId200Response

Edit Campaign Link Updates a Campaign Link

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign

  • link_id (String) —

    Numeric ID of the campaign link to update

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

    the optional parameters

Options Hash (opts):

Returns:



858
859
860
861
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 858

def put_v2_campaigns_campaign_id_shareable_link_link_id(campaign_id, link_id, opts = {})
  data, _status_code, _headers = put_v2_campaigns_campaign_id_shareable_link_link_id_with_http_info(campaign_id, link_id, opts)
  data
end

#put_v2_campaigns_campaign_id_shareable_link_link_id_with_http_info(campaign_id, link_id, opts = {}) ⇒ Array<(PutV2CampaignsCampaignIdShareableLinkLinkId200Response, Integer, Hash)>

Edit Campaign Link Updates a Campaign Link

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign

  • link_id (String) —

    Numeric ID of the campaign link to update

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

    the optional parameters

Options Hash (opts):

Returns:



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
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 870

def put_v2_campaigns_campaign_id_shareable_link_link_id_with_http_info(campaign_id, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.put_v2_campaigns_campaign_id_shareable_link_link_id ...'
  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 CampaignsApi.put_v2_campaigns_campaign_id_shareable_link_link_id"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling CampaignsApi.put_v2_campaigns_campaign_id_shareable_link_link_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/shareable-link/{linkId}'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'linkId' + '}', CGI.escape(link_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PutV2CampaignsCampaignIdShareableLinkLinkId200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.put_v2_campaigns_campaign_id_shareable_link_link_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#put_v2_campaigns_campaign_id_shareable_link_link_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#toggle_campaigns_campaign_id(campaign_id, opts = {}) ⇒ Campaign

Toggle Campaign Activation Toggles the activation of a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to toggle activation

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

    the optional parameters

Returns:



932
933
934
935
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 932

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

#toggle_campaigns_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>

Toggle Campaign Activation Toggles the activation of a campaign

Parameters:

  • campaign_id (String) —

    Numeric ID of the campaign to toggle activation

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
 
# File 'lib/cropwise-platform-sdk/api/campaigns_api.rb', line 942

def toggle_campaigns_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignsApi.toggle_campaigns_campaign_id ...'
  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 CampaignsApi.toggle_campaigns_campaign_id"
  end
  # resource path
  local_var_path = '/v2/campaigns/{campaignId}/activation-toggle'.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Campaign'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignsApi.toggle_campaigns_campaign_id",
    :header_params => header_params,
    :query_params => query_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: CampaignsApi#toggle_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end