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
data/docs/InventoryApi.md
CHANGED
|
@@ -2,46 +2,48 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://inventory.dearsystems.com/ExternalApi/v2*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**create_account**](InventoryApi.md#create_account)
|
|
8
|
-
[**
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
11
|
-
[**
|
|
12
|
-
[**
|
|
13
|
-
[**
|
|
14
|
-
[**
|
|
15
|
-
[**
|
|
16
|
-
[**
|
|
17
|
-
[**
|
|
18
|
-
[**
|
|
19
|
-
[**
|
|
20
|
-
[**
|
|
21
|
-
[**
|
|
22
|
-
[**
|
|
23
|
-
[**
|
|
24
|
-
[**
|
|
25
|
-
[**
|
|
26
|
-
[**
|
|
27
|
-
[**
|
|
28
|
-
[**
|
|
29
|
-
[**
|
|
30
|
-
[**
|
|
31
|
-
[**
|
|
32
|
-
[**
|
|
33
|
-
[**
|
|
34
|
-
[**
|
|
35
|
-
[**
|
|
36
|
-
[**
|
|
37
|
-
[**
|
|
38
|
-
[**
|
|
39
|
-
[**
|
|
40
|
-
[**
|
|
41
|
-
[**
|
|
42
|
-
[**
|
|
43
|
-
|
|
44
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ---------------------------------------------------------------- | ---------------------------- | -------------------------------------------------------------- |
|
|
7
|
+
| [**create_account**](InventoryApi.md#create_account) | **POST** /ref/account | Allows you to create an Account |
|
|
8
|
+
| [**create_attribute_set**](InventoryApi.md#create_attribute_set) | **POST** /ref/attributeset | Allows you to create an attribute set |
|
|
9
|
+
| [**create_customer**](InventoryApi.md#create_customer) | **POST** /customer | Allows you to create a customer |
|
|
10
|
+
| [**create_payment_term**](InventoryApi.md#create_payment_term) | **POST** /ref/paymentterm | Allows you to create a payment term |
|
|
11
|
+
| [**create_sale_invoice**](InventoryApi.md#create_sale_invoice) | **POST** /sale/invoice | Allows you to create a sale invoice |
|
|
12
|
+
| [**create_sale_order**](InventoryApi.md#create_sale_order) | **POST** /sale/order | Allows you to create a Sale Order |
|
|
13
|
+
| [**create_sale_payment**](InventoryApi.md#create_sale_payment) | **POST** /sale/payment | Allows you to create a Sale Payment |
|
|
14
|
+
| [**create_sale_quote**](InventoryApi.md#create_sale_quote) | **POST** /sale/quote | Allows you to create a Sale Quote |
|
|
15
|
+
| [**create_tax**](InventoryApi.md#create_tax) | **POST** /ref/tax | Allows you to create a tax |
|
|
16
|
+
| [**create_webhook**](InventoryApi.md#create_webhook) | **POST** /webhooks | Allows you to create a Webhook |
|
|
17
|
+
| [**delete_account**](InventoryApi.md#delete_account) | **DELETE** /ref/account | Allows you to delete an Account |
|
|
18
|
+
| [**delete_attribute_set**](InventoryApi.md#delete_attribute_set) | **DELETE** /ref/attributeset | Allows you to delete an attribute set |
|
|
19
|
+
| [**delete_payment_term**](InventoryApi.md#delete_payment_term) | **DELETE** /ref/paymentterm | Allows you to delete a payment term |
|
|
20
|
+
| [**delete_sale_invoice**](InventoryApi.md#delete_sale_invoice) | **DELETE** /sale/invoice | Allows you to delete a sale invoice |
|
|
21
|
+
| [**delete_sale_payment**](InventoryApi.md#delete_sale_payment) | **DELETE** /sale/payment | Allows you to delete a sale payment |
|
|
22
|
+
| [**delete_webhook**](InventoryApi.md#delete_webhook) | **DELETE** /webhooks | Allows you to delete a webhook |
|
|
23
|
+
| [**get_accounts**](InventoryApi.md#get_accounts) | **GET** /ref/account | Allows you to retrieve the Chart of Accounts |
|
|
24
|
+
| [**get_attribute_sets**](InventoryApi.md#get_attribute_sets) | **GET** /ref/attributeset | Allows you to retrieve the attribute sets |
|
|
25
|
+
| [**get_carriers**](InventoryApi.md#get_carriers) | **GET** /ref/carrier | Allows you to retrieve the carriers |
|
|
26
|
+
| [**get_customers**](InventoryApi.md#get_customers) | **GET** /customer | Allows you to retrieve the customers |
|
|
27
|
+
| [**get_locations**](InventoryApi.md#get_locations) | **GET** /ref/location | Allows you to retrieve the locations |
|
|
28
|
+
| [**get_me**](InventoryApi.md#get_me) | **GET** /me | Allows you to retrieve your information |
|
|
29
|
+
| [**get_me_contacts**](InventoryApi.md#get_me_contacts) | **GET** /me/contacts | Allows you to retrieve the me contacts (Sales Representatives) |
|
|
30
|
+
| [**get_payment_terms**](InventoryApi.md#get_payment_terms) | **GET** /ref/paymentterm | Allows you to retrieve the payment terms |
|
|
31
|
+
| [**get_price_tiers**](InventoryApi.md#get_price_tiers) | **GET** /ref/priceTier | Allows you to retrieve the Price Tiers |
|
|
32
|
+
| [**get_sale**](InventoryApi.md#get_sale) | **GET** /sale | Allows you to retrieve the Sale |
|
|
33
|
+
| [**get_sale_invoices**](InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices |
|
|
34
|
+
| [**get_sale_list**](InventoryApi.md#get_sale_list) | **GET** /saleList | Allows you to retrieve the Sales based on conditions |
|
|
35
|
+
| [**get_sale_order**](InventoryApi.md#get_sale_order) | **GET** /sale/order | Allows you to retrieve the Sale Order |
|
|
36
|
+
| [**get_sale_payment**](InventoryApi.md#get_sale_payment) | **GET** /sale/payment | Allows you to retrieve the Sale Payments |
|
|
37
|
+
| [**get_sale_quote**](InventoryApi.md#get_sale_quote) | **GET** /sale/quote | Allows you to retrieve the Sale Quote |
|
|
38
|
+
| [**get_taxes**](InventoryApi.md#get_taxes) | **GET** /ref/tax | Allows you to retrieve the taxes |
|
|
39
|
+
| [**get_webhooks**](InventoryApi.md#get_webhooks) | **GET** /webhooks | Allows you to retrieve the Webhooks |
|
|
40
|
+
| [**update_account**](InventoryApi.md#update_account) | **PUT** /ref/account | Allows you to update an Account |
|
|
41
|
+
| [**update_attribute_set**](InventoryApi.md#update_attribute_set) | **PUT** /ref/attributeset | Allows you to update an attribute set |
|
|
42
|
+
| [**update_customer**](InventoryApi.md#update_customer) | **PUT** /customer | Allows you to update a customer |
|
|
43
|
+
| [**update_payment_term**](InventoryApi.md#update_payment_term) | **PUT** /ref/paymentterm | Allows you to update a payment term |
|
|
44
|
+
| [**update_sale_payment**](InventoryApi.md#update_sale_payment) | **PUT** /sale/payment | Allows you to update a sale payment |
|
|
45
|
+
| [**update_tax**](InventoryApi.md#update_tax) | **PUT** /ref/tax | Allows you to update a tax |
|
|
46
|
+
| [**update_webhook**](InventoryApi.md#update_webhook) | **PUT** /webhooks | Allows you to update a webhook |
|
|
45
47
|
|
|
46
48
|
## create_account
|
|
47
49
|
|
|
@@ -84,11 +86,10 @@ end
|
|
|
84
86
|
|
|
85
87
|
### Parameters
|
|
86
88
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
**
|
|
91
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
89
|
+
| Name | Type | Description | Notes |
|
|
90
|
+
| -------------------- | ------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
91
|
+
| **account** | [**Account**](Account.md) | an Account object with properties to create |
|
|
92
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
92
93
|
|
|
93
94
|
### Return type
|
|
94
95
|
|
|
@@ -103,6 +104,64 @@ Name | Type | Description | Notes
|
|
|
103
104
|
- **Content-Type**: application/json
|
|
104
105
|
- **Accept**: application/json
|
|
105
106
|
|
|
107
|
+
## create_attribute_set
|
|
108
|
+
|
|
109
|
+
> AttributeSet create_attribute_set(attribute_set, opts)
|
|
110
|
+
|
|
111
|
+
Allows you to create an attribute set
|
|
112
|
+
|
|
113
|
+
### Example
|
|
114
|
+
|
|
115
|
+
```ruby
|
|
116
|
+
# load the gem
|
|
117
|
+
require 'dear-inventory-ruby'
|
|
118
|
+
# setup authorization
|
|
119
|
+
DearInventoryRuby.configure do |config|
|
|
120
|
+
# Configure API key authorization: accountID
|
|
121
|
+
config.api_key['api-auth-accountid'] = 'YOUR API KEY'
|
|
122
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
123
|
+
#config.api_key_prefix['api-auth-accountid'] = 'Bearer'
|
|
124
|
+
|
|
125
|
+
# Configure API key authorization: appKey
|
|
126
|
+
config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
|
|
127
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
128
|
+
#config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
api_instance = DearInventoryRuby::InventoryApi.new
|
|
132
|
+
attribute_set = { "Name": "Test set", "Attribute1Name": "List attribute name", "Attribute1Type": "List", "Attribute1Values": "Red, Black, Blue, Aqua", "Attribute2Name": "Check box attribute name", "Attribute2Type": "Checkbox", "Attribute2Values": "", "Attribute3Name": "Text attribute name", "Attribute3Type": "Text", "Attribute3Values": "" } # AttributeSet | an attribute set object with properties to create
|
|
133
|
+
opts = {
|
|
134
|
+
summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
begin
|
|
138
|
+
#Allows you to create an attribute set
|
|
139
|
+
result = api_instance.create_attribute_set(attribute_set, opts)
|
|
140
|
+
p result
|
|
141
|
+
rescue DearInventoryRuby::ApiError => e
|
|
142
|
+
puts "Exception when calling InventoryApi->create_attribute_set: #{e}"
|
|
143
|
+
end
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Parameters
|
|
147
|
+
|
|
148
|
+
| Name | Type | Description | Notes |
|
|
149
|
+
| -------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
150
|
+
| **attribute_set** | [**AttributeSet**](AttributeSet.md) | an attribute set object with properties to create |
|
|
151
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
152
|
+
|
|
153
|
+
### Return type
|
|
154
|
+
|
|
155
|
+
[**AttributeSet**](AttributeSet.md)
|
|
156
|
+
|
|
157
|
+
### Authorization
|
|
158
|
+
|
|
159
|
+
[accountID](../README.md#accountID), [appKey](../README.md#appKey)
|
|
160
|
+
|
|
161
|
+
### HTTP request headers
|
|
162
|
+
|
|
163
|
+
- **Content-Type**: application/json
|
|
164
|
+
- **Accept**: application/json
|
|
106
165
|
|
|
107
166
|
## create_customer
|
|
108
167
|
|
|
@@ -145,11 +204,10 @@ end
|
|
|
145
204
|
|
|
146
205
|
### Parameters
|
|
147
206
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
**
|
|
152
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
207
|
+
| Name | Type | Description | Notes |
|
|
208
|
+
| -------------------- | --------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
209
|
+
| **customer** | [**Customer**](Customer.md) | a customer object with properties to create |
|
|
210
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
153
211
|
|
|
154
212
|
### Return type
|
|
155
213
|
|
|
@@ -164,7 +222,6 @@ Name | Type | Description | Notes
|
|
|
164
222
|
- **Content-Type**: application/json
|
|
165
223
|
- **Accept**: application/json
|
|
166
224
|
|
|
167
|
-
|
|
168
225
|
## create_payment_term
|
|
169
226
|
|
|
170
227
|
> PaymentTerms create_payment_term(payment_term, opts)
|
|
@@ -206,11 +263,10 @@ end
|
|
|
206
263
|
|
|
207
264
|
### Parameters
|
|
208
265
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
**
|
|
213
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
266
|
+
| Name | Type | Description | Notes |
|
|
267
|
+
| -------------------- | --------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
268
|
+
| **payment_term** | [**PaymentTerm**](PaymentTerm.md) | a payment term object with properties to create |
|
|
269
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
214
270
|
|
|
215
271
|
### Return type
|
|
216
272
|
|
|
@@ -225,7 +281,6 @@ Name | Type | Description | Notes
|
|
|
225
281
|
- **Content-Type**: application/json
|
|
226
282
|
- **Accept**: application/json
|
|
227
283
|
|
|
228
|
-
|
|
229
284
|
## create_sale_invoice
|
|
230
285
|
|
|
231
286
|
> SaleInvoices create_sale_invoice(sale_invoice_post, opts)
|
|
@@ -267,11 +322,10 @@ end
|
|
|
267
322
|
|
|
268
323
|
### Parameters
|
|
269
324
|
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
**
|
|
274
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
325
|
+
| Name | Type | Description | Notes |
|
|
326
|
+
| --------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
327
|
+
| **sale_invoice_post** | [**SaleInvoicePost**](SaleInvoicePost.md) | a Sale Invoice object with properties to create |
|
|
328
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
275
329
|
|
|
276
330
|
### Return type
|
|
277
331
|
|
|
@@ -286,7 +340,6 @@ Name | Type | Description | Notes
|
|
|
286
340
|
- **Content-Type**: application/json
|
|
287
341
|
- **Accept**: application/json
|
|
288
342
|
|
|
289
|
-
|
|
290
343
|
## create_sale_order
|
|
291
344
|
|
|
292
345
|
> SaleOrder create_sale_order(sale_order, opts)
|
|
@@ -328,11 +381,10 @@ end
|
|
|
328
381
|
|
|
329
382
|
### Parameters
|
|
330
383
|
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
**
|
|
335
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
384
|
+
| Name | Type | Description | Notes |
|
|
385
|
+
| -------------------- | ----------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
386
|
+
| **sale_order** | [**SaleOrder**](SaleOrder.md) | a Sale Order object with properties to create |
|
|
387
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
336
388
|
|
|
337
389
|
### Return type
|
|
338
390
|
|
|
@@ -347,7 +399,6 @@ Name | Type | Description | Notes
|
|
|
347
399
|
- **Content-Type**: application/json
|
|
348
400
|
- **Accept**: application/json
|
|
349
401
|
|
|
350
|
-
|
|
351
402
|
## create_sale_payment
|
|
352
403
|
|
|
353
404
|
> SalePayment create_sale_payment(sale_payment, opts)
|
|
@@ -389,11 +440,10 @@ end
|
|
|
389
440
|
|
|
390
441
|
### Parameters
|
|
391
442
|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
**
|
|
396
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
443
|
+
| Name | Type | Description | Notes |
|
|
444
|
+
| -------------------- | --------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
445
|
+
| **sale_payment** | [**SalePayment**](SalePayment.md) | a Sale Payment object with properties to create |
|
|
446
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
397
447
|
|
|
398
448
|
### Return type
|
|
399
449
|
|
|
@@ -408,7 +458,6 @@ Name | Type | Description | Notes
|
|
|
408
458
|
- **Content-Type**: application/json
|
|
409
459
|
- **Accept**: application/json
|
|
410
460
|
|
|
411
|
-
|
|
412
461
|
## create_sale_quote
|
|
413
462
|
|
|
414
463
|
> SaleQuote create_sale_quote(sale_quote, opts)
|
|
@@ -450,11 +499,10 @@ end
|
|
|
450
499
|
|
|
451
500
|
### Parameters
|
|
452
501
|
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
**
|
|
457
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
502
|
+
| Name | Type | Description | Notes |
|
|
503
|
+
| -------------------- | ----------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
504
|
+
| **sale_quote** | [**SaleQuote**](SaleQuote.md) | a Sale Quote object with properties to create |
|
|
505
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
458
506
|
|
|
459
507
|
### Return type
|
|
460
508
|
|
|
@@ -469,7 +517,6 @@ Name | Type | Description | Notes
|
|
|
469
517
|
- **Content-Type**: application/json
|
|
470
518
|
- **Accept**: application/json
|
|
471
519
|
|
|
472
|
-
|
|
473
520
|
## create_tax
|
|
474
521
|
|
|
475
522
|
> Taxes create_tax(tax, opts)
|
|
@@ -511,11 +558,10 @@ end
|
|
|
511
558
|
|
|
512
559
|
### Parameters
|
|
513
560
|
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
**
|
|
518
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
561
|
+
| Name | Type | Description | Notes |
|
|
562
|
+
| -------------------- | ----------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
563
|
+
| **tax** | [**Tax**](Tax.md) | a tax object with properties to create |
|
|
564
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
519
565
|
|
|
520
566
|
### Return type
|
|
521
567
|
|
|
@@ -530,7 +576,6 @@ Name | Type | Description | Notes
|
|
|
530
576
|
- **Content-Type**: application/json
|
|
531
577
|
- **Accept**: application/json
|
|
532
578
|
|
|
533
|
-
|
|
534
579
|
## create_webhook
|
|
535
580
|
|
|
536
581
|
> Webhook create_webhook(webhook, opts)
|
|
@@ -572,11 +617,10 @@ end
|
|
|
572
617
|
|
|
573
618
|
### Parameters
|
|
574
619
|
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
**
|
|
579
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
620
|
+
| Name | Type | Description | Notes |
|
|
621
|
+
| -------------------- | ------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
622
|
+
| **webhook** | [**Webhook**](Webhook.md) | a webhook object with properties to create |
|
|
623
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
580
624
|
|
|
581
625
|
### Return type
|
|
582
626
|
|
|
@@ -591,7 +635,6 @@ Name | Type | Description | Notes
|
|
|
591
635
|
- **Content-Type**: application/json
|
|
592
636
|
- **Accept**: application/json
|
|
593
637
|
|
|
594
|
-
|
|
595
638
|
## delete_account
|
|
596
639
|
|
|
597
640
|
> Success delete_account(opts)
|
|
@@ -632,10 +675,9 @@ end
|
|
|
632
675
|
|
|
633
676
|
### Parameters
|
|
634
677
|
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
**code** | **String**| Default is nil | [optional]
|
|
678
|
+
| Name | Type | Description | Notes |
|
|
679
|
+
| -------- | ---------- | -------------- | ---------- |
|
|
680
|
+
| **code** | **String** | Default is nil | [optional] |
|
|
639
681
|
|
|
640
682
|
### Return type
|
|
641
683
|
|
|
@@ -650,6 +692,62 @@ Name | Type | Description | Notes
|
|
|
650
692
|
- **Content-Type**: Not defined
|
|
651
693
|
- **Accept**: application/json
|
|
652
694
|
|
|
695
|
+
## delete_attribute_set
|
|
696
|
+
|
|
697
|
+
> Success delete_attribute_set(opts)
|
|
698
|
+
|
|
699
|
+
Allows you to delete an attribute set
|
|
700
|
+
|
|
701
|
+
### Example
|
|
702
|
+
|
|
703
|
+
```ruby
|
|
704
|
+
# load the gem
|
|
705
|
+
require 'dear-inventory-ruby'
|
|
706
|
+
# setup authorization
|
|
707
|
+
DearInventoryRuby.configure do |config|
|
|
708
|
+
# Configure API key authorization: accountID
|
|
709
|
+
config.api_key['api-auth-accountid'] = 'YOUR API KEY'
|
|
710
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
711
|
+
#config.api_key_prefix['api-auth-accountid'] = 'Bearer'
|
|
712
|
+
|
|
713
|
+
# Configure API key authorization: appKey
|
|
714
|
+
config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
|
|
715
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
716
|
+
#config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
|
|
717
|
+
end
|
|
718
|
+
|
|
719
|
+
api_instance = DearInventoryRuby::InventoryApi.new
|
|
720
|
+
opts = {
|
|
721
|
+
id: 'id_example' # String | Default is nil
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
begin
|
|
725
|
+
#Allows you to delete an attribute set
|
|
726
|
+
result = api_instance.delete_attribute_set(opts)
|
|
727
|
+
p result
|
|
728
|
+
rescue DearInventoryRuby::ApiError => e
|
|
729
|
+
puts "Exception when calling InventoryApi->delete_attribute_set: #{e}"
|
|
730
|
+
end
|
|
731
|
+
```
|
|
732
|
+
|
|
733
|
+
### Parameters
|
|
734
|
+
|
|
735
|
+
| Name | Type | Description | Notes |
|
|
736
|
+
| ------ | ---------- | -------------- | ---------- |
|
|
737
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
738
|
+
|
|
739
|
+
### Return type
|
|
740
|
+
|
|
741
|
+
[**Success**](Success.md)
|
|
742
|
+
|
|
743
|
+
### Authorization
|
|
744
|
+
|
|
745
|
+
[accountID](../README.md#accountID), [appKey](../README.md#appKey)
|
|
746
|
+
|
|
747
|
+
### HTTP request headers
|
|
748
|
+
|
|
749
|
+
- **Content-Type**: Not defined
|
|
750
|
+
- **Accept**: application/json
|
|
653
751
|
|
|
654
752
|
## delete_payment_term
|
|
655
753
|
|
|
@@ -691,10 +789,9 @@ end
|
|
|
691
789
|
|
|
692
790
|
### Parameters
|
|
693
791
|
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
**id** | **String**| Default is nil | [optional]
|
|
792
|
+
| Name | Type | Description | Notes |
|
|
793
|
+
| ------ | ---------- | -------------- | ---------- |
|
|
794
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
698
795
|
|
|
699
796
|
### Return type
|
|
700
797
|
|
|
@@ -709,7 +806,6 @@ Name | Type | Description | Notes
|
|
|
709
806
|
- **Content-Type**: Not defined
|
|
710
807
|
- **Accept**: application/json
|
|
711
808
|
|
|
712
|
-
|
|
713
809
|
## delete_sale_invoice
|
|
714
810
|
|
|
715
811
|
> SaleInvoices delete_sale_invoice(opts)
|
|
@@ -751,11 +847,10 @@ end
|
|
|
751
847
|
|
|
752
848
|
### Parameters
|
|
753
849
|
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
**
|
|
758
|
-
**void** | **Boolean**| Default is false | [optional] [default to false]
|
|
850
|
+
| Name | Type | Description | Notes |
|
|
851
|
+
| ----------- | ----------- | ------------------------------- | ----------------------------- |
|
|
852
|
+
| **task_id** | **String** | ID of Sale task to Void or Undo | [optional] |
|
|
853
|
+
| **void** | **Boolean** | Default is false | [optional] [default to false] |
|
|
759
854
|
|
|
760
855
|
### Return type
|
|
761
856
|
|
|
@@ -770,7 +865,6 @@ Name | Type | Description | Notes
|
|
|
770
865
|
- **Content-Type**: Not defined
|
|
771
866
|
- **Accept**: application/json
|
|
772
867
|
|
|
773
|
-
|
|
774
868
|
## delete_sale_payment
|
|
775
869
|
|
|
776
870
|
> Success delete_sale_payment(opts)
|
|
@@ -811,10 +905,9 @@ end
|
|
|
811
905
|
|
|
812
906
|
### Parameters
|
|
813
907
|
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
**id** | **String**| Default is nil | [optional]
|
|
908
|
+
| Name | Type | Description | Notes |
|
|
909
|
+
| ------ | ---------- | -------------- | ---------- |
|
|
910
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
818
911
|
|
|
819
912
|
### Return type
|
|
820
913
|
|
|
@@ -829,7 +922,6 @@ Name | Type | Description | Notes
|
|
|
829
922
|
- **Content-Type**: Not defined
|
|
830
923
|
- **Accept**: application/json
|
|
831
924
|
|
|
832
|
-
|
|
833
925
|
## delete_webhook
|
|
834
926
|
|
|
835
927
|
> Webhooks delete_webhook(opts)
|
|
@@ -870,10 +962,9 @@ end
|
|
|
870
962
|
|
|
871
963
|
### Parameters
|
|
872
964
|
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
**id** | **String**| Default is nil | [optional]
|
|
965
|
+
| Name | Type | Description | Notes |
|
|
966
|
+
| ------ | ---------- | -------------- | ---------- |
|
|
967
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
877
968
|
|
|
878
969
|
### Return type
|
|
879
970
|
|
|
@@ -888,7 +979,6 @@ Name | Type | Description | Notes
|
|
|
888
979
|
- **Content-Type**: Not defined
|
|
889
980
|
- **Accept**: application/json
|
|
890
981
|
|
|
891
|
-
|
|
892
982
|
## get_accounts
|
|
893
983
|
|
|
894
984
|
> Accounts get_accounts(opts)
|
|
@@ -935,16 +1025,15 @@ end
|
|
|
935
1025
|
|
|
936
1026
|
### Parameters
|
|
937
1027
|
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
**
|
|
942
|
-
**
|
|
943
|
-
**
|
|
944
|
-
**
|
|
945
|
-
**
|
|
946
|
-
**
|
|
947
|
-
**status** | **String**| Default is nil | [optional]
|
|
1028
|
+
| Name | Type | Description | Notes |
|
|
1029
|
+
| ----------- | ---------- | -------------- | ------------------------------------- |
|
|
1030
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1031
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1032
|
+
| **code** | **String** | Default is nil | [optional] |
|
|
1033
|
+
| **name** | **String** | Default is nil | [optional] |
|
|
1034
|
+
| **\_class** | **String** | Default is nil | [optional] |
|
|
1035
|
+
| **type** | **String** | Default is nil | [optional] |
|
|
1036
|
+
| **status** | **String** | Default is nil | [optional] |
|
|
948
1037
|
|
|
949
1038
|
### Return type
|
|
950
1039
|
|
|
@@ -959,6 +1048,68 @@ Name | Type | Description | Notes
|
|
|
959
1048
|
- **Content-Type**: Not defined
|
|
960
1049
|
- **Accept**: application/json
|
|
961
1050
|
|
|
1051
|
+
## get_attribute_sets
|
|
1052
|
+
|
|
1053
|
+
> AttributeSets get_attribute_sets(opts)
|
|
1054
|
+
|
|
1055
|
+
Allows you to retrieve the attribute sets
|
|
1056
|
+
|
|
1057
|
+
### Example
|
|
1058
|
+
|
|
1059
|
+
```ruby
|
|
1060
|
+
# load the gem
|
|
1061
|
+
require 'dear-inventory-ruby'
|
|
1062
|
+
# setup authorization
|
|
1063
|
+
DearInventoryRuby.configure do |config|
|
|
1064
|
+
# Configure API key authorization: accountID
|
|
1065
|
+
config.api_key['api-auth-accountid'] = 'YOUR API KEY'
|
|
1066
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1067
|
+
#config.api_key_prefix['api-auth-accountid'] = 'Bearer'
|
|
1068
|
+
|
|
1069
|
+
# Configure API key authorization: appKey
|
|
1070
|
+
config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
|
|
1071
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1072
|
+
#config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
|
|
1073
|
+
end
|
|
1074
|
+
|
|
1075
|
+
api_instance = DearInventoryRuby::InventoryApi.new
|
|
1076
|
+
opts = {
|
|
1077
|
+
page: '1', # String | Default is 1
|
|
1078
|
+
limit: '100', # String | Default is 100
|
|
1079
|
+
id: 'id_example', # String | Default is nil
|
|
1080
|
+
name: 'name_example' # String | Default is nil
|
|
1081
|
+
}
|
|
1082
|
+
|
|
1083
|
+
begin
|
|
1084
|
+
#Allows you to retrieve the attribute sets
|
|
1085
|
+
result = api_instance.get_attribute_sets(opts)
|
|
1086
|
+
p result
|
|
1087
|
+
rescue DearInventoryRuby::ApiError => e
|
|
1088
|
+
puts "Exception when calling InventoryApi->get_attribute_sets: #{e}"
|
|
1089
|
+
end
|
|
1090
|
+
```
|
|
1091
|
+
|
|
1092
|
+
### Parameters
|
|
1093
|
+
|
|
1094
|
+
| Name | Type | Description | Notes |
|
|
1095
|
+
| --------- | ---------- | -------------- | ------------------------------------- |
|
|
1096
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1097
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1098
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
1099
|
+
| **name** | **String** | Default is nil | [optional] |
|
|
1100
|
+
|
|
1101
|
+
### Return type
|
|
1102
|
+
|
|
1103
|
+
[**AttributeSets**](AttributeSets.md)
|
|
1104
|
+
|
|
1105
|
+
### Authorization
|
|
1106
|
+
|
|
1107
|
+
[accountID](../README.md#accountID), [appKey](../README.md#appKey)
|
|
1108
|
+
|
|
1109
|
+
### HTTP request headers
|
|
1110
|
+
|
|
1111
|
+
- **Content-Type**: Not defined
|
|
1112
|
+
- **Accept**: application/json
|
|
962
1113
|
|
|
963
1114
|
## get_carriers
|
|
964
1115
|
|
|
@@ -1003,13 +1154,12 @@ end
|
|
|
1003
1154
|
|
|
1004
1155
|
### Parameters
|
|
1005
1156
|
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
**
|
|
1010
|
-
**
|
|
1011
|
-
**
|
|
1012
|
-
**description** | **String**| Only return Carriers that start with the specific Description | [optional]
|
|
1157
|
+
| Name | Type | Description | Notes |
|
|
1158
|
+
| --------------- | ---------- | ------------------------------------------------------------- | ------------------------------------- |
|
|
1159
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1160
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1161
|
+
| **carrier_id** | **String** | Only return Carrier with the specific CarrierID | [optional] |
|
|
1162
|
+
| **description** | **String** | Only return Carriers that start with the specific Description | [optional] |
|
|
1013
1163
|
|
|
1014
1164
|
### Return type
|
|
1015
1165
|
|
|
@@ -1024,7 +1174,6 @@ Name | Type | Description | Notes
|
|
|
1024
1174
|
- **Content-Type**: Not defined
|
|
1025
1175
|
- **Accept**: application/json
|
|
1026
1176
|
|
|
1027
|
-
|
|
1028
1177
|
## get_customers
|
|
1029
1178
|
|
|
1030
1179
|
> Customers get_customers(opts)
|
|
@@ -1072,17 +1221,16 @@ end
|
|
|
1072
1221
|
|
|
1073
1222
|
### Parameters
|
|
1074
1223
|
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
**
|
|
1079
|
-
**
|
|
1080
|
-
**
|
|
1081
|
-
**
|
|
1082
|
-
**
|
|
1083
|
-
**
|
|
1084
|
-
**
|
|
1085
|
-
**include_product_prices** | **Boolean**| Default is false | [optional] [default to false]
|
|
1224
|
+
| Name | Type | Description | Notes |
|
|
1225
|
+
| -------------------------- | ----------- | ---------------- | ------------------------------------- |
|
|
1226
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1227
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1228
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
1229
|
+
| **name** | **String** | Default is nil | [optional] |
|
|
1230
|
+
| **contact_filter** | **String** | Default is nil | [optional] |
|
|
1231
|
+
| **modified_since** | **String** | Default is nil | [optional] |
|
|
1232
|
+
| **include_deprecated** | **Boolean** | Default is false | [optional] [default to false] |
|
|
1233
|
+
| **include_product_prices** | **Boolean** | Default is false | [optional] [default to false] |
|
|
1086
1234
|
|
|
1087
1235
|
### Return type
|
|
1088
1236
|
|
|
@@ -1097,7 +1245,6 @@ Name | Type | Description | Notes
|
|
|
1097
1245
|
- **Content-Type**: Not defined
|
|
1098
1246
|
- **Accept**: application/json
|
|
1099
1247
|
|
|
1100
|
-
|
|
1101
1248
|
## get_locations
|
|
1102
1249
|
|
|
1103
1250
|
> Locations get_locations(opts)
|
|
@@ -1142,14 +1289,13 @@ end
|
|
|
1142
1289
|
|
|
1143
1290
|
### Parameters
|
|
1144
1291
|
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
**
|
|
1149
|
-
**
|
|
1150
|
-
**
|
|
1151
|
-
**
|
|
1152
|
-
**name** | **String**| Default is nil | [optional]
|
|
1292
|
+
| Name | Type | Description | Notes |
|
|
1293
|
+
| -------------- | ----------- | ---------------- | ------------------------------------- |
|
|
1294
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1295
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1296
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
1297
|
+
| **deprecated** | **Boolean** | Default is false | [optional] [default to false] |
|
|
1298
|
+
| **name** | **String** | Default is nil | [optional] |
|
|
1153
1299
|
|
|
1154
1300
|
### Return type
|
|
1155
1301
|
|
|
@@ -1164,7 +1310,6 @@ Name | Type | Description | Notes
|
|
|
1164
1310
|
- **Content-Type**: Not defined
|
|
1165
1311
|
- **Accept**: application/json
|
|
1166
1312
|
|
|
1167
|
-
|
|
1168
1313
|
## get_me
|
|
1169
1314
|
|
|
1170
1315
|
> Me get_me
|
|
@@ -1217,7 +1362,6 @@ This endpoint does not need any parameter.
|
|
|
1217
1362
|
- **Content-Type**: Not defined
|
|
1218
1363
|
- **Accept**: application/json
|
|
1219
1364
|
|
|
1220
|
-
|
|
1221
1365
|
## get_me_contacts
|
|
1222
1366
|
|
|
1223
1367
|
> MeContacts get_me_contacts
|
|
@@ -1270,7 +1414,6 @@ This endpoint does not need any parameter.
|
|
|
1270
1414
|
- **Content-Type**: Not defined
|
|
1271
1415
|
- **Accept**: application/json
|
|
1272
1416
|
|
|
1273
|
-
|
|
1274
1417
|
## get_payment_terms
|
|
1275
1418
|
|
|
1276
1419
|
> PaymentTerms get_payment_terms(opts)
|
|
@@ -1317,16 +1460,15 @@ end
|
|
|
1317
1460
|
|
|
1318
1461
|
### Parameters
|
|
1319
1462
|
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
**
|
|
1324
|
-
**
|
|
1325
|
-
**
|
|
1326
|
-
**
|
|
1327
|
-
**
|
|
1328
|
-
**
|
|
1329
|
-
**is_default** | **Boolean**| Default is nil | [optional]
|
|
1463
|
+
| Name | Type | Description | Notes |
|
|
1464
|
+
| -------------- | ----------- | -------------- | ------------------------------------- |
|
|
1465
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1466
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1467
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
1468
|
+
| **name** | **String** | Default is nil | [optional] |
|
|
1469
|
+
| **method** | **String** | Default is nil | [optional] |
|
|
1470
|
+
| **is_active** | **Boolean** | Default is nil | [optional] |
|
|
1471
|
+
| **is_default** | **Boolean** | Default is nil | [optional] |
|
|
1330
1472
|
|
|
1331
1473
|
### Return type
|
|
1332
1474
|
|
|
@@ -1341,7 +1483,6 @@ Name | Type | Description | Notes
|
|
|
1341
1483
|
- **Content-Type**: Not defined
|
|
1342
1484
|
- **Accept**: application/json
|
|
1343
1485
|
|
|
1344
|
-
|
|
1345
1486
|
## get_price_tiers
|
|
1346
1487
|
|
|
1347
1488
|
> PriceTiers get_price_tiers
|
|
@@ -1394,7 +1535,6 @@ This endpoint does not need any parameter.
|
|
|
1394
1535
|
- **Content-Type**: Not defined
|
|
1395
1536
|
- **Accept**: application/json
|
|
1396
1537
|
|
|
1397
|
-
|
|
1398
1538
|
## get_sale
|
|
1399
1539
|
|
|
1400
1540
|
> Sale get_sale(opts)
|
|
@@ -1438,13 +1578,12 @@ end
|
|
|
1438
1578
|
|
|
1439
1579
|
### Parameters
|
|
1440
1580
|
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
**
|
|
1445
|
-
**
|
|
1446
|
-
**
|
|
1447
|
-
**include_transactions** | **Boolean**| Show related transactions (Default = false) | [optional] [default to false]
|
|
1581
|
+
| Name | Type | Description | Notes |
|
|
1582
|
+
| ------------------------------ | ----------- | ------------------------------------------------ | ----------------------------- |
|
|
1583
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
1584
|
+
| **combine_additional_charges** | **Boolean** | Show additional charges in 'Lines' array | [optional] [default to false] |
|
|
1585
|
+
| **hide_inventory_movements** | **Boolean** | Hide inventory movements (Default = false) | [optional] [default to false] |
|
|
1586
|
+
| **include_transactions** | **Boolean** | Show related transactions (Default = false) | [optional] [default to false] |
|
|
1448
1587
|
|
|
1449
1588
|
### Return type
|
|
1450
1589
|
|
|
@@ -1459,7 +1598,6 @@ Name | Type | Description | Notes
|
|
|
1459
1598
|
- **Content-Type**: Not defined
|
|
1460
1599
|
- **Accept**: application/json
|
|
1461
1600
|
|
|
1462
|
-
|
|
1463
1601
|
## get_sale_invoices
|
|
1464
1602
|
|
|
1465
1603
|
> SaleInvoices get_sale_invoices(opts)
|
|
@@ -1502,12 +1640,11 @@ end
|
|
|
1502
1640
|
|
|
1503
1641
|
### Parameters
|
|
1504
1642
|
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
**
|
|
1509
|
-
**
|
|
1510
|
-
**include_product_info** | **Boolean**| Show all used products in additional array | [optional] [default to false]
|
|
1643
|
+
| Name | Type | Description | Notes |
|
|
1644
|
+
| ------------------------------ | ----------- | ------------------------------------------------ | ----------------------------- |
|
|
1645
|
+
| **sale_id** | **String** | Unique DEAR Sale ID | [optional] |
|
|
1646
|
+
| **combine_additional_charges** | **Boolean** | Show additional charges in 'Lines' array | [optional] [default to false] |
|
|
1647
|
+
| **include_product_info** | **Boolean** | Show all used products in additional array | [optional] [default to false] |
|
|
1511
1648
|
|
|
1512
1649
|
### Return type
|
|
1513
1650
|
|
|
@@ -1522,7 +1659,6 @@ Name | Type | Description | Notes
|
|
|
1522
1659
|
- **Content-Type**: Not defined
|
|
1523
1660
|
- **Accept**: application/json
|
|
1524
1661
|
|
|
1525
|
-
|
|
1526
1662
|
## get_sale_list
|
|
1527
1663
|
|
|
1528
1664
|
> SaleList get_sale_list(opts)
|
|
@@ -1579,26 +1715,25 @@ end
|
|
|
1579
1715
|
|
|
1580
1716
|
### Parameters
|
|
1581
1717
|
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
**
|
|
1586
|
-
**
|
|
1587
|
-
**
|
|
1588
|
-
**
|
|
1589
|
-
**
|
|
1590
|
-
**
|
|
1591
|
-
**
|
|
1592
|
-
**
|
|
1593
|
-
**
|
|
1594
|
-
**
|
|
1595
|
-
**
|
|
1596
|
-
**
|
|
1597
|
-
**
|
|
1598
|
-
**
|
|
1599
|
-
**
|
|
1600
|
-
**
|
|
1601
|
-
**order_location_id** | **String**| Only return sales with specified Order Location ID | [optional]
|
|
1718
|
+
| Name | Type | Description | Notes |
|
|
1719
|
+
| ---------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
|
|
1720
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1721
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1722
|
+
| **search** | **String** | Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber | [optional] |
|
|
1723
|
+
| **created_since** | **DateTime** | Only return sales created after specified date. Date must follow ISO 8601 format. | [optional] |
|
|
1724
|
+
| **updated_since** | **DateTime** | Only return sales changed after specified date. Date must follow ISO 8601 format. | [optional] |
|
|
1725
|
+
| **ship_by** | **DateTime** | Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format. | [optional] |
|
|
1726
|
+
| **quote_status** | **String** | Only return sales with specified quote status | [optional] |
|
|
1727
|
+
| **order_status** | **String** | Only return sales with specified order status | [optional] |
|
|
1728
|
+
| **combined_pick_status** | **String** | Only return sales with specified CombinedPickingStatus | [optional] |
|
|
1729
|
+
| **combined_pack_status** | **String** | Only return sales with specified CombinedPackingStatus | [optional] |
|
|
1730
|
+
| **combined_shipping_status** | **String** | Only return sales with specified CombinedShippingStatus | [optional] |
|
|
1731
|
+
| **combined_invoice_status** | **String** | Only return sales with specified CombinedInvoiceStatus | [optional] |
|
|
1732
|
+
| **credit_note_status** | **String** | Only return sales with specified credit note status | [optional] |
|
|
1733
|
+
| **external_id** | **String** | Only return sales with specified External ID | [optional] |
|
|
1734
|
+
| **status** | **String** | Default is nil | [optional] |
|
|
1735
|
+
| **ready_for_shipping** | **Boolean** | Only return sales with 'Authorised' pack and not 'Authorised' shipping | [optional] |
|
|
1736
|
+
| **order_location_id** | **String** | Only return sales with specified Order Location ID | [optional] |
|
|
1602
1737
|
|
|
1603
1738
|
### Return type
|
|
1604
1739
|
|
|
@@ -1613,7 +1748,6 @@ Name | Type | Description | Notes
|
|
|
1613
1748
|
- **Content-Type**: Not defined
|
|
1614
1749
|
- **Accept**: application/json
|
|
1615
1750
|
|
|
1616
|
-
|
|
1617
1751
|
## get_sale_order
|
|
1618
1752
|
|
|
1619
1753
|
> SaleOrder get_sale_order(opts)
|
|
@@ -1656,12 +1790,11 @@ end
|
|
|
1656
1790
|
|
|
1657
1791
|
### Parameters
|
|
1658
1792
|
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
**
|
|
1663
|
-
**
|
|
1664
|
-
**include_product_info** | **Boolean**| Show all used products in additional array | [optional] [default to false]
|
|
1793
|
+
| Name | Type | Description | Notes |
|
|
1794
|
+
| ------------------------------ | ----------- | ------------------------------------------------ | ----------------------------- |
|
|
1795
|
+
| **sale_id** | **String** | Unique DEAR Sale ID | [optional] |
|
|
1796
|
+
| **combine_additional_charges** | **Boolean** | Show additional charges in 'Lines' array | [optional] [default to false] |
|
|
1797
|
+
| **include_product_info** | **Boolean** | Show all used products in additional array | [optional] [default to false] |
|
|
1665
1798
|
|
|
1666
1799
|
### Return type
|
|
1667
1800
|
|
|
@@ -1676,7 +1809,6 @@ Name | Type | Description | Notes
|
|
|
1676
1809
|
- **Content-Type**: Not defined
|
|
1677
1810
|
- **Accept**: application/json
|
|
1678
1811
|
|
|
1679
|
-
|
|
1680
1812
|
## get_sale_payment
|
|
1681
1813
|
|
|
1682
1814
|
> Array<SalePayment> get_sale_payment(opts)
|
|
@@ -1717,10 +1849,9 @@ end
|
|
|
1717
1849
|
|
|
1718
1850
|
### Parameters
|
|
1719
1851
|
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
**sale_id** | **String**| Unique DEAR Sale ID | [optional]
|
|
1852
|
+
| Name | Type | Description | Notes |
|
|
1853
|
+
| ----------- | ---------- | ------------------- | ---------- |
|
|
1854
|
+
| **sale_id** | **String** | Unique DEAR Sale ID | [optional] |
|
|
1724
1855
|
|
|
1725
1856
|
### Return type
|
|
1726
1857
|
|
|
@@ -1735,7 +1866,6 @@ Name | Type | Description | Notes
|
|
|
1735
1866
|
- **Content-Type**: Not defined
|
|
1736
1867
|
- **Accept**: application/json
|
|
1737
1868
|
|
|
1738
|
-
|
|
1739
1869
|
## get_sale_quote
|
|
1740
1870
|
|
|
1741
1871
|
> SaleQuote get_sale_quote(opts)
|
|
@@ -1778,12 +1908,11 @@ end
|
|
|
1778
1908
|
|
|
1779
1909
|
### Parameters
|
|
1780
1910
|
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
**
|
|
1785
|
-
**
|
|
1786
|
-
**include_product_info** | **Boolean**| Show all used products in additional array | [optional] [default to false]
|
|
1911
|
+
| Name | Type | Description | Notes |
|
|
1912
|
+
| ------------------------------ | ----------- | ------------------------------------------------ | ----------------------------- |
|
|
1913
|
+
| **sale_id** | **String** | Unique DEAR Sale ID | [optional] |
|
|
1914
|
+
| **combine_additional_charges** | **Boolean** | Show additional charges in 'Lines' array | [optional] [default to false] |
|
|
1915
|
+
| **include_product_info** | **Boolean** | Show all used products in additional array | [optional] [default to false] |
|
|
1787
1916
|
|
|
1788
1917
|
### Return type
|
|
1789
1918
|
|
|
@@ -1798,7 +1927,6 @@ Name | Type | Description | Notes
|
|
|
1798
1927
|
- **Content-Type**: Not defined
|
|
1799
1928
|
- **Accept**: application/json
|
|
1800
1929
|
|
|
1801
|
-
|
|
1802
1930
|
## get_taxes
|
|
1803
1931
|
|
|
1804
1932
|
> Taxes get_taxes(opts)
|
|
@@ -1846,17 +1974,16 @@ end
|
|
|
1846
1974
|
|
|
1847
1975
|
### Parameters
|
|
1848
1976
|
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
**
|
|
1853
|
-
**
|
|
1854
|
-
**
|
|
1855
|
-
**
|
|
1856
|
-
**
|
|
1857
|
-
**
|
|
1858
|
-
**
|
|
1859
|
-
**account** | **String**| Default is nil | [optional]
|
|
1977
|
+
| Name | Type | Description | Notes |
|
|
1978
|
+
| ----------------------- | ----------- | -------------- | ------------------------------------- |
|
|
1979
|
+
| **page** | **String** | Default is 1 | [optional] [default to '1'] |
|
|
1980
|
+
| **limit** | **String** | Default is 100 | [optional] [default to '100'] |
|
|
1981
|
+
| **id** | **String** | Default is nil | [optional] |
|
|
1982
|
+
| **name** | **String** | Default is nil | [optional] |
|
|
1983
|
+
| **is_active** | **Boolean** | Default is nil | [optional] |
|
|
1984
|
+
| **is_tax_for_sale** | **Boolean** | Default is nil | [optional] |
|
|
1985
|
+
| **is_tax_for_purchase** | **Boolean** | Default is nil | [optional] |
|
|
1986
|
+
| **account** | **String** | Default is nil | [optional] |
|
|
1860
1987
|
|
|
1861
1988
|
### Return type
|
|
1862
1989
|
|
|
@@ -1871,7 +1998,6 @@ Name | Type | Description | Notes
|
|
|
1871
1998
|
- **Content-Type**: Not defined
|
|
1872
1999
|
- **Accept**: application/json
|
|
1873
2000
|
|
|
1874
|
-
|
|
1875
2001
|
## get_webhooks
|
|
1876
2002
|
|
|
1877
2003
|
> Webhooks get_webhooks
|
|
@@ -1924,7 +2050,6 @@ This endpoint does not need any parameter.
|
|
|
1924
2050
|
- **Content-Type**: Not defined
|
|
1925
2051
|
- **Accept**: application/json
|
|
1926
2052
|
|
|
1927
|
-
|
|
1928
2053
|
## update_account
|
|
1929
2054
|
|
|
1930
2055
|
> Accounts update_account(account, opts)
|
|
@@ -1966,11 +2091,10 @@ end
|
|
|
1966
2091
|
|
|
1967
2092
|
### Parameters
|
|
1968
2093
|
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
**
|
|
1973
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
2094
|
+
| Name | Type | Description | Notes |
|
|
2095
|
+
| -------------------- | ------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
2096
|
+
| **account** | [**Account**](Account.md) | an Account object with properties to update |
|
|
2097
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
1974
2098
|
|
|
1975
2099
|
### Return type
|
|
1976
2100
|
|
|
@@ -1985,6 +2109,64 @@ Name | Type | Description | Notes
|
|
|
1985
2109
|
- **Content-Type**: application/json
|
|
1986
2110
|
- **Accept**: application/json
|
|
1987
2111
|
|
|
2112
|
+
## update_attribute_set
|
|
2113
|
+
|
|
2114
|
+
> AttributeSet update_attribute_set(attribute_set, opts)
|
|
2115
|
+
|
|
2116
|
+
Allows you to update an attribute set
|
|
2117
|
+
|
|
2118
|
+
### Example
|
|
2119
|
+
|
|
2120
|
+
```ruby
|
|
2121
|
+
# load the gem
|
|
2122
|
+
require 'dear-inventory-ruby'
|
|
2123
|
+
# setup authorization
|
|
2124
|
+
DearInventoryRuby.configure do |config|
|
|
2125
|
+
# Configure API key authorization: accountID
|
|
2126
|
+
config.api_key['api-auth-accountid'] = 'YOUR API KEY'
|
|
2127
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2128
|
+
#config.api_key_prefix['api-auth-accountid'] = 'Bearer'
|
|
2129
|
+
|
|
2130
|
+
# Configure API key authorization: appKey
|
|
2131
|
+
config.api_key['api-auth-applicationkey'] = 'YOUR API KEY'
|
|
2132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2133
|
+
#config.api_key_prefix['api-auth-applicationkey'] = 'Bearer'
|
|
2134
|
+
end
|
|
2135
|
+
|
|
2136
|
+
api_instance = DearInventoryRuby::InventoryApi.new
|
|
2137
|
+
attribute_set = { "ID": "0ba27d98-42ca-4bf6-9b9e-9f71538bd53d", "Name": "Test set name", "Attribute1Name": "List attribute name", "Attribute1Type": "List", "Attribute1Values": "Red, Black, Blue, Aqua", "Attribute2Name": "Check box attribute name", "Attribute2Type": "Checkbox", "Attribute2Values": "", "Attribute3Name": "Text attribute name", "Attribute3Type": "Text", "Attribute3Values": "", "Attribute4Name": "Additional attribute", "Attribute4Type": "Text", "Attribute4Values": "", "Attribute5Name": "Hidden attribute name", "Attribute5Type": "Not used", "Attribute5Values": "", "Attribute6Name": "Additional attribute name 2", "Attribute6Type": "Checkbox", "Attribute6Values": "" } # AttributeSet | an attribute set object with properties to update
|
|
2138
|
+
opts = {
|
|
2139
|
+
summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
|
|
2140
|
+
}
|
|
2141
|
+
|
|
2142
|
+
begin
|
|
2143
|
+
#Allows you to update an attribute set
|
|
2144
|
+
result = api_instance.update_attribute_set(attribute_set, opts)
|
|
2145
|
+
p result
|
|
2146
|
+
rescue DearInventoryRuby::ApiError => e
|
|
2147
|
+
puts "Exception when calling InventoryApi->update_attribute_set: #{e}"
|
|
2148
|
+
end
|
|
2149
|
+
```
|
|
2150
|
+
|
|
2151
|
+
### Parameters
|
|
2152
|
+
|
|
2153
|
+
| Name | Type | Description | Notes |
|
|
2154
|
+
| -------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
2155
|
+
| **attribute_set** | [**AttributeSet**](AttributeSet.md) | an attribute set object with properties to update |
|
|
2156
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
2157
|
+
|
|
2158
|
+
### Return type
|
|
2159
|
+
|
|
2160
|
+
[**AttributeSet**](AttributeSet.md)
|
|
2161
|
+
|
|
2162
|
+
### Authorization
|
|
2163
|
+
|
|
2164
|
+
[accountID](../README.md#accountID), [appKey](../README.md#appKey)
|
|
2165
|
+
|
|
2166
|
+
### HTTP request headers
|
|
2167
|
+
|
|
2168
|
+
- **Content-Type**: application/json
|
|
2169
|
+
- **Accept**: application/json
|
|
1988
2170
|
|
|
1989
2171
|
## update_customer
|
|
1990
2172
|
|
|
@@ -2027,11 +2209,10 @@ end
|
|
|
2027
2209
|
|
|
2028
2210
|
### Parameters
|
|
2029
2211
|
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
**
|
|
2034
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
2212
|
+
| Name | Type | Description | Notes |
|
|
2213
|
+
| -------------------- | --------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
2214
|
+
| **customer** | [**Customer**](Customer.md) | a customer object with properties to update |
|
|
2215
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
2035
2216
|
|
|
2036
2217
|
### Return type
|
|
2037
2218
|
|
|
@@ -2046,7 +2227,6 @@ Name | Type | Description | Notes
|
|
|
2046
2227
|
- **Content-Type**: application/json
|
|
2047
2228
|
- **Accept**: application/json
|
|
2048
2229
|
|
|
2049
|
-
|
|
2050
2230
|
## update_payment_term
|
|
2051
2231
|
|
|
2052
2232
|
> PaymentTerms update_payment_term(payment_term, opts)
|
|
@@ -2088,11 +2268,10 @@ end
|
|
|
2088
2268
|
|
|
2089
2269
|
### Parameters
|
|
2090
2270
|
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
**
|
|
2095
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
2271
|
+
| Name | Type | Description | Notes |
|
|
2272
|
+
| -------------------- | --------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
2273
|
+
| **payment_term** | [**PaymentTerm**](PaymentTerm.md) | a payment term object with properties to update |
|
|
2274
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
2096
2275
|
|
|
2097
2276
|
### Return type
|
|
2098
2277
|
|
|
@@ -2107,7 +2286,6 @@ Name | Type | Description | Notes
|
|
|
2107
2286
|
- **Content-Type**: application/json
|
|
2108
2287
|
- **Accept**: application/json
|
|
2109
2288
|
|
|
2110
|
-
|
|
2111
2289
|
## update_sale_payment
|
|
2112
2290
|
|
|
2113
2291
|
> SalePayment update_sale_payment(sale_payment, opts)
|
|
@@ -2149,11 +2327,10 @@ end
|
|
|
2149
2327
|
|
|
2150
2328
|
### Parameters
|
|
2151
2329
|
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
**
|
|
2156
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
2330
|
+
| Name | Type | Description | Notes |
|
|
2331
|
+
| -------------------- | --------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
2332
|
+
| **sale_payment** | [**SalePayment**](SalePayment.md) | a sale payment object with properties to update |
|
|
2333
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
2157
2334
|
|
|
2158
2335
|
### Return type
|
|
2159
2336
|
|
|
@@ -2168,7 +2345,6 @@ Name | Type | Description | Notes
|
|
|
2168
2345
|
- **Content-Type**: application/json
|
|
2169
2346
|
- **Accept**: application/json
|
|
2170
2347
|
|
|
2171
|
-
|
|
2172
2348
|
## update_tax
|
|
2173
2349
|
|
|
2174
2350
|
> Taxes update_tax(tax, opts)
|
|
@@ -2210,11 +2386,10 @@ end
|
|
|
2210
2386
|
|
|
2211
2387
|
### Parameters
|
|
2212
2388
|
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
**
|
|
2217
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
2389
|
+
| Name | Type | Description | Notes |
|
|
2390
|
+
| -------------------- | ----------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
2391
|
+
| **tax** | [**Tax**](Tax.md) | a tax object with properties to update |
|
|
2392
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
2218
2393
|
|
|
2219
2394
|
### Return type
|
|
2220
2395
|
|
|
@@ -2229,7 +2404,6 @@ Name | Type | Description | Notes
|
|
|
2229
2404
|
- **Content-Type**: application/json
|
|
2230
2405
|
- **Accept**: application/json
|
|
2231
2406
|
|
|
2232
|
-
|
|
2233
2407
|
## update_webhook
|
|
2234
2408
|
|
|
2235
2409
|
> Webhook update_webhook(webhook, opts)
|
|
@@ -2271,11 +2445,10 @@ end
|
|
|
2271
2445
|
|
|
2272
2446
|
### Parameters
|
|
2273
2447
|
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
**
|
|
2278
|
-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
|
|
2448
|
+
| Name | Type | Description | Notes |
|
|
2449
|
+
| -------------------- | ------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
2450
|
+
| **webhook** | [**Webhook**](Webhook.md) | a webhook object with properties to update |
|
|
2451
|
+
| **summarize_errors** | **Boolean** | If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] |
|
|
2279
2452
|
|
|
2280
2453
|
### Return type
|
|
2281
2454
|
|
|
@@ -2289,4 +2462,3 @@ Name | Type | Description | Notes
|
|
|
2289
2462
|
|
|
2290
2463
|
- **Content-Type**: application/json
|
|
2291
2464
|
- **Accept**: application/json
|
|
2292
|
-
|