Class: ConnectWise::CompanyPickerItemsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompanyPickerItemsApi

Returns a new instance of CompanyPickerItemsApi.



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

def api_client
  @api_client
end

Instance Method Details

#company_company_picker_items_clear_post(opts = {}) ⇒ ClearPickerRequest

Clear All Picker Items By Member

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :member (String)
  • :type (String)

Returns:



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

def company_company_picker_items_clear_post(opts = {})
  data, _status_code, _headers = company_company_picker_items_clear_post_with_http_info(opts)
  return data
end

#company_company_picker_items_clear_post_with_http_info(opts = {}) ⇒ Array<(ClearPickerRequest, Fixnum, Hash)>

Clear All Picker Items By Member

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :member (String)
  • :type (String)

Returns:

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

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

def company_company_picker_items_clear_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyPickerItemsApi.company_company_picker_items_clear_post ..."
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['Ticket', 'Configuration'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of Ticket, Configuration'
  end
  # resource path
  local_var_path = "/company/companyPickerItems/clear"

  # query parameters
  query_params = {}
  query_params[:'member'] = opts[:'member'] if !opts[:'member'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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(: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 => 'ClearPickerRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyPickerItemsApi#company_company_picker_items_clear_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_company_picker_items_count_get(opts = {}) ⇒ Count

Get Company Picker Items Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def company_company_picker_items_count_get(opts = {})
  data, _status_code, _headers = company_company_picker_items_count_get_with_http_info(opts)
  return data
end

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

Get Company Picker Items 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



81
82
83
84
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
 
# File 'lib/connectwise-ruby-sdk/api/company_picker_items_api.rb', line 81

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

#company_company_picker_items_get(opts = {}) ⇒ Array<CompanyPickerItem>

Get Company Picker Items

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:



126
127
128
129
 
# File 'lib/connectwise-ruby-sdk/api/company_picker_items_api.rb', line 126

def company_company_picker_items_get(opts = {})
  data, _status_code, _headers = company_company_picker_items_get_with_http_info(opts)
  return data
end

#company_company_picker_items_get_with_http_info(opts = {}) ⇒ Array<(Array<CompanyPickerItem>, Fixnum, Hash)>

Get Company Picker Items

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

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



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

def company_company_picker_items_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyPickerItemsApi.company_company_picker_items_get ..."
  end
  # resource path
  local_var_path = "/company/companyPickerItems"

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

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

Delete Company Picker Item

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def company_company_picker_items_id_delete(id, opts = {})
  company_company_picker_items_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Company Picker Item

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#company_company_picker_items_id_get(id, opts = {}) ⇒ CompanyPickerItem

Get Company Picker Item By Id

Parameters:

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

    the optional parameters

Returns:



236
237
238
239
 
# File 'lib/connectwise-ruby-sdk/api/company_picker_items_api.rb', line 236

def company_company_picker_items_id_get(id, opts = {})
  data, _status_code, _headers = company_company_picker_items_id_get_with_http_info(id, opts)
  return data
end

#company_company_picker_items_id_get_with_http_info(id, opts = {}) ⇒ Array<(CompanyPickerItem, Fixnum, Hash)>

Get Company Picker Item By Id

Parameters:

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

    the optional parameters

Returns:

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

    CompanyPickerItem data, response status code and response headers



246
247
248
249
250
251
252
253
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
 
# File 'lib/connectwise-ruby-sdk/api/company_picker_items_api.rb', line 246

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

#company_company_picker_items_post(company_picker_item, opts = {}) ⇒ CompanyPickerItem

Add Company Picker Item

Parameters:

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

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/connectwise-ruby-sdk/api/company_picker_items_api.rb', line 289

def company_company_picker_items_post(company_picker_item, opts = {})
  data, _status_code, _headers = company_company_picker_items_post_with_http_info(company_picker_item, opts)
  return data
end

#company_company_picker_items_post_with_http_info(company_picker_item, opts = {}) ⇒ Array<(CompanyPickerItem, Fixnum, Hash)>

Add Company Picker Item

Parameters:

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

    the optional parameters

Returns:

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

    CompanyPickerItem data, response status code and response headers



299
300
301
302
303
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
 
# File 'lib/connectwise-ruby-sdk/api/company_picker_items_api.rb', line 299

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

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