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_flight_estimate,
  :create_hotel_estimate,
  :create_mass_estimate,
  :create_rail_shipping_estimate,
  :create_road_shipping_estimate,
  :create_sea_shipping_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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



31
32
33
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 31

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:



42
43
44
45
46
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 42

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



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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 54

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:



116
117
118
119
120
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 116

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



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

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:



190
191
192
193
194
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 190

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



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

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_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:



264
265
266
267
268
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 264

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



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

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:



338
339
340
341
342
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 338

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



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

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:



412
413
414
415
416
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 412

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



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

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:



486
487
488
489
490
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 486

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



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

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:



560
561
562
563
564
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 560

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



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

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:



634
635
636
637
638
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 634

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



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

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

#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:



708
709
710
711
712
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 708

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



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

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:



777
778
779
780
781
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 777

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



789
790
791
792
793
794
795
796
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
 
# File 'lib/patch_ruby/api/estimates_api.rb', line 789

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