dear-inventory-ruby 0.1.6 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981ad5ba57687926b043b58eb0506c75813d4d54088c83242178633bbc8fcb19
-  data.tar.gz: edb44fd63ecf8caca7bb1dc4d562e89b270c8f4a62f00baf3f398acfbe47536f
+  metadata.gz: 243e64402774069043900856b225948134147830e263704463585b194b3ed89b
+  data.tar.gz: 24f844feb4bc3e8faa91efeba7d739a547fad67cd3806808554b3559ec0f8a8e
 SHA512:
-  metadata.gz: f673a98cc125d081c4ceeaca624949a39421f438cf0fb1152f45b55e65bbd2fe7fea1eff8b61bbd285a46601ed84462432a9ed514d3b3f7789d139fa1f9303f8
-  data.tar.gz: c2f7be8f52b45c23030f951061751b102ec2e1a4e5fcb4bdbcaf8ed140003cb945aa70216c751af5e4734e9cbc99144bbba353b00d05c9c6029b81f097614bbc
+  metadata.gz: eae064c9779db74edf93facc05b24c9b95a4886aae40172e4b33466431163f199cc2f377ffdbe29087137c335fc2124e7cbc1fd4a870f1c4b6c844aefeb9158c
+  data.tar.gz: 6242834e8f61630d0afdcb0ffea31cfed05bccdce6875e103a140510e5d1826ed2c4c5e4e3d2d0d0a8e2cfd3503b522095bb35f3aa63a3a3140712376936c1ee

data/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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
+
+## [0.1.6] - 2020-02-15
+
+- Add new endpoints and models: Account, PaymentTerm, Success, Tax, TaxComponent
+- Update some models: Address, Contact, Customer
+
+## [0.1.5] - 2020-02-13
+
+- Show basic log when calling API
+
+## [0.1.4] - 2020-02-13
+
+- Rename CustomerApi to InventoryApi
+
 ## [0.1.3] - 2020-02-12
 
 - Add POST, PUT for customer endpoint.

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.6
+- Package version: 0.1.11
 - 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.6.gem
+gem install ./dear-inventory-ruby-0.1.11.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.1.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.1.11.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.6'
+    gem 'dear-inventory-ruby', '~> 0.1.11'
 
 ### Install from Git
 
@@ -100,6 +100,7 @@ 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_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
@@ -117,13 +118,16 @@ 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::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,6 +12,7 @@ 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_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
@@ -291,7 +292,7 @@ end
 
 api_instance = DearInventoryRuby::InventoryApi.new
 opts = {
-  code: 'code_example' # String | Code
+  code: 'code_example' # String | Default is nil
 }
 
 begin
@@ -308,7 +309,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **code** | **String**| Code | [optional] 
+ **code** | **String**| Default is nil | [optional] 
 
 ### Return type
 
@@ -411,9 +412,10 @@ api_instance = DearInventoryRuby::InventoryApi.new
 opts = {
   page: '1', # String | Default is 1
   limit: '100', # String | Default is 100
-  id: 'id_example', # String | Default is nil
+  code: 'code_example', # String | Default is nil
   name: 'name_example', # String | Default is nil
-  bank: 'bank_example' # String | Default is nil
+  type: 'type_example', # String | Default is nil
+  status: 'status_example' # String | Default is nil
 }
 
 begin
@@ -432,9 +434,10 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **String**| Default is 1 | [optional] [default to '1']
  **limit** | **String**| Default is 100 | [optional] [default to '100']
- **id** | **String**| Default is nil | [optional] 
+ **code** | **String**| Default is nil | [optional] 
  **name** | **String**| Default is nil | [optional] 
- **bank** | **String**| Default is nil | [optional] 
+ **type** | **String**| Default is nil | [optional] 
+ **status** | **String**| Default is nil | [optional] 
 
 ### Return type
 
@@ -519,6 +522,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)