dear-inventory-ruby 0.1.10 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c201f6b324bf74ee44d1049342dd858cd6db92262aa2a98471e78a8db6b4bcbf
-  data.tar.gz: 304fc570a210489e24c1574d40f71d1975961e66dab65aa42807d0909a62730d
+  metadata.gz: 1520077f652087124545b720ac13cd528fdf40dc9985ce8b8acc5fe3ffaef322
+  data.tar.gz: c5887cbe8fb6152b86a25a3c754940d52e905d7c8934a9b713ab46628983860d
 SHA512:
-  metadata.gz: dd7c10e2e6c7a5fafd8288cd1cd59ea7548229a978f5076df85e505e53c4e13f2af24ded11100c1e5ce8b4b6fe1ecbd8ac7f79ee242af27fefa39abddf3758ea
-  data.tar.gz: 3c4d88bddd1cf9fc255a71c35ce15857abd3f49e297747c96ccecd31ed65f44061c2dd18700a967b7f0cc7d921c006c4655538f42ffd3c1a8597f3ace5f6363b
+  metadata.gz: 6ed901fecd45e0eef5651040a5f5a6a1b5c7deaa8599f72afba5a64d24824525a3648bde1d41b6926311a3841693026ff3e03f5a4625cb39e9fdbd2b3dfdf6a4
+  data.tar.gz: 5dfa595e9d4c8a869e7ac7d496bf42e8e41ddde652d81ca63b3d3010413794cef202ea62738a6575fbaecfa88861aa4d53305a73ce71030480b15c3da09df4a5

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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.
+- Remove required conditions of Address Type in Customer Address model.
+
 ## [0.1.10] - 2020-09-04
 
 - Add some fields to Contact and Customer models.

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.10
+- Package version: 0.1.15
 - 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.10.gem
+gem install ./dear-inventory-ruby-0.1.15.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.1.10.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.1.15.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.10'
+    gem 'dear-inventory-ruby', '~> 0.1.15'
 
 ### 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,6 +125,12 @@ 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)

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,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/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,6 +29,12 @@ 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'

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

@@ -666,6 +666,123 @@ 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 sale invoices
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sale_id Unique DEAR Sale ID
+    # @option opts [Boolean] :combine_additional_charges Show additional charges in &#39;Lines&#39; array (default to false)
+    # @option opts [Boolean] :include_product_info Show all used products in additional array (default to false)
+    # @return [SaleInvoices]
+    def get_sale_invoices(opts = {})
+      data, _status_code, _headers = get_sale_invoices_with_http_info(opts)
+      data
+    end
+
+    # Allows you to retrieve the sale invoices
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sale_id Unique DEAR Sale ID
+    # @option opts [Boolean] :combine_additional_charges Show additional charges in &#39;Lines&#39; array
+    # @option opts [Boolean] :include_product_info Show all used products in additional array
+    # @return [Array<(SaleInvoices, Integer, Hash)>] SaleInvoices data, response status code and response headers
+    def get_sale_invoices_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InventoryApi.get_sale_invoices ...'
+      end
+      # resource path
+      local_var_path = '/sale/invoice'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'SaleID'] = opts[:'sale_id'] if !opts[:'sale_id'].nil?
+      query_params[:'CombineAdditionalCharges'] = opts[:'combine_additional_charges'] if !opts[:'combine_additional_charges'].nil?
+      query_params[:'IncludeProductInfo'] = opts[:'include_product_info'] if !opts[:'include_product_info'].nil?
+
+      # 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] || 'SaleInvoices' 
+
+      # 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_sale_invoices\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')