dear-inventory-ruby 0.1.16 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -10
  3. data/README.md +32 -7
  4. data/dear-inventory-ruby.gemspec +1 -1
  5. data/docs/Address.md +10 -12
  6. data/docs/Customer.md +1 -1
  7. data/docs/ExternalHeader.md +19 -0
  8. data/docs/InventoryApi.md +1021 -161
  9. data/docs/Me.md +1 -1
  10. data/docs/SaleAdditionalCharge.md +31 -0
  11. data/docs/SaleInvoice.md +1 -1
  12. data/docs/SaleInvoiceAdditionalCharge.md +3 -3
  13. data/docs/SaleInvoiceDelete.md +19 -0
  14. data/docs/SaleInvoiceLine.md +2 -2
  15. data/docs/SaleInvoicePost.md +41 -0
  16. data/docs/SaleOrder.md +35 -0
  17. data/docs/SaleOrderLine.md +41 -0
  18. data/docs/SalePayment.md +43 -0
  19. data/docs/SaleQuote.md +33 -0
  20. data/docs/SaleQuoteLine.md +37 -0
  21. data/docs/ShippingAddress.md +37 -0
  22. data/docs/SupplierCustomerAddress.md +33 -0
  23. data/docs/Webhook.md +35 -0
  24. data/docs/Webhooks.md +17 -0
  25. data/lib/dear-inventory-ruby/api/inventory_api.rb +988 -119
  26. data/lib/dear-inventory-ruby/models/account.rb +0 -34
  27. data/lib/dear-inventory-ruby/models/address.rb +28 -115
  28. data/lib/dear-inventory-ruby/models/customer.rb +1 -35
  29. data/lib/dear-inventory-ruby/models/external_header.rb +217 -0
  30. data/lib/dear-inventory-ruby/models/me.rb +2 -1
  31. data/lib/dear-inventory-ruby/models/payment_term.rb +0 -34
  32. data/lib/dear-inventory-ruby/models/sale_additional_charge.rb +302 -0
  33. data/lib/dear-inventory-ruby/models/sale_invoice.rb +1 -1
  34. data/lib/dear-inventory-ruby/models/sale_invoice_additional_charge.rb +3 -3
  35. data/lib/dear-inventory-ruby/models/sale_invoice_delete.rb +224 -0
  36. data/lib/dear-inventory-ruby/models/sale_invoice_line.rb +0 -10
  37. data/lib/dear-inventory-ruby/models/sale_invoice_post.rb +361 -0
  38. data/lib/dear-inventory-ruby/models/sale_order.rb +336 -0
  39. data/lib/dear-inventory-ruby/models/sale_order_line.rb +342 -0
  40. data/lib/dear-inventory-ruby/models/sale_payment.rb +337 -0
  41. data/lib/dear-inventory-ruby/models/sale_quote.rb +326 -0
  42. data/lib/dear-inventory-ruby/models/sale_quote_line.rb +322 -0
  43. data/lib/dear-inventory-ruby/models/shipping_address.rb +317 -0
  44. data/lib/dear-inventory-ruby/models/supplier_customer_address.rb +374 -0
  45. data/lib/dear-inventory-ruby/models/webhook.rb +319 -0
  46. data/lib/dear-inventory-ruby/models/webhooks.rb +209 -0
  47. data/lib/dear-inventory-ruby/version.rb +1 -1
  48. data/lib/dear-inventory-ruby.rb +13 -2
  49. data/spec/api/inventory_api_spec.rb +166 -0
  50. data/spec/models/account_spec.rb +0 -4
  51. data/spec/models/address_spec.rb +7 -13
  52. data/spec/models/customer_spec.rb +0 -4
  53. data/spec/models/external_header_spec.rb +47 -0
  54. data/spec/models/payment_term_spec.rb +0 -4
  55. data/spec/models/sale_additional_charge_spec.rb +83 -0
  56. data/spec/models/sale_invoice_delete_spec.rb +47 -0
  57. data/spec/models/sale_invoice_post_spec.rb +113 -0
  58. data/spec/models/sale_order_line_spec.rb +113 -0
  59. data/spec/models/sale_order_spec.rb +95 -0
  60. data/spec/models/sale_payment_spec.rb +119 -0
  61. data/spec/models/sale_quote_line_spec.rb +101 -0
  62. data/spec/models/sale_quote_spec.rb +89 -0
  63. data/spec/models/shipping_address_spec.rb +101 -0
  64. data/spec/models/supplier_customer_address_spec.rb +89 -0
  65. data/spec/models/webhook_spec.rb +95 -0
  66. data/spec/models/{currency_code_spec.rb → webhooks_spec.rb} +12 -6
  67. metadata +63 -14
  68. data/docs/CurrencyCode.md +0 -16
  69. data/docs/DimensionsUnit.md +0 -16
  70. data/lib/dear-inventory-ruby/models/currency_code.rb +0 -196
  71. data/lib/dear-inventory-ruby/models/dimensions_unit.rb +0 -42
  72. data/spec/.DS_Store +0 -0
  73. data/spec/models/dimensions_unit_spec.rb +0 -35
data/docs/Me.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **currency** | **String** | Your company base currency | [optional]
9
9
  **time_zone** | **String** | Time Zone where your company located | [optional]
10
10
  **default_weight_units** | **String** | Unit of measure for unit weight | [optional]
11
- **default_dimensions_units** | [**DimensionsUnit**](DimensionsUnit.md) | | [optional]
11
+ **default_dimensions_units** | **String** | Unit of measure for unit length/width/height | [optional]
12
12
  **lock_date** | **Date** | Financial settings option. Indicates date period start from what you can change transactional data. Formatted in Tenant date format | [optional]
13
13
  **opening_balance_date** | **Date** | Date of opening balances in the system. Formatted in Tenant date format | [optional]
14
14
 
@@ -0,0 +1,31 @@
1
+ # DearInventoryRuby::SaleAdditionalCharge
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **description** | **String** | Name of Service Product referenced by this Line |
8
+ **price** | **Float** | Decimal with up to 4 decimal places. Price per unit in Customer currency |
9
+ **quantity** | **Float** | Decimal with up to 4 decimal places. Product or service quantity. Minimal value is 1. |
10
+ **discount** | **Float** | Decimal with up to 2 decimal places. Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
11
+ **tax** | **Float** | Decimal with up to 4 decimal places. Tax. |
12
+ **total** | **Float** | Decimal with up to 4 decimal places. Line Total. For validation | [optional]
13
+ **tax_rule** | **String** | Line Tax Rule name. |
14
+ **comment** | **Float** | Comment | [optional]
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'DearInventoryRuby'
20
+
21
+ instance = DearInventoryRuby::SaleAdditionalCharge.new(description: nil,
22
+ price: nil,
23
+ quantity: nil,
24
+ discount: nil,
25
+ tax: nil,
26
+ total: nil,
27
+ tax_rule: nil,
28
+ comment: nil)
29
+ ```
30
+
31
+
data/docs/SaleInvoice.md CHANGED
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **task_id** | **String** | Identifier of sale Invoice task |
8
- **combine_additional_charges** | **Boolean** | if true then additional charges lines displayed in Lines array | [default to false]
8
+ **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
9
9
  **invoice_number** | **String** | Invoice Number (auto-generated) | [optional]
10
10
  **memo** | **String** | Additional information for Invoice. | [optional]
11
11
  **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
10
10
  **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
11
11
  **tax** | **Float** | Tax |
12
12
  **total** | **Float** | Line Total.For validation | [optional]
13
- **tax_rule** | **Float** | Line Tax Rule name. |
14
- **account** | **Float** | Revenue account |
15
- **comment** | **Float** | Comment | [optional]
13
+ **tax_rule** | **String** | Line Tax Rule name. |
14
+ **account** | **String** | Revenue account |
15
+ **comment** | **String** | Comment | [optional]
16
16
 
17
17
  ## Code Sample
18
18
 
@@ -0,0 +1,19 @@
1
+ # DearInventoryRuby::SaleInvoiceDelete
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **task_id** | **String** | ID of Sale task to Void or Undo |
8
+ **void** | **Boolean** | Default false | [optional] [default to false]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'DearInventoryRuby'
14
+
15
+ instance = DearInventoryRuby::SaleInvoiceDelete.new(task_id: nil,
16
+ void: nil)
17
+ ```
18
+
19
+
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false |
8
- **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false |
7
+ **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
+ **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
9
  **name** | **String** | Product Name referenced by this Line |
10
10
  **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
11
  **price** | **Float** | Price per unit in Customer currency |
@@ -0,0 +1,41 @@
1
+ # DearInventoryRuby::SaleInvoicePost
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **task_id** | **String** | Identifier of sale Invoice task |
9
+ **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
10
+ **memo** | **String** | Additional information for Invoice. | [optional]
11
+ **status** | **String** | Invoice status. Possible Values are values. For POST available values are DRAFT, AUTHORISED |
12
+ **invoice_date** | **String** | Invoice Date. |
13
+ **invoice_due_date** | **String** | Invoice Due Date. |
14
+ **currency_conversion_rate** | **Float** | Decimal with up to 4 decimal places | [optional]
15
+ **billing_address_line1** | **String** | Billing Address Line 1 | [optional]
16
+ **billing_address_line2** | **String** | Billing Address Line 2 | [optional]
17
+ **linked_fulfillment_number** | **Integer** | Number of Fulfilment linked to this invoice | [optional]
18
+ **lines** | [**Array<SaleInvoiceLine>**](SaleInvoiceLine.md) | | [optional]
19
+ **additional_charges** | [**Array<SaleInvoiceAdditionalCharge>**](SaleInvoiceAdditionalCharge.md) | | [optional]
20
+
21
+ ## Code Sample
22
+
23
+ ```ruby
24
+ require 'DearInventoryRuby'
25
+
26
+ instance = DearInventoryRuby::SaleInvoicePost.new(sale_id: nil,
27
+ task_id: nil,
28
+ combine_additional_charges: nil,
29
+ memo: nil,
30
+ status: nil,
31
+ invoice_date: nil,
32
+ invoice_due_date: nil,
33
+ currency_conversion_rate: nil,
34
+ billing_address_line1: nil,
35
+ billing_address_line2: nil,
36
+ linked_fulfillment_number: nil,
37
+ lines: nil,
38
+ additional_charges: nil)
39
+ ```
40
+
41
+
data/docs/SaleOrder.md ADDED
@@ -0,0 +1,35 @@
1
+ # DearInventoryRuby::SaleOrder
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **sale_order_number** | **String** | Sale Order Number (auto-generated) | [optional]
9
+ **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
10
+ **memo** | **String** | Additional information for Order. |
11
+ **status** | **String** | Order Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
12
+ **lines** | [**Array<SaleOrderLine>**](SaleOrderLine.md) | | [optional]
13
+ **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
14
+ **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges without taxes. Not required for POST. |
15
+ **tax** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges taxes. Not required for POST. |
16
+ **total** | **Float** | Decimal with up to 4 decimal places. Sum of order lines and additional charges with taxes. Not required for POST. |
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'DearInventoryRuby'
22
+
23
+ instance = DearInventoryRuby::SaleOrder.new(sale_id: nil,
24
+ sale_order_number: nil,
25
+ combine_additional_charges: nil,
26
+ memo: nil,
27
+ status: nil,
28
+ lines: nil,
29
+ additional_charges: nil,
30
+ total_before_tax: nil,
31
+ tax: nil,
32
+ total: nil)
33
+ ```
34
+
35
+
@@ -0,0 +1,41 @@
1
+ # DearInventoryRuby::SaleOrderLine
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
+ **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
+ **name** | **String** | Product Name referenced by this Line |
10
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
+ **price** | **Float** | Price per unit in Customer currency |
12
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
+ **tax** | **Float** | Tax | [optional]
14
+ **average_cost** | **Float** | Average product cost | [optional]
15
+ **tax_rule** | **String** | Line Tax Rule name. | [optional]
16
+ **comment** | **String** | Comment for this line | [optional]
17
+ **drop_ship** | **Boolean** | Required if product is not a service with “Optional Drop Ship” mode. Otherwise it ignored. | [optional]
18
+ **backorder_quantity** | **Float** | Quantity of the ordered product on backorder. Read Only for POST | [optional]
19
+ **total** | **Float** | Line Total. For validation | [optional]
20
+
21
+ ## Code Sample
22
+
23
+ ```ruby
24
+ require 'DearInventoryRuby'
25
+
26
+ instance = DearInventoryRuby::SaleOrderLine.new(product_id: nil,
27
+ sku: nil,
28
+ name: nil,
29
+ quantity: nil,
30
+ price: nil,
31
+ discount: nil,
32
+ tax: nil,
33
+ average_cost: nil,
34
+ tax_rule: nil,
35
+ comment: nil,
36
+ drop_ship: nil,
37
+ backorder_quantity: nil,
38
+ total: nil)
39
+ ```
40
+
41
+
@@ -0,0 +1,43 @@
1
+ # DearInventoryRuby::SalePayment
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **sale_id** | **String** | Unique DEAR Sale ID | [optional]
8
+ **task_id** | **String** | Unique DEAR Sale Task ID. Available for POST | [optional]
9
+ **id** | **String** | Identifier of payment. Available for PUT | [optional]
10
+ **sale_order_number** | **String** | Sale Order Number | [optional]
11
+ **invoice_number** | **String** | Sale Task Invoice Number | [optional]
12
+ **credit_note_number** | **String** | Sale Task Credit Note Number | [optional]
13
+ **type** | **String** | Available values are PREPAYMENT,PAYMENT,REFUND. Available for POST | [optional]
14
+ **reference** | **String** | Payment reference number. Available for POST/PUT | [optional]
15
+ **amount** | **Float** | Payment amount in customer currency. Available for POST/PUT | [optional]
16
+ **date_paid** | **Date** | Date when payment has been made. Available for POST/PUT | [optional]
17
+ **account** | **String** | Account Code of the bank/payment account from Chart of accounts. Available for POST/PUT | [optional]
18
+ **currency_rate** | **Float** | Currency Conversion rate expressed as number of Base currency units for one Customer currency unit. Available for POST/PUT | [optional]
19
+ **date_created** | **Date** | Date of creation payment record. | [optional]
20
+ **credit_id** | **String** | Id for Sale Credit entry | [optional]
21
+
22
+ ## Code Sample
23
+
24
+ ```ruby
25
+ require 'DearInventoryRuby'
26
+
27
+ instance = DearInventoryRuby::SalePayment.new(sale_id: nil,
28
+ task_id: nil,
29
+ id: nil,
30
+ sale_order_number: nil,
31
+ invoice_number: nil,
32
+ credit_note_number: nil,
33
+ type: nil,
34
+ reference: nil,
35
+ amount: nil,
36
+ date_paid: nil,
37
+ account: nil,
38
+ currency_rate: nil,
39
+ date_created: nil,
40
+ credit_id: nil)
41
+ ```
42
+
43
+
data/docs/SaleQuote.md ADDED
@@ -0,0 +1,33 @@
1
+ # DearInventoryRuby::SaleQuote
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **sale_id** | **String** | Unique DEAR Sale ID |
8
+ **combine_additional_charges** | **Boolean** | If `true` then `additional charges` lines displayed in `Lines` array | [default to false]
9
+ **memo** | **String** | Additional information for Quote. |
10
+ **status** | **String** | Quote Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted |
11
+ **lines** | [**Array<SaleQuoteLine>**](SaleQuoteLine.md) | | [optional]
12
+ **additional_charges** | [**Array<SaleAdditionalCharge>**](SaleAdditionalCharge.md) | | [optional]
13
+ **total_before_tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges without taxes. Not required for POST. |
14
+ **tax** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges taxes. Not required for POST. |
15
+ **total** | **Float** | Decimal with up to 4 decimal places. Sum of quote lines and additional charges with taxes. Not required for POST. |
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'DearInventoryRuby'
21
+
22
+ instance = DearInventoryRuby::SaleQuote.new(sale_id: nil,
23
+ combine_additional_charges: nil,
24
+ memo: nil,
25
+ status: nil,
26
+ lines: nil,
27
+ additional_charges: nil,
28
+ total_before_tax: nil,
29
+ tax: nil,
30
+ total: nil)
31
+ ```
32
+
33
+
@@ -0,0 +1,37 @@
1
+ # DearInventoryRuby::SaleQuoteLine
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **product_id** | **String** | Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
8
+ **sku** | **String** | Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false | [optional]
9
+ **name** | **String** | Product Name referenced by this Line |
10
+ **quantity** | **Float** | Product or service quantity. Minimal value is 1. |
11
+ **price** | **Float** | Price per unit in Customer currency |
12
+ **discount** | **Float** | Discount. Value between 0 and 100. For free items discount is 100. Default value is 0 | [optional]
13
+ **tax** | **Float** | Tax | [optional]
14
+ **average_cost** | **Float** | Average product cost | [optional]
15
+ **tax_rule** | **String** | Line Tax Rule name. | [optional]
16
+ **comment** | **String** | Comment for this line | [optional]
17
+ **total** | **Float** | Line Total. For validation | [optional]
18
+
19
+ ## Code Sample
20
+
21
+ ```ruby
22
+ require 'DearInventoryRuby'
23
+
24
+ instance = DearInventoryRuby::SaleQuoteLine.new(product_id: nil,
25
+ sku: nil,
26
+ name: nil,
27
+ quantity: nil,
28
+ price: nil,
29
+ discount: nil,
30
+ tax: nil,
31
+ average_cost: nil,
32
+ tax_rule: nil,
33
+ comment: nil,
34
+ total: nil)
35
+ ```
36
+
37
+
@@ -0,0 +1,37 @@
1
+ # DearInventoryRuby::ShippingAddress
2
+
3
+ ## Properties
4
+
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** | Post code | [optional]
14
+ **country** | **String** | Country |
15
+ **company** | **String** | Company Name | [optional]
16
+ **contact** | **String** | Contact | [optional]
17
+ **ship_to_other** | **Boolean** | If false and Customer's address matching Line 1 not found, than new customer shipping address will be created. | [optional]
18
+
19
+ ## Code Sample
20
+
21
+ ```ruby
22
+ require 'DearInventoryRuby'
23
+
24
+ instance = DearInventoryRuby::ShippingAddress.new(display_address_line1: nil,
25
+ display_address_line2: nil,
26
+ line1: nil,
27
+ line2: nil,
28
+ city: nil,
29
+ state: nil,
30
+ post_code: nil,
31
+ country: nil,
32
+ company: nil,
33
+ contact: nil,
34
+ ship_to_other: nil)
35
+ ```
36
+
37
+
@@ -0,0 +1,33 @@
1
+ # DearInventoryRuby::SupplierCustomerAddress
2
+
3
+ ## Properties
4
+
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
+ **line1** | **String** | Address Line 1 | [optional]
9
+ **line2** | **String** | Address Line 2 | [optional]
10
+ **city** | **String** | City / Suburb | [optional]
11
+ **state** | **String** | State / Province | [optional]
12
+ **post_code** | **String** | Zip / PostCode | [optional]
13
+ **country** | **String** | Country name |
14
+ **type** | **String** | Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`. |
15
+ **default_for_type** | **Boolean** | Points that Address is used as default for chosen Type. `false` as default. | [optional] [default to false]
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'DearInventoryRuby'
21
+
22
+ instance = DearInventoryRuby::SupplierCustomerAddress.new(id: nil,
23
+ line1: nil,
24
+ line2: nil,
25
+ city: nil,
26
+ state: nil,
27
+ post_code: nil,
28
+ country: nil,
29
+ type: nil,
30
+ default_for_type: nil)
31
+ ```
32
+
33
+
data/docs/Webhook.md ADDED
@@ -0,0 +1,35 @@
1
+ # DearInventoryRuby::Webhook
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | Unique ID. Required for PUT | [optional]
8
+ **type** | **String** | Webhook Type. Available values are values |
9
+ **name** | **String** | Webhook Friendly Name. Read-only. | [optional]
10
+ **is_active** | **Boolean** | Is webhook active. |
11
+ **external_url** | **String** | Callback url. |
12
+ **external_authorization_type** | **String** | Authorisation type. Available values are `noauth`, `basicauth` and `bearerauth` |
13
+ **external_user_name** | **String** | User name. Required if `ExternalAuthorizationType` is `basicauth` | [optional]
14
+ **external_password** | **String** | Password. Required if `ExternalAuthorizationType` is `basicauth` | [optional]
15
+ **external_bearer_token** | **String** | Bearer token. Required if `ExternalAuthorizationType` is `bearerauth` | [optional]
16
+ **external_headers** | [**Array<ExternalHeader>**](ExternalHeader.md) | Additional headers. | [optional]
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'DearInventoryRuby'
22
+
23
+ instance = DearInventoryRuby::Webhook.new(id: nil,
24
+ type: nil,
25
+ name: nil,
26
+ is_active: nil,
27
+ external_url: nil,
28
+ external_authorization_type: nil,
29
+ external_user_name: nil,
30
+ external_password: nil,
31
+ external_bearer_token: nil,
32
+ external_headers: nil)
33
+ ```
34
+
35
+
data/docs/Webhooks.md ADDED
@@ -0,0 +1,17 @@
1
+ # DearInventoryRuby::Webhooks
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **webhooks** | [**Array<Webhook>**](Webhook.md) | Array of Webhooks | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'DearInventoryRuby'
13
+
14
+ instance = DearInventoryRuby::Webhooks.new(webhooks: nil)
15
+ ```
16
+
17
+