dear-inventory-ruby 0.1.19.1 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +21 -0
- data/README.md +34 -5
- data/docs/Address.md +10 -12
- data/docs/AuthorizationType.md +16 -0
- data/docs/Customer.md +1 -1
- data/docs/ExternalHeader.md +19 -0
- data/docs/InventoryApi.md +1021 -163
- data/docs/SaleAdditionalCharge.md +31 -0
- data/docs/SaleInvoice.md +1 -1
- data/docs/SaleInvoiceAdditionalCharge.md +3 -3
- data/docs/SaleInvoiceDelete.md +19 -0
- data/docs/SaleInvoiceLine.md +2 -2
- data/docs/SaleInvoicePost.md +41 -0
- data/docs/SaleOrder.md +35 -0
- data/docs/SaleOrderLine.md +41 -0
- data/docs/SalePayment.md +43 -0
- data/docs/SaleQuote.md +33 -0
- data/docs/SaleQuoteLine.md +37 -0
- data/docs/ShippingAddress.md +37 -0
- data/docs/SupplierCustomerAddress.md +33 -0
- data/docs/Webhook.md +35 -0
- data/docs/WebhookType.md +16 -0
- data/docs/Webhooks.md +17 -0
- data/lib/dear-inventory-ruby/api/inventory_api.rb +985 -119
- data/lib/dear-inventory-ruby/models/address.rb +28 -115
- data/lib/dear-inventory-ruby/models/authorization_type.rb +37 -0
- data/lib/dear-inventory-ruby/models/customer.rb +1 -1
- data/lib/dear-inventory-ruby/models/external_header.rb +217 -0
- data/lib/dear-inventory-ruby/models/sale_additional_charge.rb +302 -0
- data/lib/dear-inventory-ruby/models/sale_invoice.rb +1 -1
- data/lib/dear-inventory-ruby/models/sale_invoice_additional_charge.rb +3 -3
- data/lib/dear-inventory-ruby/models/sale_invoice_delete.rb +224 -0
- data/lib/dear-inventory-ruby/models/sale_invoice_line.rb +0 -10
- data/lib/dear-inventory-ruby/models/sale_invoice_post.rb +361 -0
- data/lib/dear-inventory-ruby/models/sale_order.rb +336 -0
- data/lib/dear-inventory-ruby/models/sale_order_line.rb +342 -0
- data/lib/dear-inventory-ruby/models/sale_payment.rb +337 -0
- data/lib/dear-inventory-ruby/models/sale_quote.rb +326 -0
- data/lib/dear-inventory-ruby/models/sale_quote_line.rb +322 -0
- data/lib/dear-inventory-ruby/models/shipping_address.rb +317 -0
- data/lib/dear-inventory-ruby/models/supplier_customer_address.rb +374 -0
- data/lib/dear-inventory-ruby/models/webhook.rb +319 -0
- data/lib/dear-inventory-ruby/models/webhook_type.rb +54 -0
- data/lib/dear-inventory-ruby/models/webhooks.rb +209 -0
- data/lib/dear-inventory-ruby/version.rb +1 -1
- data/lib/dear-inventory-ruby.rb +15 -0
- data/spec/api/inventory_api_spec.rb +165 -0
- data/spec/models/address_spec.rb +7 -13
- data/spec/models/authorization_type_spec.rb +35 -0
- data/spec/models/external_header_spec.rb +47 -0
- data/spec/models/sale_additional_charge_spec.rb +83 -0
- data/spec/models/sale_invoice_delete_spec.rb +47 -0
- data/spec/models/sale_invoice_post_spec.rb +113 -0
- data/spec/models/sale_order_line_spec.rb +113 -0
- data/spec/models/sale_order_spec.rb +95 -0
- data/spec/models/sale_payment_spec.rb +119 -0
- data/spec/models/sale_quote_line_spec.rb +101 -0
- data/spec/models/sale_quote_spec.rb +89 -0
- data/spec/models/shipping_address_spec.rb +101 -0
- data/spec/models/supplier_customer_address_spec.rb +89 -0
- data/spec/models/webhook_spec.rb +95 -0
- data/spec/models/webhook_type_spec.rb +35 -0
- data/spec/models/webhooks_spec.rb +41 -0
- metadata +63 -6
- data/lib/.DS_Store +0 -0
- data/lib/dear-inventory-ruby/.DS_Store +0 -0
- data/spec/.DS_Store +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6548443c3a747000b4d565792f143837bb32cc147974ed0ac2e96bb29fe86f40
|
4
|
+
data.tar.gz: a74524ffba3f733f9a84b18e7bc20e8117bcb436e19ad5ac7e3c8a72faf8d6e3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b1b01d683d52ad6fc9005104f3c11d7fcdd323b7da96b94cb3e0a2e541ade53428a723c1101f44bc03bc3d12bd03710aadd21d9d42e2b901914be56d29fba371
|
7
|
+
data.tar.gz: 1f4f254e6262b20ba9375b97e6b6ec78a84b47cd6ee875b6f0df4292089ec9c3f841e5f23a6d7fd48435879ac0cb9ebe6ae15f392e32be2d24884ed2e2ba1e5d
|
data/CHANGELOG.md
CHANGED
@@ -2,6 +2,27 @@
|
|
2
2
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
4
4
|
|
5
|
+
## [0.2.3] - 2021-10-15
|
6
|
+
|
7
|
+
- Update `POST` response of the endpoint `/webhooks`
|
8
|
+
- Add some enums `AuthorizationType`, `WebhookType`
|
9
|
+
|
10
|
+
## [0.2.2] - 2021-10-15
|
11
|
+
|
12
|
+
- Update `POST` of the endpoint `/webhooks`
|
13
|
+
|
14
|
+
## [0.2.1] - 2021-10-15
|
15
|
+
|
16
|
+
- Update param `TaskID` for `DELETE` of the endpoint `/sale/invoice`
|
17
|
+
|
18
|
+
## [0.2.0] - 2021-10-13
|
19
|
+
|
20
|
+
- Add new endpoint GET, POST, PUT, DELETE `/webhooks` and some related models.
|
21
|
+
- Add new endpoint GET, POST `/sale/quote` and some related models.
|
22
|
+
- Add new endpoint GET, POST `/sale/order` and some related models.
|
23
|
+
- Add new endpoint POST, DELETE `/sale/invoice` and some related models.
|
24
|
+
- Add new endpoint GET, POST, PUT, DELETE `/sale/payment` and some related models.
|
25
|
+
|
5
26
|
## [0.1.19.1] - 2021-07-23
|
6
27
|
|
7
28
|
- Update gem version.
|
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.
|
10
|
+
- Package version: 0.2.3
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
-
For more information, please visit [https://www.
|
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.
|
27
|
+
gem install ./dear-inventory-ruby-0.2.3.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./dear-inventory-ruby-0.
|
30
|
+
(for development, run `gem install --dev ./dear-inventory-ruby-0.2.3.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.
|
36
|
+
gem 'dear-inventory-ruby', '~> 0.2.3'
|
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_webhook**](docs/InventoryApi.md#create_webhook) | **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
|
@@ -116,23 +130,38 @@ Class | Method | HTTP request | Description
|
|
116
130
|
- [DearInventoryRuby::Account](docs/Account.md)
|
117
131
|
- [DearInventoryRuby::Accounts](docs/Accounts.md)
|
118
132
|
- [DearInventoryRuby::Address](docs/Address.md)
|
133
|
+
- [DearInventoryRuby::AuthorizationType](docs/AuthorizationType.md)
|
119
134
|
- [DearInventoryRuby::Contact](docs/Contact.md)
|
120
135
|
- [DearInventoryRuby::Customer](docs/Customer.md)
|
121
136
|
- [DearInventoryRuby::Customers](docs/Customers.md)
|
122
137
|
- [DearInventoryRuby::Error](docs/Error.md)
|
138
|
+
- [DearInventoryRuby::ExternalHeader](docs/ExternalHeader.md)
|
123
139
|
- [DearInventoryRuby::Me](docs/Me.md)
|
124
140
|
- [DearInventoryRuby::PaymentTerm](docs/PaymentTerm.md)
|
125
141
|
- [DearInventoryRuby::PaymentTerms](docs/PaymentTerms.md)
|
126
142
|
- [DearInventoryRuby::PriceTier](docs/PriceTier.md)
|
127
143
|
- [DearInventoryRuby::PriceTiers](docs/PriceTiers.md)
|
144
|
+
- [DearInventoryRuby::SaleAdditionalCharge](docs/SaleAdditionalCharge.md)
|
128
145
|
- [DearInventoryRuby::SaleInvoice](docs/SaleInvoice.md)
|
129
146
|
- [DearInventoryRuby::SaleInvoiceAdditionalCharge](docs/SaleInvoiceAdditionalCharge.md)
|
147
|
+
- [DearInventoryRuby::SaleInvoiceDelete](docs/SaleInvoiceDelete.md)
|
130
148
|
- [DearInventoryRuby::SaleInvoiceLine](docs/SaleInvoiceLine.md)
|
149
|
+
- [DearInventoryRuby::SaleInvoicePost](docs/SaleInvoicePost.md)
|
131
150
|
- [DearInventoryRuby::SaleInvoices](docs/SaleInvoices.md)
|
151
|
+
- [DearInventoryRuby::SaleOrder](docs/SaleOrder.md)
|
152
|
+
- [DearInventoryRuby::SaleOrderLine](docs/SaleOrderLine.md)
|
153
|
+
- [DearInventoryRuby::SalePayment](docs/SalePayment.md)
|
154
|
+
- [DearInventoryRuby::SaleQuote](docs/SaleQuote.md)
|
155
|
+
- [DearInventoryRuby::SaleQuoteLine](docs/SaleQuoteLine.md)
|
156
|
+
- [DearInventoryRuby::ShippingAddress](docs/ShippingAddress.md)
|
132
157
|
- [DearInventoryRuby::Success](docs/Success.md)
|
158
|
+
- [DearInventoryRuby::SupplierCustomerAddress](docs/SupplierCustomerAddress.md)
|
133
159
|
- [DearInventoryRuby::Tax](docs/Tax.md)
|
134
160
|
- [DearInventoryRuby::TaxComponent](docs/TaxComponent.md)
|
135
161
|
- [DearInventoryRuby::Taxes](docs/Taxes.md)
|
162
|
+
- [DearInventoryRuby::Webhook](docs/Webhook.md)
|
163
|
+
- [DearInventoryRuby::WebhookType](docs/WebhookType.md)
|
164
|
+
- [DearInventoryRuby::Webhooks](docs/Webhooks.md)
|
136
165
|
|
137
166
|
|
138
167
|
## Documentation for Authorization
|
data/docs/Address.md
CHANGED
@@ -4,30 +4,28 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**
|
8
|
-
**
|
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
|
11
|
-
**state** | **String** | State
|
12
|
-
**post_code** | **String** |
|
13
|
-
**country** | **String** | Country
|
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(
|
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
|
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# DearInventoryRuby::AuthorizationType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'DearInventoryRuby'
|
12
|
+
|
13
|
+
instance = DearInventoryRuby::AuthorizationType.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
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<
|
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
|
@@ -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
|
+
|