wine_shipping 1.0.0

data/lib/wine_shipping/models/warehouse_inventory_status.rb

@@ -0,0 +1,282 @@
+=begin
+#API from Wineshipping
+
+#Wineshipping API is a programmatically consumable service or an Application Programming Interface (API) platform designed to enable Wineshipping LLC's client applications to natively transmit and manage their order, view inventory, track shipments etc.<br /><br />In order to access API operations request a UserKey and Password from Wineshipping. For any questions please contact Wineshipping Helpdesk at <a href='mailto:IT-Help@wineshipping.com?Subject=API from Wineshipping'>IT-Help@wineshipping.com</a>.
+
+OpenAPI spec version: V3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'date'
+
+module WineShipping
+  class WarehouseInventoryStatus
+    attr_accessor :customer_no
+
+    attr_accessor :customer_name
+
+    attr_accessor :item_no
+
+    attr_accessor :item_description
+
+    attr_accessor :item_unit
+
+    attr_accessor :inventory_warehouse
+
+    attr_accessor :inventory_status
+
+    attr_accessor :on_hand_quantity
+
+    attr_accessor :reserved_quantity
+
+    attr_accessor :available_quantity
+
+    attr_accessor :back_order_quantity
+
+    attr_accessor :open_po_quantity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'customer_no' => :'CustomerNo',
+        :'customer_name' => :'CustomerName',
+        :'item_no' => :'ItemNo',
+        :'item_description' => :'ItemDescription',
+        :'item_unit' => :'ItemUnit',
+        :'inventory_warehouse' => :'InventoryWarehouse',
+        :'inventory_status' => :'InventoryStatus',
+        :'on_hand_quantity' => :'OnHandQuantity',
+        :'reserved_quantity' => :'ReservedQuantity',
+        :'available_quantity' => :'AvailableQuantity',
+        :'back_order_quantity' => :'BackOrderQuantity',
+        :'open_po_quantity' => :'OpenPOQuantity'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'customer_no' => :'String',
+        :'customer_name' => :'String',
+        :'item_no' => :'String',
+        :'item_description' => :'String',
+        :'item_unit' => :'String',
+        :'inventory_warehouse' => :'String',
+        :'inventory_status' => :'String',
+        :'on_hand_quantity' => :'Integer',
+        :'reserved_quantity' => :'Integer',
+        :'available_quantity' => :'Integer',
+        :'back_order_quantity' => :'Integer',
+        :'open_po_quantity' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'CustomerNo')
+        self.customer_no = attributes[:'CustomerNo']
+      end
+
+      if attributes.has_key?(:'CustomerName')
+        self.customer_name = attributes[:'CustomerName']
+      end
+
+      if attributes.has_key?(:'ItemNo')
+        self.item_no = attributes[:'ItemNo']
+      end
+
+      if attributes.has_key?(:'ItemDescription')
+        self.item_description = attributes[:'ItemDescription']
+      end
+
+      if attributes.has_key?(:'ItemUnit')
+        self.item_unit = attributes[:'ItemUnit']
+      end
+
+      if attributes.has_key?(:'InventoryWarehouse')
+        self.inventory_warehouse = attributes[:'InventoryWarehouse']
+      end
+
+      if attributes.has_key?(:'InventoryStatus')
+        self.inventory_status = attributes[:'InventoryStatus']
+      end
+
+      if attributes.has_key?(:'OnHandQuantity')
+        self.on_hand_quantity = attributes[:'OnHandQuantity']
+      end
+
+      if attributes.has_key?(:'ReservedQuantity')
+        self.reserved_quantity = attributes[:'ReservedQuantity']
+      end
+
+      if attributes.has_key?(:'AvailableQuantity')
+        self.available_quantity = attributes[:'AvailableQuantity']
+      end
+
+      if attributes.has_key?(:'BackOrderQuantity')
+        self.back_order_quantity = attributes[:'BackOrderQuantity']
+      end
+
+      if attributes.has_key?(:'OpenPOQuantity')
+        self.open_po_quantity = attributes[:'OpenPOQuantity']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          customer_no == o.customer_no &&
+          customer_name == o.customer_name &&
+          item_no == o.item_no &&
+          item_description == o.item_description &&
+          item_unit == o.item_unit &&
+          inventory_warehouse == o.inventory_warehouse &&
+          inventory_status == o.inventory_status &&
+          on_hand_quantity == o.on_hand_quantity &&
+          reserved_quantity == o.reserved_quantity &&
+          available_quantity == o.available_quantity &&
+          back_order_quantity == o.back_order_quantity &&
+          open_po_quantity == o.open_po_quantity
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [customer_no, customer_name, item_no, item_description, item_unit, inventory_warehouse, inventory_status, on_hand_quantity, reserved_quantity, available_quantity, back_order_quantity, open_po_quantity].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = WineShipping.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/wine_shipping/version.rb

@@ -0,0 +1,15 @@
+=begin
+#API from Wineshipping
+
+#Wineshipping API is a programmatically consumable service or an Application Programming Interface (API) platform designed to enable Wineshipping LLC's client applications to natively transmit and manage their order, view inventory, track shipments etc.<br /><br />In order to access API operations request a UserKey and Password from Wineshipping. For any questions please contact Wineshipping Helpdesk at <a href='mailto:IT-Help@wineshipping.com?Subject=API from Wineshipping'>IT-Help@wineshipping.com</a>.
+
+OpenAPI spec version: V3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+module WineShipping
+  VERSION = '1.0.0'
+end

data/spec/api/inventory_api_spec.rb

@@ -0,0 +1,57 @@
+=begin
+#API from Wineshipping
+
+#Wineshipping API is a programmatically consumable service or an Application Programming Interface (API) platform designed to enable Wineshipping LLC's client applications to natively transmit and manage their order, view inventory, track shipments etc.<br /><br />In order to access API operations request a UserKey and Password from Wineshipping. For any questions please contact Wineshipping Helpdesk at <a href='mailto:IT-Help@wineshipping.com?Subject=API from Wineshipping'>IT-Help@wineshipping.com</a>.
+
+OpenAPI spec version: V3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for WineShipping::InventoryApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InventoryApi' do
+  before do
+    # run before each test
+    @instance = WineShipping::InventoryApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InventoryApi' do
+    it 'should create an instance of InventoryApi' do
+      expect(@instance).to be_instance_of(WineShipping::InventoryApi)
+    end
+  end
+
+  # unit tests for get_inventory_details
+  # This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation accepts a customer number to summarize inventory information within the Wineshipping system. This is a Legacy operation for backward compatibility. For new integration the recomended operation is GetInventoryStatus.
+  # @param authentication_details 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Inventory>]
+  describe 'get_inventory_details test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_inventory_status
+  # This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation optionally accepts a warehouse code to return related inventory records for a specific Wineshipping warehouse, if omitted the operation will return inventory records for all warehouses. The operation also accepts an array of items to query inventory records, if omitted returns inventory records for all items in the warehouse specified.
+  # @param invent_status_request 
+  # @param [Hash] opts the optional parameters
+  # @return [InventoryStatusResult]
+  describe 'get_inventory_status test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/inventory_movement_api_spec.rb

@@ -0,0 +1,57 @@
+=begin
+#API from Wineshipping
+
+#Wineshipping API is a programmatically consumable service or an Application Programming Interface (API) platform designed to enable Wineshipping LLC's client applications to natively transmit and manage their order, view inventory, track shipments etc.<br /><br />In order to access API operations request a UserKey and Password from Wineshipping. For any questions please contact Wineshipping Helpdesk at <a href='mailto:IT-Help@wineshipping.com?Subject=API from Wineshipping'>IT-Help@wineshipping.com</a>.
+
+OpenAPI spec version: V3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for WineShipping::InventoryMovementApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InventoryMovementApi' do
+  before do
+    # run before each test
+    @instance = WineShipping::InventoryMovementApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InventoryMovementApi' do
+    it 'should create an instance of InventoryMovementApi' do
+      expect(@instance).to be_instance_of(WineShipping::InventoryMovementApi)
+    end
+  end
+
+  # unit tests for create_purchase_order
+  # Successful execution of this method will generate a new purchase order in Wineshipping&#39;s system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with the purchase order.
+  # @param order_details_info 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_purchase_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_transfer_order
+  # Successful execution of this method will generate a new transfer order in Wineshipping&#39;s system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with the transfer order.
+  # @param order_details_info 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_transfer_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/sales_order_api_spec.rb

@@ -0,0 +1,90 @@
+=begin
+#API from Wineshipping
+
+#Wineshipping API is a programmatically consumable service or an Application Programming Interface (API) platform designed to enable Wineshipping LLC's client applications to natively transmit and manage their order, view inventory, track shipments etc.<br /><br />In order to access API operations request a UserKey and Password from Wineshipping. For any questions please contact Wineshipping Helpdesk at <a href='mailto:IT-Help@wineshipping.com?Subject=API from Wineshipping'>IT-Help@wineshipping.com</a>.
+
+OpenAPI spec version: V3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for WineShipping::SalesOrderApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SalesOrderApi' do
+  before do
+    # run before each test
+    @instance = WineShipping::SalesOrderApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SalesOrderApi' do
+    it 'should create an instance of SalesOrderApi' do
+      expect(@instance).to be_instance_of(WineShipping::SalesOrderApi)
+    end
+  end
+
+  # unit tests for cancel_sales_order
+  # Use this operation to cancel an existing open sales order. Successful execution of this method will cancel the sales order in Wineshipping system. If the order cannot be cancelled for some reason standard HTTP Status Code and a reason will be returned.
+  # @param cancel_sales_order_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'cancel_sales_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_sales_order
+  # Successful execution of this method will generate a new shipment order in Wineshipping&#39;s system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with your order.
+  # @param order_details_info 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_sales_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_orders_on_hold
+  # Use this operation to retrieve a list of on-hold orders for a customer. Successful execution of this method will generate a list of on hold orders from Wineshipping&#39;s system and if no orders are on hold, HTTP status code Not Found response will be returned.
+  # @param authentication_details 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<OrderOnHold>]
+  describe 'get_orders_on_hold test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_returns
+  # Use this operation to retrieve a list of return sales orders for a customer. Successful execution of this method will generate a list of returns from Wineshipping system.
+  # @param returns_request_details 
+  # @param [Hash] opts the optional parameters
+  # @return [ReturnResult]
+  describe 'get_returns test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for replace_sales_order
+  # Use this operation to replace/update an existing open sales order. Successful execution of this method will replace an open sales order in Wineshipping system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with your replacement order. If the order cannot be replaced for some, reason standard HTTP Status Code and a reason message will be returned.
+  # @param order_details_info 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'replace_sales_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end