dear-inventory-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4dc8e1a681123c408ac8e5d6ae9294680e33c560b21b59c8a18701d97df1b03
+  data.tar.gz: e8acb9bb27c89448f1c6f753934cf228e8f441b1e25ab073cf115154d7bea59a
+SHA512:
+  metadata.gz: 9ce4e3b10fc0d2b7ced53f9088fb389bf7658b81f00bec402163a81f2bdf0993833e26bebea5aed6806b61a9487035d9dd40a3b560a531b3370f0e0c55b1a5a3
+  data.tar.gz: 4052318834c97171717b689b9e09b6f58371d61c5e2dd360df2105fa4fedc6ba3a68435f0c94ee6fa37c10da4cb8684f663ad413e721161fde1e032b42d68634

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Nathan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# dear-inventory-ruby
+
+DearInventoryRuby - the Ruby gem for the DEAR Inventory API
+
+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.1.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.nnhan.me](https://www.nnhan.me)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build dear-inventory-ruby.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./dear-inventory-ruby-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./dear-inventory-ruby-0.1.0.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.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'dear-inventory-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```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::CustomerApi.new
+opts = {
+  page: '1', # String | Default is 1
+  limit: '100', # String | Default is 100
+  id: 'id_example', # String | Default is null
+  name: 'name_example', # String | Default is null
+  modified_since: 'modified_since_example', # String | Default is null
+  include_deprecated: 'false' # String | Default is false
+}
+
+begin
+  #Allows you to retrieve the customers
+  result = api_instance.get_customers(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling CustomerApi->get_customers: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://inventory.dearsystems.com/ExternalApi/v2*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DearInventoryRuby::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
+
+
+## Documentation for Models
+
+ - [DearInventoryRuby::Address](docs/Address.md)
+ - [DearInventoryRuby::Contact](docs/Contact.md)
+ - [DearInventoryRuby::CurrencyCode](docs/CurrencyCode.md)
+ - [DearInventoryRuby::Customer](docs/Customer.md)
+ - [DearInventoryRuby::Customers](docs/Customers.md)
+ - [DearInventoryRuby::Error](docs/Error.md)
+
+
+## Documentation for Authorization
+
+
+### accountID
+
+
+- **Type**: API key
+- **API key parameter name**: api_auth_accountid
+- **Location**: HTTP header
+
+### appKey
+
+
+- **Type**: API key
+- **API key parameter name**: api_auth_applicationkey
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/dear-inventory-ruby.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "dear-inventory-ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dear-inventory-ruby"
+  s.version     = DearInventoryRuby::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nhan Nguyen"]
+  s.email       = ["nnhansg@gmail.com"]
+  s.homepage    = "https://inventory.dearsystems.com"
+  s.summary     = "DEAR Inventory Ruby SDK generated from DEAR-OpenAPI Spec 3.0 for https://inventory.dearsystems.com"
+  s.description = "DEAR Inventory Ruby SDK generated from DEAR-OpenAPI Spec 3.0 for https://inventory.dearsystems.com"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'faraday', '>= 0.14.0'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Address.md

@@ -0,0 +1,33 @@
+# DearInventoryRuby::Address
+
+## 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 | [optional] 
+**type** | **String** | Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`. | [optional] 
+**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::Address.new(id: null,
+                                 line1: null,
+                                 line2: null,
+                                 city: null,
+                                 state: null,
+                                 post_code: null,
+                                 country: null,
+                                 type: null,
+                                 default_for_type: null)
+```
+
+

data/docs/Contact.md

@@ -0,0 +1,33 @@
+# DearInventoryRuby::Contact
+
+## 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] 
+**name** | **String** | Name of Contact | [optional] 
+**phone** | **String** | Phone | [optional] 
+**fax** | **String** | Fax | [optional] 
+**email** | **String** | Email | [optional] 
+**website** | **String** | Website | [optional] 
+**comment** | **String** | Comment | [optional] 
+**default** | **Boolean** | Points that Contact is used as default. `false` as default. | [optional] [default to false]
+**include_in_email** | **Boolean** | Points that Contact is included in Email. `false` as default. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Contact.new(id: null,
+                                 name: null,
+                                 phone: null,
+                                 fax: null,
+                                 email: null,
+                                 website: null,
+                                 comment: null,
+                                 default: null,
+                                 include_in_email: null)
+```
+
+

data/docs/CurrencyCode.md

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

data/docs/Customer.md

@@ -0,0 +1,77 @@
+# DearInventoryRuby::Customer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique Customer ID | [optional] 
+**name** | **String** | Name of Customer | [optional] 
+**status** | **String** | Points that Customer is Active. Available values are Active and Deprecated. Required for POST | [optional] 
+**currency** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**payment_term** | **String** | Payment term | [optional] 
+**account_receivable** | **String** | Account receivable code of Customer | [optional] 
+**revenue_account** | **String** | Sale account code of Customer | [optional] 
+**tax_rule** | **String** | Tax rule name | [optional] 
+**price_tier** | **String** | Price tier | [optional] 
+**carrier** | **String** | Carrier name | [optional] 
+**sales_representative** | **String** | Sales representative | [optional] 
+**location** | **String** | Location | [optional] 
+**discount** | **Float** | Discount must be between 0% and 100% | [optional] 
+**comments** | **String** | Comments | [optional] 
+**tax_number** | **String** | Tax number | [optional] 
+**credit_limit** | **Float** | Credit limit | [optional] 
+**tags** | **String** | Tags string | [optional] 
+**attribute_set** | **String** | AttributeSet name | [optional] 
+**additional_attribute1** | **String** | Additional attribute 1 value | [optional] 
+**additional_attribute2** | **String** | Additional attribute 2 value | [optional] 
+**additional_attribute3** | **String** | Additional attribute 3 value | [optional] 
+**additional_attribute4** | **String** | Additional attribute 4 value | [optional] 
+**additional_attribute5** | **String** | Additional attribute 5 value | [optional] 
+**additional_attribute6** | **String** | Additional attribute 6 value | [optional] 
+**additional_attribute7** | **String** | Additional attribute 7 value | [optional] 
+**additional_attribute8** | **String** | Additional attribute 8 value | [optional] 
+**additional_attribute9** | **String** | Additional attribute 9 value | [optional] 
+**additional_attribute10** | **String** | Additional attribute 10 value | [optional] 
+**last_modified_on** | **String** | Date of last modification | [optional] 
+**addresses** | [**Array<Address>**](Address.md) | List of addresses | [optional] 
+**contacts** | [**Array<Contact>**](Contact.md) | List of contacts | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::Customer.new(id: null,
+                                 name: null,
+                                 status: null,
+                                 currency: null,
+                                 payment_term: null,
+                                 account_receivable: null,
+                                 revenue_account: null,
+                                 tax_rule: null,
+                                 price_tier: null,
+                                 carrier: null,
+                                 sales_representative: null,
+                                 location: null,
+                                 discount: null,
+                                 comments: null,
+                                 tax_number: null,
+                                 credit_limit: null,
+                                 tags: null,
+                                 attribute_set: null,
+                                 additional_attribute1: null,
+                                 additional_attribute2: null,
+                                 additional_attribute3: null,
+                                 additional_attribute4: null,
+                                 additional_attribute5: null,
+                                 additional_attribute6: null,
+                                 additional_attribute7: null,
+                                 additional_attribute8: null,
+                                 additional_attribute9: null,
+                                 additional_attribute10: null,
+                                 last_modified_on: null,
+                                 addresses: null,
+                                 contacts: null)
+```
+
+

data/docs/CustomerApi.md

@@ -0,0 +1,78 @@
+# DearInventoryRuby::CustomerApi
+
+All URIs are relative to *https://inventory.dearsystems.com/ExternalApi/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_customers**](CustomerApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
+
+
+
+## get_customers
+
+> Customers get_customers(opts)
+
+Allows you to retrieve the customers
+
+### 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::CustomerApi.new
+opts = {
+  page: '1', # String | Default is 1
+  limit: '100', # String | Default is 100
+  id: 'id_example', # String | Default is null
+  name: 'name_example', # String | Default is null
+  modified_since: 'modified_since_example', # String | Default is null
+  include_deprecated: 'false' # String | Default is false
+}
+
+begin
+  #Allows you to retrieve the customers
+  result = api_instance.get_customers(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling CustomerApi->get_customers: #{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 null | [optional] 
+ **name** | **String**| Default is null | [optional] 
+ **modified_since** | **String**| Default is null | [optional] 
+ **include_deprecated** | **String**| Default is false | [optional] [default to 'false']
+
+### Return type
+
+[**Customers**](Customers.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+