Class: ConnectWise::CampaignsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-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.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 8

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#marketing_campaigns_count_get(opts = {}) ⇒ Count

Get Campaigns Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



17
18
19
20
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 17

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

#marketing_campaigns_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Campaigns Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

  • (Array<(Count, Fixnum, Hash)>) —

    Count data, response status code and response headers



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 27

def marketing_campaigns_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_count_get ..."
  end
  # resource path
  local_var_path = "/marketing/campaigns/count"

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_get(opts = {}) ⇒ Array<Campaign>

Get Campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



72
73
74
75
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 72

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

#marketing_campaigns_get_with_http_info(opts = {}) ⇒ Array<(Array<Campaign>, Fixnum, Hash)>

Get Campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 87

def marketing_campaigns_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_get ..."
  end
  # resource path
  local_var_path = "/marketing/campaigns"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Campaign>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_activities_count_get(id, opts = {}) ⇒ Count

Get Campaign Activities Count

Parameters:

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

    the optional parameters

Returns:



132
133
134
135
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 132

def marketing_campaigns_id_activities_count_get(id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_activities_count_get_with_http_info(id, opts)
  return data
end

#marketing_campaigns_id_activities_count_get_with_http_info(id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Campaign Activities Count

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Count, Fixnum, Hash)>) —

    Count data, response status code and response headers



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
177
178
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 142

def marketing_campaigns_id_activities_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_activities_count_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_activities_count_get"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/activities/count".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_activities_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_activities_get(id, opts = {}) ⇒ Array<ActivityReference>

Get Campaign Activities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



187
188
189
190
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 187

def marketing_campaigns_id_activities_get(id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_activities_get_with_http_info(id, opts)
  return data
end

#marketing_campaigns_id_activities_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ActivityReference>, Fixnum, Hash)>

Get Campaign Activities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

  • (Array<(Array<ActivityReference>, Fixnum, Hash)>) —

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



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
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 199

def marketing_campaigns_id_activities_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_activities_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_activities_get"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/activities".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<ActivityReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_activities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_delete(id, opts = {}) ⇒ nil

Delete Campaign By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


244
245
246
247
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 244

def marketing_campaigns_id_delete(id, opts = {})
  marketing_campaigns_id_delete_with_http_info(id, opts)
  return nil
end

#marketing_campaigns_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Campaign By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 254

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_get(id, opts = {}) ⇒ Campaign

Get Campaign By Id

Parameters:

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

    the optional parameters

Returns:



294
295
296
297
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 294

def marketing_campaigns_id_get(id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_get_with_http_info(id, opts)
  return data
end

#marketing_campaigns_id_get_with_http_info(id, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Get Campaign By Id

Parameters:

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



304
305
306
307
308
309
310
311
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
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 304

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_opportunities_count_get(id, opts = {}) ⇒ Count

Get Campaign Opportunities Count

Parameters:

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

    the optional parameters

Returns:



347
348
349
350
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 347

def marketing_campaigns_id_opportunities_count_get(id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_opportunities_count_get_with_http_info(id, opts)
  return data
end

#marketing_campaigns_id_opportunities_count_get_with_http_info(id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Campaign Opportunities Count

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Count, Fixnum, Hash)>) —

    Count data, response status code and response headers



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 357

def marketing_campaigns_id_opportunities_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_opportunities_count_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_opportunities_count_get"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/opportunities/count".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_opportunities_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_opportunities_get(id, opts = {}) ⇒ Array<OpportunityReference>

Get Campaign Opportunities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



402
403
404
405
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 402

def marketing_campaigns_id_opportunities_get(id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_opportunities_get_with_http_info(id, opts)
  return data
end

#marketing_campaigns_id_opportunities_get_with_http_info(id, opts = {}) ⇒ Array<(Array<OpportunityReference>, Fixnum, Hash)>

Get Campaign Opportunities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

  • (Array<(Array<OpportunityReference>, Fixnum, Hash)>) —

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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 414

def marketing_campaigns_id_opportunities_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_opportunities_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_opportunities_get"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/opportunities".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<OpportunityReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_opportunities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_patch(id, operations, opts = {}) ⇒ Campaign

Update Campaign

Parameters:

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

    the optional parameters

Returns:



460
461
462
463
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 460

def marketing_campaigns_id_patch(id, operations, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_patch_with_http_info(id, operations, opts)
  return data
end

#marketing_campaigns_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Update Campaign

Parameters:

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



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

def marketing_campaigns_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_patch ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_patch"
  end
  # verify the required parameter 'operations' is set
  if @api_client.config.client_side_validation && operations.nil?
    fail ArgumentError, "Missing the required parameter 'operations' when calling CampaignsApi.marketing_campaigns_id_patch"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(operations)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_put(id, campaign, opts = {}) ⇒ Campaign

Replace Campaign

Parameters:

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

    the optional parameters

Returns:



521
522
523
524
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 521

def marketing_campaigns_id_put(id, campaign, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_put_with_http_info(id, campaign, opts)
  return data
end

#marketing_campaigns_id_put_with_http_info(id, campaign, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Replace Campaign

Parameters:

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



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
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 532

def marketing_campaigns_id_put_with_http_info(id, campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignsApi.marketing_campaigns_id_put ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.marketing_campaigns_id_put"
  end
  # verify the required parameter 'campaign' is set
  if @api_client.config.client_side_validation && campaign.nil?
    fail ArgumentError, "Missing the required parameter 'campaign' when calling CampaignsApi.marketing_campaigns_id_put"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(campaign)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_post(campaign, opts = {}) ⇒ Campaign

Create Campaign

Parameters:

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

    the optional parameters

Returns:



581
582
583
584
 
# File 'lib/connectwise-ruby-sdk/api/campaigns_api.rb', line 581

def marketing_campaigns_post(campaign, opts = {})
  data, _status_code, _headers = marketing_campaigns_post_with_http_info(campaign, opts)
  return data
end

#marketing_campaigns_post_with_http_info(campaign, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Create Campaign

Parameters:

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



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/connectwise-ruby-sdk/api/campaigns_api.rb', line 591

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

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(campaign)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignsApi#marketing_campaigns_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end