dear-inventory-ruby 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9154483cff09f52ccea1190aad3f720ecb126ebb9432e5ac24245da56070d4b4
-  data.tar.gz: 00b191ff3026645a0891f3c6e00bcd2bdfe8224a806962186b6f04fe0da91422
+  metadata.gz: 51c48b4739e560045deac028714486d1db23d4f3424c59798638e8f0f935e425
+  data.tar.gz: 4cd9898b7d3202d14cc6488eb3cf7be1c09d6965a5f49d5ceac56172c4477ee5
 SHA512:
-  metadata.gz: 4b7cbcadbbc3fc0c3965621b0ec03db7b2a737986cbb5b64149ff97b5b45fc06c5303d43b3f769609ace79e913b600d3a6d5ef346598703dfcbfe36202b55eff
-  data.tar.gz: 115a13db7743709a4756a97444a832e62ee37863b4f87c9507fe806548b9789dde4d3ffa829b3324fb669dbf8b54afa3e7046bd1968aad6c27c02c7f4810eddc
+  metadata.gz: f288879bd2f68534b6fe69afeafd8c8884ff9f4bcef34723147bfdf92541663bf6c788cfdde49558053bf8affa7faa0b697f9cd463324552e182a927b7d19175
+  data.tar.gz: ec3eee176bc1a6b496e05cdcfc84c658f43ae7070b236f91a20c2fd48b058486b4b10a77d5cdda8d6d0feefb76a8c74d39319790b77843e1cf91058d28325b36

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.5] - 2022-05-26
+
+- Add the new endpoint GET `/saleList`
+
+## [0.2.4] - 2022-04-12
+
+- Add the new endpoint GET `/sale`
+
+## [0.2.3] - 2021-10-15
+
+- Update `POST` response of the endpoint `/webhooks`
+- Add some enums `AuthorizationType`, `WebhookType`
+
+## [0.2.2] - 2021-10-15
+
+- Update `POST` of the endpoint `/webhooks`
+
 ## [0.2.1] - 2021-10-15
 
 - Update param `TaskID` for `DELETE` of the endpoint `/sale/invoice`

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.2.2
+- Package version: 0.2.5
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.nhansg.com](https://www.nhansg.com)
 
@@ -24,16 +24,16 @@ gem build dear-inventory-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./dear-inventory-ruby-0.2.2.gem
+gem install ./dear-inventory-ruby-0.2.5.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.2.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.2.5.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.2.2'
+    gem 'dear-inventory-ruby', '~> 0.2.5'
 
 ### Install from Git
 
@@ -111,7 +111,9 @@ Class | Method | HTTP request | Description
 *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**](docs/InventoryApi.md#get_sale) | **GET** /sale | Allows you to retrieve the Sale
 *DearInventoryRuby::InventoryApi* | [**get_sale_invoices**](docs/InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices
+*DearInventoryRuby::InventoryApi* | [**get_sale_list**](docs/InventoryApi.md#get_sale_list) | **GET** /saleList | Allows you to retrieve the Sales based on conditions
 *DearInventoryRuby::InventoryApi* | [**get_sale_order**](docs/InventoryApi.md#get_sale_order) | **GET** /sale/order | Allows you to retrieve the Sale Order
 *DearInventoryRuby::InventoryApi* | [**get_sale_payment**](docs/InventoryApi.md#get_sale_payment) | **GET** /sale/payment | Allows you to retrieve the Sale Payments
 *DearInventoryRuby::InventoryApi* | [**get_sale_quote**](docs/InventoryApi.md#get_sale_quote) | **GET** /sale/quote | Allows you to retrieve the Sale Quote
@@ -130,6 +132,7 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::Account](docs/Account.md)
  - [DearInventoryRuby::Accounts](docs/Accounts.md)
  - [DearInventoryRuby::Address](docs/Address.md)
+ - [DearInventoryRuby::AuthorizationType](docs/AuthorizationType.md)
  - [DearInventoryRuby::Contact](docs/Contact.md)
  - [DearInventoryRuby::Customer](docs/Customer.md)
  - [DearInventoryRuby::Customers](docs/Customers.md)
@@ -140,6 +143,7 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::PaymentTerms](docs/PaymentTerms.md)
  - [DearInventoryRuby::PriceTier](docs/PriceTier.md)
  - [DearInventoryRuby::PriceTiers](docs/PriceTiers.md)
+ - [DearInventoryRuby::Sale](docs/Sale.md)
  - [DearInventoryRuby::SaleAdditionalCharge](docs/SaleAdditionalCharge.md)
  - [DearInventoryRuby::SaleInvoice](docs/SaleInvoice.md)
  - [DearInventoryRuby::SaleInvoiceAdditionalCharge](docs/SaleInvoiceAdditionalCharge.md)
@@ -147,6 +151,8 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::SaleInvoiceLine](docs/SaleInvoiceLine.md)
  - [DearInventoryRuby::SaleInvoicePost](docs/SaleInvoicePost.md)
  - [DearInventoryRuby::SaleInvoices](docs/SaleInvoices.md)
+ - [DearInventoryRuby::SaleItem](docs/SaleItem.md)
+ - [DearInventoryRuby::SaleList](docs/SaleList.md)
  - [DearInventoryRuby::SaleOrder](docs/SaleOrder.md)
  - [DearInventoryRuby::SaleOrderLine](docs/SaleOrderLine.md)
  - [DearInventoryRuby::SalePayment](docs/SalePayment.md)
@@ -159,6 +165,7 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::TaxComponent](docs/TaxComponent.md)
  - [DearInventoryRuby::Taxes](docs/Taxes.md)
  - [DearInventoryRuby::Webhook](docs/Webhook.md)
+ - [DearInventoryRuby::WebhookType](docs/WebhookType.md)
  - [DearInventoryRuby::Webhooks](docs/Webhooks.md)
 
 

data/docs/AuthorizationType.md

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

data/docs/InventoryApi.md

@@ -23,7 +23,9 @@ Method | HTTP request | Description
 [**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**](InventoryApi.md#get_sale) | **GET** /sale | Allows you to retrieve the Sale
 [**get_sale_invoices**](InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices
+[**get_sale_list**](InventoryApi.md#get_sale_list) | **GET** /saleList | Allows you to retrieve the Sales based on conditions
 [**get_sale_order**](InventoryApi.md#get_sale_order) | **GET** /sale/order | Allows you to retrieve the Sale Order
 [**get_sale_payment**](InventoryApi.md#get_sale_payment) | **GET** /sale/payment | Allows you to retrieve the Sale Payments
 [**get_sale_quote**](InventoryApi.md#get_sale_quote) | **GET** /sale/quote | Allows you to retrieve the Sale Quote
@@ -528,7 +530,7 @@ Name | Type | Description  | Notes
 
 ## create_webhook
 
-> Webhooks create_webhook(webhook, opts)
+> Webhook create_webhook(webhook, opts)
 
 Allows you to create a Webhook
 
@@ -575,7 +577,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Webhooks**](Webhooks.md)
+[**Webhook**](Webhook.md)
 
 ### Authorization
 
@@ -1201,6 +1203,71 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_sale
+
+> Sale get_sale(opts)
+
+Allows you to retrieve the Sale
+
+### 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 = {
+  id: 'id_example', # String | Default is nil
+  combine_additional_charges: false, # Boolean | Show additional charges in 'Lines' array
+  hide_inventory_movements: false, # Boolean | Hide inventory movements (Default = false)
+  include_transactions: false # Boolean | Show related transactions (Default = false)
+}
+
+begin
+  #Allows you to retrieve the Sale
+  result = api_instance.get_sale(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_sale: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Default is nil | [optional] 
+ **combine_additional_charges** | **Boolean**| Show additional charges in 'Lines' array | [optional] [default to false]
+ **hide_inventory_movements** | **Boolean**| Hide inventory movements (Default = false) | [optional] [default to false]
+ **include_transactions** | **Boolean**| Show related transactions (Default = false) | [optional] [default to false]
+
+### Return type
+
+[**Sale**](Sale.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)
@@ -1264,6 +1331,97 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_sale_list
+
+> SaleList get_sale_list(opts)
+
+Allows you to retrieve the Sales based on conditions
+
+### 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 = {
+  page: '1', # String | Default is 1
+  limit: '100', # String | Default is 100
+  search: 'search_example', # String | Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber
+  created_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales created after specified date. Date must follow ISO 8601 format.
+  updated_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales changed after specified date. Date must follow ISO 8601 format.
+  ship_by: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format.
+  quote_status: 'quote_status_example', # String | Only return sales with specified quote status
+  order_status: 'order_status_example', # String | Only return sales with specified order status
+  combined_pick_status: 'combined_pick_status_example', # String | Only return sales with specified CombinedPickingStatus
+  combined_pack_status: 'combined_pack_status_example', # String | Only return sales with specified CombinedPackingStatus
+  combined_shipping_status: 'combined_shipping_status_example', # String | Only return sales with specified CombinedShippingStatus
+  combined_invoice_status: 'combined_invoice_status_example', # String | Only return sales with specified CombinedInvoiceStatus
+  credit_note_status: 'credit_note_status_example', # String | Only return sales with specified credit note status
+  external_id: 'external_id_example', # String | Only return sales with specified External ID
+  status: 'status_example', # String | Default is nil
+  ready_for_shipping: true, # Boolean | Only return sales with 'Authorised' pack and not 'Authorised' shipping
+  order_location_id: 'order_location_id_example' # String | Only return sales with specified Order Location ID
+}
+
+begin
+  #Allows you to retrieve the Sales based on conditions
+  result = api_instance.get_sale_list(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_sale_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **String**| Default is 1 | [optional] [default to '1']
+ **limit** | **String**| Default is 100 | [optional] [default to '100']
+ **search** | **String**| Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber | [optional] 
+ **created_since** | **DateTime**| Only return sales created after specified date. Date must follow ISO 8601 format. | [optional] 
+ **updated_since** | **DateTime**| Only return sales changed after specified date. Date must follow ISO 8601 format. | [optional] 
+ **ship_by** | **DateTime**| Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format. | [optional] 
+ **quote_status** | **String**| Only return sales with specified quote status | [optional] 
+ **order_status** | **String**| Only return sales with specified order status | [optional] 
+ **combined_pick_status** | **String**| Only return sales with specified CombinedPickingStatus | [optional] 
+ **combined_pack_status** | **String**| Only return sales with specified CombinedPackingStatus | [optional] 
+ **combined_shipping_status** | **String**| Only return sales with specified CombinedShippingStatus | [optional] 
+ **combined_invoice_status** | **String**| Only return sales with specified CombinedInvoiceStatus | [optional] 
+ **credit_note_status** | **String**| Only return sales with specified credit note status | [optional] 
+ **external_id** | **String**| Only return sales with specified External ID | [optional] 
+ **status** | **String**| Default is nil | [optional] 
+ **ready_for_shipping** | **Boolean**| Only return sales with 'Authorised' pack and not 'Authorised' shipping | [optional] 
+ **order_location_id** | **String**| Only return sales with specified Order Location ID | [optional] 
+
+### Return type
+
+[**SaleList**](SaleList.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sale_order
 
 > SaleOrder get_sale_order(opts)
@@ -1882,7 +2040,7 @@ Name | Type | Description  | Notes
 
 ## update_webhook
 
-> Webhooks update_webhook(webhook, opts)
+> Webhook update_webhook(webhook, opts)
 
 Allows you to update a webhook
 
@@ -1905,7 +2063,7 @@ DearInventoryRuby.configure do |config|
 end
 
 api_instance = DearInventoryRuby::InventoryApi.new
-webhook = { "ID": "1cf8cb83-bf39-494b-87f9-1252b684d6d5", "Type": "Sale/OrderAuthorised", "Name": "Sale order has been authorised", "IsActive": true, "ExternalURL": "https://hookb.in/Zn8950P7", "ExternalAuthorizationType": "basicauth", "ExternalUserName": "Hello", "ExternalPassword": "123", "ExternalBearerToken": null, "ExternalHeaders": [ { "Key": "Key", "Value": "123" }, { "Key": "6", "Value": "0" }, { "Key": "New Key", "Value": "New Value" } ] } # Webhook | a webhook object with properties to update
+webhook = { "ID": "1cf8cb83-bf39-494b-87f9-1252b684d6d5", "Type": "Sale/OrderAuthorised", "Name": "Sale order has been authorised", "IsActive": true, "ExternalURL": "https://hookb.in/Zn8950P7", "ExternalAuthorizationType": "basicauth", "ExternalUserName": "Hello", "ExternalPassword": "123", "ExternalBearerToken": nil, "ExternalHeaders": [ { "Key": "Key", "Value": "123" }, { "Key": "6", "Value": "0" }, { "Key": "New Key", "Value": "New Value" } ] } # Webhook | a webhook object with properties to update
 opts = {
   summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
 }
@@ -1929,7 +2087,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Webhooks**](Webhooks.md)
+[**Webhook**](Webhook.md)
 
 ### Authorization
 

data/docs/Sale.md

@@ -0,0 +1,99 @@
+# DearInventoryRuby::Sale
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique DEAR Sale ID. Required for PUT | [optional] 
+**customer** | **String** | Customer name | [optional] 
+**customer_id** | **String** | Customer identifier | [optional] 
+**contact** | **String** | Customer Contact name | [optional] 
+**phone** | **String** | Customer Contact phone | [optional] 
+**email** | **String** | Customer Contact email | [optional] 
+**default_account** | **String** | Account code used by default for invoice lines when no revenue account is defined on Product. By default it is equal to Customer Sale account | [optional] 
+**skip_quote** | **Boolean** | True if there is no quote in the sale | [optional] 
+**billing_address** | [**Address**](Address.md) |  | [optional] 
+**shipping_address** | [**ShippingAddress**](ShippingAddress.md) |  | [optional] 
+**shipping_notes** | **String** | Shipping Notes | [optional] 
+**base_currency** | **String** | 3 character currency code of Base Currency defined in General Settings on the moment when Sale was created. | [optional] 
+**customer_currency** | **String** | 3 character currency code of customer Currency defined in Customer card at the moment when customer is selected for the Sale. | [optional] 
+**tax_rule** | **String** | Default Tax Rule name selected for Sale | [optional] 
+**tax_calculation** | **String** | Inclusive or Exclusive | [optional] 
+**terms** | **String** | Payment terms name | [optional] 
+**price_tier** | **String** | Price Tier name selected for Sale | [optional] 
+**ship_by** | **Date** | Date when shipment is due | [optional] 
+**location** | **String** | Default location to pick stock from | [optional] 
+**sale_order_date** | **Date** | Date when task was created | [optional] 
+**last_modified_on** | **Date** | UTC Time | [optional] 
+**note** | **String** | Custom Sale note | [optional] 
+**customer_reference** | **String** | Reference number used by customer to identify this sale. Could be a purchase order number generated by customer. | [optional] 
+**cogs_amount** | **Float** | COGS amount in base currency | [optional] 
+**status** | **String** | Sale Status, see possible values | [optional] 
+**combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional] 
+**combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional] 
+**combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional] 
+**ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional] 
+**combined_invoice_status** | **String** | Invoice status. Possible Values are INVOICED, INVOICED / CREDITED, NOT AVAILABLE, NOT INVOICED, PARTIALLY INVOICED, PARTIALLY INVOICED / CREDITED | [optional] 
+**combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional] 
+**combined_tracking_numbers** | **String** | Tracking Numbers | [optional] 
+**carrier** | **String** | Name of Carrier/shipping method | [optional] 
+**currency_rate** | **Float** | Conversion Rate expressed as number of Base currency units for one Customer currency unit | [optional] 
+**sales_representative** | **String** | Sales representative name | [optional] 
+**type** | **String** | Type of sale Simple Sale or Advanced Sale, Service Sale | [optional] 
+**source_channel** | **String** | Source of the sale. read-only field | [optional] 
+**external_id** | **String** | Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic | [optional] 
+**service_only** | **String** | true when it is service-only sale | [optional] 
+**quote** | [**SaleQuote**](SaleQuote.md) |  | [optional] 
+**order** | [**SaleOrder**](SaleOrder.md) |  | [optional] 
+**invoices** | [**Array<SaleInvoice>**](SaleInvoice.md) | Sale Invoices | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Sale.new(id: nil,
+                                 customer: nil,
+                                 customer_id: nil,
+                                 contact: nil,
+                                 phone: nil,
+                                 email: nil,
+                                 default_account: nil,
+                                 skip_quote: nil,
+                                 billing_address: nil,
+                                 shipping_address: nil,
+                                 shipping_notes: nil,
+                                 base_currency: nil,
+                                 customer_currency: nil,
+                                 tax_rule: nil,
+                                 tax_calculation: nil,
+                                 terms: nil,
+                                 price_tier: nil,
+                                 ship_by: nil,
+                                 location: nil,
+                                 sale_order_date: nil,
+                                 last_modified_on: nil,
+                                 note: nil,
+                                 customer_reference: nil,
+                                 cogs_amount: nil,
+                                 status: nil,
+                                 combined_picking_status: nil,
+                                 combined_packing_status: nil,
+                                 combined_shipping_status: nil,
+                                 ful_filment_status: nil,
+                                 combined_invoice_status: nil,
+                                 combined_payment_status: nil,
+                                 combined_tracking_numbers: nil,
+                                 carrier: nil,
+                                 currency_rate: nil,
+                                 sales_representative: nil,
+                                 type: nil,
+                                 source_channel: nil,
+                                 external_id: nil,
+                                 service_only: nil,
+                                 quote: nil,
+                                 order: nil,
+                                 invoices: nil)
+```
+
+

data/docs/SaleItem.md

@@ -0,0 +1,77 @@
+# DearInventoryRuby::SaleItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale_id** | **String** | Unique DEAR Sale identifier | [optional] 
+**order_number** | **String** | Sale Order number generated by DEAR | [optional] 
+**status** | **String** | Current sale status. Possible values are values | [optional] 
+**order_date** | **Date** | Date when Sale Order was created | [optional] 
+**invoice_date** | **Date** | Date when Invoice was issued | [optional] 
+**customer** | **String** | Name of the customer | [optional] 
+**customer_id** | **String** | Customer Identifier | [optional] 
+**invoice_number** | **String** | Invoice number generated by DEAR | [optional] 
+**customer_reference** | **String** | Optional Customer Reference (typically customer Purchase order number) supplied by the customer for the sale | [optional] 
+**invoice_amount** | **Float** | Total Invoice amount minus total Credit note amount in customer currency | [optional] 
+**paid_amount** | **Float** | Total Paid amount minus Refunded amount in customer currency | [optional] 
+**invoice_due_date** | **Date** | Date when invoice is due according to selected payment terms | [optional] 
+**ship_by** | **Date** | Date when shipment is due | [optional] 
+**base_currency** | **String** | 3 digit Base currency code (as configured in General Settings) | [optional] 
+**customer_currency** | **String** | 3 digit Customer currency code | [optional] 
+**credit_note_number** | **String** | Credit note number generated by DEAR. Is empty unless credit note is created | [optional] 
+**updated** | **Date** | Date when the sale was last created/updated last time | [optional] 
+**quote_status** | **String** | Sale Quote status. Possible Values are values | [optional] 
+**order_status** | **String** | Sale Order status. Possible Values are values | [optional] 
+**combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional] 
+**combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional] 
+**combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional] 
+**ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional] 
+**combined_invoice_status** | **String** | Invoice status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE, PAID | [optional] 
+**credit_note_status** | **String** | Credit Note status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE | [optional] 
+**combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional] 
+**type** | **String** | Type of Sale. Possible Values are Simple Sale, Advanced Sale , Service Sale | [optional] 
+**combined_tracking_numbers** | **String** | Tracking Numbers | [optional] 
+**source_channel** | **String** | Source of the sale. read-only field | [optional] 
+**external_id** | **String** | Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic | [optional] 
+**order_location_id** | **String** | Sale Order Location ID | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleItem.new(sale_id: nil,
+                                 order_number: nil,
+                                 status: nil,
+                                 order_date: nil,
+                                 invoice_date: nil,
+                                 customer: nil,
+                                 customer_id: nil,
+                                 invoice_number: nil,
+                                 customer_reference: nil,
+                                 invoice_amount: nil,
+                                 paid_amount: nil,
+                                 invoice_due_date: nil,
+                                 ship_by: nil,
+                                 base_currency: nil,
+                                 customer_currency: nil,
+                                 credit_note_number: nil,
+                                 updated: nil,
+                                 quote_status: nil,
+                                 order_status: nil,
+                                 combined_picking_status: nil,
+                                 combined_packing_status: nil,
+                                 combined_shipping_status: nil,
+                                 ful_filment_status: nil,
+                                 combined_invoice_status: nil,
+                                 credit_note_status: nil,
+                                 combined_payment_status: nil,
+                                 type: nil,
+                                 combined_tracking_numbers: nil,
+                                 source_channel: nil,
+                                 external_id: nil,
+                                 order_location_id: nil)
+```
+
+

data/docs/SaleList.md

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

data/docs/WebhookType.md

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