Class: ConnectWise::CompanySitesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompanySitesApi

Returns a new instance of CompanySitesApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Get Sites Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def company_companies_id_sites_count_get(id, opts = {})
  data, _status_code, _headers = company_companies_id_sites_count_get_with_http_info(id, opts)
  return data
end

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

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



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/company_sites_api.rb', line 29

def company_companies_id_sites_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanySitesApi.company_companies_id_sites_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 CompanySitesApi.company_companies_id_sites_count_get"
  end
  # resource path
  local_var_path = "/company/companies/{id}/sites/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: CompanySitesApi#company_companies_id_sites_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_companies_id_sites_get(id, opts = {}) ⇒ Array<CompanySite>

Get Sites

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:



79
80
81
82
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 79

def company_companies_id_sites_get(id, opts = {})
  data, _status_code, _headers = company_companies_id_sites_get_with_http_info(id, opts)
  return data
end

#company_companies_id_sites_get_with_http_info(id, opts = {}) ⇒ Array<(Array<CompanySite>, Fixnum, Hash)>

Get Sites

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<CompanySite>, Fixnum, Hash)>) —

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



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
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 95

def company_companies_id_sites_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanySitesApi.company_companies_id_sites_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 CompanySitesApi.company_companies_id_sites_get"
  end
  # resource path
  local_var_path = "/company/companies/{id}/sites".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<CompanySite>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanySitesApi#company_companies_id_sites_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_companies_id_sites_post(id, site, opts = {}) ⇒ CompanySite

Create Site

Parameters:

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 145

def company_companies_id_sites_post(id, site, opts = {})
  data, _status_code, _headers = company_companies_id_sites_post_with_http_info(id, site, opts)
  return data
end

#company_companies_id_sites_post_with_http_info(id, site, opts = {}) ⇒ Array<(CompanySite, Fixnum, Hash)>

Create Site

Parameters:

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

    the optional parameters

Returns:

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

    CompanySite data, response status code and response headers



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
193
194
195
196
197
198
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 156

def company_companies_id_sites_post_with_http_info(id, site, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanySitesApi.company_companies_id_sites_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 CompanySitesApi.company_companies_id_sites_post"
  end
  # verify the required parameter 'site' is set
  if @api_client.config.client_side_validation && site.nil?
    fail ArgumentError, "Missing the required parameter 'site' when calling CompanySitesApi.company_companies_id_sites_post"
  end
  # resource path
  local_var_path = "/company/companies/{id}/sites".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(site)
  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 => 'CompanySite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanySitesApi#company_companies_id_sites_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_companies_id_sites_site_id_delete(id, site_id, opts = {}) ⇒ nil

Delete Site By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


206
207
208
209
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 206

def company_companies_id_sites_site_id_delete(id, site_id, opts = {})
  company_companies_id_sites_site_id_delete_with_http_info(id, site_id, opts)
  return nil
end

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

Delete Site By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def company_companies_id_sites_site_id_delete_with_http_info(id, site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanySitesApi.company_companies_id_sites_site_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 CompanySitesApi.company_companies_id_sites_site_id_delete"
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling CompanySitesApi.company_companies_id_sites_site_id_delete"
  end
  # resource path
  local_var_path = "/company/companies/{id}/sites/{siteId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'siteId' + '}', site_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: CompanySitesApi#company_companies_id_sites_site_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_companies_id_sites_site_id_get(id, site_id, opts = {}) ⇒ CompanySite

Get Site By Id

Parameters:

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 262

def company_companies_id_sites_site_id_get(id, site_id, opts = {})
  data, _status_code, _headers = company_companies_id_sites_site_id_get_with_http_info(id, site_id, opts)
  return data
end

#company_companies_id_sites_site_id_get_with_http_info(id, site_id, opts = {}) ⇒ Array<(CompanySite, Fixnum, Hash)>

Get Site By Id

Parameters:

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

    the optional parameters

Returns:

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

    CompanySite data, response status code and response headers



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 273

def company_companies_id_sites_site_id_get_with_http_info(id, site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanySitesApi.company_companies_id_sites_site_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 CompanySitesApi.company_companies_id_sites_site_id_get"
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling CompanySitesApi.company_companies_id_sites_site_id_get"
  end
  # resource path
  local_var_path = "/company/companies/{id}/sites/{siteId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'siteId' + '}', site_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 => 'CompanySite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanySitesApi#company_companies_id_sites_site_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_companies_id_sites_site_id_patch(id, site_id, operations, opts = {}) ⇒ CompanySite

Update Site

Parameters:

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

    the optional parameters

Returns:



322
323
324
325
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 322

def company_companies_id_sites_site_id_patch(id, site_id, operations, opts = {})
  data, _status_code, _headers = company_companies_id_sites_site_id_patch_with_http_info(id, site_id, operations, opts)
  return data
end

#company_companies_id_sites_site_id_patch_with_http_info(id, site_id, operations, opts = {}) ⇒ Array<(CompanySite, Fixnum, Hash)>

Update Site

Parameters:

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

    the optional parameters

Returns:

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

    CompanySite data, response status code and response headers



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

def company_companies_id_sites_site_id_patch_with_http_info(id, site_id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanySitesApi.company_companies_id_sites_site_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 CompanySitesApi.company_companies_id_sites_site_id_patch"
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling CompanySitesApi.company_companies_id_sites_site_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 CompanySitesApi.company_companies_id_sites_site_id_patch"
  end
  # resource path
  local_var_path = "/company/companies/{id}/sites/{siteId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'siteId' + '}', site_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 => 'CompanySite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanySitesApi#company_companies_id_sites_site_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_companies_id_sites_site_id_put(id, site_id, site, opts = {}) ⇒ CompanySite

Replace Site

Parameters:

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

    the optional parameters

Returns:



389
390
391
392
 
# File 'lib/connectwise-ruby-sdk/api/company_sites_api.rb', line 389

def company_companies_id_sites_site_id_put(id, site_id, site, opts = {})
  data, _status_code, _headers = company_companies_id_sites_site_id_put_with_http_info(id, site_id, site, opts)
  return data
end

#company_companies_id_sites_site_id_put_with_http_info(id, site_id, site, opts = {}) ⇒ Array<(CompanySite, Fixnum, Hash)>

Replace Site

Parameters:

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

    the optional parameters

Returns:

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

    CompanySite data, response status code and response headers



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

def company_companies_id_sites_site_id_put_with_http_info(id, site_id, site, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanySitesApi.company_companies_id_sites_site_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 CompanySitesApi.company_companies_id_sites_site_id_put"
  end
  # verify the required parameter 'site_id' is set
  if @api_client.config.client_side_validation && site_id.nil?
    fail ArgumentError, "Missing the required parameter 'site_id' when calling CompanySitesApi.company_companies_id_sites_site_id_put"
  end
  # verify the required parameter 'site' is set
  if @api_client.config.client_side_validation && site.nil?
    fail ArgumentError, "Missing the required parameter 'site' when calling CompanySitesApi.company_companies_id_sites_site_id_put"
  end
  # resource path
  local_var_path = "/company/companies/{id}/sites/{siteId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'siteId' + '}', site_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(site)
  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 => 'CompanySite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanySitesApi#company_companies_id_sites_site_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end