Class: Patch::EstimatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/patch_ruby/api/estimates_api.rb

Constant Summary collapse

OPERATIONS = 
[
  :create_air_shipping_estimate,
  :create_bitcoin_estimate,
  :create_ecommerce_estimate,
  :create_ethereum_estimate,
  :create_flight_estimate,
  :create_hotel_estimate,
  :create_mass_estimate,
  :create_rail_shipping_estimate,
  :create_road_shipping_estimate,
  :create_sea_shipping_estimate,
  :create_shipping_estimate,
  :create_vehicle_estimate,
  :retrieve_estimate,
  :retrieve_estimates,
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EstimatesApi

Returns a new instance of EstimatesApi.



36
37
38
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#create_air_shipping_estimate(create_air_shipping_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Creates a GLEC air shipping estimate given freight mass and logistics Creates a GLEC air shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:



45
46
47
48
49
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 45

def create_air_shipping_estimate(create_air_shipping_estimate_request = {}, opts = {})
  _create_air_shipping_estimate_request = Patch::CreateAirShippingEstimateRequest.new(create_air_shipping_estimate_request) 
  data, _status_code, _headers = create_air_shipping_estimate_with_http_info(_create_air_shipping_estimate_request, opts)
  data
end

#create_air_shipping_estimate_with_http_info(create_air_shipping_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Creates a GLEC air shipping estimate given freight mass and logistics Creates a GLEC air shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



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
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
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 57

def create_air_shipping_estimate_with_http_info(create_air_shipping_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_air_shipping_estimate ...'
  end
  # verify the required parameter 'create_air_shipping_estimate_request' is set
  if @api_client.config.client_side_validation && create_air_shipping_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_air_shipping_estimate_request' when calling EstimatesApi.create_air_shipping_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/shipping/air'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_air_shipping_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_air_shipping_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bitcoin_estimate(create_bitcoin_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create a bitcoin estimate given a timestamp and transaction value Creates a bitcoin estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



119
120
121
122
123
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 119

def create_bitcoin_estimate(create_bitcoin_estimate_request = {}, opts = {})
  _create_bitcoin_estimate_request = Patch::CreateBitcoinEstimateRequest.new(create_bitcoin_estimate_request) 
  data, _status_code, _headers = create_bitcoin_estimate_with_http_info(_create_bitcoin_estimate_request, opts)
  data
end

#create_bitcoin_estimate_with_http_info(create_bitcoin_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create a bitcoin estimate given a timestamp and transaction value Creates a bitcoin estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



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
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 131

def create_bitcoin_estimate_with_http_info(create_bitcoin_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_bitcoin_estimate ...'
  end
  # verify the required parameter 'create_bitcoin_estimate_request' is set
  if @api_client.config.client_side_validation && create_bitcoin_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_bitcoin_estimate_request' when calling EstimatesApi.create_bitcoin_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/crypto/btc'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_bitcoin_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_bitcoin_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_ecommerce_estimate(create_ecommerce_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create an e-commerce estimate given the distance traveled in meters, package weight, and transportation method. Creates a e-commerce estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:



193
194
195
196
197
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 193

def create_ecommerce_estimate(create_ecommerce_estimate_request = {}, opts = {})
  _create_ecommerce_estimate_request = Patch::CreateEcommerceEstimateRequest.new(create_ecommerce_estimate_request) 
  data, _status_code, _headers = create_ecommerce_estimate_with_http_info(_create_ecommerce_estimate_request, opts)
  data
end

#create_ecommerce_estimate_with_http_info(create_ecommerce_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create an e-commerce estimate given the distance traveled in meters, package weight, and transportation method. Creates a e-commerce estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 205

def create_ecommerce_estimate_with_http_info(create_ecommerce_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_ecommerce_estimate ...'
  end
  # verify the required parameter 'create_ecommerce_estimate_request' is set
  if @api_client.config.client_side_validation && create_ecommerce_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_ecommerce_estimate_request' when calling EstimatesApi.create_ecommerce_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/ecommerce'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_ecommerce_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_ecommerce_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_ethereum_estimate(create_ethereum_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create an ethereum estimate Creates an ethereum estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:



267
268
269
270
271
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 267

def create_ethereum_estimate(create_ethereum_estimate_request = {}, opts = {})
  _create_ethereum_estimate_request = Patch::CreateEthereumEstimateRequest.new(create_ethereum_estimate_request) 
  data, _status_code, _headers = create_ethereum_estimate_with_http_info(_create_ethereum_estimate_request, opts)
  data
end

#create_ethereum_estimate_with_http_info(create_ethereum_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create an ethereum estimate Creates an ethereum estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
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
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 279

def create_ethereum_estimate_with_http_info(create_ethereum_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_ethereum_estimate ...'
  end
  # verify the required parameter 'create_ethereum_estimate_request' is set
  if @api_client.config.client_side_validation && create_ethereum_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_ethereum_estimate_request' when calling EstimatesApi.create_ethereum_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/crypto/eth'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_ethereum_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_ethereum_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_flight_estimate(create_flight_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create a flight estimate given the distance traveled in meters Creates a flight estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



341
342
343
344
345
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 341

def create_flight_estimate(create_flight_estimate_request = {}, opts = {})
  _create_flight_estimate_request = Patch::CreateFlightEstimateRequest.new(create_flight_estimate_request) 
  data, _status_code, _headers = create_flight_estimate_with_http_info(_create_flight_estimate_request, opts)
  data
end

#create_flight_estimate_with_http_info(create_flight_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create a flight estimate given the distance traveled in meters Creates a flight estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



353
354
355
356
357
358
359
360
361
362
363
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
407
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 353

def create_flight_estimate_with_http_info(create_flight_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_flight_estimate ...'
  end
  # verify the required parameter 'create_flight_estimate_request' is set
  if @api_client.config.client_side_validation && create_flight_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_flight_estimate_request' when calling EstimatesApi.create_flight_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/flight'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_flight_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_flight_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_hotel_estimate(create_hotel_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create a hotel estimate. Creates a hotel estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



415
416
417
418
419
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 415

def create_hotel_estimate(create_hotel_estimate_request = {}, opts = {})
  _create_hotel_estimate_request = Patch::CreateHotelEstimateRequest.new(create_hotel_estimate_request) 
  data, _status_code, _headers = create_hotel_estimate_with_http_info(_create_hotel_estimate_request, opts)
  data
end

#create_hotel_estimate_with_http_info(create_hotel_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create a hotel estimate. Creates a hotel estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 427

def create_hotel_estimate_with_http_info(create_hotel_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_hotel_estimate ...'
  end
  # verify the required parameter 'create_hotel_estimate_request' is set
  if @api_client.config.client_side_validation && create_hotel_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_hotel_estimate_request' when calling EstimatesApi.create_hotel_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/hotel'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_hotel_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_hotel_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_mass_estimate(create_mass_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create an estimate based on mass of CO2 Creates an estimate for the mass of CO2 to be compensated. An order in the ‘draft` state will also be created, linked to the estimate.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



489
490
491
492
493
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 489

def create_mass_estimate(create_mass_estimate_request = {}, opts = {})
  _create_mass_estimate_request = Patch::CreateMassEstimateRequest.new(create_mass_estimate_request) 
  data, _status_code, _headers = create_mass_estimate_with_http_info(_create_mass_estimate_request, opts)
  data
end

#create_mass_estimate_with_http_info(create_mass_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create an estimate based on mass of CO2 Creates an estimate for the mass of CO2 to be compensated. An order in the ‘draft` state will also be created, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



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
526
527
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
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 501

def create_mass_estimate_with_http_info(create_mass_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_mass_estimate ...'
  end
  # verify the required parameter 'create_mass_estimate_request' is set
  if @api_client.config.client_side_validation && create_mass_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_mass_estimate_request' when calling EstimatesApi.create_mass_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/mass'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_mass_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_mass_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_rail_shipping_estimate(create_rail_shipping_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Creates a GLEC rail shipping estimate given freight mass and logistics Creates a GLEC rail shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:



563
564
565
566
567
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 563

def create_rail_shipping_estimate(create_rail_shipping_estimate_request = {}, opts = {})
  _create_rail_shipping_estimate_request = Patch::CreateRailShippingEstimateRequest.new(create_rail_shipping_estimate_request) 
  data, _status_code, _headers = create_rail_shipping_estimate_with_http_info(_create_rail_shipping_estimate_request, opts)
  data
end

#create_rail_shipping_estimate_with_http_info(create_rail_shipping_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Creates a GLEC rail shipping estimate given freight mass and logistics Creates a GLEC rail shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
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
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 575

def create_rail_shipping_estimate_with_http_info(create_rail_shipping_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_rail_shipping_estimate ...'
  end
  # verify the required parameter 'create_rail_shipping_estimate_request' is set
  if @api_client.config.client_side_validation && create_rail_shipping_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_rail_shipping_estimate_request' when calling EstimatesApi.create_rail_shipping_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/shipping/rail'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_rail_shipping_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_rail_shipping_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_road_shipping_estimate(create_road_shipping_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Creates a GLEC road shipping estimate given freight mass and logistics Creates a GLEC road shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:



637
638
639
640
641
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 637

def create_road_shipping_estimate(create_road_shipping_estimate_request = {}, opts = {})
  _create_road_shipping_estimate_request = Patch::CreateRoadShippingEstimateRequest.new(create_road_shipping_estimate_request) 
  data, _status_code, _headers = create_road_shipping_estimate_with_http_info(_create_road_shipping_estimate_request, opts)
  data
end

#create_road_shipping_estimate_with_http_info(create_road_shipping_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Creates a GLEC road shipping estimate given freight mass and logistics Creates a GLEC road shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 649

def create_road_shipping_estimate_with_http_info(create_road_shipping_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_road_shipping_estimate ...'
  end
  # verify the required parameter 'create_road_shipping_estimate_request' is set
  if @api_client.config.client_side_validation && create_road_shipping_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_road_shipping_estimate_request' when calling EstimatesApi.create_road_shipping_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/shipping/road'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_road_shipping_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_road_shipping_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_sea_shipping_estimate(create_sea_shipping_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Creates a GLEC sea shipping estimate given freight mass and logistics Creates a GLEC sea shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:



711
712
713
714
715
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 711

def create_sea_shipping_estimate(create_sea_shipping_estimate_request = {}, opts = {})
  _create_sea_shipping_estimate_request = Patch::CreateSeaShippingEstimateRequest.new(create_sea_shipping_estimate_request) 
  data, _status_code, _headers = create_sea_shipping_estimate_with_http_info(_create_sea_shipping_estimate_request, opts)
  data
end

#create_sea_shipping_estimate_with_http_info(create_sea_shipping_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Creates a GLEC sea shipping estimate given freight mass and logistics Creates a GLEC sea shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 723

def create_sea_shipping_estimate_with_http_info(create_sea_shipping_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_sea_shipping_estimate ...'
  end
  # verify the required parameter 'create_sea_shipping_estimate_request' is set
  if @api_client.config.client_side_validation && create_sea_shipping_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_sea_shipping_estimate_request' when calling EstimatesApi.create_sea_shipping_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/shipping/sea'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_sea_shipping_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_sea_shipping_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_shipping_estimate(create_shipping_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create a shipping estimate given the distance traveled in meters, package weight, and transportation method. Creates a shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:



785
786
787
788
789
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 785

def create_shipping_estimate(create_shipping_estimate_request = {}, opts = {})
  _create_shipping_estimate_request = Patch::CreateShippingEstimateRequest.new(create_shipping_estimate_request) 
  data, _status_code, _headers = create_shipping_estimate_with_http_info(_create_shipping_estimate_request, opts)
  data
end

#create_shipping_estimate_with_http_info(create_shipping_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create a shipping estimate given the distance traveled in meters, package weight, and transportation method. Creates a shipping estimate for the amount of CO2 to be compensated. An order in the ‘draft` state may be created based on the parameters.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 797

def create_shipping_estimate_with_http_info(create_shipping_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_shipping_estimate ...'
  end
  # verify the required parameter 'create_shipping_estimate_request' is set
  if @api_client.config.client_side_validation && create_shipping_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_shipping_estimate_request' when calling EstimatesApi.create_shipping_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/shipping'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_shipping_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_shipping_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_vehicle_estimate(create_vehicle_estimate_request = {}, opts = {}) ⇒ EstimateResponse

Create a vehicle estimate given the distance traveled in meters and the type of vehicle Creates an estimate and calculates the amount of CO2 to be compensated depending on the distance and the vehicle. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



859
860
861
862
863
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 859

def create_vehicle_estimate(create_vehicle_estimate_request = {}, opts = {})
  _create_vehicle_estimate_request = Patch::CreateVehicleEstimateRequest.new(create_vehicle_estimate_request) 
  data, _status_code, _headers = create_vehicle_estimate_with_http_info(_create_vehicle_estimate_request, opts)
  data
end

#create_vehicle_estimate_with_http_info(create_vehicle_estimate_request, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Create a vehicle estimate given the distance traveled in meters and the type of vehicle Creates an estimate and calculates the amount of CO2 to be compensated depending on the distance and the vehicle. An order in the ‘draft` state may be created based on the parameters, linked to the estimate.

Parameters:

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 871

def create_vehicle_estimate_with_http_info(create_vehicle_estimate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.create_vehicle_estimate ...'
  end
  # verify the required parameter 'create_vehicle_estimate_request' is set
  if @api_client.config.client_side_validation && create_vehicle_estimate_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_vehicle_estimate_request' when calling EstimatesApi.create_vehicle_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/vehicle'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.create_vehicle_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#create_vehicle_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_estimate(id, opts = {}) ⇒ EstimateResponse

Retrieves an estimate Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



933
934
935
936
937
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 933

def retrieve_estimate(id, opts = {})

  data, _status_code, _headers = retrieve_estimate_with_http_info(id, opts)
  data
end

#retrieve_estimate_with_http_info(id, opts = {}) ⇒ Array<(EstimateResponse, Integer, Hash)>

Retrieves an estimate Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(EstimateResponse, Integer, Hash)>) —

    EstimateResponse data, response status code and response headers



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 945

def retrieve_estimate_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.retrieve_estimate ...'
  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 EstimatesApi.retrieve_estimate"
  end
  # resource path
  local_var_path = '/v1/estimates/{id}'.sub('{' + 'id' + '}', CGI.escape(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/json'])
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.retrieve_estimate",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#retrieve_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_estimates(opts = {}) ⇒ EstimateListResponse

Retrieves a list of estimates Retrieves a list of estimates and their associated orders. You can only retrieve estimates associated with the organization you are querying for.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :patch_version (Integer)

Returns:



1002
1003
1004
1005
1006
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 1002

def retrieve_estimates(opts = {})

  data, _status_code, _headers = retrieve_estimates_with_http_info(opts)
  data
end

#retrieve_estimates_with_http_info(opts = {}) ⇒ Array<(EstimateListResponse, Integer, Hash)>

Retrieves a list of estimates Retrieves a list of estimates and their associated orders. You can only retrieve estimates associated with the organization you are querying for.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :patch_version (Integer)

Returns:

  • (Array<(EstimateListResponse, Integer, Hash)>) —

    EstimateListResponse data, response status code and response headers



1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 1014

def retrieve_estimates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EstimatesApi.retrieve_estimates ...'
  end
  # resource path
  local_var_path = '/v1/estimates'

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

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

  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"EstimatesApi.retrieve_estimates",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EstimatesApi#retrieve_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end