dear-inventory-ruby 0.1.5 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 727a014b9815bd76c254c9f6315951458046e0808bb811db5a0bc6690bb7ddf0
-  data.tar.gz: 51138ec20b08a7b2875f65b6016532a441cac28dc797a4dae022c02a2ceb7cc4
+  metadata.gz: c201f6b324bf74ee44d1049342dd858cd6db92262aa2a98471e78a8db6b4bcbf
+  data.tar.gz: 304fc570a210489e24c1574d40f71d1975961e66dab65aa42807d0909a62730d
 SHA512:
-  metadata.gz: ead27d454433630290c7dc828838d7754dcd1b23b7c229be23c45ff7fb30ff4f47f7877399cdcfbeff45c013345784d1e6669e5f2fd87e889cbba3bde5ac58aa
-  data.tar.gz: bd46592e998eedc10c53b9c149cbc32385c6f651bc7a4fa32dff46aa4c2ec06586daaf328787d2a1a4e7867c1d2d21399edd570de4e7d185ac7daf29fc74ede4
+  metadata.gz: dd7c10e2e6c7a5fafd8288cd1cd59ea7548229a978f5076df85e505e53c4e13f2af24ded11100c1e5ce8b4b6fe1ecbd8ac7f79ee242af27fefa39abddf3758ea
+  data.tar.gz: 3c4d88bddd1cf9fc255a71c35ce15857abd3f49e297747c96ccecd31ed65f44061c2dd18700a967b7f0cc7d921c006c4655538f42ffd3c1a8597f3ace5f6363b

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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.5
+- Package version: 0.1.10
 - 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.5.gem
+gem install ./dear-inventory-ruby-0.1.10.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.1.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.1.10.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.5'
+    gem 'dear-inventory-ruby', '~> 0.1.10'
 
 ### Install from Git
 
@@ -71,17 +71,17 @@ DearInventoryRuby.configure do |config|
 end
 
 api_instance = DearInventoryRuby::InventoryApi.new
-customer = { "Name": "DIISR - Small Business Services customer", "Currency": "AUD", "PaymentTerm": "30 days", "Discount": 0, "TaxRule": "GST Free Exports", "Carrier": "DEFAULT Carrier", "SalesRepresentative": nil, "Location": "Main Warehouse", "Comments": nil, "AccountReceivable": "610", "RevenueAccount": "200", "PriceTier": "Tier 1", "TaxNumber": nil, "AdditionalAttribute1": nil, "AdditionalAttribute2": nil, "AdditionalAttribute3": nil, "AdditionalAttribute4": nil, "AdditionalAttribute5": nil, "AdditionalAttribute6": nil, "AdditionalAttribute7": nil, "AdditionalAttribute8": nil, "AdditionalAttribute9": nil, "AdditionalAttribute10": nil, "AttributeSet": nil, "Tags": nil, "Status": "Active", "Addresses": [ { "ID": "4bc4e423-d8af-454d-a186-4a827c15bd0b", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Line1": "L3, Southbank House", "Line2": "13 Gallery Ave", "City": "Melbourne", "State": "VIC", "Postcode": "3131", "Country": nil, "Type": "Business", "DefaultForType": true }, { "ID": "35cec087-04da-46b5-b3c8-c3a7311f2417", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Line1": "L3, Southbank House", "Line2": "13 Gallery Ave", "City": "Melbourne", "State": "VIC", "Postcode": "3131", "Country": nil, "Type": "Billing", "DefaultForType": true } ], "Contacts": [ { "ID": "1d62f59b-657d-423f-ad95-9ad9ec4f29a3", "CustomerID": "4978c3ff-4382-4045-819b-2971480ddaf1", "Name": "Sheree Bond", "JobTitle": nil, "Phone": "0800 4389376", "MobilePhone": nil, "Fax": "03 4389379", "Email": "accounts@diisr.govt", "Website": nil, "Default": true, "Comment": nil, "IncludeInEmail": false } ] } # Customer | a Contact object with properties to create
+account = { "Code": "001", "Status": "ACTIVE", "Name": "Accounts Payable test", "Type": "CURRLIAB", "Description": "Outstanding invoices the company has received from suppliers but has not yet paid at balance date", "Class": "LIABILITY", "SystemAccount": "CREDITORS", } # Account | an Account object with properties to create
 opts = {
-  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created obejcts and any with validation errors
+  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
 }
 
 begin
-  #Allows you to create a customer
-  result = api_instance.create_customer(customer, opts)
+  #Allows you to create an Account
+  result = api_instance.create_account(account, opts)
   p result
 rescue DearInventoryRuby::ApiError => e
-  puts "Exception when calling InventoryApi->create_customer: #{e}"
+  puts "Exception when calling InventoryApi->create_account: #{e}"
 end
 
 ```
@@ -92,19 +92,42 @@ All URIs are relative to *https://inventory.dearsystems.com/ExternalApi/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*DearInventoryRuby::InventoryApi* | [**create_account**](docs/InventoryApi.md#create_account) | **POST** /ref/account | Allows you to create an Account
 *DearInventoryRuby::InventoryApi* | [**create_customer**](docs/InventoryApi.md#create_customer) | **POST** /customer | Allows you to create a customer
+*DearInventoryRuby::InventoryApi* | [**create_payment_term**](docs/InventoryApi.md#create_payment_term) | **POST** /ref/paymentterm | Allows you to create a payment term
+*DearInventoryRuby::InventoryApi* | [**create_tax**](docs/InventoryApi.md#create_tax) | **POST** /ref/tax | Allows you to create a tax
+*DearInventoryRuby::InventoryApi* | [**delete_account**](docs/InventoryApi.md#delete_account) | **DELETE** /ref/account | Allows you to delete an Account
+*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
 *DearInventoryRuby::InventoryApi* | [**update_customer**](docs/InventoryApi.md#update_customer) | **PUT** /customer | Allows you to update a customer
+*DearInventoryRuby::InventoryApi* | [**update_payment_term**](docs/InventoryApi.md#update_payment_term) | **PUT** /ref/paymentterm | Allows you to update a payment term
+*DearInventoryRuby::InventoryApi* | [**update_tax**](docs/InventoryApi.md#update_tax) | **PUT** /ref/tax | Allows you to update a tax
 
 
 ## Documentation for Models
 
+ - [DearInventoryRuby::Account](docs/Account.md)
+ - [DearInventoryRuby::Accounts](docs/Accounts.md)
  - [DearInventoryRuby::Address](docs/Address.md)
  - [DearInventoryRuby::Contact](docs/Contact.md)
  - [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

@@ -0,0 +1,45 @@
+# DearInventoryRuby::Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Unique code of Account | 
+**name** | **String** | Account Name | 
+**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** | 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] 
+**bank** | **String** | Name of the Bank. Only for PUT and POST. Required if Account Type is BANK. | [optional] 
+**bank_account_number** | **String** | Bank Account Number. Only for PUT and POST. Required if Account Type is BANK. | [optional] 
+**bank_account_id** | **String** | Bank Account ID to which the Account is linked. Read-only. | [optional] 
+**currency** | **String** | Currency. Read-only. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+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

@@ -0,0 +1,21 @@
+# DearInventoryRuby::Accounts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **String** | Total | [optional] 
+**page** | **String** | Page | [optional] 
+**accounts_list** | [**Array<Account>**](Account.md) | Array of Accounts | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Accounts.new(total: nil,
+                                 page: nil,
+                                 accounts_list: nil)
+```
+
+

data/docs/Address.md

@@ -10,8 +10,8 @@ Name | Type | Description | Notes
 **city** | **String** | City / Suburb | [optional] 
 **state** | **String** | State / Province | [optional] 
 **post_code** | **String** | Zip / PostCode | [optional] 
-**country** | **String** | Country name | [optional] 
-**type** | **String** | Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`. | [optional] 
+**country** | **String** | Country name | 
+**type** | **String** | Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`. | 
 **default_for_type** | **Boolean** | Points that Address is used as default for chosen Type. `false` as default. | [optional] [default to false]
 
 ## Code Sample
@@ -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

@@ -5,8 +5,10 @@
 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 | [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

@@ -5,13 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Unique Customer ID | [optional] 
-**name** | **String** | Name of Customer | [optional] 
-**status** | **String** | Points that Customer is Active. Available values are Active and Deprecated. Required for POST | [optional] 
-**currency** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**payment_term** | **String** | Payment term | [optional] 
-**account_receivable** | **String** | Account receivable code of Customer | [optional] 
-**revenue_account** | **String** | Sale account code of Customer | [optional] 
-**tax_rule** | **String** | Tax rule name | [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) |  | 
+**payment_term** | **String** | Payment term | 
+**account_receivable** | **String** | Account receivable code of Customer | 
+**revenue_account** | **String** | Sale account code of Customer | 
+**tax_rule** | **String** | Tax rule name | 
 **price_tier** | **String** | Price tier | [optional] 
 **carrier** | **String** | Carrier name | [optional] 
 **sales_representative** | **String** | Sales representative | [optional] 
@@ -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)
 ```