Class: Patch::OrdersApi

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

Constant Summary collapse

OPERATIONS = 
[
  :cancel_order,
  :create_order,
  :delete_order,
  :place_order,
  :retrieve_order,
  :retrieve_orders,
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrdersApi

Returns a new instance of OrdersApi.



28
29
30
 
# File 'lib/patch_ruby/api/orders_api.rb', line 28

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



26
27
28
 
# File 'lib/patch_ruby/api/orders_api.rb', line 26

def api_client
  @api_client
end

Instance Method Details

#cancel_order(id, opts = {}) ⇒ OrderResponse

Cancel an order Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the ‘draft` or `placed` state can be cancelled.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



37
38
39
40
41
 
# File 'lib/patch_ruby/api/orders_api.rb', line 37

def cancel_order(id, opts = {})

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

#cancel_order_with_http_info(id, opts = {}) ⇒ Array<(OrderResponse, Integer, Hash)>

Cancel an order Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the ‘draft` or `placed` state can be cancelled.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:

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

    OrderResponse data, response status code and response headers



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/patch_ruby/api/orders_api.rb', line 49

def cancel_order_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.cancel_order ...'
  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 OrdersApi.cancel_order"
  end
  # resource path
  local_var_path = '/v1/orders/{id}/cancel'.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] || 'OrderResponse'

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

  new_options = opts.merge(
    :operation => :"OrdersApi.cancel_order",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#create_order(create_order_request = {}, opts = {}) ⇒ OrderResponse

Creates an order Creates an order in the ‘placed` or `draft`, or `reserved` state.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



106
107
108
109
110
 
# File 'lib/patch_ruby/api/orders_api.rb', line 106

def create_order(create_order_request = {}, opts = {})
  _create_order_request = Patch::CreateOrderRequest.new(create_order_request) 
  data, _status_code, _headers = create_order_with_http_info(_create_order_request, opts)
  data
end

#create_order_with_http_info(create_order_request, opts = {}) ⇒ Array<(OrderResponse, Integer, Hash)>

Creates an order Creates an order in the ‘placed` or `draft`, or `reserved` state.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:

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

    OrderResponse data, response status code and response headers



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/patch_ruby/api/orders_api.rb', line 118

def create_order_with_http_info(create_order_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.create_order ...'
  end
  # verify the required parameter 'create_order_request' is set
  if @api_client.config.client_side_validation && create_order_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_order_request' when calling OrdersApi.create_order"
  end
  # resource path
  local_var_path = '/v1/orders'

  # 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_order_request)

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

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

  new_options = opts.merge(
    :operation => :"OrdersApi.create_order",
    :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: OrdersApi#create_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_order(uid, opts = {}) ⇒ DeleteOrderResponse

Deletes a draft order Deletes an order that is in the ‘draft` state.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



180
181
182
183
184
 
# File 'lib/patch_ruby/api/orders_api.rb', line 180

def delete_order(uid, opts = {})

  data, _status_code, _headers = delete_order_with_http_info(uid, opts)
  data
end

#delete_order_with_http_info(uid, opts = {}) ⇒ Array<(DeleteOrderResponse, Integer, Hash)>

Deletes a draft order Deletes an order that is in the ‘draft` state.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:

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

    DeleteOrderResponse data, response status code and response headers



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/patch_ruby/api/orders_api.rb', line 192

def delete_order_with_http_info(uid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.delete_order ...'
  end
  # verify the required parameter 'uid' is set
  if @api_client.config.client_side_validation && uid.nil?
    fail ArgumentError, "Missing the required parameter 'uid' when calling OrdersApi.delete_order"
  end
  # resource path
  local_var_path = '/v1/orders/{uid}'.sub('{' + 'uid' + '}', CGI.escape(uid.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] || 'DeleteOrderResponse'

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

  new_options = opts.merge(
    :operation => :"OrdersApi.delete_order",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#place_order(id, opts = {}) ⇒ OrderResponse

Place an order Placing an order confirms an order’s allocation of offsets. Only orders that are in the ‘draft` state can be placed

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



250
251
252
253
254
 
# File 'lib/patch_ruby/api/orders_api.rb', line 250

def place_order(id, opts = {})

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

#place_order_with_http_info(id, opts = {}) ⇒ Array<(OrderResponse, Integer, Hash)>

Place an order Placing an order confirms an order’s allocation of offsets. Only orders that are in the ‘draft` state can be placed

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    OrderResponse data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
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
 
# File 'lib/patch_ruby/api/orders_api.rb', line 263

def place_order_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.place_order ...'
  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 OrdersApi.place_order"
  end
  # resource path
  local_var_path = '/v1/orders/{id}/place'.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'])
  # 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(opts)

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

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

  new_options = opts.merge(
    :operation => :"OrdersApi.place_order",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#retrieve_order(id, opts = {}) ⇒ OrderResponse

Retrieves an order Retrieves a given order and its allocation offsets or negative emissions. You can only retrieve orders 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:



325
326
327
328
329
 
# File 'lib/patch_ruby/api/orders_api.rb', line 325

def retrieve_order(id, opts = {})

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

#retrieve_order_with_http_info(id, opts = {}) ⇒ Array<(OrderResponse, Integer, Hash)>

Retrieves an order Retrieves a given order and its allocation offsets or negative emissions. You can only retrieve orders 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<(OrderResponse, Integer, Hash)>) —

    OrderResponse data, response status code and response headers



337
338
339
340
341
342
343
344
345
346
347
348
349
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
 
# File 'lib/patch_ruby/api/orders_api.rb', line 337

def retrieve_order_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.retrieve_order ...'
  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 OrdersApi.retrieve_order"
  end
  # resource path
  local_var_path = '/v1/orders/{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] || 'OrderResponse'

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

  new_options = opts.merge(
    :operation => :"OrdersApi.retrieve_order",
    :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: OrdersApi#retrieve_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_orders(opts = {}) ⇒ OrderListResponse

Retrieves a list of orders Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :metadata (String)
  • :metadata_example1 (String)
  • :metadata_example2 (String)
  • :patch_version (Integer)

Returns:



397
398
399
400
401
 
# File 'lib/patch_ruby/api/orders_api.rb', line 397

def retrieve_orders(opts = {})

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

#retrieve_orders_with_http_info(opts = {}) ⇒ Array<(OrderListResponse, Integer, Hash)>

Retrieves a list of orders Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :metadata (String)
  • :metadata_example1 (String)
  • :metadata_example2 (String)
  • :patch_version (Integer)

Returns:

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

    OrderListResponse data, response status code and response headers



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/patch_ruby/api/orders_api.rb', line 412

def retrieve_orders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrdersApi.retrieve_orders ...'
  end
  # resource path
  local_var_path = '/v1/orders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
  query_params[:'metadata[example1]'] = opts[:'metadata_example1'] if !opts[:'metadata_example1'].nil?
  query_params[:'metadata[example2]'] = opts[:'metadata_example2'] if !opts[:'metadata_example2'].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] || 'OrderListResponse'

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

  new_options = opts.merge(
    :operation => :"OrdersApi.retrieve_orders",
    :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: OrdersApi#retrieve_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end