growwer 1.0.0

data/lib/growwer/api/orders_api.rb

@@ -0,0 +1,855 @@
+=begin
+#Growwer API
+
+#The Growwer customer API. Authenticate every call with an API key created on your profile page, sent as `Authorization: Bearer <key>`. A read key can call every GET operation; writes need a read and write key and an `Idempotency-Key` header.  Idempotency: use a new `Idempotency-Key` (1 to 255 printable ASCII characters without spaces) for each operation and reuse it only to retry that same operation. Keys belong to your account, not to one API key. - A successful write is stored for 30 days: a retry with the same key and   the same request replays its response with `Idempotent-Replayed: true`   and does nothing again. - A refused write (4xx) has no effect and releases its key: once you fix the   cause, retry with the same key and the write runs. - A failed write (5xx) may have taken effect, so it is never run again under   its key: a retry gets 409 `idempotency_outcome_unknown`. Check whether it   took effect before retrying with a new key. - A retry while the first request is still running gets 409   `idempotency_request_in_progress`. A request still running after 5 minutes   is treated as failed: a retry gets 409 `idempotency_outcome_unknown`. - The same key with a different request (method, path, query or body) gets   409 `idempotency_key_reused`. A write without the header gets 400   `idempotency_key_required`.  Every response carries `X-Request-Id`. Errors share one shape, `{code, message, requestId, details?}`. Money is integer cents plus a currency code and dates are ISO-8601. 
+
+The version of the OpenAPI document: 1
+Contact: support@growwer.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Growwer
+  class OrdersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Approve an order's delivery
+    # Approves the delivery of an order whose `pendingAction` is yours to review the delivery, as the web does. The order finishes and the seller is paid. It takes no body.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Order]
+    def approve_order(id, idempotency_key, opts = {})
+      data, _status_code, _headers = approve_order_with_http_info(id, idempotency_key, opts)
+      data
+    end
+
+    # Approve an order&#39;s delivery
+    # Approves the delivery of an order whose &#x60;pendingAction&#x60; is yours to review the delivery, as the web does. The order finishes and the seller is paid. It takes no body.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers
+    def approve_order_with_http_info(id, idempotency_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.approve_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.approve_order"
+      end
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling OrdersApi.approve_order"
+      end
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling OrdersApi.approve_order, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/orders/{id}/approve'.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']) unless header_params['Accept']
+      header_params[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Order'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.approve_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#approve_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Approve a draft
+    # Approves the draft of a post order whose `pendingAction` is yours to review the draft (GET /orders/{id}/draft downloads it), as the web does. The seller then publishes it. It takes no body.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Order]
+    def approve_order_draft(id, idempotency_key, opts = {})
+      data, _status_code, _headers = approve_order_draft_with_http_info(id, idempotency_key, opts)
+      data
+    end
+
+    # Approve a draft
+    # Approves the draft of a post order whose &#x60;pendingAction&#x60; is yours to review the draft (GET /orders/{id}/draft downloads it), as the web does. The seller then publishes it. It takes no body.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers
+    def approve_order_draft_with_http_info(id, idempotency_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.approve_order_draft ...'
+      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.approve_order_draft"
+      end
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling OrdersApi.approve_order_draft"
+      end
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling OrdersApi.approve_order_draft, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/orders/{id}/approve-draft'.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']) unless header_params['Accept']
+      header_params[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Order'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.approve_order_draft",
+        :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#approve_order_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Cancel an order
+    # Cancels an order the seller has not accepted yet (`state` `pending_acceptance`), as the web does. Its price returns to your wallet's available balance, and the seller is told your reason.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_action_reason [OrderActionReason] 
+    # @param [Hash] opts the optional parameters
+    # @return [Order]
+    def cancel_order(id, idempotency_key, order_action_reason, opts = {})
+      data, _status_code, _headers = cancel_order_with_http_info(id, idempotency_key, order_action_reason, opts)
+      data
+    end
+
+    # Cancel an order
+    # Cancels an order the seller has not accepted yet (&#x60;state&#x60; &#x60;pending_acceptance&#x60;), as the web does. Its price returns to your wallet&#39;s available balance, and the seller is told your reason.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_action_reason [OrderActionReason] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers
+    def cancel_order_with_http_info(id, idempotency_key, order_action_reason, 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
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling OrdersApi.cancel_order"
+      end
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling OrdersApi.cancel_order, the character length must be smaller than or equal to 255.'
+      end
+
+      # verify the required parameter 'order_action_reason' is set
+      if @api_client.config.client_side_validation && order_action_reason.nil?
+        fail ArgumentError, "Missing the required parameter 'order_action_reason' when calling OrdersApi.cancel_order"
+      end
+      # resource path
+      local_var_path = '/api/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']) unless header_params['Accept']
+      # 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[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(order_action_reason)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Order'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      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(:POST, 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
+
+    # Place an order
+    # Places an order on a media for one of your projects and pays its price from your wallet's available balance, as ordering on the web does. Estimate the order first (POST /orders/estimate) and send the price it answers as `expectedPrice`: the order is placed only at that price.  Placing the same order (same project, media, type and price) again within 5 seconds of one still in progress is refused with `duplicate_order`. Its `details.orderId` is the earlier order, or null when that order has finished or was deleted since.  A proposed draft (`proposedDraftFileId`, from POST /files) is used up when the order is placed. If the order is then refused because another request changed your balance, the media or its price, or placed the same order, the file is used up all the same and the refusal's message says so: upload it again before retrying.
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_create_request [OrderCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Order]
+    def create_order(idempotency_key, order_create_request, opts = {})
+      data, _status_code, _headers = create_order_with_http_info(idempotency_key, order_create_request, opts)
+      data
+    end
+
+    # Place an order
+    # Places an order on a media for one of your projects and pays its price from your wallet&#39;s available balance, as ordering on the web does. Estimate the order first (POST /orders/estimate) and send the price it answers as &#x60;expectedPrice&#x60;: the order is placed only at that price.  Placing the same order (same project, media, type and price) again within 5 seconds of one still in progress is refused with &#x60;duplicate_order&#x60;. Its &#x60;details.orderId&#x60; is the earlier order, or null when that order has finished or was deleted since.  A proposed draft (&#x60;proposedDraftFileId&#x60;, from POST /files) is used up when the order is placed. If the order is then refused because another request changed your balance, the media or its price, or placed the same order, the file is used up all the same and the refusal&#39;s message says so: upload it again before retrying.
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_create_request [OrderCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers
+    def create_order_with_http_info(idempotency_key, order_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.create_order ...'
+      end
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling OrdersApi.create_order"
+      end
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling OrdersApi.create_order, the character length must be smaller than or equal to 255.'
+      end
+
+      # verify the required parameter 'order_create_request' is set
+      if @api_client.config.client_side_validation && order_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'order_create_request' when calling OrdersApi.create_order"
+      end
+      # resource path
+      local_var_path = '/api/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']) unless header_params['Accept']
+      # 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[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(order_create_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Order'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      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
+
+    # Download the draft you attached to an order
+    # The file you attached to the briefing of a post order. 404 when the order has none (`briefing.hasProposedDraft` is false) or the file cannot be read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def download_order_briefing(id, opts = {})
+      data, _status_code, _headers = download_order_briefing_with_http_info(id, opts)
+      data
+    end
+
+    # Download the draft you attached to an order
+    # The file you attached to the briefing of a post order. 404 when the order has none (&#x60;briefing.hasProposedDraft&#x60; is false) or the file cannot be read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def download_order_briefing_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.download_order_briefing ...'
+      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.download_order_briefing"
+      end
+      # resource path
+      local_var_path = '/api/v1/orders/{id}/briefing'.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/octet-stream', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.download_order_briefing",
+        :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#download_order_briefing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download the draft of an order
+    # The file of the current draft of a post order. 404 when the order has no draft file (`draft.hasFile` is false) or the file cannot be read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def download_order_draft(id, opts = {})
+      data, _status_code, _headers = download_order_draft_with_http_info(id, opts)
+      data
+    end
+
+    # Download the draft of an order
+    # The file of the current draft of a post order. 404 when the order has no draft file (&#x60;draft.hasFile&#x60; is false) or the file cannot be read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def download_order_draft_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.download_order_draft ...'
+      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.download_order_draft"
+      end
+      # resource path
+      local_var_path = '/api/v1/orders/{id}/draft'.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/octet-stream', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.download_order_draft",
+        :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#download_order_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Estimate an order
+    # Checks and prices the order POST /orders would place with the same body, without `expectedPrice`, and compares the price with your wallet's available balance. Nothing is placed, charged or used up, so a read-only key may call it and it takes no Idempotency-Key. Send the `price` it answers as `expectedPrice` when you place the order.  The estimate is refused for the same reasons as the order itself, except a balance that does not cover the price: that is answered here with `sufficientBalance: false` and the `missing` amount.
+    # @param order_estimate_request [OrderEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OrderEstimate]
+    def estimate_order(order_estimate_request, opts = {})
+      data, _status_code, _headers = estimate_order_with_http_info(order_estimate_request, opts)
+      data
+    end
+
+    # Estimate an order
+    # Checks and prices the order POST /orders would place with the same body, without &#x60;expectedPrice&#x60;, and compares the price with your wallet&#39;s available balance. Nothing is placed, charged or used up, so a read-only key may call it and it takes no Idempotency-Key. Send the &#x60;price&#x60; it answers as &#x60;expectedPrice&#x60; when you place the order.  The estimate is refused for the same reasons as the order itself, except a balance that does not cover the price: that is answered here with &#x60;sufficientBalance: false&#x60; and the &#x60;missing&#x60; amount.
+    # @param order_estimate_request [OrderEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderEstimate, Integer, Hash)>] OrderEstimate data, response status code and response headers
+    def estimate_order_with_http_info(order_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.estimate_order ...'
+      end
+      # verify the required parameter 'order_estimate_request' is set
+      if @api_client.config.client_side_validation && order_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'order_estimate_request' when calling OrdersApi.estimate_order"
+      end
+      # resource path
+      local_var_path = '/api/v1/orders/estimate'
+
+      # 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']) unless header_params['Accept']
+      # 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
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(order_estimate_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderEstimate'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.estimate_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#estimate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an order
+    # One order you bought, with its briefing, its draft and its state history.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Order]
+    def get_order(id, opts = {})
+      data, _status_code, _headers = get_order_with_http_info(id, opts)
+      data
+    end
+
+    # Get an order
+    # One order you bought, with its briefing, its draft and its state history.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers
+    def get_order_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.get_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.get_order"
+      end
+      # resource path
+      local_var_path = '/api/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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Order'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.get_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#get_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List your orders
+    # The orders you bought, newest first by default. To follow your orders, poll with `sort=updatedAt` and `updatedSince` set to the `updatedAt` of the last order you saw: an order moves to the end of that list each time it changes state.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :project_id Only the orders of this project of yours.
+    # @option opts [String] :media_id Only the orders on this media.
+    # @option opts [String] :state Only the orders in one of these states, comma-separated. An unknown state is refused with 422 and the list of valid ones.
+    # @option opts [Time] :updated_since Only the orders whose &#x60;updatedAt&#x60; is at or after this instant, an ISO-8601 date-time with its offset (send &#x60;+&#x60; as &#x60;%2B&#x60;).
+    # @option opts [String] :sort &#x60;-createdAt&#x60;, newest first, or &#x60;updatedAt&#x60;, least recently changed first. Orders of the same instant come in id order. (default to '-createdAt')
+    # @option opts [Integer] :limit Orders per page, 1 to 100. (default to 20)
+    # @option opts [Integer] :offset Orders to skip. (default to 0)
+    # @return [ListOrders200Response]
+    def list_orders(opts = {})
+      data, _status_code, _headers = list_orders_with_http_info(opts)
+      data
+    end
+
+    # List your orders
+    # The orders you bought, newest first by default. To follow your orders, poll with &#x60;sort&#x3D;updatedAt&#x60; and &#x60;updatedSince&#x60; set to the &#x60;updatedAt&#x60; of the last order you saw: an order moves to the end of that list each time it changes state.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :project_id Only the orders of this project of yours.
+    # @option opts [String] :media_id Only the orders on this media.
+    # @option opts [String] :state Only the orders in one of these states, comma-separated. An unknown state is refused with 422 and the list of valid ones.
+    # @option opts [Time] :updated_since Only the orders whose &#x60;updatedAt&#x60; is at or after this instant, an ISO-8601 date-time with its offset (send &#x60;+&#x60; as &#x60;%2B&#x60;).
+    # @option opts [String] :sort &#x60;-createdAt&#x60;, newest first, or &#x60;updatedAt&#x60;, least recently changed first. Orders of the same instant come in id order. (default to '-createdAt')
+    # @option opts [Integer] :limit Orders per page, 1 to 100. (default to 20)
+    # @option opts [Integer] :offset Orders to skip. (default to 0)
+    # @return [Array<(ListOrders200Response, Integer, Hash)>] ListOrders200Response data, response status code and response headers
+    def list_orders_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.list_orders ...'
+      end
+      allowable_values = ["-createdAt", "updatedAt"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrdersApi.list_orders, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrdersApi.list_orders, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling OrdersApi.list_orders, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/orders'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
+      query_params[:'mediaId'] = opts[:'media_id'] if !opts[:'media_id'].nil?
+      query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+      query_params[:'updatedSince'] = opts[:'updated_since'] if !opts[:'updated_since'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListOrders200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.list_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#list_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Request changes to a draft
+    # Asks the seller to change the draft of a post order whose `pendingAction` is yours to review the draft, as the web does. The seller is told your reason.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_action_reason [OrderActionReason] 
+    # @param [Hash] opts the optional parameters
+    # @return [Order]
+    def request_order_draft_update(id, idempotency_key, order_action_reason, opts = {})
+      data, _status_code, _headers = request_order_draft_update_with_http_info(id, idempotency_key, order_action_reason, opts)
+      data
+    end
+
+    # Request changes to a draft
+    # Asks the seller to change the draft of a post order whose &#x60;pendingAction&#x60; is yours to review the draft, as the web does. The seller is told your reason.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_action_reason [OrderActionReason] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers
+    def request_order_draft_update_with_http_info(id, idempotency_key, order_action_reason, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.request_order_draft_update ...'
+      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.request_order_draft_update"
+      end
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling OrdersApi.request_order_draft_update"
+      end
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling OrdersApi.request_order_draft_update, the character length must be smaller than or equal to 255.'
+      end
+
+      # verify the required parameter 'order_action_reason' is set
+      if @api_client.config.client_side_validation && order_action_reason.nil?
+        fail ArgumentError, "Missing the required parameter 'order_action_reason' when calling OrdersApi.request_order_draft_update"
+      end
+      # resource path
+      local_var_path = '/api/v1/orders/{id}/request-draft-update'.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']) unless header_params['Accept']
+      # 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[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(order_action_reason)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Order'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.request_order_draft_update",
+        :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#request_order_draft_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Request changes to a delivery
+    # Asks the seller to change the delivery of an order whose `pendingAction` is yours to review the delivery, as the web does. The seller is told your reason.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_action_reason [OrderActionReason] 
+    # @param [Hash] opts the optional parameters
+    # @return [Order]
+    def request_order_update(id, idempotency_key, order_action_reason, opts = {})
+      data, _status_code, _headers = request_order_update_with_http_info(id, idempotency_key, order_action_reason, opts)
+      data
+    end
+
+    # Request changes to a delivery
+    # Asks the seller to change the delivery of an order whose &#x60;pendingAction&#x60; is yours to review the delivery, as the web does. The seller is told your reason.
+    # @param id [String] 
+    # @param idempotency_key [String] A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;.
+    # @param order_action_reason [OrderActionReason] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers
+    def request_order_update_with_http_info(id, idempotency_key, order_action_reason, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.request_order_update ...'
+      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.request_order_update"
+      end
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling OrdersApi.request_order_update"
+      end
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling OrdersApi.request_order_update, the character length must be smaller than or equal to 255.'
+      end
+
+      # verify the required parameter 'order_action_reason' is set
+      if @api_client.config.client_side_validation && order_action_reason.nil?
+        fail ArgumentError, "Missing the required parameter 'order_action_reason' when calling OrdersApi.request_order_update"
+      end
+      # resource path
+      local_var_path = '/api/v1/orders/{id}/request-update'.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']) unless header_params['Accept']
+      # 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[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(order_action_reason)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Order'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.request_order_update",
+        :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#request_order_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end