Class: ConnectWise::ContactsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactsApi

Returns a new instance of ContactsApi.



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

def api_client
  @api_client
end

Instance Method Details

#company_contacts_count_get(opts = {}) ⇒ Count

Get Contacts Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)
  • :child_conditions (String)

Returns:



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

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

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

Get Contacts Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)
  • :child_conditions (String)

Returns:

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

    Count data, response status code and response headers



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/contacts_api.rb', line 31

def company_contacts_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_count_get ..."
  end
  # resource path
  local_var_path = "/company/contacts/count"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'customFieldConditions'] = opts[:'custom_field_conditions'] if !opts[:'custom_field_conditions'].nil?
  query_params[:'childConditions'] = opts[:'child_conditions'] if !opts[:'child_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: ContactsApi#company_contacts_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_contacts_get(opts = {}) ⇒ Array<Contact>

Get Contacts

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:



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

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

#company_contacts_get_with_http_info(opts = {}) ⇒ Array<(Array<Contact>, Fixnum, Hash)>

Get Contacts

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

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



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
126
127
128
129
130
131
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 93

def company_contacts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_get ..."
  end
  # resource path
  local_var_path = "/company/contacts"

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

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

Delete Contact By Id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :transfer_contact_id (Integer)

Returns:

  • (nil) 


139
140
141
142
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 139

def company_contacts_id_delete(id, opts = {})
  company_contacts_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Contact By Id

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :transfer_contact_id (Integer)

Returns:

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

    nil, response status code and response headers



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

def company_contacts_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_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 ContactsApi.company_contacts_id_delete"
  end
  # resource path
  local_var_path = "/company/contacts/{id}".sub('{' + 'id' + '}', id.to_s)

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

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

#company_contacts_id_get(id, opts = {}) ⇒ Contact

Get Contact By Id

Parameters:

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

    the optional parameters

Returns:



191
192
193
194
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 191

def company_contacts_id_get(id, opts = {})
  data, _status_code, _headers = company_contacts_id_get_with_http_info(id, opts)
  return data
end

#company_contacts_id_get_with_http_info(id, opts = {}) ⇒ Array<(Contact, Fixnum, Hash)>

Get Contact By Id

Parameters:

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



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/contacts_api.rb', line 201

def company_contacts_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_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 ContactsApi.company_contacts_id_get"
  end
  # resource path
  local_var_path = "/company/contacts/{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 => 'Contact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#company_contacts_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Contact Image

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :use_default_flag (BOOLEAN)
  • :last_modified (String)

Returns:

  • (nil) 


246
247
248
249
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 246

def company_contacts_id_image_get(id, opts = {})
  company_contacts_id_image_get_with_http_info(id, opts)
  return nil
end

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

Get Contact Image

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :use_default_flag (BOOLEAN)
  • :last_modified (String)

Returns:

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

    nil, response status code and response headers



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
292
293
294
295
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 258

def company_contacts_id_image_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_id_image_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 ContactsApi.company_contacts_id_image_get"
  end
  # resource path
  local_var_path = "/company/contacts/{id}/image".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'useDefaultFlag'] = opts[:'use_default_flag'] if !opts[:'use_default_flag'].nil?
  query_params[:'lastModified'] = opts[:'last_modified'] if !opts[:'last_modified'].nil?

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

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

#company_contacts_id_patch(id, operations, opts = {}) ⇒ Contact

Update Contact

Parameters:

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

    the optional parameters

Returns:



303
304
305
306
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 303

def company_contacts_id_patch(id, operations, opts = {})
  data, _status_code, _headers = company_contacts_id_patch_with_http_info(id, operations, opts)
  return data
end

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

Update Contact

Parameters:

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



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

def company_contacts_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_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 ContactsApi.company_contacts_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 ContactsApi.company_contacts_id_patch"
  end
  # resource path
  local_var_path = "/company/contacts/{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 => 'Contact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#company_contacts_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_contacts_id_portal_security_get(id, opts = {}) ⇒ Array<PortalSecurity>

Get Portal Security

Parameters:

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

    the optional parameters

Returns:



363
364
365
366
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 363

def company_contacts_id_portal_security_get(id, opts = {})
  data, _status_code, _headers = company_contacts_id_portal_security_get_with_http_info(id, opts)
  return data
end

#company_contacts_id_portal_security_get_with_http_info(id, opts = {}) ⇒ Array<(Array<PortalSecurity>, Fixnum, Hash)>

Get Portal Security

Parameters:

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

    the optional parameters

Returns:

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

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



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

def company_contacts_id_portal_security_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_id_portal_security_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 ContactsApi.company_contacts_id_portal_security_get"
  end
  # resource path
  local_var_path = "/company/contacts/{id}/portalSecurity".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 => 'Array<PortalSecurity>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#company_contacts_id_portal_security_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_contacts_id_put(id, contact, opts = {}) ⇒ Contact

Replace Contact

Parameters:

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

    the optional parameters

Returns:



417
418
419
420
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 417

def company_contacts_id_put(id, contact, opts = {})
  data, _status_code, _headers = company_contacts_id_put_with_http_info(id, contact, opts)
  return data
end

#company_contacts_id_put_with_http_info(id, contact, opts = {}) ⇒ Array<(Contact, Fixnum, Hash)>

Replace Contact

Parameters:

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 428

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

#company_contacts_post(contact, opts = {}) ⇒ Contact

Create Contact

Parameters:

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

    the optional parameters

Returns:



477
478
479
480
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 477

def company_contacts_post(contact, opts = {})
  data, _status_code, _headers = company_contacts_post_with_http_info(contact, opts)
  return data
end

#company_contacts_post_with_http_info(contact, opts = {}) ⇒ Array<(Contact, Fixnum, Hash)>

Create Contact

Parameters:

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 487

def company_contacts_post_with_http_info(contact, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_post ..."
  end
  # verify the required parameter 'contact' is set
  if @api_client.config.client_side_validation && contact.nil?
    fail ArgumentError, "Missing the required parameter 'contact' when calling ContactsApi.company_contacts_post"
  end
  # resource path
  local_var_path = "/company/contacts"

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

#company_contacts_request_password_post(request, opts = {}) ⇒ nil

Request Password

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


532
533
534
535
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 532

def company_contacts_request_password_post(request, opts = {})
  company_contacts_request_password_post_with_http_info(request, opts)
  return nil
end

#company_contacts_request_password_post_with_http_info(request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Request Password

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 542

def company_contacts_request_password_post_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_request_password_post ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling ContactsApi.company_contacts_request_password_post"
  end
  # resource path
  local_var_path = "/company/contacts/requestPassword"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # 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(request)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#company_contacts_request_password_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_contacts_validate_portal_credentials_post(request, opts = {}) ⇒ ValidatePortalResponse

Validate Portal Credentials

Parameters:

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

    the optional parameters

Returns:



584
585
586
587
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 584

def company_contacts_validate_portal_credentials_post(request, opts = {})
  data, _status_code, _headers = company_contacts_validate_portal_credentials_post_with_http_info(request, opts)
  return data
end

#company_contacts_validate_portal_credentials_post_with_http_info(request, opts = {}) ⇒ Array<(ValidatePortalResponse, Fixnum, Hash)>

Validate Portal Credentials

Parameters:

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

    the optional parameters

Returns:

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

    ValidatePortalResponse data, response status code and response headers



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
630
631
632
 
# File 'lib/connectwise-ruby-sdk/api/contacts_api.rb', line 594

def company_contacts_validate_portal_credentials_post_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.company_contacts_validate_portal_credentials_post ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling ContactsApi.company_contacts_validate_portal_credentials_post"
  end
  # resource path
  local_var_path = "/company/contacts/validatePortalCredentials"

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