dear-inventory-ruby 0.2.10.1 → 0.2.12

data/docs/SalePaymentLine.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | Identifier of payment. | [optional] 
-**reference** | **String** | Payment reference number. | [optional] 
-**amount** | **Float** | Decimal with up to 2 decimal places. Payment amount in customer currency. | [optional] 
-**date_paid** | **Date** | Date when payment has been made. | [optional] 
-**account** | **String** | Account Code of the bank/payment account from Chart of accounts. | [optional] 
-**currency_rate** | **Float** | Decimal with up to 4 decimal places. Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. | [optional] 
-**date_created** | **Date** | Date of creation payment record. | [optional] 
+**id** | **String** | Identifier of payment. | [optional]
+**reference** | **String** | Payment reference number. | [optional]
+**amount** | **Float** | Decimal with up to 2 decimal places. Payment amount in customer currency. | [optional]
+**date_paid** | **Date** | Date when payment has been made. | [optional]
+**account** | **String** | Account Code of the bank/payment account from Chart of accounts. | [optional]
+**currency_rate** | **Float** | Decimal with up to 4 decimal places. Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. | [optional]
+**date_created** | **Date** | Date of creation payment record. | [optional]
 
 ## Code Sample
 

data/docs/SaleQuote.md

@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sale_id** | **String** | Unique DEAR Sale ID | 
+**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. | 
+**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
 

data/docs/SaleQuoteLine.md

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

data/docs/ShippingAddress.md

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

data/docs/Success.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**success** | **Boolean** | Success | [optional] 
+**success** | **Boolean** | Success | [optional]
 
 ## Code Sample
 

data/docs/SupplierCustomerAddress.md

@@ -4,14 +4,14 @@
 
 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`. | 
+**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]
+**postcode** | **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
@@ -24,7 +24,7 @@ instance = DearInventoryRuby::SupplierCustomerAddress.new(id: nil,
                                  line2: nil,
                                  city: nil,
                                  state: nil,
-                                 post_code: nil,
+                                 postcode: nil,
                                  country: nil,
                                  type: nil,
                                  default_for_type: nil)

data/docs/Tax.md

@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | Unique ID | [optional] 
-**name** | **String** | Tax Name | 
-**account** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` | 
+**id** | **String** | Unique ID | [optional]
+**name** | **String** | Tax Name |
+**account** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` |
 **is_active** | **Boolean** | Points that tax is Active | [default to true]
 **tax_inclusive** | **Boolean** | Points that tax is Inclusive | [default to true]
-**tax_percent** | **Float** | Tax percentage, should be between 0 and 100. Read-only | [optional] 
+**tax_percent** | **Float** | Tax percentage, should be between 0 and 100. Read-only | [optional]
 **is_tax_for_sale** | **Boolean** | Points that tax is used for Sale | [optional] [default to true]
 **is_tax_for_purchase** | **Boolean** | Points that tax is used for Purchase | [optional] [default to true]
-**components** | [**Array<TaxComponent>**](TaxComponent.md) | List of Tax Components | [optional] 
+**components** | [**Array<TaxComponent>**](TaxComponent.md) | List of Tax Components | [optional]
 
 ## Code Sample
 

data/docs/TaxComponent.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of product. Read-only. | 
+**name** | **String** | Name of product. Read-only. |
 **percent** | **Float** | Cost. Required if product type is `Service`. Default value = 0. | [default to 0]
-**account_code** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` | 
-**component_order** | **Integer** | The order of sequence taxes components. | 
+**account_code** | **String** | ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE` |
+**component_order** | **Integer** | The order of sequence taxes components. |
 
 ## Code Sample
 

data/docs/Taxes.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**total** | **String** | Total | [optional] 
-**page** | **String** | Page | [optional] 
-**tax_rule_list** | [**Array<Tax>**](Tax.md) | Array of Taxes | [optional] 
+**total** | **String** | Total | [optional]
+**page** | **String** | Page | [optional]
+**tax_rule_list** | [**Array<Tax>**](Tax.md) | Array of Taxes | [optional]
 
 ## Code Sample
 

data/docs/Webhook.md

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

data/docs/Webhooks.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**webhooks** | [**Array<Webhook>**](Webhook.md) | Array of Webhooks | [optional] 
+**webhooks** | [**Array<Webhook>**](Webhook.md) | Array of Webhooks | [optional]
 
 ## Code Sample
 

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

@@ -967,6 +967,72 @@ module DearInventoryRuby
       return data, status_code, headers
     end
 
+    # Allows you to retrieve the carriers
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page Default is 1 (default to '1')
+    # @option opts [String] :limit Default is 100 (default to '100')
+    # @option opts [String] :carrier_id Only return Carrier with the specific CarrierID
+    # @option opts [String] :description Only return Carriers that start with the specific Description
+    # @return [Carriers]
+    def get_carriers(opts = {})
+      data, _status_code, _headers = get_carriers_with_http_info(opts)
+      data
+    end
+
+    # Allows you to retrieve the carriers
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page Default is 1
+    # @option opts [String] :limit Default is 100
+    # @option opts [String] :carrier_id Only return Carrier with the specific CarrierID
+    # @option opts [String] :description Only return Carriers that start with the specific Description
+    # @return [Array<(Carriers, Integer, Hash)>] Carriers data, response status code and response headers
+    def get_carriers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InventoryApi.get_carriers ...'
+      end
+      # resource path
+      local_var_path = '/ref/carrier'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'Page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'Limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'CarrierID'] = opts[:'carrier_id'] if !opts[:'carrier_id'].nil?
+      query_params[:'Description'] = opts[:'description'] if !opts[:'description'].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] || 'Carriers' 
+
+      # 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_carriers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to retrieve the customers
     # @param [Hash] opts the optional parameters
     # @option opts [String] :page Default is 1 (default to '1')
@@ -975,8 +1041,8 @@ module DearInventoryRuby
     # @option opts [String] :name Default is nil
     # @option opts [String] :contact_filter Default is nil
     # @option opts [String] :modified_since Default is nil
-    # @option opts [String] :include_deprecated Default is false (default to 'false')
-    # @option opts [String] :include_product_prices Default is false (default to 'false')
+    # @option opts [Boolean] :include_deprecated Default is false (default to false)
+    # @option opts [Boolean] :include_product_prices Default is false (default to false)
     # @return [Customers]
     def get_customers(opts = {})
       data, _status_code, _headers = get_customers_with_http_info(opts)
@@ -991,8 +1057,8 @@ module DearInventoryRuby
     # @option opts [String] :name Default is nil
     # @option opts [String] :contact_filter Default is nil
     # @option opts [String] :modified_since Default is nil
-    # @option opts [String] :include_deprecated Default is false
-    # @option opts [String] :include_product_prices Default is false
+    # @option opts [Boolean] :include_deprecated Default is false
+    # @option opts [Boolean] :include_product_prices Default is false
     # @return [Array<(Customers, Integer, Hash)>] Customers data, response status code and response headers
     def get_customers_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1045,6 +1111,75 @@ module DearInventoryRuby
       return data, status_code, headers
     end
 
+    # Allows you to retrieve the locations
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page Default is 1 (default to '1')
+    # @option opts [String] :limit Default is 100 (default to '100')
+    # @option opts [String] :id Default is nil
+    # @option opts [Boolean] :deprecated Default is false (default to false)
+    # @option opts [String] :name Default is nil
+    # @return [Locations]
+    def get_locations(opts = {})
+      data, _status_code, _headers = get_locations_with_http_info(opts)
+      data
+    end
+
+    # Allows you to retrieve the locations
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page Default is 1
+    # @option opts [String] :limit Default is 100
+    # @option opts [String] :id Default is nil
+    # @option opts [Boolean] :deprecated Default is false
+    # @option opts [String] :name Default is nil
+    # @return [Array<(Locations, Integer, Hash)>] Locations data, response status code and response headers
+    def get_locations_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InventoryApi.get_locations ...'
+      end
+      # resource path
+      local_var_path = '/ref/location'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'Page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'Limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'ID'] = opts[:'id'] if !opts[:'id'].nil?
+      query_params[:'Deprecated'] = opts[:'deprecated'] if !opts[:'deprecated'].nil?
+      query_params[:'Name'] = opts[:'name'] if !opts[:'name'].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] || 'Locations' 
+
+      # 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_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to retrieve your information
     # @param [Hash] opts the optional parameters
     # @return [Me]
@@ -1099,6 +1234,60 @@ module DearInventoryRuby
       return data, status_code, headers
     end
 
+    # Allows you to retrieve the me contacts (Sales Representatives)
+    # @param [Hash] opts the optional parameters
+    # @return [MeContacts]
+    def get_me_contacts(opts = {})
+      data, _status_code, _headers = get_me_contacts_with_http_info(opts)
+      data
+    end
+
+    # Allows you to retrieve the me contacts (Sales Representatives)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MeContacts, Integer, Hash)>] MeContacts data, response status code and response headers
+    def get_me_contacts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InventoryApi.get_me_contacts ...'
+      end
+      # resource path
+      local_var_path = '/me/contacts'
+
+      # 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] || 'MeContacts' 
+
+      # 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_me_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to retrieve the payment terms
     # @param [Hash] opts the optional parameters
     # @option opts [String] :page Default is 1 (default to '1')