Class: ConnectWise::PricingBreaksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/pricing_breaks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PricingBreaksApi

Returns a new instance of PricingBreaksApi.



17
18
19
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



15
16
17
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, opts = {}) ⇒ nil

Delete PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


28
29
30
31
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 28

def delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, opts = {})
  delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, opts)
  nil
end

#delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers

Raises:

  • (ArgumentError)


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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 40

def delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: PricingBreaksApi.delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling PricingBreaksApi.delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling PricingBreaksApi.delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling PricingBreaksApi.delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling PricingBreaksApi.delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'PricingBreaksApi.delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  @api_client.config.logger.debug "API called: PricingBreaksApi#delete_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks(parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<PricingBreak>

Get List of PricingBreak

Parameters:

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



102
103
104
105
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 102

def get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks(parent_id, grandparent_id, client_id, opts = {})
  data, _status_code, _headers = get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_with_http_info(parent_id, grandparent_id, client_id, opts)
  data
end

#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, opts = {}) ⇒ PricingBreak

Get PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



192
193
194
195
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 192

def get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, opts = {})
  data, _status_code, _headers = get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, opts)
  data
end

#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<(PricingBreak, Integer, Hash)>

Get PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(PricingBreak, Integer, Hash)>)

    PricingBreak data, response status code and response headers

Raises:

  • (ArgumentError)


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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 212

def get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PricingBreak'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: PricingBreaksApi#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count(parent_id, grandparent_id, client_id, opts = {}) ⇒ Count

Get Count of PricingBreak

Parameters:

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



284
285
286
287
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 284

def get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count(parent_id, grandparent_id, client_id, opts = {})
  data, _status_code, _headers = get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count_with_http_info(parent_id, grandparent_id, client_id, opts)
  data
end

#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count_with_http_info(parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<(Count, Integer, Hash)>

Get Count of PricingBreak

Parameters:

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Count, Integer, Hash)>)

    Count data, response status code and response headers

Raises:

  • (ArgumentError)


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
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 303

def get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count_with_http_info(parent_id, grandparent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks/count'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Count'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: PricingBreaksApi#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_with_http_info(parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<(Array<PricingBreak>, Integer, Hash)>

Get List of PricingBreak

Parameters:

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Array<PricingBreak>, Integer, Hash)>)

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

Raises:

  • (ArgumentError)


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 121

def get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_with_http_info(parent_id, grandparent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PricingBreak>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'PricingBreaksApi.get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: PricingBreaksApi#get_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, patch_operation, opts = {}) ⇒ PricingBreak

Patch PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • patch_operation (Array<PatchOperation>)

    List of PatchOperation

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

    the optional parameters

Returns:



367
368
369
370
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 367

def patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, patch_operation, opts)
  data
end

#patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, patch_operation, opts = {}) ⇒ Array<(PricingBreak, Integer, Hash)>

Patch PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • patch_operation (Array<PatchOperation>)

    List of PatchOperation

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

    the optional parameters

Returns:

  • (Array<(PricingBreak, Integer, Hash)>)

    PricingBreak data, response status code and response headers

Raises:

  • (ArgumentError)


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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 380

def patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, patch_operation, opts = {})
  @api_client.config.logger.debug 'Calling API: PricingBreaksApi.patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling PricingBreaksApi.patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling PricingBreaksApi.patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling PricingBreaksApi.patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling PricingBreaksApi.patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'patch_operation' is set
  raise ArgumentError, "Missing the required parameter 'patch_operation' when calling PricingBreaksApi.patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && patch_operation.nil?

  # resource path
  local_var_path = '/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)

  # return_type
  return_type = opts[:debug_return_type] || 'PricingBreak'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'PricingBreaksApi.patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  @api_client.config.logger.debug "API called: PricingBreaksApi#patch_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks(parent_id, grandparent_id, client_id, pricing_break, opts = {}) ⇒ PricingBreak

Post PricingBreak

Parameters:

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • pricing_break (PricingBreak)

    pricingBreak

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

    the optional parameters

Returns:



442
443
444
445
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 442

def post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks(parent_id, grandparent_id, client_id, pricing_break, opts = {})
  data, _status_code, _headers = post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_with_http_info(parent_id, grandparent_id, client_id, pricing_break, opts)
  data
end

#post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_with_http_info(parent_id, grandparent_id, client_id, pricing_break, opts = {}) ⇒ Array<(PricingBreak, Integer, Hash)>

Post PricingBreak

Parameters:

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • pricing_break (PricingBreak)

    pricingBreak

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

    the optional parameters

Returns:

  • (Array<(PricingBreak, Integer, Hash)>)

    PricingBreak data, response status code and response headers

Raises:

  • (ArgumentError)


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 454

def post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_with_http_info(parent_id, grandparent_id, client_id, pricing_break, opts = {})
  @api_client.config.logger.debug 'Calling API: PricingBreaksApi.post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling PricingBreaksApi.post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling PricingBreaksApi.post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling PricingBreaksApi.post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'pricing_break' is set
  raise ArgumentError, "Missing the required parameter 'pricing_break' when calling PricingBreaksApi.post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks" if @api_client.config.client_side_validation && pricing_break.nil?

  # resource path
  local_var_path = '/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(pricing_break)

  # return_type
  return_type = opts[:debug_return_type] || 'PricingBreak'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'PricingBreaksApi.post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: PricingBreaksApi#post_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, pricing_break, opts = {}) ⇒ PricingBreak

Put PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • pricing_break (PricingBreak)

    pricingBreak

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

    the optional parameters

Returns:



515
516
517
518
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 515

def put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id(id, parent_id, grandparent_id, client_id, pricing_break, opts = {})
  data, _status_code, _headers = put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, pricing_break, opts)
  data
end

#put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, pricing_break, opts = {}) ⇒ Array<(PricingBreak, Integer, Hash)>

Put PricingBreak

Parameters:

  • id (Integer)

    breakId

  • parent_id (Integer)

    detailId

  • grandparent_id (Integer)

    pricingscheduleId

  • client_id (String)
  • pricing_break (PricingBreak)

    pricingBreak

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

    the optional parameters

Returns:

  • (Array<(PricingBreak, Integer, Hash)>)

    PricingBreak data, response status code and response headers

Raises:

  • (ArgumentError)


528
529
530
531
532
533
534
535
536
537
538
539
540
541
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
578
579
580
581
# File 'lib/connect_wise/api/pricing_breaks_api.rb', line 528

def put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id_with_http_info(id, parent_id, grandparent_id, client_id, pricing_break, opts = {})
  @api_client.config.logger.debug 'Calling API: PricingBreaksApi.put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling PricingBreaksApi.put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling PricingBreaksApi.put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling PricingBreaksApi.put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling PricingBreaksApi.put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'pricing_break' is set
  raise ArgumentError, "Missing the required parameter 'pricing_break' when calling PricingBreaksApi.put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id" if @api_client.config.client_side_validation && pricing_break.nil?

  # resource path
  local_var_path = '/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(pricing_break)

  # return_type
  return_type = opts[:debug_return_type] || 'PricingBreak'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'PricingBreaksApi.put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  @api_client.config.logger.debug "API called: PricingBreaksApi#put_procurement_pricingschedules_by_grandparent_id_details_by_parent_id_breaks_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end