patch_ruby 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adcc2ae16ffd8f1fae30c7231ea100282a46b9cb59fa04ef855d37b3c0269b7e
+  data.tar.gz: 87c2e5a75eec03a3d05ccca1bc74201e658f3d1bf1a0eec3759b7df3c6815c77
+SHA512:
+  metadata.gz: 0d8c3b806824a51b72215cab36372c1608e46c02b3e6ea007f060871da0c3e22e943edffc7484cbe9a9d551685bedd3e14e2eb35b3655e38dd6cfec8f9abcca6
+  data.tar.gz: b66e6323bfa7932d43d3865b28bc9e09d3cac9a14daa5177fe7a0c1bc5355403e64aed6cee1ba126c5c1fcf3b7c01152dd25408cb7add2742ddf07e20977c129

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+  gem 'vcr', '~> 6.0'
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    patch_ruby (1.0.0.pre)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.13.1)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+    vcr (6.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  patch_ruby!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+  vcr (~> 6.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,54 @@
+# Patch ruby
+![Test](https://github.com/patch-technology/patch-ruby/workflows/Test/badge.svg)
+
+The official Ruby gem for the [Patch API](https://www.usepatch.com)
+
+## Documentation
+
+For detailed documentation and examples, see the [Patch API docs](https://www.usepatch.com).
+
+## Installation
+
+Add the gem to your Gemfile:
+```ruby
+gem 'patch_ruby'
+```
+
+Then run:
+```shell
+bundle
+```
+
+Or install it directly with
+```shell
+gem install patch_ruby
+```
+
+### Requirements
+- Ruby 1.9+
+
+## Usage
+
+After installing the gem, you'll have to configure it with your API key which is available from the API key page in the Patch dashboard:
+```ruby
+require 'patch_ruby'
+
+Patch.configure do |config|
+  # Configure the Patch gem with your API key here
+  config.access_token = ENV['PATCH_RUBY_API_KEY']
+end
+```
+
+Once configured, you can test it out:
+```ruby
+begin
+  orders_response = Patch::Order.retrieve_orders
+
+  orders_response.data.each do |order|
+    puts "Order ID: #{order.id}, Order State: #{order.state}"
+  end
+# Rescue from any Patch API errors
+rescue Patch::ApiError => e
+  puts "Failed to retrieve Orders with status code #{e.code}: #{e.message}"
+end
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/patch_ruby.rb

@@ -0,0 +1,61 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+# Common files
+require 'patch_ruby/api_client'
+require 'patch_ruby/api_error'
+require 'patch_ruby/version'
+require 'patch_ruby/configuration'
+
+# Models
+require 'patch_ruby/models/allocation'
+require 'patch_ruby/models/create_mass_estimate_request'
+require 'patch_ruby/models/create_order_request'
+require 'patch_ruby/models/create_preference_request'
+require 'patch_ruby/models/error_response'
+require 'patch_ruby/models/estimate'
+require 'patch_ruby/models/estimate_list_response'
+require 'patch_ruby/models/estimate_response'
+require 'patch_ruby/models/meta_index_object'
+require 'patch_ruby/models/order'
+require 'patch_ruby/models/order_list_response'
+require 'patch_ruby/models/order_response'
+require 'patch_ruby/models/preference'
+require 'patch_ruby/models/preference_list_response'
+require 'patch_ruby/models/preference_response'
+require 'patch_ruby/models/project'
+require 'patch_ruby/models/project_list_response'
+require 'patch_ruby/models/project_response'
+
+# APIs
+require 'patch_ruby/api/estimates_api'
+require 'patch_ruby/api/orders_api'
+require 'patch_ruby/api/preferences_api'
+require 'patch_ruby/api/projects_api'
+
+module Patch
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Patch.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/patch_ruby/api/estimates_api.rb

@@ -0,0 +1,213 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Patch
+  class EstimatesApi
+    OPERATIONS = [
+      :create_mass_estimate,
+      :retrieve_estimate,
+      :retrieve_estimates,
+    ]
+
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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. 
+    # @param create_mass_estimate_request [CreateMassEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_mass_estimate(create_mass_estimate_request, opts = {})
+      data, _status_code, _headers = create_mass_estimate_with_http_info(create_mass_estimate_request, opts)
+      data
+    end
+
+    # 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. 
+    # @param create_mass_estimate_request [CreateMassEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_mass_estimate_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'EstimateResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+
+    # Retrieves an estimate
+    # Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def retrieve_estimate(id, opts = {})
+      data, _status_code, _headers = retrieve_estimate_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieves an estimate
+    # Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'EstimateResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @return [EstimateListResponse]
+    def retrieve_estimates(opts = {})
+      data, _status_code, _headers = retrieve_estimates_with_http_info(opts)
+      data
+    end
+
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @return [Array<(EstimateListResponse, Integer, Hash)>] EstimateListResponse data, response status code and response headers
+    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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'EstimateListResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+  end
+end

data/lib/patch_ruby/api/orders_api.rb

@@ -0,0 +1,339 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Patch
+  class OrdersApi
+    OPERATIONS = [
+      :cancel_order,
+      :create_order,
+      :place_order,
+      :retrieve_order,
+      :retrieve_orders,
+    ]
+
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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` state can be cancelled. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [OrderResponse]
+    def cancel_order(id, opts = {})
+      data, _status_code, _headers = cancel_order_with_http_info(id, opts)
+      data
+    end
+
+    # 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` state can be cancelled. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
+    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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'OrderResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+
+    # Creates an order
+    # Creates an order in the `placed` state. To create a `draft` order, create an estimate first. 
+    # @param create_order_request [CreateOrderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OrderResponse]
+    def create_order(create_order_request, opts = {})
+      data, _status_code, _headers = create_order_with_http_info(create_order_request, opts)
+      data
+    end
+
+    # Creates an order
+    # Creates an order in the &#x60;placed&#x60; state. To create a &#x60;draft&#x60; order, create an estimate first. 
+    # @param create_order_request [CreateOrderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
+    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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_order_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'OrderResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+
+    # Place an order
+    # Placing an order confirms an order's allocation of offsets. Only orders that are in the `draft` state can be placed 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [OrderResponse]
+    def place_order(id, opts = {})
+      data, _status_code, _headers = place_order_with_http_info(id, opts)
+      data
+    end
+
+    # Place an order
+    # Placing an order confirms an order&#39;s allocation of offsets. Only orders that are in the &#x60;draft&#x60; state can be placed 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
+    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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'OrderResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+
+    # 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. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [OrderResponse]
+    def retrieve_order(id, opts = {})
+      data, _status_code, _headers = retrieve_order_with_http_info(id, opts)
+      data
+    end
+
+    # 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. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
+    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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'OrderResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @return [OrderListResponse]
+    def retrieve_orders(opts = {})
+      data, _status_code, _headers = retrieve_orders_with_http_info(opts)
+      data
+    end
+
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @return [Array<(OrderListResponse, Integer, Hash)>] OrderListResponse data, response status code and response headers
+    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?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'OrderListResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :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
+  end
+end