dear-inventory-ruby 0.2.10.1 → 0.2.12

data/lib/dear-inventory-ruby/models/me_contact.rb

@@ -0,0 +1,289 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module DearInventoryRuby
+  class MeContact
+    # Unique `MeContact` ID
+    attr_accessor :contact_id
+
+    # Name of `MeContact`
+    attr_accessor :name
+
+    # Phone
+    attr_accessor :phone
+
+    # Fax
+    attr_accessor :fax
+
+    # Email
+    attr_accessor :email
+
+    # Website
+    attr_accessor :website
+
+    # Comment
+    attr_accessor :comment
+
+    # `MeContact` Type. Should be one of the following values: `Billing`, `Business`, `Sale`, `Shipping` or `Employee`
+    attr_accessor :type
+
+    # Points that `MeContact` is used as default for chosen `Type`. `False` as default.
+    attr_accessor :default_for_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'contact_id' => :'ContactID',
+        :'name' => :'Name',
+        :'phone' => :'Phone',
+        :'fax' => :'Fax',
+        :'email' => :'Email',
+        :'website' => :'Website',
+        :'comment' => :'Comment',
+        :'type' => :'Type',
+        :'default_for_type' => :'DefaultForType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'contact_id' => :'String',
+        :'name' => :'String',
+        :'phone' => :'String',
+        :'fax' => :'String',
+        :'email' => :'String',
+        :'website' => :'String',
+        :'comment' => :'String',
+        :'type' => :'String',
+        :'default_for_type' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::MeContact` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DearInventoryRuby::MeContact`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'contact_id')
+        self.contact_id = attributes[:'contact_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'phone')
+        self.phone = attributes[:'phone']
+      end
+
+      if attributes.key?(:'fax')
+        self.fax = attributes[:'fax']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'default_for_type')
+        self.default_for_type = attributes[:'default_for_type']
+      else
+        self.default_for_type = false
+      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 &&
+          contact_id == o.contact_id &&
+          name == o.name &&
+          phone == o.phone &&
+          fax == o.fax &&
+          email == o.email &&
+          website == o.website &&
+          comment == o.comment &&
+          type == o.type &&
+          default_for_type == o.default_for_type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [contact_id, name, phone, fax, email, website, comment, type, default_for_type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that 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
+        DearInventoryRuby.const_get(type).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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        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/dear-inventory-ruby/models/me_contacts.rb

@@ -0,0 +1,229 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module DearInventoryRuby
+  class MeContacts
+    # Total
+    attr_accessor :total
+
+    # Page
+    attr_accessor :page
+
+    # Array of MeContacts
+    attr_accessor :me_contacts_list
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'Total',
+        :'page' => :'Page',
+        :'me_contacts_list' => :'MeContactsList'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'total' => :'Float',
+        :'page' => :'Float',
+        :'me_contacts_list' => :'Array<MeContact>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::MeContacts` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DearInventoryRuby::MeContacts`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'page')
+        self.page = attributes[:'page']
+      end
+
+      if attributes.key?(:'me_contacts_list')
+        if (value = attributes[:'me_contacts_list']).is_a?(Array)
+          self.me_contacts_list = value
+        end
+      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 &&
+          total == o.total &&
+          page == o.page &&
+          me_contacts_list == o.me_contacts_list
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [total, page, me_contacts_list].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that 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
+        DearInventoryRuby.const_get(type).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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        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/dear-inventory-ruby/models/supplier_customer_address.rb

@@ -30,7 +30,7 @@ module DearInventoryRuby
     attr_accessor :state
 
     # Zip / PostCode
-    attr_accessor :post_code
+    attr_accessor :postcode
 
     # Country name
     attr_accessor :country
@@ -49,7 +49,7 @@ module DearInventoryRuby
         :'line2' => :'Line2',
         :'city' => :'City',
         :'state' => :'State',
-        :'post_code' => :'PostCode',
+        :'postcode' => :'Postcode',
         :'country' => :'Country',
         :'type' => :'Type',
         :'default_for_type' => :'DefaultForType'
@@ -64,7 +64,7 @@ module DearInventoryRuby
         :'line2' => :'String',
         :'city' => :'String',
         :'state' => :'String',
-        :'post_code' => :'String',
+        :'postcode' => :'String',
         :'country' => :'String',
         :'type' => :'String',
         :'default_for_type' => :'Boolean'
@@ -112,8 +112,8 @@ module DearInventoryRuby
         self.state = attributes[:'state']
       end
 
-      if attributes.key?(:'post_code')
-        self.post_code = attributes[:'post_code']
+      if attributes.key?(:'postcode')
+        self.postcode = attributes[:'postcode']
       end
 
       if attributes.key?(:'country')
@@ -164,7 +164,7 @@ module DearInventoryRuby
           line2 == o.line2 &&
           city == o.city &&
           state == o.state &&
-          post_code == o.post_code &&
+          postcode == o.postcode &&
           country == o.country &&
           type == o.type &&
           default_for_type == o.default_for_type
@@ -179,7 +179,7 @@ module DearInventoryRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, line1, line2, city, state, post_code, country, type, default_for_type].hash
+      [id, line1, line2, city, state, postcode, country, type, default_for_type].hash
     end
 
     # Builds the object from hash

data/lib/dear-inventory-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module DearInventoryRuby
-  VERSION = '0.2.10.1'
+  VERSION = '0.2.12'
 end

data/lib/dear-inventory-ruby.rb

@@ -22,12 +22,19 @@ require 'dear-inventory-ruby/models/accounts'
 require 'dear-inventory-ruby/models/address'
 require 'dear-inventory-ruby/models/attachment_line'
 require 'dear-inventory-ruby/models/authorization_type'
+require 'dear-inventory-ruby/models/bin'
+require 'dear-inventory-ruby/models/carrier'
+require 'dear-inventory-ruby/models/carriers'
 require 'dear-inventory-ruby/models/contact'
 require 'dear-inventory-ruby/models/customer'
 require 'dear-inventory-ruby/models/customers'
 require 'dear-inventory-ruby/models/error'
 require 'dear-inventory-ruby/models/external_header'
+require 'dear-inventory-ruby/models/location'
+require 'dear-inventory-ruby/models/locations'
 require 'dear-inventory-ruby/models/me'
+require 'dear-inventory-ruby/models/me_contact'
+require 'dear-inventory-ruby/models/me_contacts'
 require 'dear-inventory-ruby/models/payment_term'
 require 'dear-inventory-ruby/models/payment_terms'
 require 'dear-inventory-ruby/models/price_tier'

data/spec/api/inventory_api_spec.rb

@@ -213,6 +213,20 @@ describe 'InventoryApi' do
     end
   end
 
+  # unit tests for get_carriers
+  # Allows you to retrieve the carriers
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :page Default is 1
+  # @option opts [String] :limit Default is 100
+  # @option opts [String] :carrier_id Only return Carrier with the specific CarrierID
+  # @option opts [String] :description Only return Carriers that start with the specific Description
+  # @return [Carriers]
+  describe 'get_carriers 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_customers
   # Allows you to retrieve the customers
   # @param [Hash] opts the optional parameters
@@ -222,8 +236,8 @@ describe 'InventoryApi' do
   # @option opts [String] :name Default is nil
   # @option opts [String] :contact_filter Default is nil
   # @option opts [String] :modified_since Default is nil
-  # @option opts [String] :include_deprecated Default is false
-  # @option opts [String] :include_product_prices Default is false
+  # @option opts [Boolean] :include_deprecated Default is false
+  # @option opts [Boolean] :include_product_prices Default is false
   # @return [Customers]
   describe 'get_customers test' do
     it 'should work' do
@@ -231,6 +245,21 @@ describe 'InventoryApi' do
     end
   end
 
+  # unit tests for get_locations
+  # Allows you to retrieve the locations
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :page Default is 1
+  # @option opts [String] :limit Default is 100
+  # @option opts [String] :id Default is nil
+  # @option opts [Boolean] :deprecated Default is false
+  # @option opts [String] :name Default is nil
+  # @return [Locations]
+  describe 'get_locations 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_me
   # Allows you to retrieve your information
   # @param [Hash] opts the optional parameters
@@ -241,6 +270,16 @@ describe 'InventoryApi' do
     end
   end
 
+  # unit tests for get_me_contacts
+  # Allows you to retrieve the me contacts (Sales Representatives)
+  # @param [Hash] opts the optional parameters
+  # @return [MeContacts]
+  describe 'get_me_contacts 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_payment_terms
   # Allows you to retrieve the payment terms
   # @param [Hash] opts the optional parameters