dear-inventory-ruby 0.1.7 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff6fd2166dfaa0d47768c396b6d0950f8641cb4217a9b550fda86a2c10e596a
-  data.tar.gz: 7c5bb9ac261515780aa137e756c0ed97e61df92bc00bbde6fc5c757565468ada
+  metadata.gz: a7798e799cbf4fa681aad8ee42427c13fb6da8fd45e72b6c6feeb69af8ba371f
+  data.tar.gz: 2121bc741a44a0af49b783443b0e554fcb140461c615e74fd59918b14dc3d5b8
 SHA512:
-  metadata.gz: 3a6c9374a87ab7763ff5f8c9c441f9549e4d6fe11850b45aebc7d79d38d024afbdf3f385743a0f531dc1ecbb9996823be3d7d32d40e02f05104f5d4899c03d81
-  data.tar.gz: 981a79e7bd7061091193f3b0530d40fb9605016594afa38813746ca560a795890a06bf5fd7115fd885d319762504007ccaf7da58b57bdd84777be8e53c2d88c2
+  metadata.gz: e7a495a34bf3bfaec919ce61024002f81ab698dd085b4104a4454db4366f1dd9d3ff9c0bfc5de35e6613337fd93fe8ff4db0c61d814e6fa121c10c2548e0e94f
+  data.tar.gz: 67eb1ebfda865b6888d4e4737705cc27641d571e50d39ec5e48ee323c6cb4bb4bb8b236654335db827c2ed9e25ffb92fe38b047d0aec5aa6d8c316338ec29204

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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
+- Update OpenAPI Generator version 4.3.0
+
+## [0.1.8] - 2020-02-16
+
+- Remove the validations of attributes: Type, SystemAccount because Dear API docs is not mapping for the result of API returned
+
 ## [0.1.7] - 2020-02-16
 
 - Fix params of /account GET

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 0.66.0'
 end

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.7
+- Package version: 0.1.12
 - 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.7.gem
+gem install ./dear-inventory-ruby-0.1.12.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.1.7.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.1.12.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.7'
+    gem 'dear-inventory-ruby', '~> 0.1.12'
 
 ### Install from Git
 
@@ -100,7 +100,9 @@ Class | Method | HTTP request | Description
 *DearInventoryRuby::InventoryApi* | [**delete_payment_term**](docs/InventoryApi.md#delete_payment_term) | **DELETE** /ref/paymentterm | Allows you to delete a payment term
 *DearInventoryRuby::InventoryApi* | [**get_accounts**](docs/InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
 *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
@@ -117,13 +119,18 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::CurrencyCode](docs/CurrencyCode.md)
  - [DearInventoryRuby::Customer](docs/Customer.md)
  - [DearInventoryRuby::Customers](docs/Customers.md)
+ - [DearInventoryRuby::DimensionsUnit](docs/DimensionsUnit.md)
  - [DearInventoryRuby::Error](docs/Error.md)
+ - [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)
  - [DearInventoryRuby::Taxes](docs/Taxes.md)
+ - [DearInventoryRuby::WeightUnit](docs/WeightUnit.md)
 
 
 ## Documentation for Authorization

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.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/docs/Account.md

@@ -6,11 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | Unique code of Account | 
 **name** | **String** | Account Name | 
-**type** | **String** | Should be one of the following values: `BANK`, `CURRLIAB`, `LIABILITY`, `TERMLIA`, `PAYGLIABILITY`, `SUPERANNUATIONLIABILITY`, `WAGESPAYABLELIABILITY` | 
+**type** | **String** | Type | 
 **status** | **String** | Account status | 
 **description** | **String** | Account description | [optional] 
 **_class** | **String** | Should be one of the following values: `ASSET`, `LIABILITY`, `EXPENSE`, `EQUITY`, `REVENUE` | [optional] 
-**system_account** | **String** | Read-only for PUT. Should be one of the following values: BANKCURRENCYGAIN, CREDITORS, DEBTORS, GST, GSTONIMPORTS, HISTORICAL, REALISEDCURRENCYGAIN, RETAINEDEARNINGS, ROUNDING, TRACKINGTRANSFERS, UNPAIDEXPCLM, UNREALISEDCURRENCYGAIN, WAGEPAYABLES | [optional] 
+**system_account** | **String** | SystemAccount | [optional] 
+**system_account_code** | **String** | SystemAccountCode | [optional] 
 **for_payments** | **String** | Account status | [optional] 
 **display_name** | **String** | Account display name. Read-only. | [optional] 
 **old_code** | **String** | Read-only. | [optional] 
@@ -24,20 +25,21 @@ Name | Type | Description | Notes
 ```ruby
 require 'DearInventoryRuby'
 
-instance = DearInventoryRuby::Account.new(code: null,
-                                 name: null,
-                                 type: null,
-                                 status: null,
-                                 description: null,
-                                 _class: null,
-                                 system_account: null,
-                                 for_payments: null,
-                                 display_name: null,
-                                 old_code: null,
-                                 bank: null,
-                                 bank_account_number: null,
-                                 bank_account_id: null,
-                                 currency: null)
+instance = DearInventoryRuby::Account.new(code: nil,
+                                 name: nil,
+                                 type: nil,
+                                 status: nil,
+                                 description: nil,
+                                 _class: nil,
+                                 system_account: nil,
+                                 system_account_code: nil,
+                                 for_payments: nil,
+                                 display_name: nil,
+                                 old_code: nil,
+                                 bank: nil,
+                                 bank_account_number: nil,
+                                 bank_account_id: nil,
+                                 currency: nil)
 ```
 
 

data/docs/Accounts.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ```ruby
 require 'DearInventoryRuby'
 
-instance = DearInventoryRuby::Accounts.new(total: null,
-                                 page: null,
-                                 accounts_list: null)
+instance = DearInventoryRuby::Accounts.new(total: nil,
+                                 page: nil,
+                                 accounts_list: nil)
 ```
 
 

data/docs/Address.md

@@ -19,15 +19,15 @@ Name | Type | Description | Notes
 ```ruby
 require 'DearInventoryRuby'
 
-instance = DearInventoryRuby::Address.new(id: null,
-                                 line1: null,
-                                 line2: null,
-                                 city: null,
-                                 state: null,
-                                 post_code: null,
-                                 country: null,
-                                 type: null,
-                                 default_for_type: null)
+instance = DearInventoryRuby::Address.new(id: nil,
+                                 line1: nil,
+                                 line2: nil,
+                                 city: nil,
+                                 state: nil,
+                                 post_code: nil,
+                                 country: nil,
+                                 type: nil,
+                                 default_for_type: nil)
 ```
 
 

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] 
@@ -19,15 +21,17 @@ Name | Type | Description | Notes
 ```ruby
 require 'DearInventoryRuby'
 
-instance = DearInventoryRuby::Contact.new(id: null,
-                                 name: null,
-                                 phone: null,
-                                 fax: null,
-                                 email: null,
-                                 website: null,
-                                 comment: null,
-                                 default: null,
-                                 include_in_email: null)
+instance = DearInventoryRuby::Contact.new(id: nil,
+                                 name: nil,
+                                 job_title: nil,
+                                 phone: nil,
+                                 mobile_phone: nil,
+                                 fax: nil,
+                                 email: nil,
+                                 website: nil,
+                                 comment: nil,
+                                 default: nil,
+                                 include_in_email: nil)
 ```
 
 

data/docs/Customer.md

@@ -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] 
@@ -41,37 +42,38 @@ Name | Type | Description | Notes
 ```ruby
 require 'DearInventoryRuby'
 
-instance = DearInventoryRuby::Customer.new(id: null,
-                                 name: null,
-                                 status: null,
-                                 currency: null,
-                                 payment_term: null,
-                                 account_receivable: null,
-                                 revenue_account: null,
-                                 tax_rule: null,
-                                 price_tier: null,
-                                 carrier: null,
-                                 sales_representative: null,
-                                 location: null,
-                                 discount: null,
-                                 comments: null,
-                                 tax_number: null,
-                                 credit_limit: null,
-                                 tags: null,
-                                 attribute_set: null,
-                                 additional_attribute1: null,
-                                 additional_attribute2: null,
-                                 additional_attribute3: null,
-                                 additional_attribute4: null,
-                                 additional_attribute5: null,
-                                 additional_attribute6: null,
-                                 additional_attribute7: null,
-                                 additional_attribute8: null,
-                                 additional_attribute9: null,
-                                 additional_attribute10: null,
-                                 last_modified_on: null,
-                                 addresses: null,
-                                 contacts: null)
+instance = DearInventoryRuby::Customer.new(id: nil,
+                                 name: nil,
+                                 status: nil,
+                                 currency: nil,
+                                 payment_term: nil,
+                                 account_receivable: nil,
+                                 revenue_account: nil,
+                                 tax_rule: nil,
+                                 price_tier: nil,
+                                 carrier: nil,
+                                 sales_representative: nil,
+                                 location: nil,
+                                 discount: nil,
+                                 comments: nil,
+                                 tax_number: nil,
+                                 credit_limit: nil,
+                                 is_on_credit_hold: nil,
+                                 tags: nil,
+                                 attribute_set: nil,
+                                 additional_attribute1: nil,
+                                 additional_attribute2: nil,
+                                 additional_attribute3: nil,
+                                 additional_attribute4: nil,
+                                 additional_attribute5: nil,
+                                 additional_attribute6: nil,
+                                 additional_attribute7: nil,
+                                 additional_attribute8: nil,
+                                 additional_attribute9: nil,
+                                 additional_attribute10: nil,
+                                 last_modified_on: nil,
+                                 addresses: nil,
+                                 contacts: nil)
 ```
 
 

data/docs/Customers.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ```ruby
 require 'DearInventoryRuby'
 
-instance = DearInventoryRuby::Customers.new(total: null,
-                                 page: null,
-                                 customer_list: null)
+instance = DearInventoryRuby::Customers.new(total: nil,
+                                 page: nil,
+                                 customer_list: nil)
 ```
 
 

data/docs/DimensionsUnit.md

@@ -0,0 +1,16 @@
+# DearInventoryRuby::DimensionsUnit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::DimensionsUnit.new()
+```
+
+

data/docs/Error.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'DearInventoryRuby'
 
-instance = DearInventoryRuby::Error.new(error_code: null,
-                                 exception: null)
+instance = DearInventoryRuby::Error.new(error_code: nil,
+                                 exception: nil)
 ```
 
 

data/docs/InventoryApi.md

@@ -12,7 +12,9 @@ Method | HTTP request | Description
 [**delete_payment_term**](InventoryApi.md#delete_payment_term) | **DELETE** /ref/paymentterm | Allows you to delete a payment term
 [**get_accounts**](InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
 [**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
@@ -521,6 +523,59 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_me
+
+> Me get_me
+
+Allows you to retrieve your information
+
+### 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 your information
+  result = api_instance.get_me
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_me: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Me**](Me.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_payment_terms
 
 > PaymentTerms get_payment_terms(opts)
@@ -592,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)