dear-inventory-ruby 0.1.11 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 243e64402774069043900856b225948134147830e263704463585b194b3ed89b
-  data.tar.gz: 24f844feb4bc3e8faa91efeba7d739a547fad67cd3806808554b3559ec0f8a8e
+  metadata.gz: 8b834f6ab3bf12c608c9240ddf4270fce75f960cb7143d865f825da063414316
+  data.tar.gz: 5bf7c451d1a81ce76feaa63db7c4f76f633da5d8d87b9ffa07b7eee27f8c35a1
 SHA512:
-  metadata.gz: eae064c9779db74edf93facc05b24c9b95a4886aae40172e4b33466431163f199cc2f377ffdbe29087137c335fc2124e7cbc1fd4a870f1c4b6c844aefeb9158c
-  data.tar.gz: 6242834e8f61630d0afdcb0ffea31cfed05bccdce6875e103a140510e5d1826ed2c4c5e4e3d2d0d0a8e2cfd3503b522095bb35f3aa63a3a3140712376936c1ee
+  metadata.gz: 89f027d1132209a90d492ccd13819c9c787a5d48e47fcca3c2a12460c619be2648cda857a6ed28801837370f9b32ebc870977cea3d635737a8bc38e13a96af5c
+  data.tar.gz: e780a8342d238ce90cab70a64388857cb52bb28c80e83978e6911cbe0799e114a7d991b4c499e7bc3dc64caeaa1ebb1250876d067f6f8a871ed6484930e8981b

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.16] - 2021-05-14
+
+- Remove require `ENUM` for `WeightUnit`.
+
+## [0.1.15] - 2021-02-22
+
+- Add new endpoint GET `/sale/invoice` and some related models.
+
+## [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.

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.11
+- Package version: 0.1.16
 - 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.11.gem
+gem install ./dear-inventory-ruby-0.1.16.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.1.11.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.1.16.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.11'
+    gem 'dear-inventory-ruby', '~> 0.1.16'
 
 ### Install from Git
 
@@ -102,6 +102,8 @@ 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_sale_invoices**](docs/InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices
 *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,11 +125,16 @@ 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::SaleInvoice](docs/SaleInvoice.md)
+ - [DearInventoryRuby::SaleInvoiceAdditionalCharge](docs/SaleInvoiceAdditionalCharge.md)
+ - [DearInventoryRuby::SaleInvoiceLine](docs/SaleInvoiceLine.md)
+ - [DearInventoryRuby::SaleInvoices](docs/SaleInvoices.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/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 | 

data/docs/InventoryApi.md

@@ -14,6 +14,8 @@ 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_sale_invoices**](InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices
 [**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 +648,122 @@ 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_sale_invoices
+
+> SaleInvoices get_sale_invoices(opts)
+
+Allows you to retrieve the sale invoices
+
+### 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
+opts = {
+  sale_id: 'sale_id_example', # String | Unique DEAR Sale ID
+  combine_additional_charges: false, # Boolean | Show additional charges in 'Lines' array
+  include_product_info: false # Boolean | Show all used products in additional array
+}
+
+begin
+  #Allows you to retrieve the sale invoices
+  result = api_instance.get_sale_invoices(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_sale_invoices: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sale_id** | **String**| Unique DEAR Sale ID | [optional] 
+ **combine_additional_charges** | **Boolean**| Show additional charges in 'Lines' array | [optional] [default to false]
+ **include_product_info** | **Boolean**| Show all used products in additional array | [optional] [default to false]
+
+### Return type
+
+[**SaleInvoices**](SaleInvoices.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,9 +5,9 @@
 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_weight_units** | **String** | Unit of measure for unit weight | [optional] 
 **default_dimensions_units** | [**DimensionsUnit**](DimensionsUnit.md) |  | [optional] 
 **lock_date** | **Date** | Financial settings option. Indicates date period start from what you can change transactional data. Formatted in Tenant date format | [optional] 
 **opening_balance_date** | **Date** | Date of opening balances in the system. Formatted in Tenant date format | [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/docs/SaleInvoice.md

@@ -0,0 +1,41 @@
+# DearInventoryRuby::SaleInvoice
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **String** | Identifier of sale Invoice task | 
+**combine_additional_charges** | **Boolean** | if true then additional charges lines displayed in Lines array | [default to false]
+**invoice_number** | **String** | Invoice Number (auto-generated) | [optional] 
+**memo** | **String** | Additional information for Invoice. | [optional] 
+**status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED | 
+**invoice_date** | **String** | Invoice Date. | 
+**invoice_due_date** | **String** | Invoice Due Date. | 
+**currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional] 
+**billing_address_line1** | **String** | Billing Address Line 1 | [optional] 
+**billing_address_line2** | **String** | Billing Address Line 2 | [optional] 
+**linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional] 
+**lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) |  | [optional] 
+**additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleInvoice.new(task_id: nil,
+                                 combine_additional_charges: nil,
+                                 invoice_number: nil,
+                                 memo: nil,
+                                 status: nil,
+                                 invoice_date: nil,
+                                 invoice_due_date: nil,
+                                 currency_conversion_rate: nil,
+                                 billing_address_line1: nil,
+                                 billing_address_line2: nil,
+                                 linked_fulfillment_number: nil,
+                                 lines: nil,
+                                 additional_charges: nil)
+```
+
+

data/docs/SaleInvoiceAdditionalCharge.md

@@ -0,0 +1,33 @@
+# DearInventoryRuby::SaleInvoiceAdditionalCharge
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Name of Service Product referenced by this Line | 
+**quantity** | **Float** | Product or service quantity. Minimal value is 1. | 
+**price** | **Float** | Price per unit in Customer currency | 
+**discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional] 
+**tax** | **Float** | Tax | 
+**total** | **Float** | Line Total.For validation | [optional] 
+**tax_rule** | **Float** | Line Tax Rule name. | 
+**account** | **Float** | Revenue account | 
+**comment** | **Float** | Comment | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleInvoiceAdditionalCharge.new(description: nil,
+                                 quantity: nil,
+                                 price: nil,
+                                 discount: nil,
+                                 tax: nil,
+                                 total: nil,
+                                 tax_rule: nil,
+                                 account: nil,
+                                 comment: nil)
+```
+
+

data/docs/SaleInvoiceLine.md

@@ -0,0 +1,39 @@
+# DearInventoryRuby::SaleInvoiceLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | 
+**sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | 
+**name** | **String** | Product Name referenced by this Line | 
+**quantity** | **Float** | Product or service quantity. Minimal value is 1. | 
+**price** | **Float** | Price per unit in Customer currency | 
+**discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional] 
+**tax** | **Float** | Tax | [optional] 
+**total** | **Float** | Line Total. For validation | [optional] 
+**average_cost** | **Float** | Average product cost | [optional] 
+**tax_rule** | **String** | Line Tax Rule name. | [optional] 
+**account** | **String** | Revenue account | [optional] 
+**comment** | **String** | Comment for this line | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleInvoiceLine.new(product_id: nil,
+                                 sku: nil,
+                                 name: nil,
+                                 quantity: nil,
+                                 price: nil,
+                                 discount: nil,
+                                 tax: nil,
+                                 total: nil,
+                                 average_cost: nil,
+                                 tax_rule: nil,
+                                 account: nil,
+                                 comment: nil)
+```
+
+

data/docs/SaleInvoices.md

@@ -0,0 +1,19 @@
+# DearInventoryRuby::SaleInvoices
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale_id** | **String** | Unique DEAR Sale ID | 
+**invoices** | [**Array<SaleInvoice>**](SaleInvoice.md) | Array of Invoices | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleInvoices.new(sale_id: nil,
+                                 invoices: nil)
+```
+
+

data/lib/dear-inventory-ruby.rb

@@ -29,11 +29,16 @@ 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/sale_invoice'
+require 'dear-inventory-ruby/models/sale_invoice_additional_charge'
+require 'dear-inventory-ruby/models/sale_invoice_line'
+require 'dear-inventory-ruby/models/sale_invoices'
 require 'dear-inventory-ruby/models/success'
 require 'dear-inventory-ruby/models/tax'
 require 'dear-inventory-ruby/models/tax_component'
 require 'dear-inventory-ruby/models/taxes'
-require 'dear-inventory-ruby/models/weight_unit'
 
 # APIs
 require 'dear-inventory-ruby/api/inventory_api'