dear-inventory-ruby 0.1.9 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe0a172dc3b6ea6dc88ee24a04dcf0d06aef4f1575f0eb1077534860d28b32a9
-  data.tar.gz: 4a9652d006b996e30b8889f0ef8855c26ff3fe0f8323dd383b060f26d6918e18
+  metadata.gz: 9ffbd271d3c715cef93bb33ce9a2f24c53c2decb1ecd1dcdfb15efc1929caf79
+  data.tar.gz: ba565c2f1ff6c1784d015e782bfbeb673e5540dce0120035854a4e16e939cff0
 SHA512:
-  metadata.gz: 12e37bb9d13b239f3992f2fd0bce2a7d0d0ea1a59b03e4bf3b0fef8e80e521c4478769836af705cb54c302355f05f4cf406ea955ffac2cc0499f8b0deedd3d60
-  data.tar.gz: 6fbe291c379f67c2d35abaa02dfa7459c3665415d42406162629d2f5538895bc8e409b5211020d5cd2c1b0a92d43de410a980031065687b3fbbb7f206326c92c
+  metadata.gz: b284bec84a7a1cd777cda1c0d085446f4fefb4e8244b9f8e08796291d7a4ceacb52e4fd2e00f0d636f7226f22a0952502180bfd0223b7e8230ca41ff574e4b88
+  data.tar.gz: 9953f21dc71d78792c23c307965ff6d878e4684a075c5b9d25afbac53bdd6cc5dde695676e32a551cf7803e1c020a5d0298e90f0202d2303618c7483599c0503

data/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.14] - 2021-05-01
+
+- Remove validation `Currency` for `Customer` and `Me` models.
+
+## [0.1.13] - 2020-10-28
+
+- Update `PriceTiersList` to `PriceTiers`.
+
+## [0.1.12] - 2020-10-28
+
+- Add new endpoint and model: `PriceTier`
+- Endpoint GET `PriceTiers`
+
+## [0.1.11] - 2020-09-21
+
+- Update limit of Comments in Customer model.
+- Remove required conditions of Address Type in Customer Address model.
+
+## [0.1.10] - 2020-09-04
+
+- Add some fields to Contact and Customer models.
+- Update OpenAPI Generator version 4.3.1
+
 ## [0.1.9] - 2020-04-12
 
 - Add new endpoint and model: Me

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.1.9
+- Package version: 0.1.14
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.nnhan.me](https://www.nnhan.me)
 
@@ -24,16 +24,16 @@ gem build dear-inventory-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./dear-inventory-ruby-0.1.9.gem
+gem install ./dear-inventory-ruby-0.1.14.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.1.9.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.1.14.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.1.9'
+    gem 'dear-inventory-ruby', '~> 0.1.14'
 
 ### Install from Git
 
@@ -102,6 +102,7 @@ Class | Method | HTTP request | Description
 *DearInventoryRuby::InventoryApi* | [**get_customers**](docs/InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
 *DearInventoryRuby::InventoryApi* | [**get_me**](docs/InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information
 *DearInventoryRuby::InventoryApi* | [**get_payment_terms**](docs/InventoryApi.md#get_payment_terms) | **GET** /ref/paymentterm | Allows you to retrieve the payment terms
+*DearInventoryRuby::InventoryApi* | [**get_price_tiers**](docs/InventoryApi.md#get_price_tiers) | **GET** /ref/priceTier | Allows you to retrieve the Price Tiers
 *DearInventoryRuby::InventoryApi* | [**get_taxes**](docs/InventoryApi.md#get_taxes) | **GET** /ref/tax | Allows you to retrieve the taxes
 *DearInventoryRuby::InventoryApi* | [**update_account**](docs/InventoryApi.md#update_account) | **PUT** /ref/account | Allows you to update an Account
 *DearInventoryRuby::InventoryApi* | [**update_customer**](docs/InventoryApi.md#update_customer) | **PUT** /customer | Allows you to update a customer
@@ -123,6 +124,8 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::Me](docs/Me.md)
  - [DearInventoryRuby::PaymentTerm](docs/PaymentTerm.md)
  - [DearInventoryRuby::PaymentTerms](docs/PaymentTerms.md)
+ - [DearInventoryRuby::PriceTier](docs/PriceTier.md)
+ - [DearInventoryRuby::PriceTiers](docs/PriceTiers.md)
  - [DearInventoryRuby::Success](docs/Success.md)
  - [DearInventoryRuby::Tax](docs/Tax.md)
  - [DearInventoryRuby::TaxComponent](docs/TaxComponent.md)

data/dear-inventory-ruby.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/docs/Contact.md

@@ -6,7 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | If passed in PUT method, entry will be searched by id, found entry will be updated, otherwise created | [optional] 
 **name** | **String** | Name of Contact | 
+**job_title** | **String** | Job Title | [optional] 
 **phone** | **String** | Phone | [optional] 
+**mobile_phone** | **String** | Mobile Phone | [optional] 
 **fax** | **String** | Fax | [optional] 
 **email** | **String** | Email | [optional] 
 **website** | **String** | Website | [optional] 
@@ -21,7 +23,9 @@ require 'DearInventoryRuby'
 
 instance = DearInventoryRuby::Contact.new(id: nil,
                                  name: nil,
+                                 job_title: nil,
                                  phone: nil,
+                                 mobile_phone: nil,
                                  fax: nil,
                                  email: nil,
                                  website: nil,

data/docs/Customer.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **id** | **String** | Unique Customer ID | [optional] 
 **name** | **String** | Name of Customer | 
 **status** | **String** | Points that Customer is Active. Available values are Active and Deprecated. Required for POST | 
-**currency** | [**CurrencyCode**](CurrencyCode.md) |  | 
+**currency** | **String** | Currency code of Customer | 
 **payment_term** | **String** | Payment term | 
 **account_receivable** | **String** | Account receivable code of Customer | 
 **revenue_account** | **String** | Sale account code of Customer | 
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **comments** | **String** | Comments | [optional] 
 **tax_number** | **String** | Tax number | [optional] 
 **credit_limit** | **Float** | Credit limit | [optional] 
+**is_on_credit_hold** | **Boolean** | boolean to indicate if a customer is on credit hold | [optional] [default to false]
 **tags** | **String** | Tags string | [optional] 
 **attribute_set** | **String** | AttributeSet name | [optional] 
 **additional_attribute1** | **String** | Additional attribute 1 value | [optional] 
@@ -57,6 +58,7 @@ instance = DearInventoryRuby::Customer.new(id: nil,
                                  comments: nil,
                                  tax_number: nil,
                                  credit_limit: nil,
+                                 is_on_credit_hold: nil,
                                  tags: nil,
                                  attribute_set: nil,
                                  additional_attribute1: nil,

data/docs/InventoryApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**get_customers**](InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
 [**get_me**](InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information
 [**get_payment_terms**](InventoryApi.md#get_payment_terms) | **GET** /ref/paymentterm | Allows you to retrieve the payment terms
+[**get_price_tiers**](InventoryApi.md#get_price_tiers) | **GET** /ref/priceTier | Allows you to retrieve the Price Tiers
 [**get_taxes**](InventoryApi.md#get_taxes) | **GET** /ref/tax | Allows you to retrieve the taxes
 [**update_account**](InventoryApi.md#update_account) | **PUT** /ref/account | Allows you to update an Account
 [**update_customer**](InventoryApi.md#update_customer) | **PUT** /customer | Allows you to update a customer
@@ -646,6 +647,59 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_price_tiers
+
+> PriceTiers get_price_tiers
+
+Allows you to retrieve the Price Tiers
+
+### Example
+
+```ruby
+# load the gem
+require 'dear-inventory-ruby'
+# setup authorization
+DearInventoryRuby.configure do |config|
+  # Configure API key authorization: accountID
+  config.api_key['api-auth-accountid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-auth-accountid'] = 'Bearer'
+
+  # Configure API key authorization: appKey
+  config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
+end
+
+api_instance = DearInventoryRuby::InventoryApi.new
+
+begin
+  #Allows you to retrieve the Price Tiers
+  result = api_instance.get_price_tiers
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_price_tiers: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PriceTiers**](PriceTiers.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_taxes
 
 > Taxes get_taxes(opts)

data/docs/Me.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **company** | **String** | Your company name | [optional] 
-**currency** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**currency** | **String** | Your company base currency | [optional] 
 **time_zone** | **String** | Time Zone where your company located | [optional] 
 **default_weight_units** | [**WeightUnit**](WeightUnit.md) |  | [optional] 
 **default_dimensions_units** | [**DimensionsUnit**](DimensionsUnit.md) |  | [optional] 

data/docs/PriceTier.md

@@ -0,0 +1,19 @@
+# DearInventoryRuby::PriceTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Code number of Price Tier | [optional] 
+**name** | **String** | Price Tier name | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::PriceTier.new(code: nil,
+                                 name: nil)
+```
+
+

data/docs/PriceTiers.md

@@ -0,0 +1,17 @@
+# DearInventoryRuby::PriceTiers
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_tiers** | [**Array<PriceTier>**](PriceTier.md) | Array of PriceTiers | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::PriceTiers.new(price_tiers: nil)
+```
+
+

data/lib/dear-inventory-ruby.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -29,6 +29,8 @@ require 'dear-inventory-ruby/models/error'
 require 'dear-inventory-ruby/models/me'
 require 'dear-inventory-ruby/models/payment_term'
 require 'dear-inventory-ruby/models/payment_terms'
+require 'dear-inventory-ruby/models/price_tier'
+require 'dear-inventory-ruby/models/price_tiers'
 require 'dear-inventory-ruby/models/success'
 require 'dear-inventory-ruby/models/tax'
 require 'dear-inventory-ruby/models/tax_component'

data/lib/dear-inventory-ruby/api/inventory_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -666,6 +666,60 @@ module DearInventoryRuby
       return data, status_code, headers
     end
 
+    # Allows you to retrieve the Price Tiers
+    # @param [Hash] opts the optional parameters
+    # @return [PriceTiers]
+    def get_price_tiers(opts = {})
+      data, _status_code, _headers = get_price_tiers_with_http_info(opts)
+      data
+    end
+
+    # Allows you to retrieve the Price Tiers
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PriceTiers, Integer, Hash)>] PriceTiers data, response status code and response headers
+    def get_price_tiers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InventoryApi.get_price_tiers ...'
+      end
+      # resource path
+      local_var_path = '/ref/priceTier'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PriceTiers' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['accountID', 'appKey']
+
+      new_options = opts.merge(
+        :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: InventoryApi#get_price_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to retrieve the taxes
     # @param [Hash] opts the optional parameters
     # @option opts [String] :page Default is 1 (default to '1')

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -287,11 +287,13 @@ module DearInventoryRuby
         tempfile.write(chunk)
       end
       request.on_complete do |response|
-        tempfile.close if tempfile
-        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+        if tempfile
+          tempfile.close
+          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+        end
       end
     end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2.0.0
 Contact: nnhansg@gmail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -41,28 +41,6 @@ module DearInventoryRuby
     # Points that Address is used as default for chosen Type. `false` as default.
     attr_accessor :default_for_type
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -198,8 +176,6 @@ module DearInventoryRuby
       return false if !@post_code.nil? && @post_code.to_s.length > 20
       return false if @country.nil?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["Billing", "Business", "Shipping"])
-      return false unless type_validator.valid?(@type)
       true
     end
 
@@ -253,16 +229,6 @@ module DearInventoryRuby
       @post_code = post_code
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["Billing", "Business", "Shipping"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
-      end
-      @type = type
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)