dear-inventory-ruby 0.2.10.1 → 0.2.12

data/docs/InventoryApi.md

@@ -19,8 +19,11 @@ Method | HTTP request | Description
 [**delete_sale_payment**](InventoryApi.md#delete_sale_payment) | **DELETE** /sale/payment | Allows you to delete a sale payment
 [**delete_webhook**](InventoryApi.md#delete_webhook) | **DELETE** /webhooks | Allows you to delete a webhook
 [**get_accounts**](InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
+[**get_carriers**](InventoryApi.md#get_carriers) | **GET** /ref/carrier | Allows you to retrieve the carriers
 [**get_customers**](InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
+[**get_locations**](InventoryApi.md#get_locations) | **GET** /ref/location | Allows you to retrieve the locations
 [**get_me**](InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information
+[**get_me_contacts**](InventoryApi.md#get_me_contacts) | **GET** /me/contacts | Allows you to retrieve the me contacts (Sales Representatives)
 [**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
@@ -84,7 +87,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **account** | [**Account**](Account.md)| an Account object with properties to create | 
+ **account** | [**Account**](Account.md)| an Account object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -145,7 +148,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **customer** | [**Customer**](Customer.md)| a customer object with properties to create | 
+ **customer** | [**Customer**](Customer.md)| a customer object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -206,7 +209,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to create | 
+ **payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -267,7 +270,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_invoice_post** | [**SaleInvoicePost**](SaleInvoicePost.md)| a Sale Invoice object with properties to create | 
+ **sale_invoice_post** | [**SaleInvoicePost**](SaleInvoicePost.md)| a Sale Invoice object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -328,7 +331,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_order** | [**SaleOrder**](SaleOrder.md)| a Sale Order object with properties to create | 
+ **sale_order** | [**SaleOrder**](SaleOrder.md)| a Sale Order object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -389,7 +392,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_payment** | [**SalePayment**](SalePayment.md)| a Sale Payment object with properties to create | 
+ **sale_payment** | [**SalePayment**](SalePayment.md)| a Sale Payment object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -450,7 +453,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_quote** | [**SaleQuote**](SaleQuote.md)| a Sale Quote object with properties to create | 
+ **sale_quote** | [**SaleQuote**](SaleQuote.md)| a Sale Quote object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -511,7 +514,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **tax** | [**Tax**](Tax.md)| a tax object with properties to create | 
+ **tax** | [**Tax**](Tax.md)| a tax object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -572,7 +575,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to create | 
+ **webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to create |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -632,7 +635,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **code** | **String**| Default is nil | [optional] 
+ **code** | **String**| Default is nil | [optional]
 
 ### Return type
 
@@ -691,7 +694,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| Default is nil | [optional] 
+ **id** | **String**| Default is nil | [optional]
 
 ### Return type
 
@@ -751,7 +754,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **task_id** | **String**| ID of Sale task to Void or Undo | [optional] 
+ **task_id** | **String**| ID of Sale task to Void or Undo | [optional]
  **void** | **Boolean**| Default is false | [optional] [default to false]
 
 ### Return type
@@ -811,7 +814,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| Default is nil | [optional] 
+ **id** | **String**| Default is nil | [optional]
 
 ### Return type
 
@@ -870,7 +873,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| Default is nil | [optional] 
+ **id** | **String**| Default is nil | [optional]
 
 ### Return type
 
@@ -937,11 +940,11 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **String**| Default is 1 | [optional] [default to '1']
  **limit** | **String**| Default is 100 | [optional] [default to '100']
- **code** | **String**| Default is nil | [optional] 
- **name** | **String**| Default is nil | [optional] 
- **_class** | **String**| Default is nil | [optional] 
- **type** | **String**| Default is nil | [optional] 
- **status** | **String**| Default is nil | [optional] 
+ **code** | **String**| Default is nil | [optional]
+ **name** | **String**| Default is nil | [optional]
+ **_class** | **String**| Default is nil | [optional]
+ **type** | **String**| Default is nil | [optional]
+ **status** | **String**| Default is nil | [optional]
 
 ### Return type
 
@@ -957,6 +960,71 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_carriers
+
+> Carriers get_carriers(opts)
+
+Allows you to retrieve the carriers
+
+### 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
+  carrier_id: 'carrier_id_example', # String | Only return Carrier with the specific CarrierID
+  description: 'description_example' # String | Only return Carriers that start with the specific Description
+}
+
+begin
+  #Allows you to retrieve the carriers
+  result = api_instance.get_carriers(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_carriers: #{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']
+ **carrier_id** | **String**| Only return Carrier with the specific CarrierID | [optional]
+ **description** | **String**| Only return Carriers that start with the specific Description | [optional]
+
+### Return type
+
+[**Carriers**](Carriers.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_customers
 
 > Customers get_customers(opts)
@@ -989,8 +1057,8 @@ opts = {
   name: 'name_example', # String | Default is nil
   contact_filter: 'contact_filter_example', # String | Default is nil
   modified_since: 'modified_since_example', # String | Default is nil
-  include_deprecated: 'false', # String | Default is false
-  include_product_prices: 'false' # String | Default is false
+  include_deprecated: false, # Boolean | Default is false
+  include_product_prices: false # Boolean | Default is false
 }
 
 begin
@@ -1009,12 +1077,12 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **String**| Default is 1 | [optional] [default to '1']
  **limit** | **String**| Default is 100 | [optional] [default to '100']
- **id** | **String**| Default is nil | [optional] 
- **name** | **String**| Default is nil | [optional] 
- **contact_filter** | **String**| Default is nil | [optional] 
- **modified_since** | **String**| Default is nil | [optional] 
- **include_deprecated** | **String**| Default is false | [optional] [default to 'false']
- **include_product_prices** | **String**| Default is false | [optional] [default to 'false']
+ **id** | **String**| Default is nil | [optional]
+ **name** | **String**| Default is nil | [optional]
+ **contact_filter** | **String**| Default is nil | [optional]
+ **modified_since** | **String**| Default is nil | [optional]
+ **include_deprecated** | **Boolean**| Default is false | [optional] [default to false]
+ **include_product_prices** | **Boolean**| Default is false | [optional] [default to false]
 
 ### Return type
 
@@ -1030,6 +1098,73 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_locations
+
+> Locations get_locations(opts)
+
+Allows you to retrieve the locations
+
+### 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
+  id: 'id_example', # String | Default is nil
+  deprecated: false, # Boolean | Default is false
+  name: 'name_example' # String | Default is nil
+}
+
+begin
+  #Allows you to retrieve the locations
+  result = api_instance.get_locations(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_locations: #{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']
+ **id** | **String**| Default is nil | [optional]
+ **deprecated** | **Boolean**| Default is false | [optional] [default to false]
+ **name** | **String**| Default is nil | [optional]
+
+### Return type
+
+[**Locations**](Locations.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_me
 
 > Me get_me
@@ -1083,6 +1218,59 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_me_contacts
+
+> MeContacts get_me_contacts
+
+Allows you to retrieve the me contacts (Sales Representatives)
+
+### 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 me contacts (Sales Representatives)
+  result = api_instance.get_me_contacts
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_me_contacts: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MeContacts**](MeContacts.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_payment_terms
 
 > PaymentTerms get_payment_terms(opts)
@@ -1134,11 +1322,11 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **String**| Default is 1 | [optional] [default to '1']
  **limit** | **String**| Default is 100 | [optional] [default to '100']
- **id** | **String**| Default is nil | [optional] 
- **name** | **String**| Default is nil | [optional] 
- **method** | **String**| Default is nil | [optional] 
- **is_active** | **Boolean**| Default is nil | [optional] 
- **is_default** | **Boolean**| Default is nil | [optional] 
+ **id** | **String**| Default is nil | [optional]
+ **name** | **String**| Default is nil | [optional]
+ **method** | **String**| Default is nil | [optional]
+ **is_active** | **Boolean**| Default is nil | [optional]
+ **is_default** | **Boolean**| Default is nil | [optional]
 
 ### Return type
 
@@ -1253,7 +1441,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| Default is nil | [optional] 
+ **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]
@@ -1317,7 +1505,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_id** | **String**| Unique DEAR Sale ID | [optional] 
+ **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]
 
@@ -1396,21 +1584,21 @@ 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] 
+ **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
 
@@ -1471,7 +1659,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_id** | **String**| Unique DEAR Sale ID | [optional] 
+ **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]
 
@@ -1532,7 +1720,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_id** | **String**| Unique DEAR Sale ID | [optional] 
+ **sale_id** | **String**| Unique DEAR Sale ID | [optional]
 
 ### Return type
 
@@ -1593,7 +1781,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_id** | **String**| Unique DEAR Sale ID | [optional] 
+ **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]
 
@@ -1663,12 +1851,12 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **String**| Default is 1 | [optional] [default to '1']
  **limit** | **String**| Default is 100 | [optional] [default to '100']
- **id** | **String**| Default is nil | [optional] 
- **name** | **String**| Default is nil | [optional] 
- **is_active** | **Boolean**| Default is nil | [optional] 
- **is_tax_for_sale** | **Boolean**| Default is nil | [optional] 
- **is_tax_for_purchase** | **Boolean**| Default is nil | [optional] 
- **account** | **String**| Default is nil | [optional] 
+ **id** | **String**| Default is nil | [optional]
+ **name** | **String**| Default is nil | [optional]
+ **is_active** | **Boolean**| Default is nil | [optional]
+ **is_tax_for_sale** | **Boolean**| Default is nil | [optional]
+ **is_tax_for_purchase** | **Boolean**| Default is nil | [optional]
+ **account** | **String**| Default is nil | [optional]
 
 ### Return type
 
@@ -1781,7 +1969,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **account** | [**Account**](Account.md)| an Account object with properties to update | 
+ **account** | [**Account**](Account.md)| an Account object with properties to update |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -1842,7 +2030,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **customer** | [**Customer**](Customer.md)| a customer object with properties to update | 
+ **customer** | [**Customer**](Customer.md)| a customer object with properties to update |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -1903,7 +2091,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to update | 
+ **payment_term** | [**PaymentTerm**](PaymentTerm.md)| a payment term object with properties to update |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -1964,7 +2152,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sale_payment** | [**SalePayment**](SalePayment.md)| a sale payment object with properties to update | 
+ **sale_payment** | [**SalePayment**](SalePayment.md)| a sale payment object with properties to update |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -2025,7 +2213,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **tax** | [**Tax**](Tax.md)| a tax object with properties to update | 
+ **tax** | [**Tax**](Tax.md)| a tax object with properties to update |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type
@@ -2086,7 +2274,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to update | 
+ **webhook** | [**Webhook**](Webhook.md)| a webhook object with properties to update |
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
 
 ### Return type

data/docs/Location.md

@@ -0,0 +1,51 @@
+# DearInventoryRuby::Location
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Required for `PUT` and `DELETE`, Ignored for `POST` operations | [optional]
+**name** | **String** | Location name | [optional]
+**is_default** | **Boolean** | Points that location is used as default | [optional] [default to false]
+**deprecated** | **Boolean** | Points that location is deprecated | [optional] [default to false]
+**bins** | [**Array<Bin>**](Bin.md) | Array (ID, Name) with related Bins | [optional]
+**fixed_assets_location** | **Boolean** | Points that location is used as Fixed Asset | [optional] [default to false]
+**parent_id** | **String** | Parent ID (used for Bins) | [optional]
+**reference_count** | **Integer** | Reference linked to current location | [optional]
+**address_line1** | **String** | Address line | [optional]
+**address_line2** | **String** | Address line second | [optional]
+**address_city_suburb** | **String** | City suburb | [optional]
+**address_state_province** | **String** | State province | [optional]
+**address_zip_post_code** | **String** | Zip post code | [optional]
+**address_country** | **String** | Country | [optional]
+**pick_zones** | **String** | Pick zones | [optional]
+**is_shopfloor** | **Boolean** | Points that location is shopfloor | [optional] [default to false]
+**is_co_man** | **Boolean** | Points that location is location of co-manufacturer | [optional] [default to false]
+**is_staging** | **Boolean** | Points that location is staging. It is used only for Bins | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Location.new(id: nil,
+                                 name: nil,
+                                 is_default: nil,
+                                 deprecated: nil,
+                                 bins: nil,
+                                 fixed_assets_location: nil,
+                                 parent_id: nil,
+                                 reference_count: nil,
+                                 address_line1: nil,
+                                 address_line2: nil,
+                                 address_city_suburb: nil,
+                                 address_state_province: nil,
+                                 address_zip_post_code: nil,
+                                 address_country: nil,
+                                 pick_zones: nil,
+                                 is_shopfloor: nil,
+                                 is_co_man: nil,
+                                 is_staging: nil)
+```
+
+

data/docs/Locations.md

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

data/docs/Me.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**company** | **String** | Your company name | [optional] 
-**currency** | **String** | Your company base currency | [optional] 
-**time_zone** | **String** | Time Zone where your company located | [optional] 
-**default_weight_units** | **String** | Unit of measure for unit weight | [optional] 
-**default_dimensions_units** | **String** | Unit of measure for unit length/width/height | [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] 
+**company** | **String** | Your company name | [optional]
+**currency** | **String** | Your company base currency | [optional]
+**time_zone** | **String** | Time Zone where your company located | [optional]
+**default_weight_units** | **String** | Unit of measure for unit weight | [optional]
+**default_dimensions_units** | **String** | Unit of measure for unit length/width/height | [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]
 
 ## Code Sample