dear-inventory-ruby 0.1.19.1 → 0.2.3

data/docs/SaleAdditionalCharge.md

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

data/docs/SaleInvoice.md

@@ -5,7 +5,7 @@
 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]
+**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 | 

data/docs/SaleInvoiceAdditionalCharge.md

@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 **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] 
+**tax_rule** | **String** | Line Tax Rule name. | 
+**account** | **String** | Revenue account | 
+**comment** | **String** | Comment | [optional] 
 
 ## Code Sample
 

data/docs/SaleInvoiceDelete.md

@@ -0,0 +1,19 @@
+# DearInventoryRuby::SaleInvoiceDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **String** | ID of Sale task to Void or Undo | 
+**void** | **Boolean** | Default false | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleInvoiceDelete.new(task_id: nil,
+                                 void: nil)
+```
+
+

data/docs/SaleInvoiceLine.md

@@ -4,8 +4,8 @@
 
 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 | 
+**product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional] 
+**sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional] 
 **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 | 

data/docs/SaleInvoicePost.md

@@ -0,0 +1,41 @@
+# DearInventoryRuby::SaleInvoicePost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale_id** | **String** | Unique DEAR Sale ID | 
+**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]
+**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::SaleInvoicePost.new(sale_id: nil,
+                                 task_id: nil,
+                                 combine_additional_charges: 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/SaleOrder.md

@@ -0,0 +1,35 @@
+# DearInventoryRuby::SaleOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale_id** | **String** | Unique DEAR Sale ID | 
+**sale_order_number** | **String** | Sale Order Number (auto-generated) | [optional] 
+**combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
+**memo** | **String** | Additional information for Order. | 
+**status** | **String** | Order Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted | 
+**lines** | [**Array<SaleOrderLine>**](SaleOrderLine.md) |  | [optional] 
+**additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) |  | [optional] 
+**total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges without taxes. Not required for POST. | 
+**tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges taxes. Not required for POST. | 
+**total** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges with taxes. Not required for POST. | 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleOrder.new(sale_id: nil,
+                                 sale_order_number: nil,
+                                 combine_additional_charges: nil,
+                                 memo: nil,
+                                 status: nil,
+                                 lines: nil,
+                                 additional_charges: nil,
+                                 total_before_tax: nil,
+                                 tax: nil,
+                                 total: nil)
+```
+
+

data/docs/SaleOrderLine.md

@@ -0,0 +1,41 @@
+# DearInventoryRuby::SaleOrderLine
+
+## 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 | [optional] 
+**sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional] 
+**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] 
+**average_cost** | **Float** | Average product cost | [optional] 
+**tax_rule** | **String** | Line Tax Rule name. | [optional] 
+**comment** | **String** | Comment for this line | [optional] 
+**drop_ship** | **Boolean** | Required if product is not a service with “Optional Drop Ship” mode. Otherwise it ignored. | [optional] 
+**backorder_quantity** | **Float** | Quantity of the ordered product on backorder. Read Only for POST | [optional] 
+**total** | **Float** | Line Total. For validation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleOrderLine.new(product_id: nil,
+                                 sku: nil,
+                                 name: nil,
+                                 quantity: nil,
+                                 price: nil,
+                                 discount: nil,
+                                 tax: nil,
+                                 average_cost: nil,
+                                 tax_rule: nil,
+                                 comment: nil,
+                                 drop_ship: nil,
+                                 backorder_quantity: nil,
+                                 total: nil)
+```
+
+

data/docs/SalePayment.md

@@ -0,0 +1,43 @@
+# DearInventoryRuby::SalePayment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale_id** | **String** | Unique DEAR Sale ID | [optional] 
+**task_id** | **String** | Unique DEAR Sale Task ID. Available for POST | [optional] 
+**id** | **String** | Identifier of payment. Available for PUT | [optional] 
+**sale_order_number** | **String** | Sale Order Number | [optional] 
+**invoice_number** | **String** | Sale Task Invoice Number | [optional] 
+**credit_note_number** | **String** | Sale Task Credit Note Number | [optional] 
+**type** | **String** | Available values are PREPAYMENT,PAYMENT,REFUND. Available for POST | [optional] 
+**reference** | **String** | Payment reference number. Available for POST/PUT | [optional] 
+**amount** | **Float** | Payment amount in customer currency. Available for POST/PUT | [optional] 
+**date_paid** | **Date** | Date when payment has been made. Available for POST/PUT | [optional] 
+**account** | **String** | Account Code of the bank/payment account from Chart of accounts. Available for POST/PUT | [optional] 
+**currency_rate** | **Float** | Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. Available for POST/PUT | [optional] 
+**date_created** | **Date** | Date of creation payment record. | [optional] 
+**credit_id** | **String** | Id for Sale Credit entry | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SalePayment.new(sale_id: nil,
+                                 task_id: nil,
+                                 id: nil,
+                                 sale_order_number: nil,
+                                 invoice_number: nil,
+                                 credit_note_number: nil,
+                                 type: nil,
+                                 reference: nil,
+                                 amount: nil,
+                                 date_paid: nil,
+                                 account: nil,
+                                 currency_rate: nil,
+                                 date_created: nil,
+                                 credit_id: nil)
+```
+
+

data/docs/SaleQuote.md

@@ -0,0 +1,33 @@
+# DearInventoryRuby::SaleQuote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale_id** | **String** | Unique DEAR Sale ID | 
+**combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
+**memo** | **String** | Additional information for Quote. | 
+**status** | **String** | Quote Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted | 
+**lines** | [**Array<SaleQuoteLine>**](SaleQuoteLine.md) |  | [optional] 
+**additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) |  | [optional] 
+**total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges without taxes. Not required for POST. | 
+**tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges taxes. Not required for POST. | 
+**total** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges with taxes. Not required for POST. | 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleQuote.new(sale_id: nil,
+                                 combine_additional_charges: nil,
+                                 memo: nil,
+                                 status: nil,
+                                 lines: nil,
+                                 additional_charges: nil,
+                                 total_before_tax: nil,
+                                 tax: nil,
+                                 total: nil)
+```
+
+

data/docs/SaleQuoteLine.md

@@ -0,0 +1,37 @@
+# DearInventoryRuby::SaleQuoteLine
+
+## 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 | [optional] 
+**sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional] 
+**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] 
+**average_cost** | **Float** | Average product cost | [optional] 
+**tax_rule** | **String** | Line Tax Rule name. | [optional] 
+**comment** | **String** | Comment for this line | [optional] 
+**total** | **Float** | Line Total. For validation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleQuoteLine.new(product_id: nil,
+                                 sku: nil,
+                                 name: nil,
+                                 quantity: nil,
+                                 price: nil,
+                                 discount: nil,
+                                 tax: nil,
+                                 average_cost: nil,
+                                 tax_rule: nil,
+                                 comment: nil,
+                                 total: nil)
+```
+
+

data/docs/ShippingAddress.md

@@ -0,0 +1,37 @@
+# DearInventoryRuby::ShippingAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_address_line1** | **String** | Address Line 1 as displayed on Sale form. = Line1 + Line2 | [optional] 
+**display_address_line2** | **String** | Address Line 2 as displayed on Sale form. = City + State/Region + Zip/Postcode + Country | [optional] 
+**line1** | **String** | Address Line 1 | 
+**line2** | **String** | Address Line 2 | [optional] 
+**city** | **String** | City | [optional] 
+**state** | **String** | State | [optional] 
+**post_code** | **String** | Post code | [optional] 
+**country** | **String** | Country | 
+**company** | **String** | Company Name | [optional] 
+**contact** | **String** | Contact | [optional] 
+**ship_to_other** | **Boolean** | If false and Customer's address matching Line 1 not found, than new customer shipping address will be created. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::ShippingAddress.new(display_address_line1: nil,
+                                 display_address_line2: nil,
+                                 line1: nil,
+                                 line2: nil,
+                                 city: nil,
+                                 state: nil,
+                                 post_code: nil,
+                                 country: nil,
+                                 company: nil,
+                                 contact: nil,
+                                 ship_to_other: nil)
+```
+
+

data/docs/SupplierCustomerAddress.md

@@ -0,0 +1,33 @@
+# DearInventoryRuby::SupplierCustomerAddress
+
+## Properties
+
+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] 
+**line1** | **String** | Address Line 1 | [optional] 
+**line2** | **String** | Address Line 2 | [optional] 
+**city** | **String** | City / Suburb | [optional] 
+**state** | **String** | State / Province | [optional] 
+**post_code** | **String** | Zip / PostCode | [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
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SupplierCustomerAddress.new(id: nil,
+                                 line1: nil,
+                                 line2: nil,
+                                 city: nil,
+                                 state: nil,
+                                 post_code: nil,
+                                 country: nil,
+                                 type: nil,
+                                 default_for_type: nil)
+```
+
+

data/docs/Webhook.md

@@ -0,0 +1,35 @@
+# DearInventoryRuby::Webhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique ID. Required for PUT | [optional] 
+**type** | **String** | Webhook Type. Available values are values | 
+**name** | **String** | Webhook Friendly Name. Read-only. | [optional] 
+**is_active** | **Boolean** | Is webhook active. | 
+**external_url** | **String** | Callback url. | 
+**external_authorization_type** | **String** | Authorisation type. Available values are `noauth`, `basicauth` and `bearerauth` | 
+**external_user_name** | **String** | User name. Required if `ExternalAuthorizationType` is `basicauth` | [optional] 
+**external_password** | **String** | Password. Required if `ExternalAuthorizationType` is `basicauth` | [optional] 
+**external_bearer_token** | **String** | Bearer token. Required if `ExternalAuthorizationType` is `bearerauth` | [optional] 
+**external_headers** | [**Array<ExternalHeader>**](ExternalHeader.md) | Additional headers. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Webhook.new(id: nil,
+                                 type: nil,
+                                 name: nil,
+                                 is_active: nil,
+                                 external_url: nil,
+                                 external_authorization_type: nil,
+                                 external_user_name: nil,
+                                 external_password: nil,
+                                 external_bearer_token: nil,
+                                 external_headers: 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()
+```
+
+

data/docs/Webhooks.md

@@ -0,0 +1,17 @@
+# DearInventoryRuby::Webhooks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhooks** | [**Array<Webhook>**](Webhook.md) | Array of Webhooks | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Webhooks.new(webhooks: nil)
+```
+
+