zippendo 1.0.0

data/lib/zippendo/api/orders_api.rb

@@ -0,0 +1,412 @@
+=begin
+#Zippendo Public API
+
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zippendo.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Zippendo
+  class OrdersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create order
+    # Creates a new order under an existing order channel for the organization.
+    # @param org_id [String] Organization ID
+    # @param create_order_request [CreateOrderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateOrder201Response]
+    def create_order(org_id, create_order_request, opts = {})
+      data, _status_code, _headers = create_order_with_http_info(org_id, create_order_request, opts)
+      data
+    end
+
+    # Create order
+    # Creates a new order under an existing order channel for the organization.
+    # @param org_id [String] Organization ID
+    # @param create_order_request [CreateOrderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateOrder201Response, Integer, Hash)>] CreateOrder201Response data, response status code and response headers
+    def create_order_with_http_info(org_id, create_order_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.create_order ...'
+      end
+      # verify the required parameter 'org_id' is set
+      if @api_client.config.client_side_validation && org_id.nil?
+        fail ArgumentError, "Missing the required parameter 'org_id' when calling 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 = '/orgs/{orgId}/orders'.sub('{orgId}', CGI.escape(org_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
+
+      # 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] || 'CreateOrder201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      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
+    # Deletes an order. Fails if the order has associated shipments.
+    # @param org_id [String] Organization ID.
+    # @param order_id [String] Order ID.
+    # @param [Hash] opts the optional parameters
+    # @return [RevokeApiToken200Response]
+    def delete_order(org_id, order_id, opts = {})
+      data, _status_code, _headers = delete_order_with_http_info(org_id, order_id, opts)
+      data
+    end
+
+    # Delete order
+    # Deletes an order. Fails if the order has associated shipments.
+    # @param org_id [String] Organization ID.
+    # @param order_id [String] Order ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RevokeApiToken200Response, Integer, Hash)>] RevokeApiToken200Response data, response status code and response headers
+    def delete_order_with_http_info(org_id, order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.delete_order ...'
+      end
+      # verify the required parameter 'org_id' is set
+      if @api_client.config.client_side_validation && org_id.nil?
+        fail ArgumentError, "Missing the required parameter 'org_id' when calling OrdersApi.delete_order"
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrdersApi.delete_order"
+      end
+      # resource path
+      local_var_path = '/orgs/{orgId}/orders/{orderId}'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{orderId}', CGI.escape(order_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] || 'RevokeApiToken200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      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
+
+    # Get order
+    # Returns a single order with its channel, shipping rule, shipments, and documents.
+    # @param org_id [String] Organization ID.
+    # @param order_id [String] Order ID.
+    # @param [Hash] opts the optional parameters
+    # @return [GetOrder200Response]
+    def get_order(org_id, order_id, opts = {})
+      data, _status_code, _headers = get_order_with_http_info(org_id, order_id, opts)
+      data
+    end
+
+    # Get order
+    # Returns a single order with its channel, shipping rule, shipments, and documents.
+    # @param org_id [String] Organization ID.
+    # @param order_id [String] Order ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetOrder200Response, Integer, Hash)>] GetOrder200Response data, response status code and response headers
+    def get_order_with_http_info(org_id, order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.get_order ...'
+      end
+      # verify the required parameter 'org_id' is set
+      if @api_client.config.client_side_validation && org_id.nil?
+        fail ArgumentError, "Missing the required parameter 'org_id' when calling OrdersApi.get_order"
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrdersApi.get_order"
+      end
+      # resource path
+      local_var_path = '/orgs/{orgId}/orders/{orderId}'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{orderId}', CGI.escape(order_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] || 'GetOrder200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      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 orders
+    # Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
+    # @param org_id [String] Organization ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based) (default to 1)
+    # @option opts [Integer] :limit Items per page (max 100) (default to 20)
+    # @option opts [String] :status Order fulfilment status derived from its shipments.
+    # @option opts [String] :order_channel_id Filter by order channel ID.
+    # @option opts [String] :search Search by order number or customer name/email.
+    # @return [ListOrders200Response]
+    def list_orders(org_id, opts = {})
+      data, _status_code, _headers = list_orders_with_http_info(org_id, opts)
+      data
+    end
+
+    # List orders
+    # Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
+    # @param org_id [String] Organization ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based) (default to 1)
+    # @option opts [Integer] :limit Items per page (max 100) (default to 20)
+    # @option opts [String] :status Order fulfilment status derived from its shipments.
+    # @option opts [String] :order_channel_id Filter by order channel ID.
+    # @option opts [String] :search Search by order number or customer name/email.
+    # @return [Array<(ListOrders200Response, Integer, Hash)>] ListOrders200Response data, response status code and response headers
+    def list_orders_with_http_info(org_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.list_orders ...'
+      end
+      # verify the required parameter 'org_id' is set
+      if @api_client.config.client_side_validation && org_id.nil?
+        fail ArgumentError, "Missing the required parameter 'org_id' when calling OrdersApi.list_orders"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] > 9007199254740991
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling OrdersApi.list_orders, must be smaller than or equal to 9007199254740991.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling OrdersApi.list_orders, must be greater than or equal to 1.'
+      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
+
+      allowable_values = ["pending", "processing", "partially_fulfilled", "fulfilled", "error", "cancelled"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/orgs/{orgId}/orders'.sub('{orgId}', CGI.escape(org_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'orderChannelId'] = opts[:'order_channel_id'] if !opts[:'order_channel_id'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].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] || ['bearerAuth']
+
+      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
+
+    # Update order
+    # Updates an order that is not yet fulfilled or cancelled.
+    # @param org_id [String] Organization ID.
+    # @param order_id [String] Order ID.
+    # @param update_order_request [UpdateOrderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateOrder201Response]
+    def update_order(org_id, order_id, update_order_request, opts = {})
+      data, _status_code, _headers = update_order_with_http_info(org_id, order_id, update_order_request, opts)
+      data
+    end
+
+    # Update order
+    # Updates an order that is not yet fulfilled or cancelled.
+    # @param org_id [String] Organization ID.
+    # @param order_id [String] Order ID.
+    # @param update_order_request [UpdateOrderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateOrder201Response, Integer, Hash)>] CreateOrder201Response data, response status code and response headers
+    def update_order_with_http_info(org_id, order_id, update_order_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrdersApi.update_order ...'
+      end
+      # verify the required parameter 'org_id' is set
+      if @api_client.config.client_side_validation && org_id.nil?
+        fail ArgumentError, "Missing the required parameter 'org_id' when calling OrdersApi.update_order"
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrdersApi.update_order"
+      end
+      # verify the required parameter 'update_order_request' is set
+      if @api_client.config.client_side_validation && update_order_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_order_request' when calling OrdersApi.update_order"
+      end
+      # resource path
+      local_var_path = '/orgs/{orgId}/orders/{orderId}'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{orderId}', CGI.escape(order_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
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_order_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateOrder201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrdersApi.update_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#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end