dear-inventory-ruby 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55910dcce013a8a19e74b7a2bc2d152e7ed86815c3329b22516286b61c79efbe
-  data.tar.gz: 7a171b04aa4d7f83431a3ba967cc36a1ca9e8e349726bd1660058d30130df798
+  metadata.gz: 46a7bf68cac78ec398af03a348361976a1b36a5f47540a55c04ed6233321664c
+  data.tar.gz: ba84070b6d81230ee401e84f773741d2e25d00fad208893cf05dd3604892e640
 SHA512:
-  metadata.gz: 56225a5d84b30c6d337ba8256cab93cb7df36dc945ba31591a9a6704a0838e1a8f44eaa12fa06754fc2dd715a54165c3c22708d9002f86a95fa3a582869cf228
-  data.tar.gz: c4c81d7d9305a1fc5886e90961a1e3aae39147a9410e36522fdc6c1ab1c6d97a0c1a5278e2cfa6a78f1a2b4a491d2d48731b743a521587264faf3255a6214667
+  metadata.gz: 264b8ecf72a6f6e0b1a2cac41894fa66d1a819896b2da8e0764df4b311b318360bfb1240b12bb467252f67b8ea8e28fe5406937353a014aec59199a521daa435
+  data.tar.gz: 39bdca1e9f50d91d201a6f445620585d46eb814e5bea255fa7d02a079aa81a0357f77b9e7290c71f6349fb4aba249f92e0e4be7911322042c13bd94ac4b34bca

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.9] - 2023-05-30
+
+- Add `Attachments` property to responses of the endpoint GET `/sale`
+
 ## [0.2.8] - 2022-12-15
 
 - Remove some validations of `Tax`

data/README.md

@@ -7,7 +7,7 @@ This specifing endpoints for DEAR Inventory API
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 0.2.8
+- Package version: 0.2.9
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.nhansg.com](https://www.nhansg.com)
 
@@ -24,16 +24,16 @@ gem build dear-inventory-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./dear-inventory-ruby-0.2.8.gem
+gem install ./dear-inventory-ruby-0.2.9.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.2.8.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.2.9.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'dear-inventory-ruby', '~> 0.2.8'
+    gem 'dear-inventory-ruby', '~> 0.2.9'
 
 ### Install from Git
 
@@ -132,6 +132,7 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::Account](docs/Account.md)
  - [DearInventoryRuby::Accounts](docs/Accounts.md)
  - [DearInventoryRuby::Address](docs/Address.md)
+ - [DearInventoryRuby::AttachmentLine](docs/AttachmentLine.md)
  - [DearInventoryRuby::AuthorizationType](docs/AuthorizationType.md)
  - [DearInventoryRuby::Contact](docs/Contact.md)
  - [DearInventoryRuby::Customer](docs/Customer.md)

data/docs/AttachmentLine.md

@@ -0,0 +1,25 @@
+# DearInventoryRuby::AttachmentLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Attached file ID | [optional] 
+**content_type** | **String** | Attached file content type | [optional] 
+**is_default** | **Boolean** | Is this attachment will be used as default product image. Is visible only for product Attachment Endpoint. | [optional] 
+**file_name** | **String** | Attached file name | [optional] 
+**download_url** | **String** | Url to download attached File | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::AttachmentLine.new(id: nil,
+                                 content_type: nil,
+                                 is_default: nil,
+                                 file_name: nil,
+                                 download_url: nil)
+```
+
+

data/docs/Sale.md

@@ -46,6 +46,7 @@ Name | Type | Description | Notes
 **quote** | [**SaleQuote**](SaleQuote.md) |  | [optional] 
 **order** | [**SaleOrder**](SaleOrder.md) |  | [optional] 
 **invoices** | [**Array<SaleInvoice>**](SaleInvoice.md) | Sale Invoices | [optional] 
+**attachments** | [**Array<AttachmentLine>**](AttachmentLine.md) | Sale Attachments | [optional] 
 
 ## Code Sample
 
@@ -93,7 +94,8 @@ instance = DearInventoryRuby::Sale.new(id: nil,
                                  service_only: nil,
                                  quote: nil,
                                  order: nil,
-                                 invoices: nil)
+                                 invoices: nil,
+                                 attachments: nil)
 ```
 
 

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

@@ -0,0 +1,247 @@
+=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 AttachmentLine
+    # Attached file ID
+    attr_accessor :id
+
+    # Attached file content type
+    attr_accessor :content_type
+
+    # Is this attachment will be used as default product image. Is visible only for product Attachment Endpoint.
+    attr_accessor :is_default
+
+    # Attached file name
+    attr_accessor :file_name
+
+    # Url to download attached File
+    attr_accessor :download_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'ID',
+        :'content_type' => :'ContentType',
+        :'is_default' => :'IsDefault',
+        :'file_name' => :'FileName',
+        :'download_url' => :'DownloadUrl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'content_type' => :'String',
+        :'is_default' => :'Boolean',
+        :'file_name' => :'String',
+        :'download_url' => :'String'
+      }
+    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::AttachmentLine` 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::AttachmentLine`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
+
+      if attributes.key?(:'is_default')
+        self.is_default = attributes[:'is_default']
+      end
+
+      if attributes.key?(:'file_name')
+        self.file_name = attributes[:'file_name']
+      end
+
+      if attributes.key?(:'download_url')
+        self.download_url = attributes[:'download_url']
+      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 &&
+          id == o.id &&
+          content_type == o.content_type &&
+          is_default == o.is_default &&
+          file_name == o.file_name &&
+          download_url == o.download_url
+    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
+      [id, content_type, is_default, file_name, download_url].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/sale.rb

@@ -136,6 +136,9 @@ module DearInventoryRuby
     # Sale Invoices
     attr_accessor :invoices
 
+    # Sale Attachments
+    attr_accessor :attachments
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -180,7 +183,8 @@ module DearInventoryRuby
         :'service_only' => :'ServiceOnly',
         :'quote' => :'Quote',
         :'order' => :'Order',
-        :'invoices' => :'Invoices'
+        :'invoices' => :'Invoices',
+        :'attachments' => :'Attachments'
       }
     end
 
@@ -228,7 +232,8 @@ module DearInventoryRuby
         :'service_only' => :'String',
         :'quote' => :'SaleQuote',
         :'order' => :'SaleOrder',
-        :'invoices' => :'Array<SaleInvoice>'
+        :'invoices' => :'Array<SaleInvoice>',
+        :'attachments' => :'Array<AttachmentLine>'
       }
     end
 
@@ -422,6 +427,12 @@ module DearInventoryRuby
           self.invoices = value
         end
       end
+
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -483,7 +494,8 @@ module DearInventoryRuby
           service_only == o.service_only &&
           quote == o.quote &&
           order == o.order &&
-          invoices == o.invoices
+          invoices == o.invoices &&
+          attachments == o.attachments
     end
 
     # @see the `==` method
@@ -495,7 +507,7 @@ module DearInventoryRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, customer, customer_id, contact, phone, email, default_account, skip_quote, billing_address, shipping_address, shipping_notes, base_currency, customer_currency, tax_rule, tax_calculation, terms, price_tier, ship_by, location, sale_order_date, last_modified_on, note, customer_reference, cogs_amount, status, combined_picking_status, combined_packing_status, combined_shipping_status, ful_filment_status, combined_invoice_status, combined_payment_status, combined_tracking_numbers, carrier, currency_rate, sales_representative, type, source_channel, external_id, service_only, quote, order, invoices].hash
+      [id, customer, customer_id, contact, phone, email, default_account, skip_quote, billing_address, shipping_address, shipping_notes, base_currency, customer_currency, tax_rule, tax_calculation, terms, price_tier, ship_by, location, sale_order_date, last_modified_on, note, customer_reference, cogs_amount, status, combined_picking_status, combined_packing_status, combined_shipping_status, ful_filment_status, combined_invoice_status, combined_payment_status, combined_tracking_numbers, carrier, currency_rate, sales_representative, type, source_channel, external_id, service_only, quote, order, invoices, attachments].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.8'
+  VERSION = '0.2.9'
 end

data/lib/dear-inventory-ruby.rb

@@ -20,6 +20,7 @@ require 'dear-inventory-ruby/configuration'
 require 'dear-inventory-ruby/models/account'
 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/contact'
 require 'dear-inventory-ruby/models/customer'

data/spec/models/attachment_line_spec.rb

@@ -0,0 +1,65 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DearInventoryRuby::AttachmentLine
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AttachmentLine' do
+  before do
+    # run before each test
+    @instance = DearInventoryRuby::AttachmentLine.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AttachmentLine' do
+    it 'should create an instance of AttachmentLine' do
+      expect(@instance).to be_instance_of(DearInventoryRuby::AttachmentLine)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "content_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "is_default"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "file_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "download_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/sale_spec.rb

@@ -284,4 +284,10 @@ describe 'Sale' do
     end
   end
 
+  describe 'test attribute "attachments"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dear-inventory-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Nhan Nguyen
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-15 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,6 +87,7 @@ files:
 - docs/Account.md
 - docs/Accounts.md
 - docs/Address.md
+- docs/AttachmentLine.md
 - docs/AuthorizationType.md
 - docs/Contact.md
 - docs/Customer.md
@@ -134,6 +135,7 @@ files:
 - lib/dear-inventory-ruby/models/account.rb
 - lib/dear-inventory-ruby/models/accounts.rb
 - lib/dear-inventory-ruby/models/address.rb
+- lib/dear-inventory-ruby/models/attachment_line.rb
 - lib/dear-inventory-ruby/models/authorization_type.rb
 - lib/dear-inventory-ruby/models/contact.rb
 - lib/dear-inventory-ruby/models/customer.rb
@@ -179,6 +181,7 @@ files:
 - spec/models/account_spec.rb
 - spec/models/accounts_spec.rb
 - spec/models/address_spec.rb
+- spec/models/attachment_line_spec.rb
 - spec/models/authorization_type_spec.rb
 - spec/models/contact_spec.rb
 - spec/models/customer_spec.rb
@@ -225,7 +228,7 @@ metadata:
   source_code_uri: https://github.com/nnhansg/dear-ruby
   changelog_uri: https://github.com/nnhansg/dear-ruby/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/nnhansg/dear-ruby/issues
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -240,8 +243,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
 specification_version: 4
 summary: DEAR Inventory Ruby SDK generated from DEAR-OpenAPI Spec 3.0 for https://inventory.dearsystems.com
 test_files:
@@ -265,6 +269,7 @@ test_files:
 - spec/models/sale_invoice_partial_spec.rb
 - spec/models/sale_order_line_spec.rb
 - spec/models/customers_spec.rb
+- spec/models/attachment_line_spec.rb
 - spec/models/customer_spec.rb
 - spec/models/sale_invoice_delete_spec.rb
 - spec/models/sale_payment_spec.rb