dear-inventory-ruby 0.2.13 → 0.2.14
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 +4 -0
- data/README.md +11 -4
- data/docs/Account.md +17 -19
- data/docs/Accounts.md +5 -7
- data/docs/Address.md +10 -12
- data/docs/AttachmentLine.md +7 -9
- data/docs/AttributeSet.md +79 -0
- data/docs/AttributeSetAttribute.md +19 -0
- data/docs/AttributeSets.md +19 -0
- data/docs/Bin.md +4 -6
- data/docs/Carrier.md +4 -6
- data/docs/Carriers.md +5 -7
- data/docs/Contact.md +13 -15
- data/docs/Customer.md +34 -36
- data/docs/Customers.md +5 -7
- data/docs/Error.md +4 -6
- data/docs/ExternalHeader.md +4 -6
- data/docs/InventoryApi.md +446 -274
- data/docs/Location.md +20 -22
- data/docs/Locations.md +5 -7
- data/docs/Me.md +9 -11
- data/docs/MeContact.md +11 -13
- data/docs/MeContacts.md +5 -7
- data/docs/PaymentTerm.md +8 -10
- data/docs/PaymentTerms.md +5 -7
- data/docs/PriceTier.md +4 -6
- data/docs/PriceTiers.md +3 -5
- data/docs/Sale.md +45 -47
- data/docs/SaleAdditionalCharge.md +10 -12
- data/docs/SaleInvoice.md +19 -21
- data/docs/SaleInvoiceAdditionalCharge.md +11 -13
- data/docs/SaleInvoiceDelete.md +4 -6
- data/docs/SaleInvoiceLine.md +14 -16
- data/docs/SaleInvoicePartial.md +15 -17
- data/docs/SaleInvoicePost.md +15 -17
- data/docs/SaleInvoices.md +4 -6
- data/docs/SaleItem.md +33 -35
- data/docs/SaleList.md +5 -7
- data/docs/SaleOrder.md +12 -14
- data/docs/SaleOrderLine.md +15 -17
- data/docs/SalePayment.md +16 -18
- data/docs/SalePaymentLine.md +9 -11
- data/docs/SaleQuote.md +11 -13
- data/docs/SaleQuoteLine.md +13 -15
- data/docs/ShippingAddress.md +13 -15
- data/docs/Success.md +3 -5
- data/docs/SupplierCustomerAddress.md +11 -13
- data/docs/Tax.md +11 -13
- data/docs/TaxComponent.md +6 -8
- data/docs/Taxes.md +5 -7
- data/docs/Webhook.md +12 -14
- data/docs/Webhooks.md +3 -5
- data/lib/dear-inventory-ruby/api/inventory_api.rb +253 -0
- data/lib/dear-inventory-ruby/models/attribute_set.rb +534 -0
- data/lib/dear-inventory-ruby/models/attribute_set_attribute.rb +237 -0
- data/lib/dear-inventory-ruby/models/attribute_sets.rb +229 -0
- data/lib/dear-inventory-ruby/version.rb +1 -1
- data/lib/dear-inventory-ruby.rb +3 -0
- data/spec/.DS_Store +0 -0
- data/spec/api/inventory_api_spec.rb +49 -0
- data/spec/models/attribute_set_attribute_spec.rb +53 -0
- data/spec/models/attribute_set_spec.rb +233 -0
- data/spec/models/attribute_sets_spec.rb +53 -0
- metadata +53 -41
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f66c26edfcdbb7b191e30a48a5962d4227be9061d78ae9a2099a8d004216ebe2
|
|
4
|
+
data.tar.gz: 63de8ab48273d9dff2072774742ba3d18608dcd3dec3f26fecc65458dbc70695
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 279a28114cc78dcec1478848e8eca5165b56ec511214ffa5549ead67f14f939575791d4a43ba7aa4e520e3af3237122dfd824ad3f3b79da00c7a8cc3ec8b0366
|
|
7
|
+
data.tar.gz: 4eeb879f2c6cd20d851c4d57c015bc015d534ff8c370e41800e7a32746c1616d793ef4aad15c3b499378586929250fc24dcc2eabb2ab03919203a7057e1b71db
|
data/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## [0.2.14] - 2026-03-26
|
|
6
|
+
|
|
7
|
+
- Add new endpoint GET, POST, PUT, DELETE `/ref/attributeset` and related models (`AttributeSet`, `AttributeSetAttribute`, `AttributeSets`).
|
|
8
|
+
|
|
5
9
|
## [0.2.13] - 2025-03-15
|
|
6
10
|
|
|
7
11
|
- Update version
|
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.2.
|
|
10
|
+
- Package version: 0.2.14
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [https://www.nhansg.com](https://www.nhansg.com)
|
|
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.2.
|
|
27
|
+
gem install ./dear-inventory-ruby-0.2.14.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./dear-inventory-ruby-0.2.
|
|
30
|
+
(for development, run `gem install --dev ./dear-inventory-ruby-0.2.14.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.2.
|
|
36
|
+
gem 'dear-inventory-ruby', '~> 0.2.14'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -93,6 +93,7 @@ All URIs are relative to *https://inventory.dearsystems.com/ExternalApi/v2*
|
|
|
93
93
|
Class | Method | HTTP request | Description
|
|
94
94
|
------------ | ------------- | ------------- | -------------
|
|
95
95
|
*DearInventoryRuby::InventoryApi* | [**create_account**](docs/InventoryApi.md#create_account) | **POST** /ref/account | Allows you to create an Account
|
|
96
|
+
*DearInventoryRuby::InventoryApi* | [**create_attribute_set**](docs/InventoryApi.md#create_attribute_set) | **POST** /ref/attributeset | Allows you to create an attribute set
|
|
96
97
|
*DearInventoryRuby::InventoryApi* | [**create_customer**](docs/InventoryApi.md#create_customer) | **POST** /customer | Allows you to create a customer
|
|
97
98
|
*DearInventoryRuby::InventoryApi* | [**create_payment_term**](docs/InventoryApi.md#create_payment_term) | **POST** /ref/paymentterm | Allows you to create a payment term
|
|
98
99
|
*DearInventoryRuby::InventoryApi* | [**create_sale_invoice**](docs/InventoryApi.md#create_sale_invoice) | **POST** /sale/invoice | Allows you to create a sale invoice
|
|
@@ -102,11 +103,13 @@ Class | Method | HTTP request | Description
|
|
|
102
103
|
*DearInventoryRuby::InventoryApi* | [**create_tax**](docs/InventoryApi.md#create_tax) | **POST** /ref/tax | Allows you to create a tax
|
|
103
104
|
*DearInventoryRuby::InventoryApi* | [**create_webhook**](docs/InventoryApi.md#create_webhook) | **POST** /webhooks | Allows you to create a Webhook
|
|
104
105
|
*DearInventoryRuby::InventoryApi* | [**delete_account**](docs/InventoryApi.md#delete_account) | **DELETE** /ref/account | Allows you to delete an Account
|
|
106
|
+
*DearInventoryRuby::InventoryApi* | [**delete_attribute_set**](docs/InventoryApi.md#delete_attribute_set) | **DELETE** /ref/attributeset | Allows you to delete an attribute set
|
|
105
107
|
*DearInventoryRuby::InventoryApi* | [**delete_payment_term**](docs/InventoryApi.md#delete_payment_term) | **DELETE** /ref/paymentterm | Allows you to delete a payment term
|
|
106
108
|
*DearInventoryRuby::InventoryApi* | [**delete_sale_invoice**](docs/InventoryApi.md#delete_sale_invoice) | **DELETE** /sale/invoice | Allows you to delete a sale invoice
|
|
107
109
|
*DearInventoryRuby::InventoryApi* | [**delete_sale_payment**](docs/InventoryApi.md#delete_sale_payment) | **DELETE** /sale/payment | Allows you to delete a sale payment
|
|
108
110
|
*DearInventoryRuby::InventoryApi* | [**delete_webhook**](docs/InventoryApi.md#delete_webhook) | **DELETE** /webhooks | Allows you to delete a webhook
|
|
109
111
|
*DearInventoryRuby::InventoryApi* | [**get_accounts**](docs/InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts
|
|
112
|
+
*DearInventoryRuby::InventoryApi* | [**get_attribute_sets**](docs/InventoryApi.md#get_attribute_sets) | **GET** /ref/attributeset | Allows you to retrieve the attribute sets
|
|
110
113
|
*DearInventoryRuby::InventoryApi* | [**get_carriers**](docs/InventoryApi.md#get_carriers) | **GET** /ref/carrier | Allows you to retrieve the carriers
|
|
111
114
|
*DearInventoryRuby::InventoryApi* | [**get_customers**](docs/InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers
|
|
112
115
|
*DearInventoryRuby::InventoryApi* | [**get_locations**](docs/InventoryApi.md#get_locations) | **GET** /ref/location | Allows you to retrieve the locations
|
|
@@ -123,6 +126,7 @@ Class | Method | HTTP request | Description
|
|
|
123
126
|
*DearInventoryRuby::InventoryApi* | [**get_taxes**](docs/InventoryApi.md#get_taxes) | **GET** /ref/tax | Allows you to retrieve the taxes
|
|
124
127
|
*DearInventoryRuby::InventoryApi* | [**get_webhooks**](docs/InventoryApi.md#get_webhooks) | **GET** /webhooks | Allows you to retrieve the Webhooks
|
|
125
128
|
*DearInventoryRuby::InventoryApi* | [**update_account**](docs/InventoryApi.md#update_account) | **PUT** /ref/account | Allows you to update an Account
|
|
129
|
+
*DearInventoryRuby::InventoryApi* | [**update_attribute_set**](docs/InventoryApi.md#update_attribute_set) | **PUT** /ref/attributeset | Allows you to update an attribute set
|
|
126
130
|
*DearInventoryRuby::InventoryApi* | [**update_customer**](docs/InventoryApi.md#update_customer) | **PUT** /customer | Allows you to update a customer
|
|
127
131
|
*DearInventoryRuby::InventoryApi* | [**update_payment_term**](docs/InventoryApi.md#update_payment_term) | **PUT** /ref/paymentterm | Allows you to update a payment term
|
|
128
132
|
*DearInventoryRuby::InventoryApi* | [**update_sale_payment**](docs/InventoryApi.md#update_sale_payment) | **PUT** /sale/payment | Allows you to update a sale payment
|
|
@@ -136,6 +140,9 @@ Class | Method | HTTP request | Description
|
|
|
136
140
|
- [DearInventoryRuby::Accounts](docs/Accounts.md)
|
|
137
141
|
- [DearInventoryRuby::Address](docs/Address.md)
|
|
138
142
|
- [DearInventoryRuby::AttachmentLine](docs/AttachmentLine.md)
|
|
143
|
+
- [DearInventoryRuby::AttributeSet](docs/AttributeSet.md)
|
|
144
|
+
- [DearInventoryRuby::AttributeSetAttribute](docs/AttributeSetAttribute.md)
|
|
145
|
+
- [DearInventoryRuby::AttributeSets](docs/AttributeSets.md)
|
|
139
146
|
- [DearInventoryRuby::AuthorizationType](docs/AuthorizationType.md)
|
|
140
147
|
- [DearInventoryRuby::Bin](docs/Bin.md)
|
|
141
148
|
- [DearInventoryRuby::Carrier](docs/Carrier.md)
|
data/docs/Account.md
CHANGED
|
@@ -2,23 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**code**
|
|
8
|
-
**name**
|
|
9
|
-
**type**
|
|
10
|
-
**status**
|
|
11
|
-
**description**
|
|
12
|
-
|
|
13
|
-
**system_account**
|
|
14
|
-
**system_account_code** | **String** | SystemAccountCode
|
|
15
|
-
**for_payments**
|
|
16
|
-
**display_name**
|
|
17
|
-
**old_code**
|
|
18
|
-
**bank**
|
|
19
|
-
**bank_account_number** | **String** | Bank Account Number. Only for PUT and POST. Required if Account Type is BANK.
|
|
20
|
-
**bank_account_id**
|
|
21
|
-
**currency**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **code** | **String** | Unique code of Account |
|
|
8
|
+
| **name** | **String** | Account Name |
|
|
9
|
+
| **type** | **String** | Type |
|
|
10
|
+
| **status** | **String** | Account status |
|
|
11
|
+
| **description** | **String** | Account description | [optional] |
|
|
12
|
+
| **\_class** | **String** | Should be one of the following values: `ASSET`, `LIABILITY`, `EXPENSE`, `EQUITY`, `REVENUE` | [optional] |
|
|
13
|
+
| **system_account** | **String** | SystemAccount | [optional] |
|
|
14
|
+
| **system_account_code** | **String** | SystemAccountCode | [optional] |
|
|
15
|
+
| **for_payments** | **String** | Account status | [optional] |
|
|
16
|
+
| **display_name** | **String** | Account display name. Read-only. | [optional] |
|
|
17
|
+
| **old_code** | **String** | Read-only. | [optional] |
|
|
18
|
+
| **bank** | **String** | Name of the Bank. Only for PUT and POST. Required if Account Type is BANK. | [optional] |
|
|
19
|
+
| **bank_account_number** | **String** | Bank Account Number. Only for PUT and POST. Required if Account Type is BANK. | [optional] |
|
|
20
|
+
| **bank_account_id** | **String** | Bank Account ID to which the Account is linked. Read-only. | [optional] |
|
|
21
|
+
| **currency** | **String** | Currency. Read-only. | [optional] |
|
|
22
22
|
|
|
23
23
|
## Code Sample
|
|
24
24
|
|
|
@@ -41,5 +41,3 @@ instance = DearInventoryRuby::Account.new(code: nil,
|
|
|
41
41
|
bank_account_id: nil,
|
|
42
42
|
currency: nil)
|
|
43
43
|
```
|
|
44
|
-
|
|
45
|
-
|
data/docs/Accounts.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**total**
|
|
8
|
-
**page**
|
|
9
|
-
**accounts_list** | [**Array<Account>**](Account.md) | Array of Accounts | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------------- | -------------------------------------- | ----------------- | ---------- |
|
|
7
|
+
| **total** | **String** | Total | [optional] |
|
|
8
|
+
| **page** | **String** | Page | [optional] |
|
|
9
|
+
| **accounts_list** | [**Array<Account>**](Account.md) | Array of Accounts | [optional] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -17,5 +17,3 @@ instance = DearInventoryRuby::Accounts.new(total: nil,
|
|
|
17
17
|
page: nil,
|
|
18
18
|
accounts_list: nil)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/Address.md
CHANGED
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**display_address_line1** | **String** | Address Line 1 as displayed on Sale form. = Line1 + Line2
|
|
8
|
-
**display_address_line2** | **String** | Address Line 2 as displayed on Sale form. = City + State/Region + Zip/Postcode + Country | [optional]
|
|
9
|
-
**line1**
|
|
10
|
-
**line2**
|
|
11
|
-
**city**
|
|
12
|
-
**state**
|
|
13
|
-
**post_code**
|
|
14
|
-
**country**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ------------------------- | ---------- | --------------------------------------------------------------------------------------------- | ---------- |
|
|
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 |
|
|
10
|
+
| **line2** | **String** | Address Line 2 | [optional] |
|
|
11
|
+
| **city** | **String** | City | [optional] |
|
|
12
|
+
| **state** | **String** | State | [optional] |
|
|
13
|
+
| **post_code** | **String** | PostCode | [optional] |
|
|
14
|
+
| **country** | **String** | Country |
|
|
15
15
|
|
|
16
16
|
## Code Sample
|
|
17
17
|
|
|
@@ -27,5 +27,3 @@ instance = DearInventoryRuby::Address.new(display_address_line1: nil,
|
|
|
27
27
|
post_code: nil,
|
|
28
28
|
country: nil)
|
|
29
29
|
```
|
|
30
|
-
|
|
31
|
-
|
data/docs/AttachmentLine.md
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**id**
|
|
8
|
-
**content_type** | **String**
|
|
9
|
-
**is_default**
|
|
10
|
-
**file_name**
|
|
11
|
-
**download_url** | **String**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------------- | ----------- | ---------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **id** | **String** | Attached file ID | [optional] |
|
|
8
|
+
| **content_type** | **String** | Attached file content type | [optional] |
|
|
9
|
+
| **is_default** | **Boolean** | Is this attachment will be used as default product image. Is visible only for product Attachment Endpoint. | [optional] |
|
|
10
|
+
| **file_name** | **String** | Attached file name | [optional] |
|
|
11
|
+
| **download_url** | **String** | Url to download attached File | [optional] |
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
@@ -21,5 +21,3 @@ instance = DearInventoryRuby::AttachmentLine.new(id: nil,
|
|
|
21
21
|
file_name: nil,
|
|
22
22
|
download_url: nil)
|
|
23
23
|
```
|
|
24
|
-
|
|
25
|
-
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# DearInventoryRuby::AttributeSet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **id** | **String** | Unique Attribute Set identifier | [optional] |
|
|
8
|
+
| **name** | **String** | Name of Attribute Set |
|
|
9
|
+
| **attribute1_name** | **String** | Name of first attribute | [optional] |
|
|
10
|
+
| **attribute1_type** | **String** | Type of first attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
11
|
+
| **attribute1_values** | **String** | Comma-separated list of values for first attribute (applicable when Type is List) | [optional] |
|
|
12
|
+
| **attribute2_name** | **String** | Name of second attribute | [optional] |
|
|
13
|
+
| **attribute2_type** | **String** | Type of second attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
14
|
+
| **attribute2_values** | **String** | Comma-separated list of values for second attribute (applicable when Type is List) | [optional] |
|
|
15
|
+
| **attribute3_name** | **String** | Name of third attribute | [optional] |
|
|
16
|
+
| **attribute3_type** | **String** | Type of third attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
17
|
+
| **attribute3_values** | **String** | Comma-separated list of values for third attribute (applicable when Type is List) | [optional] |
|
|
18
|
+
| **attribute4_name** | **String** | Name of fourth attribute | [optional] |
|
|
19
|
+
| **attribute4_type** | **String** | Type of fourth attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
20
|
+
| **attribute4_values** | **String** | Comma-separated list of values for fourth attribute (applicable when Type is List) | [optional] |
|
|
21
|
+
| **attribute5_name** | **String** | Name of fifth attribute | [optional] |
|
|
22
|
+
| **attribute5_type** | **String** | Type of fifth attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
23
|
+
| **attribute5_values** | **String** | Comma-separated list of values for fifth attribute (applicable when Type is List) | [optional] |
|
|
24
|
+
| **attribute6_name** | **String** | Name of sixth attribute | [optional] |
|
|
25
|
+
| **attribute6_type** | **String** | Type of sixth attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
26
|
+
| **attribute6_values** | **String** | Comma-separated list of values for sixth attribute (applicable when Type is List) | [optional] |
|
|
27
|
+
| **attribute7_name** | **String** | Name of seventh attribute | [optional] |
|
|
28
|
+
| **attribute7_type** | **String** | Type of seventh attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
29
|
+
| **attribute7_values** | **String** | Comma-separated list of values for seventh attribute (applicable when Type is List) | [optional] |
|
|
30
|
+
| **attribute8_name** | **String** | Name of eighth attribute | [optional] |
|
|
31
|
+
| **attribute8_type** | **String** | Type of eighth attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
32
|
+
| **attribute8_values** | **String** | Comma-separated list of values for eighth attribute (applicable when Type is List) | [optional] |
|
|
33
|
+
| **attribute9_name** | **String** | Name of ninth attribute | [optional] |
|
|
34
|
+
| **attribute9_type** | **String** | Type of ninth attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
35
|
+
| **attribute9_values** | **String** | Comma-separated list of values for ninth attribute (applicable when Type is List) | [optional] |
|
|
36
|
+
| **attribute10_name** | **String** | Name of tenth attribute | [optional] |
|
|
37
|
+
| **attribute10_type** | **String** | Type of tenth attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` | [optional] |
|
|
38
|
+
| **attribute10_values** | **String** | Comma-separated list of values for tenth attribute (applicable when Type is List) | [optional] |
|
|
39
|
+
| **attributes** | [**Array<AttributeSetAttribute>**](AttributeSetAttribute.md) | Array of Attribute Set Attributes | [optional] |
|
|
40
|
+
|
|
41
|
+
## Code Sample
|
|
42
|
+
|
|
43
|
+
```ruby
|
|
44
|
+
require 'DearInventoryRuby'
|
|
45
|
+
|
|
46
|
+
instance = DearInventoryRuby::AttributeSet.new(id: nil,
|
|
47
|
+
name: nil,
|
|
48
|
+
attribute1_name: nil,
|
|
49
|
+
attribute1_type: nil,
|
|
50
|
+
attribute1_values: nil,
|
|
51
|
+
attribute2_name: nil,
|
|
52
|
+
attribute2_type: nil,
|
|
53
|
+
attribute2_values: nil,
|
|
54
|
+
attribute3_name: nil,
|
|
55
|
+
attribute3_type: nil,
|
|
56
|
+
attribute3_values: nil,
|
|
57
|
+
attribute4_name: nil,
|
|
58
|
+
attribute4_type: nil,
|
|
59
|
+
attribute4_values: nil,
|
|
60
|
+
attribute5_name: nil,
|
|
61
|
+
attribute5_type: nil,
|
|
62
|
+
attribute5_values: nil,
|
|
63
|
+
attribute6_name: nil,
|
|
64
|
+
attribute6_type: nil,
|
|
65
|
+
attribute6_values: nil,
|
|
66
|
+
attribute7_name: nil,
|
|
67
|
+
attribute7_type: nil,
|
|
68
|
+
attribute7_values: nil,
|
|
69
|
+
attribute8_name: nil,
|
|
70
|
+
attribute8_type: nil,
|
|
71
|
+
attribute8_values: nil,
|
|
72
|
+
attribute9_name: nil,
|
|
73
|
+
attribute9_type: nil,
|
|
74
|
+
attribute9_values: nil,
|
|
75
|
+
attribute10_name: nil,
|
|
76
|
+
attribute10_type: nil,
|
|
77
|
+
attribute10_values: nil,
|
|
78
|
+
attributes: nil)
|
|
79
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# DearInventoryRuby::AttributeSetAttribute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **name** | **String** | Name of the attribute |
|
|
8
|
+
| **type** | **String** | Type of the attribute. Should be one of the following values: `Text`, `List`, `Checkbox`, `Not used`, `Date`, `Numeric` |
|
|
9
|
+
| **values** | **String** | Comma-separated list of values (applicable when Type is List) | [optional] |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'DearInventoryRuby'
|
|
15
|
+
|
|
16
|
+
instance = DearInventoryRuby::AttributeSetAttribute.new(name: nil,
|
|
17
|
+
type: nil,
|
|
18
|
+
values: nil)
|
|
19
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# DearInventoryRuby::AttributeSets
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------------------- | ------------------------------------------------ | ----------------------- | ---------- |
|
|
7
|
+
| **total** | **Float** | Total | [optional] |
|
|
8
|
+
| **page** | **Float** | Page | [optional] |
|
|
9
|
+
| **attribute_set_list** | [**Array<AttributeSet>**](AttributeSet.md) | Array of Attribute Sets | [optional] |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'DearInventoryRuby'
|
|
15
|
+
|
|
16
|
+
instance = DearInventoryRuby::AttributeSets.new(total: nil,
|
|
17
|
+
page: nil,
|
|
18
|
+
attribute_set_list: nil)
|
|
19
|
+
```
|
data/docs/Bin.md
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**id**
|
|
8
|
-
**name** | **String** | Name of `Bin` | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------- | ---------- | ----------------------- | ---------- |
|
|
7
|
+
| **id** | **String** | Unique ID | [optional] |
|
|
8
|
+
| **name** | **String** | Name of `Bin` | [optional] |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -15,5 +15,3 @@ require 'DearInventoryRuby'
|
|
|
15
15
|
instance = DearInventoryRuby::Bin.new(id: nil,
|
|
16
16
|
name: nil)
|
|
17
17
|
```
|
|
18
|
-
|
|
19
|
-
|
data/docs/Carrier.md
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**carrier_id**
|
|
8
|
-
**description** | **String** | Name of `Carrier`
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------- | ---------- | ----------------------------- | ---------- |
|
|
7
|
+
| **carrier_id** | **String** | Unique `Carrier` ID | [optional] |
|
|
8
|
+
| **description** | **String** | Name of `Carrier` | [optional] |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -15,5 +15,3 @@ require 'DearInventoryRuby'
|
|
|
15
15
|
instance = DearInventoryRuby::Carrier.new(carrier_id: nil,
|
|
16
16
|
description: nil)
|
|
17
17
|
```
|
|
18
|
-
|
|
19
|
-
|
data/docs/Carriers.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**total**
|
|
8
|
-
**page**
|
|
9
|
-
**carrier_list** | [**Array<Carrier>**](Carrier.md) | Array of Carriers | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------------- | -------------------------------------- | ----------------- | ---------- |
|
|
7
|
+
| **total** | **Float** | Total | [optional] |
|
|
8
|
+
| **page** | **Float** | Page | [optional] |
|
|
9
|
+
| **carrier_list** | [**Array<Carrier>**](Carrier.md) | Array of Carriers | [optional] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -17,5 +17,3 @@ instance = DearInventoryRuby::Carriers.new(total: nil,
|
|
|
17
17
|
page: nil,
|
|
18
18
|
carrier_list: nil)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/Contact.md
CHANGED
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**id**
|
|
8
|
-
**name**
|
|
9
|
-
**job_title**
|
|
10
|
-
**phone**
|
|
11
|
-
**mobile_phone**
|
|
12
|
-
**fax**
|
|
13
|
-
**email**
|
|
14
|
-
**website**
|
|
15
|
-
**comment**
|
|
16
|
-
**default**
|
|
17
|
-
**include_in_email** | **Boolean** | Points that Contact is included in Email. `false` as default.
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------------- | ----------- | ----------------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
7
|
+
| **id** | **String** | If passed in PUT method, entry will be searched by id, found entry will be updated, otherwise created | [optional] |
|
|
8
|
+
| **name** | **String** | Name of Contact |
|
|
9
|
+
| **job_title** | **String** | Job Title | [optional] |
|
|
10
|
+
| **phone** | **String** | Phone | [optional] |
|
|
11
|
+
| **mobile_phone** | **String** | Mobile Phone | [optional] |
|
|
12
|
+
| **fax** | **String** | Fax | [optional] |
|
|
13
|
+
| **email** | **String** | Email | [optional] |
|
|
14
|
+
| **website** | **String** | Website | [optional] |
|
|
15
|
+
| **comment** | **String** | Comment | [optional] |
|
|
16
|
+
| **default** | **Boolean** | Points that Contact is used as default. `false` as default. | [optional] [default to false] |
|
|
17
|
+
| **include_in_email** | **Boolean** | Points that Contact is included in Email. `false` as default. | [optional] [default to false] |
|
|
18
18
|
|
|
19
19
|
## Code Sample
|
|
20
20
|
|
|
@@ -33,5 +33,3 @@ instance = DearInventoryRuby::Contact.new(id: nil,
|
|
|
33
33
|
default: nil,
|
|
34
34
|
include_in_email: nil)
|
|
35
35
|
```
|
|
36
|
-
|
|
37
|
-
|
data/docs/Customer.md
CHANGED
|
@@ -2,40 +2,40 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**id**
|
|
8
|
-
**name**
|
|
9
|
-
**status**
|
|
10
|
-
**currency**
|
|
11
|
-
**payment_term**
|
|
12
|
-
**account_receivable**
|
|
13
|
-
**revenue_account**
|
|
14
|
-
**tax_rule**
|
|
15
|
-
**price_tier**
|
|
16
|
-
**carrier**
|
|
17
|
-
**sales_representative**
|
|
18
|
-
**location**
|
|
19
|
-
**discount**
|
|
20
|
-
**comments**
|
|
21
|
-
**tax_number**
|
|
22
|
-
**credit_limit**
|
|
23
|
-
**is_on_credit_hold**
|
|
24
|
-
**tags**
|
|
25
|
-
**attribute_set**
|
|
26
|
-
**additional_attribute1**
|
|
27
|
-
**additional_attribute2**
|
|
28
|
-
**additional_attribute3**
|
|
29
|
-
**additional_attribute4**
|
|
30
|
-
**additional_attribute5**
|
|
31
|
-
**additional_attribute6**
|
|
32
|
-
**additional_attribute7**
|
|
33
|
-
**additional_attribute8**
|
|
34
|
-
**additional_attribute9**
|
|
35
|
-
**additional_attribute10** | **String**
|
|
36
|
-
**last_modified_on**
|
|
37
|
-
**addresses**
|
|
38
|
-
**contacts**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
7
|
+
| **id** | **String** | Unique Customer ID | [optional] |
|
|
8
|
+
| **name** | **String** | Name of Customer |
|
|
9
|
+
| **status** | **String** | Points that Customer is Active. Available values are Active and Deprecated. Required for POST |
|
|
10
|
+
| **currency** | **String** | Currency code of Customer |
|
|
11
|
+
| **payment_term** | **String** | Payment term |
|
|
12
|
+
| **account_receivable** | **String** | Account receivable code of Customer |
|
|
13
|
+
| **revenue_account** | **String** | Sale account code of Customer |
|
|
14
|
+
| **tax_rule** | **String** | Tax rule name |
|
|
15
|
+
| **price_tier** | **String** | Price tier | [optional] |
|
|
16
|
+
| **carrier** | **String** | Carrier name | [optional] |
|
|
17
|
+
| **sales_representative** | **String** | Sales representative | [optional] |
|
|
18
|
+
| **location** | **String** | Location | [optional] |
|
|
19
|
+
| **discount** | **Float** | Discount must be between 0% and 100% | [optional] |
|
|
20
|
+
| **comments** | **String** | Comments | [optional] |
|
|
21
|
+
| **tax_number** | **String** | Tax number | [optional] |
|
|
22
|
+
| **credit_limit** | **Float** | Credit limit | [optional] |
|
|
23
|
+
| **is_on_credit_hold** | **Boolean** | boolean to indicate if a customer is on credit hold | [optional] [default to false] |
|
|
24
|
+
| **tags** | **String** | Tags string | [optional] |
|
|
25
|
+
| **attribute_set** | **String** | AttributeSet name | [optional] |
|
|
26
|
+
| **additional_attribute1** | **String** | Additional attribute 1 value | [optional] |
|
|
27
|
+
| **additional_attribute2** | **String** | Additional attribute 2 value | [optional] |
|
|
28
|
+
| **additional_attribute3** | **String** | Additional attribute 3 value | [optional] |
|
|
29
|
+
| **additional_attribute4** | **String** | Additional attribute 4 value | [optional] |
|
|
30
|
+
| **additional_attribute5** | **String** | Additional attribute 5 value | [optional] |
|
|
31
|
+
| **additional_attribute6** | **String** | Additional attribute 6 value | [optional] |
|
|
32
|
+
| **additional_attribute7** | **String** | Additional attribute 7 value | [optional] |
|
|
33
|
+
| **additional_attribute8** | **String** | Additional attribute 8 value | [optional] |
|
|
34
|
+
| **additional_attribute9** | **String** | Additional attribute 9 value | [optional] |
|
|
35
|
+
| **additional_attribute10** | **String** | Additional attribute 10 value | [optional] |
|
|
36
|
+
| **last_modified_on** | **String** | Date of last modification | [optional] |
|
|
37
|
+
| **addresses** | [**Array<SupplierCustomerAddress>**](SupplierCustomerAddress.md) | List of addresses | [optional] |
|
|
38
|
+
| **contacts** | [**Array<Contact>**](Contact.md) | List of contacts | [optional] |
|
|
39
39
|
|
|
40
40
|
## Code Sample
|
|
41
41
|
|
|
@@ -75,5 +75,3 @@ instance = DearInventoryRuby::Customer.new(id: nil,
|
|
|
75
75
|
addresses: nil,
|
|
76
76
|
contacts: nil)
|
|
77
77
|
```
|
|
78
|
-
|
|
79
|
-
|
data/docs/Customers.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**total**
|
|
8
|
-
**page**
|
|
9
|
-
**customer_list** | [**Array<Customer>**](Customer.md) | Array of Customers | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------------- | ---------------------------------------- | ------------------ | ---------- |
|
|
7
|
+
| **total** | **String** | Total | [optional] |
|
|
8
|
+
| **page** | **String** | Page | [optional] |
|
|
9
|
+
| **customer_list** | [**Array<Customer>**](Customer.md) | Array of Customers | [optional] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -17,5 +17,3 @@ instance = DearInventoryRuby::Customers.new(total: nil,
|
|
|
17
17
|
page: nil,
|
|
18
18
|
customer_list: nil)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|