dear-inventory-ruby 0.1.8 → 0.1.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/Gemfile +1 -1
  4. data/README.md +8 -4
  5. data/dear-inventory-ruby.gemspec +1 -1
  6. data/docs/Account.md +15 -15
  7. data/docs/Accounts.md +3 -3
  8. data/docs/Address.md +9 -9
  9. data/docs/Contact.md +9 -9
  10. data/docs/Customer.md +31 -31
  11. data/docs/Customers.md +3 -3
  12. data/docs/DimensionsUnit.md +16 -0
  13. data/docs/Error.md +2 -2
  14. data/docs/InventoryApi.md +54 -0
  15. data/docs/Me.md +29 -0
  16. data/docs/PaymentTerm.md +6 -6
  17. data/docs/PaymentTerms.md +3 -3
  18. data/docs/Success.md +1 -1
  19. data/docs/Tax.md +9 -9
  20. data/docs/TaxComponent.md +4 -4
  21. data/docs/Taxes.md +3 -3
  22. data/docs/WeightUnit.md +16 -0
  23. data/lib/dear-inventory-ruby.rb +4 -1
  24. data/lib/dear-inventory-ruby/api/inventory_api.rb +55 -1
  25. data/lib/dear-inventory-ruby/api_client.rb +1 -1
  26. data/lib/dear-inventory-ruby/api_error.rb +1 -1
  27. data/lib/dear-inventory-ruby/configuration.rb +1 -1
  28. data/lib/dear-inventory-ruby/models/account.rb +1 -1
  29. data/lib/dear-inventory-ruby/models/accounts.rb +1 -1
  30. data/lib/dear-inventory-ruby/models/address.rb +1 -1
  31. data/lib/dear-inventory-ruby/models/contact.rb +1 -1
  32. data/lib/dear-inventory-ruby/models/currency_code.rb +1 -1
  33. data/lib/dear-inventory-ruby/models/customer.rb +1 -1
  34. data/lib/dear-inventory-ruby/models/customers.rb +1 -1
  35. data/lib/dear-inventory-ruby/models/dimensions_unit.rb +42 -0
  36. data/lib/dear-inventory-ruby/models/error.rb +1 -1
  37. data/lib/dear-inventory-ruby/models/me.rb +264 -0
  38. data/lib/dear-inventory-ruby/models/payment_term.rb +1 -1
  39. data/lib/dear-inventory-ruby/models/payment_terms.rb +1 -1
  40. data/lib/dear-inventory-ruby/models/success.rb +1 -1
  41. data/lib/dear-inventory-ruby/models/tax.rb +1 -1
  42. data/lib/dear-inventory-ruby/models/tax_component.rb +1 -1
  43. data/lib/dear-inventory-ruby/models/taxes.rb +1 -1
  44. data/lib/dear-inventory-ruby/models/weight_unit.rb +39 -0
  45. data/lib/dear-inventory-ruby/version.rb +2 -2
  46. data/spec/api/inventory_api_spec.rb +11 -1
  47. data/spec/api_client_spec.rb +2 -2
  48. data/spec/configuration_spec.rb +1 -1
  49. data/spec/models/account_spec.rb +1 -1
  50. data/spec/models/accounts_spec.rb +1 -1
  51. data/spec/models/address_spec.rb +1 -1
  52. data/spec/models/contact_spec.rb +1 -1
  53. data/spec/models/currency_code_spec.rb +1 -1
  54. data/spec/models/customer_spec.rb +1 -1
  55. data/spec/models/customers_spec.rb +1 -1
  56. data/spec/models/dimensions_unit_spec.rb +35 -0
  57. data/spec/models/error_spec.rb +1 -1
  58. data/spec/models/me_spec.rb +77 -0
  59. data/spec/models/payment_term_spec.rb +1 -1
  60. data/spec/models/payment_terms_spec.rb +1 -1
  61. data/spec/models/success_spec.rb +1 -1
  62. data/spec/models/tax_component_spec.rb +1 -1
  63. data/spec/models/tax_spec.rb +1 -1
  64. data/spec/models/taxes_spec.rb +1 -1
  65. data/spec/models/weight_unit_spec.rb +35 -0
  66. data/spec/spec_helper.rb +1 -1
  67. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '08b171f5661cd11f44abba7fb3baafaa42e3348db4c57f519181a78916a7c179'
4
- data.tar.gz: 2afb2457cce6dafe81007899a281df7bd2043f1199591774d9eeef4c8c2f730e
3
+ metadata.gz: fe0a172dc3b6ea6dc88ee24a04dcf0d06aef4f1575f0eb1077534860d28b32a9
4
+ data.tar.gz: 4a9652d006b996e30b8889f0ef8855c26ff3fe0f8323dd383b060f26d6918e18
5
5
  SHA512:
6
- metadata.gz: e223e254efdfae01f7b8ec0f714fdb02f317f722d3f17d63bf977b3515b77340303e18975365621aafb75988be5f8d1e9da84cd64720f00d422433c8b67ebb19
7
- data.tar.gz: 4bf4faf0dfcb47e58cd2f66f85d3b4479801cc3cf70464fd029d94be4c9ff73f8c6eb8ff238e05f99d327c90778f3289bd6d39bf8723fbd8251937e5d9766431
6
+ metadata.gz: 12e37bb9d13b239f3992f2fd0bce2a7d0d0ea1a59b03e4bf3b0fef8e80e521c4478769836af705cb54c302355f05f4cf406ea955ffac2cc0499f8b0deedd3d60
7
+ data.tar.gz: 6fbe291c379f67c2d35abaa02dfa7459c3665415d42406162629d2f5538895bc8e409b5211020d5cd2c1b0a92d43de410a980031065687b3fbbb7f206326c92c
data/CHANGELOG.md CHANGED
@@ -2,6 +2,15 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file.
4
4
 
5
+ ## [0.1.9] - 2020-04-12
6
+
7
+ - Add new endpoint and model: Me
8
+ - Update OpenAPI Generator version 4.3.0
9
+
10
+ ## [0.1.8] - 2020-02-16
11
+
12
+ - Remove the validations of attributes: Type, SystemAccount because Dear API docs is not mapping for the result of API returned
13
+
5
14
  ## [0.1.7] - 2020-02-16
6
15
 
7
16
  - Fix params of /account GET
data/Gemfile CHANGED
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '~> 12.0.0'
6
+ gem 'rake', '~> 13.0.1'
7
7
  gem 'pry-byebug'
8
8
  gem 'rubocop', '~> 0.66.0'
9
9
  end
data/README.md CHANGED
@@ -7,7 +7,7 @@ This specifing endpoints for DEAR Inventory API
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 0.1.8
10
+ - Package version: 0.1.9
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://www.nnhan.me](https://www.nnhan.me)
13
13
 
@@ -24,16 +24,16 @@ gem build dear-inventory-ruby.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./dear-inventory-ruby-0.1.8.gem
27
+ gem install ./dear-inventory-ruby-0.1.9.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./dear-inventory-ruby-0.1.8.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./dear-inventory-ruby-0.1.9.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'dear-inventory-ruby', '~> 0.1.8'
36
+ gem 'dear-inventory-ruby', '~> 0.1.9'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -100,6 +100,7 @@ Class | Method | HTTP request | Description
100
100
  *DearInventoryRuby::InventoryApi* | [**delete_payment_term**](docs/InventoryApi.md#delete_payment_term) | **DELETE** /ref/paymentterm | Allows you to delete a payment term
101
101
  *DearInventoryRuby::InventoryApi* | [**get_accounts**](docs/InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
102
102
  *DearInventoryRuby::InventoryApi* | [**get_customers**](docs/InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
103
+ *DearInventoryRuby::InventoryApi* | [**get_me**](docs/InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information
103
104
  *DearInventoryRuby::InventoryApi* | [**get_payment_terms**](docs/InventoryApi.md#get_payment_terms) | **GET** /ref/paymentterm | Allows you to retrieve the payment terms
104
105
  *DearInventoryRuby::InventoryApi* | [**get_taxes**](docs/InventoryApi.md#get_taxes) | **GET** /ref/tax | Allows you to retrieve the taxes
105
106
  *DearInventoryRuby::InventoryApi* | [**update_account**](docs/InventoryApi.md#update_account) | **PUT** /ref/account | Allows you to update an Account
@@ -117,13 +118,16 @@ Class | Method | HTTP request | Description
117
118
  - [DearInventoryRuby::CurrencyCode](docs/CurrencyCode.md)
118
119
  - [DearInventoryRuby::Customer](docs/Customer.md)
119
120
  - [DearInventoryRuby::Customers](docs/Customers.md)
121
+ - [DearInventoryRuby::DimensionsUnit](docs/DimensionsUnit.md)
120
122
  - [DearInventoryRuby::Error](docs/Error.md)
123
+ - [DearInventoryRuby::Me](docs/Me.md)
121
124
  - [DearInventoryRuby::PaymentTerm](docs/PaymentTerm.md)
122
125
  - [DearInventoryRuby::PaymentTerms](docs/PaymentTerms.md)
123
126
  - [DearInventoryRuby::Success](docs/Success.md)
124
127
  - [DearInventoryRuby::Tax](docs/Tax.md)
125
128
  - [DearInventoryRuby::TaxComponent](docs/TaxComponent.md)
126
129
  - [DearInventoryRuby::Taxes](docs/Taxes.md)
130
+ - [DearInventoryRuby::WeightUnit](docs/WeightUnit.md)
127
131
 
128
132
 
129
133
  ## Documentation for Authorization
@@ -8,7 +8,7 @@
8
8
  The version of the OpenAPI document: 2.0.0
9
9
  Contact: nnhansg@gmail.com
10
10
  Generated by: https://openapi-generator.tech
11
- OpenAPI Generator version: 4.2.3
11
+ OpenAPI Generator version: 4.3.0
12
12
 
13
13
  =end
14
14
 
data/docs/Account.md CHANGED
@@ -25,21 +25,21 @@ Name | Type | Description | Notes
25
25
  ```ruby
26
26
  require 'DearInventoryRuby'
27
27
 
28
- instance = DearInventoryRuby::Account.new(code: null,
29
- name: null,
30
- type: null,
31
- status: null,
32
- description: null,
33
- _class: null,
34
- system_account: null,
35
- system_account_code: null,
36
- for_payments: null,
37
- display_name: null,
38
- old_code: null,
39
- bank: null,
40
- bank_account_number: null,
41
- bank_account_id: null,
42
- currency: null)
28
+ instance = DearInventoryRuby::Account.new(code: nil,
29
+ name: nil,
30
+ type: nil,
31
+ status: nil,
32
+ description: nil,
33
+ _class: nil,
34
+ system_account: nil,
35
+ system_account_code: nil,
36
+ for_payments: nil,
37
+ display_name: nil,
38
+ old_code: nil,
39
+ bank: nil,
40
+ bank_account_number: nil,
41
+ bank_account_id: nil,
42
+ currency: nil)
43
43
  ```
44
44
 
45
45
 
data/docs/Accounts.md CHANGED
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
13
13
  ```ruby
14
14
  require 'DearInventoryRuby'
15
15
 
16
- instance = DearInventoryRuby::Accounts.new(total: null,
17
- page: null,
18
- accounts_list: null)
16
+ instance = DearInventoryRuby::Accounts.new(total: nil,
17
+ page: nil,
18
+ accounts_list: nil)
19
19
  ```
20
20
 
21
21
 
data/docs/Address.md CHANGED
@@ -19,15 +19,15 @@ Name | Type | Description | Notes
19
19
  ```ruby
20
20
  require 'DearInventoryRuby'
21
21
 
22
- instance = DearInventoryRuby::Address.new(id: null,
23
- line1: null,
24
- line2: null,
25
- city: null,
26
- state: null,
27
- post_code: null,
28
- country: null,
29
- type: null,
30
- default_for_type: null)
22
+ instance = DearInventoryRuby::Address.new(id: nil,
23
+ line1: nil,
24
+ line2: nil,
25
+ city: nil,
26
+ state: nil,
27
+ post_code: nil,
28
+ country: nil,
29
+ type: nil,
30
+ default_for_type: nil)
31
31
  ```
32
32
 
33
33
 
data/docs/Contact.md CHANGED
@@ -19,15 +19,15 @@ Name | Type | Description | Notes
19
19
  ```ruby
20
20
  require 'DearInventoryRuby'
21
21
 
22
- instance = DearInventoryRuby::Contact.new(id: null,
23
- name: null,
24
- phone: null,
25
- fax: null,
26
- email: null,
27
- website: null,
28
- comment: null,
29
- default: null,
30
- include_in_email: null)
22
+ instance = DearInventoryRuby::Contact.new(id: nil,
23
+ name: nil,
24
+ phone: nil,
25
+ fax: nil,
26
+ email: nil,
27
+ website: nil,
28
+ comment: nil,
29
+ default: nil,
30
+ include_in_email: nil)
31
31
  ```
32
32
 
33
33
 
data/docs/Customer.md CHANGED
@@ -41,37 +41,37 @@ Name | Type | Description | Notes
41
41
  ```ruby
42
42
  require 'DearInventoryRuby'
43
43
 
44
- instance = DearInventoryRuby::Customer.new(id: null,
45
- name: null,
46
- status: null,
47
- currency: null,
48
- payment_term: null,
49
- account_receivable: null,
50
- revenue_account: null,
51
- tax_rule: null,
52
- price_tier: null,
53
- carrier: null,
54
- sales_representative: null,
55
- location: null,
56
- discount: null,
57
- comments: null,
58
- tax_number: null,
59
- credit_limit: null,
60
- tags: null,
61
- attribute_set: null,
62
- additional_attribute1: null,
63
- additional_attribute2: null,
64
- additional_attribute3: null,
65
- additional_attribute4: null,
66
- additional_attribute5: null,
67
- additional_attribute6: null,
68
- additional_attribute7: null,
69
- additional_attribute8: null,
70
- additional_attribute9: null,
71
- additional_attribute10: null,
72
- last_modified_on: null,
73
- addresses: null,
74
- contacts: null)
44
+ instance = DearInventoryRuby::Customer.new(id: nil,
45
+ name: nil,
46
+ status: nil,
47
+ currency: nil,
48
+ payment_term: nil,
49
+ account_receivable: nil,
50
+ revenue_account: nil,
51
+ tax_rule: nil,
52
+ price_tier: nil,
53
+ carrier: nil,
54
+ sales_representative: nil,
55
+ location: nil,
56
+ discount: nil,
57
+ comments: nil,
58
+ tax_number: nil,
59
+ credit_limit: nil,
60
+ tags: nil,
61
+ attribute_set: nil,
62
+ additional_attribute1: nil,
63
+ additional_attribute2: nil,
64
+ additional_attribute3: nil,
65
+ additional_attribute4: nil,
66
+ additional_attribute5: nil,
67
+ additional_attribute6: nil,
68
+ additional_attribute7: nil,
69
+ additional_attribute8: nil,
70
+ additional_attribute9: nil,
71
+ additional_attribute10: nil,
72
+ last_modified_on: nil,
73
+ addresses: nil,
74
+ contacts: nil)
75
75
  ```
76
76
 
77
77
 
data/docs/Customers.md CHANGED
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
13
13
  ```ruby
14
14
  require 'DearInventoryRuby'
15
15
 
16
- instance = DearInventoryRuby::Customers.new(total: null,
17
- page: null,
18
- customer_list: null)
16
+ instance = DearInventoryRuby::Customers.new(total: nil,
17
+ page: nil,
18
+ customer_list: nil)
19
19
  ```
20
20
 
21
21
 
@@ -0,0 +1,16 @@
1
+ # DearInventoryRuby::DimensionsUnit
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'DearInventoryRuby'
12
+
13
+ instance = DearInventoryRuby::DimensionsUnit.new()
14
+ ```
15
+
16
+
data/docs/Error.md CHANGED
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
12
12
  ```ruby
13
13
  require 'DearInventoryRuby'
14
14
 
15
- instance = DearInventoryRuby::Error.new(error_code: null,
16
- exception: null)
15
+ instance = DearInventoryRuby::Error.new(error_code: nil,
16
+ exception: nil)
17
17
  ```
18
18
 
19
19
 
data/docs/InventoryApi.md CHANGED
@@ -12,6 +12,7 @@ Method | HTTP request | Description
12
12
  [**delete_payment_term**](InventoryApi.md#delete_payment_term) | **DELETE** /ref/paymentterm | Allows you to delete a payment term
13
13
  [**get_accounts**](InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
14
14
  [**get_customers**](InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
15
+ [**get_me**](InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information
15
16
  [**get_payment_terms**](InventoryApi.md#get_payment_terms) | **GET** /ref/paymentterm | Allows you to retrieve the payment terms
16
17
  [**get_taxes**](InventoryApi.md#get_taxes) | **GET** /ref/tax | Allows you to retrieve the taxes
17
18
  [**update_account**](InventoryApi.md#update_account) | **PUT** /ref/account | Allows you to update an Account
@@ -521,6 +522,59 @@ Name | Type | Description | Notes
521
522
  - **Accept**: application/json
522
523
 
523
524
 
525
+ ## get_me
526
+
527
+ > Me get_me
528
+
529
+ Allows you to retrieve your information
530
+
531
+ ### Example
532
+
533
+ ```ruby
534
+ # load the gem
535
+ require 'dear-inventory-ruby'
536
+ # setup authorization
537
+ DearInventoryRuby.configure do |config|
538
+ # Configure API key authorization: accountID
539
+ config.api_key['api-auth-accountid'] = 'YOUR API KEY'
540
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
541
+ #config.api_key_prefix['api-auth-accountid'] = 'Bearer'
542
+
543
+ # Configure API key authorization: appKey
544
+ config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
545
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
546
+ #config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
547
+ end
548
+
549
+ api_instance = DearInventoryRuby::InventoryApi.new
550
+
551
+ begin
552
+ #Allows you to retrieve your information
553
+ result = api_instance.get_me
554
+ p result
555
+ rescue DearInventoryRuby::ApiError => e
556
+ puts "Exception when calling InventoryApi->get_me: #{e}"
557
+ end
558
+ ```
559
+
560
+ ### Parameters
561
+
562
+ This endpoint does not need any parameter.
563
+
564
+ ### Return type
565
+
566
+ [**Me**](Me.md)
567
+
568
+ ### Authorization
569
+
570
+ [accountID](../README.md#accountID), [appKey](../README.md#appKey)
571
+
572
+ ### HTTP request headers
573
+
574
+ - **Content-Type**: Not defined
575
+ - **Accept**: application/json
576
+
577
+
524
578
  ## get_payment_terms
525
579
 
526
580
  > PaymentTerms get_payment_terms(opts)
data/docs/Me.md ADDED
@@ -0,0 +1,29 @@
1
+ # DearInventoryRuby::Me
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **company** | **String** | Your company name | [optional]
8
+ **currency** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
9
+ **time_zone** | **String** | Time Zone where your company located | [optional]
10
+ **default_weight_units** | [**WeightUnit**](WeightUnit.md) | | [optional]
11
+ **default_dimensions_units** | [**DimensionsUnit**](DimensionsUnit.md) | | [optional]
12
+ **lock_date** | **Date** | Financial settings option. Indicates date period start from what you can change transactional data. Formatted in Tenant date format | [optional]
13
+ **opening_balance_date** | **Date** | Date of opening balances in the system. Formatted in Tenant date format | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'DearInventoryRuby'
19
+
20
+ instance = DearInventoryRuby::Me.new(company: nil,
21
+ currency: nil,
22
+ time_zone: nil,
23
+ default_weight_units: nil,
24
+ default_dimensions_units: nil,
25
+ lock_date: nil,
26
+ opening_balance_date: nil)
27
+ ```
28
+
29
+
data/docs/PaymentTerm.md CHANGED
@@ -16,12 +16,12 @@ Name | Type | Description | Notes
16
16
  ```ruby
17
17
  require 'DearInventoryRuby'
18
18
 
19
- instance = DearInventoryRuby::PaymentTerm.new(id: null,
20
- name: null,
21
- duration: null,
22
- method: null,
23
- is_active: null,
24
- is_default: null)
19
+ instance = DearInventoryRuby::PaymentTerm.new(id: nil,
20
+ name: nil,
21
+ duration: nil,
22
+ method: nil,
23
+ is_active: nil,
24
+ is_default: nil)
25
25
  ```
26
26
 
27
27
 
data/docs/PaymentTerms.md CHANGED
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
13
13
  ```ruby
14
14
  require 'DearInventoryRuby'
15
15
 
16
- instance = DearInventoryRuby::PaymentTerms.new(total: null,
17
- page: null,
18
- payment_term_list: null)
16
+ instance = DearInventoryRuby::PaymentTerms.new(total: nil,
17
+ page: nil,
18
+ payment_term_list: nil)
19
19
  ```
20
20
 
21
21