Class: ConnectWise::CatalogsItemApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CatalogsItemApi

Returns a new instance of CatalogsItemApi.



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

def api_client
  @api_client
end

Instance Method Details

#procurement_catalog_catalog_item_identifier_quantity_on_hand_get(catalog_item_identifier, opts = {}) ⇒ Count

Get Inventory Quantity On Hand

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :warehouse_bin_id (Integer)

Returns:



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

def procurement_catalog_catalog_item_identifier_quantity_on_hand_get(catalog_item_identifier, opts = {})
  data, _status_code, _headers = procurement_catalog_catalog_item_identifier_quantity_on_hand_get_with_http_info(catalog_item_identifier, opts)
  return data
end

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

Get Inventory Quantity On Hand

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :warehouse_bin_id (Integer)

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

def procurement_catalog_catalog_item_identifier_quantity_on_hand_get_with_http_info(catalog_item_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogsItemApi.procurement_catalog_catalog_item_identifier_quantity_on_hand_get ..."
  end
  # verify the required parameter 'catalog_item_identifier' is set
  if @api_client.config.client_side_validation && catalog_item_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'catalog_item_identifier' when calling CatalogsItemApi.procurement_catalog_catalog_item_identifier_quantity_on_hand_get"
  end
  # resource path
  local_var_path = "/procurement/catalog/{catalogItemIdentifier}/quantityOnHand".sub('{' + 'catalogItemIdentifier' + '}', catalog_item_identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'warehouseBinId'] = opts[:'warehouse_bin_id'] if !opts[:'warehouse_bin_id'].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: CatalogsItemApi#procurement_catalog_catalog_item_identifier_quantity_on_hand_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procurement_catalog_count_get(opts = {}) ⇒ Count

Get Catalogs Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def procurement_catalog_count_get(opts = {})
  data, _status_code, _headers = procurement_catalog_count_get_with_http_info(opts)
  return data
end

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

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



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
115
116
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 83

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

#procurement_catalog_get(opts = {}) ⇒ Array<CatalogItem>

Get Catalogs

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:



128
129
130
131
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 128

def procurement_catalog_get(opts = {})
  data, _status_code, _headers = procurement_catalog_get_with_http_info(opts)
  return data
end

#procurement_catalog_get_with_http_info(opts = {}) ⇒ Array<(Array<CatalogItem>, Fixnum, Hash)>

Get Catalogs

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

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



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
180
181
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 143

def procurement_catalog_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogsItemApi.procurement_catalog_get ..."
  end
  # resource path
  local_var_path = "/procurement/catalog"

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

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

Delete Catalog By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


188
189
190
191
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 188

def procurement_catalog_id_delete(id, opts = {})
  procurement_catalog_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Catalog By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
230
231
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 198

def procurement_catalog_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogsItemApi.procurement_catalog_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 CatalogsItemApi.procurement_catalog_id_delete"
  end
  # resource path
  local_var_path = "/procurement/catalog/{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: CatalogsItemApi#procurement_catalog_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procurement_catalog_id_get(id, opts = {}) ⇒ CatalogItem

Get Catalog By Id

Parameters:

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 238

def procurement_catalog_id_get(id, opts = {})
  data, _status_code, _headers = procurement_catalog_id_get_with_http_info(id, opts)
  return data
end

#procurement_catalog_id_get_with_http_info(id, opts = {}) ⇒ Array<(CatalogItem, Fixnum, Hash)>

Get Catalog By Id

Parameters:

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

    the optional parameters

Returns:

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

    CatalogItem data, response status code and response headers



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
283
284
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 248

def procurement_catalog_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogsItemApi.procurement_catalog_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 CatalogsItemApi.procurement_catalog_id_get"
  end
  # resource path
  local_var_path = "/procurement/catalog/{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 => 'CatalogItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogsItemApi#procurement_catalog_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procurement_catalog_id_patch(id, operations, opts = {}) ⇒ CatalogItem

Update Catalog

Parameters:

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

    the optional parameters

Returns:



292
293
294
295
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 292

def procurement_catalog_id_patch(id, operations, opts = {})
  data, _status_code, _headers = procurement_catalog_id_patch_with_http_info(id, operations, opts)
  return data
end

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

Update Catalog

Parameters:

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

    the optional parameters

Returns:

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

    CatalogItem data, response status code and response headers



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
338
339
340
341
342
343
344
345
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 303

def procurement_catalog_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogsItemApi.procurement_catalog_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 CatalogsItemApi.procurement_catalog_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 CatalogsItemApi.procurement_catalog_id_patch"
  end
  # resource path
  local_var_path = "/procurement/catalog/{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 => 'CatalogItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogsItemApi#procurement_catalog_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procurement_catalog_id_put(id, catalog_item, opts = {}) ⇒ CatalogItem

Replace Catalog

Parameters:

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

    the optional parameters

Returns:



353
354
355
356
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 353

def procurement_catalog_id_put(id, catalog_item, opts = {})
  data, _status_code, _headers = procurement_catalog_id_put_with_http_info(id, catalog_item, opts)
  return data
end

#procurement_catalog_id_put_with_http_info(id, catalog_item, opts = {}) ⇒ Array<(CatalogItem, Fixnum, Hash)>

Replace Catalog

Parameters:

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

    the optional parameters

Returns:

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

    CatalogItem data, response status code and response headers



364
365
366
367
368
369
370
371
372
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
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 364

def procurement_catalog_id_put_with_http_info(id, catalog_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogsItemApi.procurement_catalog_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 CatalogsItemApi.procurement_catalog_id_put"
  end
  # verify the required parameter 'catalog_item' is set
  if @api_client.config.client_side_validation && catalog_item.nil?
    fail ArgumentError, "Missing the required parameter 'catalog_item' when calling CatalogsItemApi.procurement_catalog_id_put"
  end
  # resource path
  local_var_path = "/procurement/catalog/{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(catalog_item)
  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 => 'CatalogItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogsItemApi#procurement_catalog_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#procurement_catalog_post(catalog_item, opts = {}) ⇒ CatalogItem

Create Catalog

Parameters:

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

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 413

def procurement_catalog_post(catalog_item, opts = {})
  data, _status_code, _headers = procurement_catalog_post_with_http_info(catalog_item, opts)
  return data
end

#procurement_catalog_post_with_http_info(catalog_item, opts = {}) ⇒ Array<(CatalogItem, Fixnum, Hash)>

Create Catalog

Parameters:

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

    the optional parameters

Returns:

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

    CatalogItem data, response status code and response headers



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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/connectwise-ruby-sdk/api/catalogs_item_api.rb', line 423

def procurement_catalog_post_with_http_info(catalog_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogsItemApi.procurement_catalog_post ..."
  end
  # verify the required parameter 'catalog_item' is set
  if @api_client.config.client_side_validation && catalog_item.nil?
    fail ArgumentError, "Missing the required parameter 'catalog_item' when calling CatalogsItemApi.procurement_catalog_post"
  end
  # resource path
  local_var_path = "/procurement/catalog"

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