dear-inventory-ruby 0.2.10.1 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77bdd34f343e803604fada055da784f0693b628d3e44987a3eb2b4db5f2b4c4
-  data.tar.gz: 65e24829fec2fca131f62d72b3568bd072bf7ece094236cda84d7f29e452f540
+  metadata.gz: 784c9c2d581cdb49797edb13ad15f7cc1a26a1854a9134db021894879df9cac8
+  data.tar.gz: 518147a06737463f51381764479b67c44b60496baf44c142570b7f3683471773
 SHA512:
-  metadata.gz: 3b843cfc2806503478ccd252f38051d53d5148a400ae041abb7ca1c4a274afc2a71ffcb78e84344b8b7418c339d40ae41acf8ef03cedce2337eba38375a21e14
-  data.tar.gz: 5fbbcc7d7bf3a16964bd50a1ccac546aa1ecd068f16a2846c94e0fca3019fe0385e6b880c35374668c3bf20c9546baab50f52614c0888bdc768b50af50af871d
+  metadata.gz: 665d6760d0dcddb08b86f42ea176416c42dbf1590ef7e711a2afb5839d226480e89f2cde0800e94eed05711042e90bec8b5ba37e12ba4909f92da26de540a916
+  data.tar.gz: 4099384656dc34f0142301986378a053666790682cb19236f42cdc8b9d8761489331397602ffbfbfeeff764d9c099a5a160cf9d308187cca6aa399052b563209

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.11] - 2024-02-21
+
+- Add the new endpoints
+  + GET `/me/contacts`
+  + GET `/ref/carrier`
+  + GET `/ref/location`
+
 ## [0.2.10.1] - 2024-02-06
 
 - Update gem version

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.10.1
+- Package version: 0.2.11
 - 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.10.1.gem
+gem install ./dear-inventory-ruby-0.2.11.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.2.10.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.2.11.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.10.1'
+    gem 'dear-inventory-ruby', '~> 0.2.11'
 
 ### Install from Git
 
@@ -107,8 +107,11 @@ Class | Method | HTTP request | Description
 *DearInventoryRuby::InventoryApi* | [**delete_sale_payment**](docs/InventoryApi.md#delete_sale_payment) | **DELETE** /sale/payment | Allows you to delete a sale payment
 *DearInventoryRuby::InventoryApi* | [**delete_webhook**](docs/InventoryApi.md#delete_webhook) | **DELETE** /webhooks | Allows you to delete a webhook
 *DearInventoryRuby::InventoryApi* | [**get_accounts**](docs/InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
+*DearInventoryRuby::InventoryApi* | [**get_carriers**](docs/InventoryApi.md#get_carriers) | **GET** /ref/carrier | Allows you to retrieve the carriers
 *DearInventoryRuby::InventoryApi* | [**get_customers**](docs/InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
+*DearInventoryRuby::InventoryApi* | [**get_locations**](docs/InventoryApi.md#get_locations) | **GET** /ref/location | Allows you to retrieve the locations
 *DearInventoryRuby::InventoryApi* | [**get_me**](docs/InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information
+*DearInventoryRuby::InventoryApi* | [**get_me_contacts**](docs/InventoryApi.md#get_me_contacts) | **GET** /me/contacts | Allows you to retrieve the me contacts (Sales Representatives)
 *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
@@ -134,12 +137,19 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::Address](docs/Address.md)
  - [DearInventoryRuby::AttachmentLine](docs/AttachmentLine.md)
  - [DearInventoryRuby::AuthorizationType](docs/AuthorizationType.md)
+ - [DearInventoryRuby::Bin](docs/Bin.md)
+ - [DearInventoryRuby::Carrier](docs/Carrier.md)
+ - [DearInventoryRuby::Carriers](docs/Carriers.md)
  - [DearInventoryRuby::Contact](docs/Contact.md)
  - [DearInventoryRuby::Customer](docs/Customer.md)
  - [DearInventoryRuby::Customers](docs/Customers.md)
  - [DearInventoryRuby::Error](docs/Error.md)
  - [DearInventoryRuby::ExternalHeader](docs/ExternalHeader.md)
+ - [DearInventoryRuby::Location](docs/Location.md)
+ - [DearInventoryRuby::Locations](docs/Locations.md)
  - [DearInventoryRuby::Me](docs/Me.md)
+ - [DearInventoryRuby::MeContact](docs/MeContact.md)
+ - [DearInventoryRuby::MeContacts](docs/MeContacts.md)
  - [DearInventoryRuby::PaymentTerm](docs/PaymentTerm.md)
  - [DearInventoryRuby::PaymentTerms](docs/PaymentTerms.md)
  - [DearInventoryRuby::PriceTier](docs/PriceTier.md)

data/docs/Bin.md

@@ -0,0 +1,19 @@
+# DearInventoryRuby::Bin
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique ID | [optional] 
+**name** | **String** | Name of `Bin` | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Bin.new(id: nil,
+                                 name: nil)
+```
+
+

data/docs/Carrier.md

@@ -0,0 +1,19 @@
+# DearInventoryRuby::Carrier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_id** | **String** | Unique `Carrier` ID | [optional] 
+**description** | **String** | Name of `Carrier` | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Carrier.new(carrier_id: nil,
+                                 description: nil)
+```
+
+

data/docs/Carriers.md

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

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
@@ -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
@@ -1013,8 +1081,8 @@ Name | Type | Description  | Notes
  **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']
+ **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)

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/MeContact.md

@@ -0,0 +1,33 @@
+# DearInventoryRuby::MeContact
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact_id** | **String** | Unique `MeContact` ID | [optional] 
+**name** | **String** | Name of `MeContact` | [optional] 
+**phone** | **String** | Phone | [optional] 
+**fax** | **String** | Fax | [optional] 
+**email** | **String** | Email | [optional] 
+**website** | **String** | Website | [optional] 
+**comment** | **String** | Comment | [optional] 
+**type** | **String** | `MeContact` Type. Should be one of the following values: `Billing`, `Business`, `Sale`, `Shipping` or `Employee` | [optional] 
+**default_for_type** | **Boolean** | Points that `MeContact` is used as default for chosen `Type`. `False` as default. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::MeContact.new(contact_id: nil,
+                                 name: nil,
+                                 phone: nil,
+                                 fax: nil,
+                                 email: nil,
+                                 website: nil,
+                                 comment: nil,
+                                 type: nil,
+                                 default_for_type: nil)
+```
+
+

data/docs/MeContacts.md

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