Class: ConnectWise::CampaignAuditsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/campaign_audits_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CampaignAuditsApi

Returns a new instance of CampaignAuditsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_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/campaign_audits_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#marketing_campaigns_id_audits_audit_id_delete(id, audit_id, opts = {}) ⇒ nil

Delete Campaign Audit By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def marketing_campaigns_id_audits_audit_id_delete(id, audit_id, opts = {})
  marketing_campaigns_id_audits_audit_id_delete_with_http_info(id, audit_id, opts)
  return nil
end

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

Delete Campaign Audit By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
61
62
63
64
65
66
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 29

def marketing_campaigns_id_audits_audit_id_delete_with_http_info(id, audit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignAuditsApi.marketing_campaigns_id_audits_audit_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 CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_delete"
  end
  # verify the required parameter 'audit_id' is set
  if @api_client.config.client_side_validation && audit_id.nil?
    fail ArgumentError, "Missing the required parameter 'audit_id' when calling CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_delete"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/audits/{auditId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'auditId' + '}', audit_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: CampaignAuditsApi#marketing_campaigns_id_audits_audit_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_audits_audit_id_get(id, audit_id, opts = {}) ⇒ CampaignAudit

Get Campaign Audit By Id

Parameters:

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

    the optional parameters

Returns:



74
75
76
77
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 74

def marketing_campaigns_id_audits_audit_id_get(id, audit_id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_audits_audit_id_get_with_http_info(id, audit_id, opts)
  return data
end

#marketing_campaigns_id_audits_audit_id_get_with_http_info(id, audit_id, opts = {}) ⇒ Array<(CampaignAudit, Fixnum, Hash)>

Get Campaign Audit By Id

Parameters:

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

    the optional parameters

Returns:

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

    CampaignAudit data, response status code and response headers



85
86
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/campaign_audits_api.rb', line 85

def marketing_campaigns_id_audits_audit_id_get_with_http_info(id, audit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignAuditsApi.marketing_campaigns_id_audits_audit_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 CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_get"
  end
  # verify the required parameter 'audit_id' is set
  if @api_client.config.client_side_validation && audit_id.nil?
    fail ArgumentError, "Missing the required parameter 'audit_id' when calling CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_get"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/audits/{auditId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'auditId' + '}', audit_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 => 'CampaignAudit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignAuditsApi#marketing_campaigns_id_audits_audit_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_audits_audit_id_patch(id, audit_id, operations, opts = {}) ⇒ CampaignAudit

Update Campaign Audit

Parameters:

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

    the optional parameters

Returns:



134
135
136
137
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 134

def marketing_campaigns_id_audits_audit_id_patch(id, audit_id, operations, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_audits_audit_id_patch_with_http_info(id, audit_id, operations, opts)
  return data
end

#marketing_campaigns_id_audits_audit_id_patch_with_http_info(id, audit_id, operations, opts = {}) ⇒ Array<(CampaignAudit, Fixnum, Hash)>

Update Campaign Audit

Parameters:

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

    the optional parameters

Returns:

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

    CampaignAudit data, response status code and response headers



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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 146

def marketing_campaigns_id_audits_audit_id_patch_with_http_info(id, audit_id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignAuditsApi.marketing_campaigns_id_audits_audit_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 CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_patch"
  end
  # verify the required parameter 'audit_id' is set
  if @api_client.config.client_side_validation && audit_id.nil?
    fail ArgumentError, "Missing the required parameter 'audit_id' when calling CampaignAuditsApi.marketing_campaigns_id_audits_audit_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 CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_patch"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/audits/{auditId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'auditId' + '}', audit_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 => 'CampaignAudit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignAuditsApi#marketing_campaigns_id_audits_audit_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_audits_audit_id_put(id, audit_id, campaign_audit, opts = {}) ⇒ CampaignAudit

Replace Campaign Audit

Parameters:

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

    the optional parameters

Returns:



201
202
203
204
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 201

def marketing_campaigns_id_audits_audit_id_put(id, audit_id, campaign_audit, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_audits_audit_id_put_with_http_info(id, audit_id, campaign_audit, opts)
  return data
end

#marketing_campaigns_id_audits_audit_id_put_with_http_info(id, audit_id, campaign_audit, opts = {}) ⇒ Array<(CampaignAudit, Fixnum, Hash)>

Replace Campaign Audit

Parameters:

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

    the optional parameters

Returns:

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

    CampaignAudit data, response status code and response headers



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
253
254
255
256
257
258
259
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 213

def marketing_campaigns_id_audits_audit_id_put_with_http_info(id, audit_id, campaign_audit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignAuditsApi.marketing_campaigns_id_audits_audit_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 CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_put"
  end
  # verify the required parameter 'audit_id' is set
  if @api_client.config.client_side_validation && audit_id.nil?
    fail ArgumentError, "Missing the required parameter 'audit_id' when calling CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_put"
  end
  # verify the required parameter 'campaign_audit' is set
  if @api_client.config.client_side_validation && campaign_audit.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_audit' when calling CampaignAuditsApi.marketing_campaigns_id_audits_audit_id_put"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/audits/{auditId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'auditId' + '}', audit_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_audit)
  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 => 'CampaignAudit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignAuditsApi#marketing_campaigns_id_audits_audit_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Campaign Audits Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



267
268
269
270
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 267

def marketing_campaigns_id_audits_count_get(id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_audits_count_get_with_http_info(id, opts)
  return data
end

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

Get Campaign Audits Count

Parameters:

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



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

def marketing_campaigns_id_audits_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignAuditsApi.marketing_campaigns_id_audits_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 CampaignAuditsApi.marketing_campaigns_id_audits_count_get"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/audits/count".sub('{' + 'id' + '}', id.to_s)

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

#marketing_campaigns_id_audits_get(id, opts = {}) ⇒ Array<CampaignAudit>

Get Campaign Audits

Parameters:

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



328
329
330
331
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 328

def marketing_campaigns_id_audits_get(id, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_audits_get_with_http_info(id, opts)
  return data
end

#marketing_campaigns_id_audits_get_with_http_info(id, opts = {}) ⇒ Array<(Array<CampaignAudit>, Fixnum, Hash)>

Get Campaign Audits

Parameters:

  • id
  • 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<CampaignAudit>, Fixnum, Hash)>) —

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



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
381
382
383
384
385
386
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 344

def marketing_campaigns_id_audits_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignAuditsApi.marketing_campaigns_id_audits_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 CampaignAuditsApi.marketing_campaigns_id_audits_get"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/audits".sub('{' + 'id' + '}', id.to_s)

  # 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<CampaignAudit>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignAuditsApi#marketing_campaigns_id_audits_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#marketing_campaigns_id_audits_post(id, campaign_audit, opts = {}) ⇒ CampaignAudit

Create Campaign Audit

Parameters:

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

    the optional parameters

Returns:



394
395
396
397
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 394

def marketing_campaigns_id_audits_post(id, campaign_audit, opts = {})
  data, _status_code, _headers = marketing_campaigns_id_audits_post_with_http_info(id, campaign_audit, opts)
  return data
end

#marketing_campaigns_id_audits_post_with_http_info(id, campaign_audit, opts = {}) ⇒ Array<(CampaignAudit, Fixnum, Hash)>

Create Campaign Audit

Parameters:

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

    the optional parameters

Returns:

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

    CampaignAudit data, response status code and response headers



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/connectwise-ruby-sdk/api/campaign_audits_api.rb', line 405

def marketing_campaigns_id_audits_post_with_http_info(id, campaign_audit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CampaignAuditsApi.marketing_campaigns_id_audits_post ..."
  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 CampaignAuditsApi.marketing_campaigns_id_audits_post"
  end
  # verify the required parameter 'campaign_audit' is set
  if @api_client.config.client_side_validation && campaign_audit.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_audit' when calling CampaignAuditsApi.marketing_campaigns_id_audits_post"
  end
  # resource path
  local_var_path = "/marketing/campaigns/{id}/audits".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_audit)
  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 => 'CampaignAudit')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignAuditsApi#marketing_campaigns_id_audits_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end