Class: ConnectWise::ProjectContactsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProjectContactsApi

Returns a new instance of ProjectContactsApi.



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

def api_client
  @api_client
end

Instance Method Details

#project_projects_id_contacts_contact_id_delete(id, contact_id, opts = {}) ⇒ nil

Delete Project Contact By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def project_projects_id_contacts_contact_id_delete(id, contact_id, opts = {})
  project_projects_id_contacts_contact_id_delete_with_http_info(id, contact_id, opts)
  return nil
end

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

Delete Project Contact By Id

Parameters:

  • id
  • contact_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/project_contacts_api.rb', line 29

def project_projects_id_contacts_contact_id_delete_with_http_info(id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProjectContactsApi.project_projects_id_contacts_contact_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 ProjectContactsApi.project_projects_id_contacts_contact_id_delete"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ProjectContactsApi.project_projects_id_contacts_contact_id_delete"
  end
  # resource path
  local_var_path = "/project/projects/{id}/contacts/{contactId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'contactId' + '}', contact_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: ProjectContactsApi#project_projects_id_contacts_contact_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#project_projects_id_contacts_contact_id_get(id, contact_id, opts = {}) ⇒ ProjectContact

Get Project Contact By Id

Parameters:

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

    the optional parameters

Returns:



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

def project_projects_id_contacts_contact_id_get(id, contact_id, opts = {})
  data, _status_code, _headers = project_projects_id_contacts_contact_id_get_with_http_info(id, contact_id, opts)
  return data
end

#project_projects_id_contacts_contact_id_get_with_http_info(id, contact_id, opts = {}) ⇒ Array<(ProjectContact, Fixnum, Hash)>

Get Project Contact By Id

Parameters:

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

    the optional parameters

Returns:

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

    ProjectContact 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/project_contacts_api.rb', line 85

def project_projects_id_contacts_contact_id_get_with_http_info(id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProjectContactsApi.project_projects_id_contacts_contact_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 ProjectContactsApi.project_projects_id_contacts_contact_id_get"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ProjectContactsApi.project_projects_id_contacts_contact_id_get"
  end
  # resource path
  local_var_path = "/project/projects/{id}/contacts/{contactId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'contactId' + '}', contact_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 => 'ProjectContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectContactsApi#project_projects_id_contacts_contact_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#project_projects_id_contacts_get(id, opts = {}) ⇒ Array<ProjectContact>

Get Project Contacts

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:



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

def project_projects_id_contacts_get(id, opts = {})
  data, _status_code, _headers = project_projects_id_contacts_get_with_http_info(id, opts)
  return data
end

#project_projects_id_contacts_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ProjectContact>, Fixnum, Hash)>

Get Project Contacts

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

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



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

def project_projects_id_contacts_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProjectContactsApi.project_projects_id_contacts_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 ProjectContactsApi.project_projects_id_contacts_get"
  end
  # resource path
  local_var_path = "/project/projects/{id}/contacts".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<ProjectContact>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectContactsApi#project_projects_id_contacts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#project_projects_id_contacts_post(id, contact, opts = {}) ⇒ ProjectContact

Create Project Contact

Parameters:

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

    the optional parameters

Returns:



204
205
206
207
 
# File 'lib/connectwise-ruby-sdk/api/project_contacts_api.rb', line 204

def project_projects_id_contacts_post(id, contact, opts = {})
  data, _status_code, _headers = project_projects_id_contacts_post_with_http_info(id, contact, opts)
  return data
end

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

Create Project Contact

Parameters:

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

    the optional parameters

Returns:

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

    ProjectContact data, response status code and response headers



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

def project_projects_id_contacts_post_with_http_info(id, contact, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProjectContactsApi.project_projects_id_contacts_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 ProjectContactsApi.project_projects_id_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 ProjectContactsApi.project_projects_id_contacts_post"
  end
  # resource path
  local_var_path = "/project/projects/{id}/contacts".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(: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 => 'ProjectContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectContactsApi#project_projects_id_contacts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end