dear-inventory-ruby 0.1.17 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -10
  3. data/README.md +32 -5
  4. data/dear-inventory-ruby.gemspec +1 -1
  5. data/docs/Address.md +10 -12
  6. data/docs/Customer.md +1 -1
  7. data/docs/ExternalHeader.md +19 -0
  8. data/docs/InventoryApi.md +1021 -161
  9. data/docs/SaleAdditionalCharge.md +31 -0
  10. data/docs/SaleInvoice.md +1 -1
  11. data/docs/SaleInvoiceAdditionalCharge.md +3 -3
  12. data/docs/SaleInvoiceDelete.md +19 -0
  13. data/docs/SaleInvoiceLine.md +2 -2
  14. data/docs/SaleInvoicePost.md +41 -0
  15. data/docs/SaleOrder.md +35 -0
  16. data/docs/SaleOrderLine.md +41 -0
  17. data/docs/SalePayment.md +43 -0
  18. data/docs/SaleQuote.md +33 -0
  19. data/docs/SaleQuoteLine.md +37 -0
  20. data/docs/ShippingAddress.md +37 -0
  21. data/docs/SupplierCustomerAddress.md +33 -0
  22. data/docs/Webhook.md +35 -0
  23. data/docs/Webhooks.md +17 -0
  24. data/lib/dear-inventory-ruby/api/inventory_api.rb +988 -119
  25. data/lib/dear-inventory-ruby/models/address.rb +28 -115
  26. data/lib/dear-inventory-ruby/models/customer.rb +1 -1
  27. data/lib/dear-inventory-ruby/models/external_header.rb +217 -0
  28. data/lib/dear-inventory-ruby/models/sale_additional_charge.rb +302 -0
  29. data/lib/dear-inventory-ruby/models/sale_invoice.rb +1 -1
  30. data/lib/dear-inventory-ruby/models/sale_invoice_additional_charge.rb +3 -3
  31. data/lib/dear-inventory-ruby/models/sale_invoice_delete.rb +224 -0
  32. data/lib/dear-inventory-ruby/models/sale_invoice_line.rb +0 -10
  33. data/lib/dear-inventory-ruby/models/sale_invoice_post.rb +361 -0
  34. data/lib/dear-inventory-ruby/models/sale_order.rb +336 -0
  35. data/lib/dear-inventory-ruby/models/sale_order_line.rb +342 -0
  36. data/lib/dear-inventory-ruby/models/sale_payment.rb +337 -0
  37. data/lib/dear-inventory-ruby/models/sale_quote.rb +326 -0
  38. data/lib/dear-inventory-ruby/models/sale_quote_line.rb +322 -0
  39. data/lib/dear-inventory-ruby/models/shipping_address.rb +317 -0
  40. data/lib/dear-inventory-ruby/models/supplier_customer_address.rb +374 -0
  41. data/lib/dear-inventory-ruby/models/webhook.rb +319 -0
  42. data/lib/dear-inventory-ruby/models/webhooks.rb +209 -0
  43. data/lib/dear-inventory-ruby/version.rb +1 -1
  44. data/lib/dear-inventory-ruby.rb +13 -0
  45. data/spec/api/inventory_api_spec.rb +166 -0
  46. data/spec/models/address_spec.rb +7 -13
  47. data/spec/models/external_header_spec.rb +47 -0
  48. data/spec/models/sale_additional_charge_spec.rb +83 -0
  49. data/spec/models/sale_invoice_delete_spec.rb +47 -0
  50. data/spec/models/sale_invoice_post_spec.rb +113 -0
  51. data/spec/models/sale_order_line_spec.rb +113 -0
  52. data/spec/models/sale_order_spec.rb +95 -0
  53. data/spec/models/sale_payment_spec.rb +119 -0
  54. data/spec/models/sale_quote_line_spec.rb +101 -0
  55. data/spec/models/sale_quote_spec.rb +89 -0
  56. data/spec/models/shipping_address_spec.rb +101 -0
  57. data/spec/models/supplier_customer_address_spec.rb +89 -0
  58. data/spec/models/webhook_spec.rb +95 -0
  59. data/spec/models/webhooks_spec.rb +41 -0
  60. metadata +63 -6
  61. data/spec/.DS_Store +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 006be1c3b63051c309b4b632785951a40094ef9938c03b8bcb517dc5c6fc8d18
4
- data.tar.gz: 744d7099d7ceaa2a41d988d03bf2f92f8d961b9d7e7a7f1ac90b5800a9dd0f68
3
+ metadata.gz: 84d29c0ced39cf41145beea2c57d0123fe657c214e088769aedaacbfc4c90c6d
4
+ data.tar.gz: 3e7d341b031d925d060ce69fc838d6cf8a5294f64c81ed295d2cc30cce435aa7
5
5
  SHA512:
6
- metadata.gz: 391dcc662d1fb7227d86b3f305174ec012f107f2154a6cbbe0e19cc27c5ecbecb947708fab816676dbcbaca4ebc1a2eab7a2d6af95c8fe13662368087a84f840
7
- data.tar.gz: 57377d70ea6345f8822be25d5224c94b57754bb184df24f24d532669ea8f598881732e63afa7d8cb435b66780d4914b25c017a78bf92fe1cdc2b9cc4e566097e
6
+ metadata.gz: c02d415d3ee35627ba3a67ef18b8d06cfcff79124fbec9b3a1a3f37f44974ede71ccc48ec607ffdffd7507172f4040d6df0607417cc5e3b9e9cfdc22d0260ea3
7
+ data.tar.gz: f24496e8da915bf12e253c214966385a092bac88ca44c5a467e537cffac14eae86ecff392d47da3dceb4f6270cae212dee6b11dc0830c7697d93a41696b1d9cd
data/CHANGELOG.md CHANGED
@@ -2,6 +2,30 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file.
4
4
 
5
+ ## [0.2.1] - 2021-10-15
6
+
7
+ - Update param `TaskID` for `DELETE` of the endpoint `/sale/invoice`
8
+
9
+ ## [0.2.0] - 2021-10-13
10
+
11
+ - Add new endpoint GET, POST, PUT, DELETE `/webhooks` and some related models.
12
+ - Add new endpoint GET, POST `/sale/quote` and some related models.
13
+ - Add new endpoint GET, POST `/sale/order` and some related models.
14
+ - Add new endpoint POST, DELETE `/sale/invoice` and some related models.
15
+ - Add new endpoint GET, POST, PUT, DELETE `/sale/payment` and some related models.
16
+
17
+ ## [0.1.19.1] - 2021-07-23
18
+
19
+ - Update gem version.
20
+
21
+ ## [0.1.19] - 2021-07-23
22
+
23
+ - Support `Class` filter for getting `accounts`.
24
+
25
+ ## [0.1.18] - 2021-06-07
26
+
27
+ - Update `faraday` version.
28
+
5
29
  ## [0.1.17] - 2021-05-25
6
30
 
7
31
  - Remove all `ENUM`.
@@ -29,31 +53,31 @@ All notable changes to this project will be documented in this file.
29
53
 
30
54
  ## [0.1.11] - 2020-09-21
31
55
 
32
- - Update limit of Comments in Customer model.
33
- - Remove required conditions of Address Type in Customer Address model.
56
+ - Update limit of `Comments` in `Customer` model.
57
+ - Remove required conditions of `Address Type` in `Customer Address` model.
34
58
 
35
59
  ## [0.1.10] - 2020-09-04
36
60
 
37
- - Add some fields to Contact and Customer models.
61
+ - Add some fields to `Contact` and `Customer` models.
38
62
  - Update OpenAPI Generator version 4.3.1
39
63
 
40
64
  ## [0.1.9] - 2020-04-12
41
65
 
42
- - Add new endpoint and model: Me
66
+ - Add new endpoint and model: `Me`
43
67
  - Update OpenAPI Generator version 4.3.0
44
68
 
45
69
  ## [0.1.8] - 2020-02-16
46
70
 
47
- - Remove the validations of attributes: Type, SystemAccount because Dear API docs is not mapping for the result of API returned
71
+ - Remove the validations of attributes: `Type`, `SystemAccount` because Dear API docs is not mapping for the result of API returned
48
72
 
49
73
  ## [0.1.7] - 2020-02-16
50
74
 
51
- - Fix params of /account GET
75
+ - Fix params of `/account` GET
52
76
 
53
77
  ## [0.1.6] - 2020-02-15
54
78
 
55
- - Add new endpoints and models: Account, PaymentTerm, Success, Tax, TaxComponent
56
- - Update some models: Address, Contact, Customer
79
+ - Add new endpoints and models: `Account`, `PaymentTerm`, `Success`, `Tax`, `TaxComponent`
80
+ - Update some models: `Address`, `Contact`, `Customer`
57
81
 
58
82
  ## [0.1.5] - 2020-02-13
59
83
 
@@ -61,11 +85,11 @@ All notable changes to this project will be documented in this file.
61
85
 
62
86
  ## [0.1.4] - 2020-02-13
63
87
 
64
- - Rename CustomerApi to InventoryApi
88
+ - Rename `CustomerApi` to `InventoryApi`
65
89
 
66
90
  ## [0.1.3] - 2020-02-12
67
91
 
68
- - Add POST, PUT for customer endpoint.
92
+ - Add POST, PUT for `customer` endpoint.
69
93
 
70
94
  ## [0.1.2] - 2020-02-12
71
95
 
data/README.md CHANGED
@@ -7,9 +7,9 @@ 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.17
10
+ - Package version: 0.2.1
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
- For more information, please visit [https://www.nnhan.me](https://www.nnhan.me)
12
+ For more information, please visit [https://www.nhansg.com](https://www.nhansg.com)
13
13
 
14
14
  ## Installation
15
15
 
@@ -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.17.gem
27
+ gem install ./dear-inventory-ruby-0.2.1.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./dear-inventory-ruby-0.1.17.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./dear-inventory-ruby-0.2.1.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.17'
36
+ gem 'dear-inventory-ruby', '~> 0.2.1'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -95,20 +95,34 @@ Class | Method | HTTP request | Description
95
95
  *DearInventoryRuby::InventoryApi* | [**create_account**](docs/InventoryApi.md#create_account) | **POST** /ref/account | Allows you to create an Account
96
96
  *DearInventoryRuby::InventoryApi* | [**create_customer**](docs/InventoryApi.md#create_customer) | **POST** /customer | Allows you to create a customer
97
97
  *DearInventoryRuby::InventoryApi* | [**create_payment_term**](docs/InventoryApi.md#create_payment_term) | **POST** /ref/paymentterm | Allows you to create a payment term
98
+ *DearInventoryRuby::InventoryApi* | [**create_sale_invoice**](docs/InventoryApi.md#create_sale_invoice) | **POST** /sale/invoice | Allows you to create a sale invoice
99
+ *DearInventoryRuby::InventoryApi* | [**create_sale_order**](docs/InventoryApi.md#create_sale_order) | **POST** /sale/order | Allows you to create a Sale Order
100
+ *DearInventoryRuby::InventoryApi* | [**create_sale_payment**](docs/InventoryApi.md#create_sale_payment) | **POST** /sale/payment | Allows you to create a Sale Payment
101
+ *DearInventoryRuby::InventoryApi* | [**create_sale_quote**](docs/InventoryApi.md#create_sale_quote) | **POST** /sale/quote | Allows you to create a Sale Quote
98
102
  *DearInventoryRuby::InventoryApi* | [**create_tax**](docs/InventoryApi.md#create_tax) | **POST** /ref/tax | Allows you to create a tax
103
+ *DearInventoryRuby::InventoryApi* | [**create_webhooks**](docs/InventoryApi.md#create_webhooks) | **POST** /webhooks | Allows you to create a Webhook
99
104
  *DearInventoryRuby::InventoryApi* | [**delete_account**](docs/InventoryApi.md#delete_account) | **DELETE** /ref/account | Allows you to delete an Account
100
105
  *DearInventoryRuby::InventoryApi* | [**delete_payment_term**](docs/InventoryApi.md#delete_payment_term) | **DELETE** /ref/paymentterm | Allows you to delete a payment term
106
+ *DearInventoryRuby::InventoryApi* | [**delete_sale_invoice**](docs/InventoryApi.md#delete_sale_invoice) | **DELETE** /sale/invoice | Allows you to delete a sale invoice
107
+ *DearInventoryRuby::InventoryApi* | [**delete_sale_payment**](docs/InventoryApi.md#delete_sale_payment) | **DELETE** /sale/payment | Allows you to delete a sale payment
108
+ *DearInventoryRuby::InventoryApi* | [**delete_webhook**](docs/InventoryApi.md#delete_webhook) | **DELETE** /webhooks | Allows you to delete a webhook
101
109
  *DearInventoryRuby::InventoryApi* | [**get_accounts**](docs/InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
102
110
  *DearInventoryRuby::InventoryApi* | [**get_customers**](docs/InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
103
111
  *DearInventoryRuby::InventoryApi* | [**get_me**](docs/InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information
104
112
  *DearInventoryRuby::InventoryApi* | [**get_payment_terms**](docs/InventoryApi.md#get_payment_terms) | **GET** /ref/paymentterm | Allows you to retrieve the payment terms
105
113
  *DearInventoryRuby::InventoryApi* | [**get_price_tiers**](docs/InventoryApi.md#get_price_tiers) | **GET** /ref/priceTier | Allows you to retrieve the Price Tiers
106
114
  *DearInventoryRuby::InventoryApi* | [**get_sale_invoices**](docs/InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices
115
+ *DearInventoryRuby::InventoryApi* | [**get_sale_order**](docs/InventoryApi.md#get_sale_order) | **GET** /sale/order | Allows you to retrieve the Sale Order
116
+ *DearInventoryRuby::InventoryApi* | [**get_sale_payment**](docs/InventoryApi.md#get_sale_payment) | **GET** /sale/payment | Allows you to retrieve the Sale Payments
117
+ *DearInventoryRuby::InventoryApi* | [**get_sale_quote**](docs/InventoryApi.md#get_sale_quote) | **GET** /sale/quote | Allows you to retrieve the Sale Quote
107
118
  *DearInventoryRuby::InventoryApi* | [**get_taxes**](docs/InventoryApi.md#get_taxes) | **GET** /ref/tax | Allows you to retrieve the taxes
119
+ *DearInventoryRuby::InventoryApi* | [**get_webhooks**](docs/InventoryApi.md#get_webhooks) | **GET** /webhooks | Allows you to retrieve the Webhooks
108
120
  *DearInventoryRuby::InventoryApi* | [**update_account**](docs/InventoryApi.md#update_account) | **PUT** /ref/account | Allows you to update an Account
109
121
  *DearInventoryRuby::InventoryApi* | [**update_customer**](docs/InventoryApi.md#update_customer) | **PUT** /customer | Allows you to update a customer
110
122
  *DearInventoryRuby::InventoryApi* | [**update_payment_term**](docs/InventoryApi.md#update_payment_term) | **PUT** /ref/paymentterm | Allows you to update a payment term
123
+ *DearInventoryRuby::InventoryApi* | [**update_sale_payment**](docs/InventoryApi.md#update_sale_payment) | **PUT** /sale/payment | Allows you to update a sale payment
111
124
  *DearInventoryRuby::InventoryApi* | [**update_tax**](docs/InventoryApi.md#update_tax) | **PUT** /ref/tax | Allows you to update a tax
125
+ *DearInventoryRuby::InventoryApi* | [**update_webhook**](docs/InventoryApi.md#update_webhook) | **PUT** /webhooks | Allows you to update a webhook
112
126
 
113
127
 
114
128
  ## Documentation for Models
@@ -120,19 +134,32 @@ Class | Method | HTTP request | Description
120
134
  - [DearInventoryRuby::Customer](docs/Customer.md)
121
135
  - [DearInventoryRuby::Customers](docs/Customers.md)
122
136
  - [DearInventoryRuby::Error](docs/Error.md)
137
+ - [DearInventoryRuby::ExternalHeader](docs/ExternalHeader.md)
123
138
  - [DearInventoryRuby::Me](docs/Me.md)
124
139
  - [DearInventoryRuby::PaymentTerm](docs/PaymentTerm.md)
125
140
  - [DearInventoryRuby::PaymentTerms](docs/PaymentTerms.md)
126
141
  - [DearInventoryRuby::PriceTier](docs/PriceTier.md)
127
142
  - [DearInventoryRuby::PriceTiers](docs/PriceTiers.md)
143
+ - [DearInventoryRuby::SaleAdditionalCharge](docs/SaleAdditionalCharge.md)
128
144
  - [DearInventoryRuby::SaleInvoice](docs/SaleInvoice.md)
129
145
  - [DearInventoryRuby::SaleInvoiceAdditionalCharge](docs/SaleInvoiceAdditionalCharge.md)
146
+ - [DearInventoryRuby::SaleInvoiceDelete](docs/SaleInvoiceDelete.md)
130
147
  - [DearInventoryRuby::SaleInvoiceLine](docs/SaleInvoiceLine.md)
148
+ - [DearInventoryRuby::SaleInvoicePost](docs/SaleInvoicePost.md)
131
149
  - [DearInventoryRuby::SaleInvoices](docs/SaleInvoices.md)
150
+ - [DearInventoryRuby::SaleOrder](docs/SaleOrder.md)
151
+ - [DearInventoryRuby::SaleOrderLine](docs/SaleOrderLine.md)
152
+ - [DearInventoryRuby::SalePayment](docs/SalePayment.md)
153
+ - [DearInventoryRuby::SaleQuote](docs/SaleQuote.md)
154
+ - [DearInventoryRuby::SaleQuoteLine](docs/SaleQuoteLine.md)
155
+ - [DearInventoryRuby::ShippingAddress](docs/ShippingAddress.md)
132
156
  - [DearInventoryRuby::Success](docs/Success.md)
157
+ - [DearInventoryRuby::SupplierCustomerAddress](docs/SupplierCustomerAddress.md)
133
158
  - [DearInventoryRuby::Tax](docs/Tax.md)
134
159
  - [DearInventoryRuby::TaxComponent](docs/TaxComponent.md)
135
160
  - [DearInventoryRuby::Taxes](docs/Taxes.md)
161
+ - [DearInventoryRuby::Webhook](docs/Webhook.md)
162
+ - [DearInventoryRuby::Webhooks](docs/Webhooks.md)
136
163
 
137
164
 
138
165
  ## Documentation for Authorization
data/dear-inventory-ruby.gemspec CHANGED
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
33
33
 
34
34
  s.required_ruby_version = ">= 1.9"
35
35
 
36
- s.add_runtime_dependency 'faraday', '>= 0.14.0'
36
+ s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
37
37
  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
38
38
 
39
39
  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
data/docs/Address.md CHANGED
@@ -4,30 +4,28 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **String** | If passed in PUT method, entry will be searched by id, found entry will be updated, otherwise created | [optional]
8
- **line1** | **String** | Address Line 1 | [optional]
7
+ **display_address_line1** | **String** | Address Line 1 as displayed on Sale form. = Line1 + Line2 | [optional]
8
+ **display_address_line2** | **String** | Address Line 2 as displayed on Sale form. = City + State/Region + Zip/Postcode + Country | [optional]
9
+ **line1** | **String** | Address Line 1 |
9
10
  **line2** | **String** | Address Line 2 | [optional]
10
- **city** | **String** | City / Suburb | [optional]
11
- **state** | **String** | State / Province | [optional]
12
- **post_code** | **String** | Zip / PostCode | [optional]
13
- **country** | **String** | Country name |
14
- **type** | **String** | Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`. |
15
- **default_for_type** | **Boolean** | Points that Address is used as default for chosen Type. `false` as default. | [optional] [default to false]
11
+ **city** | **String** | City | [optional]
12
+ **state** | **String** | State | [optional]
13
+ **post_code** | **String** | PostCode | [optional]
14
+ **country** | **String** | Country |
16
15
 
17
16
  ## Code Sample
18
17
 
19
18
  ```ruby
20
19
  require 'DearInventoryRuby'
21
20
 
22
- instance = DearInventoryRuby::Address.new(id: nil,
21
+ instance = DearInventoryRuby::Address.new(display_address_line1: nil,
22
+ display_address_line2: nil,
23
23
  line1: nil,
24
24
  line2: nil,
25
25
  city: nil,
26
26
  state: nil,
27
27
  post_code: nil,
28
- country: nil,
29
- type: nil,
30
- default_for_type: nil)
28
+ country: nil)
31
29
  ```
32
30
 
33
31
 
data/docs/Customer.md CHANGED
@@ -34,7 +34,7 @@ Name | Type | Description | Notes
34
34
  **additional_attribute9** | **String** | Additional attribute 9 value | [optional]
35
35
  **additional_attribute10** | **String** | Additional attribute 10 value | [optional]
36
36
  **last_modified_on** | **String** | Date of last modification | [optional]
37
- **addresses** | [**Array<Address>**](Address.md) | List of addresses | [optional]
37
+ **addresses** | [**Array<SupplierCustomerAddress>**](SupplierCustomerAddress.md) | List of addresses | [optional]
38
38
  **contacts** | [**Array<Contact>**](Contact.md) | List of contacts | [optional]
39
39
 
40
40
  ## Code Sample
data/docs/ExternalHeader.md ADDED
@@ -0,0 +1,19 @@
1
+ # DearInventoryRuby::ExternalHeader
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **key** | **String** | Key | [optional]
8
+ **value** | **String** | Value | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'DearInventoryRuby'
14
+
15
+ instance = DearInventoryRuby::ExternalHeader.new(key: nil,
16
+ value: nil)
17
+ ```
18
+
19
+