dear_inventory 0.7.5 → 1.0.0

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.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +15 -0
  3. data/README.md +70 -18
  4. data/dear_inventory.gemspec +1 -1
  5. data/docs/resources/advanced_purchase.md +25 -0
  6. data/docs/resources/customer.md +31 -0
  7. data/docs/resources/product.md +37 -0
  8. data/docs/resources/purchase.md +89 -0
  9. data/docs/resources/sale.md +89 -0
  10. data/lib/dear_inventory.rb +20 -8
  11. data/lib/dear_inventory/config.rb +17 -6
  12. data/lib/dear_inventory/errors/api_limit.rb +6 -0
  13. data/lib/dear_inventory/errors/no_more_pages.rb +6 -0
  14. data/lib/dear_inventory/lib/endpoint_class.rb +1 -1
  15. data/lib/dear_inventory/lib/request.rb +45 -8
  16. data/lib/dear_inventory/lib/strings/urlize.rb +18 -0
  17. data/lib/dear_inventory/model.rb +22 -9
  18. data/lib/dear_inventory/models/advanced_purchase.rb +176 -0
  19. data/lib/dear_inventory/models/customer.rb +1 -1
  20. data/lib/dear_inventory/models/customers.rb +1 -1
  21. data/lib/dear_inventory/models/products.rb +1 -1
  22. data/lib/dear_inventory/models/{purchase_list.rb → purchases.rb} +12 -2
  23. data/lib/dear_inventory/models/purchases/additional_charge.rb +1 -1
  24. data/lib/dear_inventory/models/purchases/advanced/credit_note.rb +21 -0
  25. data/lib/dear_inventory/models/purchases/advanced/invoice.rb +68 -0
  26. data/lib/dear_inventory/models/purchases/advanced/manual_journal.rb +21 -0
  27. data/lib/dear_inventory/models/purchases/advanced/put_away.rb +34 -0
  28. data/lib/dear_inventory/models/purchases/advanced/put_away_line.rb +21 -0
  29. data/lib/dear_inventory/models/purchases/advanced/stock.rb +30 -0
  30. data/lib/dear_inventory/models/purchases/advanced/stock_line.rb +61 -0
  31. data/lib/dear_inventory/models/purchases/credit_note.rb +1 -1
  32. data/lib/dear_inventory/models/purchases/inventory_movement.rb +1 -1
  33. data/lib/dear_inventory/models/purchases/invoice.rb +1 -1
  34. data/lib/dear_inventory/models/purchases/invoice_additional_charge.rb +1 -1
  35. data/lib/dear_inventory/models/purchases/invoice_line.rb +1 -1
  36. data/lib/dear_inventory/models/purchases/line.rb +1 -1
  37. data/lib/dear_inventory/models/purchases/manual_journal.rb +1 -1
  38. data/lib/dear_inventory/models/purchases/manual_journal_line.rb +1 -1
  39. data/lib/dear_inventory/models/purchases/order.rb +1 -1
  40. data/lib/dear_inventory/models/purchases/payment_line.rb +51 -0
  41. data/lib/dear_inventory/models/purchases/stock.rb +1 -1
  42. data/lib/dear_inventory/models/purchases/stock_line.rb +1 -1
  43. data/lib/dear_inventory/models/purchases/unstock_line.rb +1 -1
  44. data/lib/dear_inventory/models/{purchase_lists.rb → purchases_results.rb} +4 -4
  45. data/lib/dear_inventory/models/{sale_list.rb → sales.rb} +7 -2
  46. data/lib/dear_inventory/models/sales/additional_charge.rb +1 -1
  47. data/lib/dear_inventory/models/sales/credit_note.rb +1 -1
  48. data/lib/dear_inventory/models/sales/fulfilment.rb +1 -1
  49. data/lib/dear_inventory/models/sales/fulfilments/pick_pack.rb +1 -1
  50. data/lib/dear_inventory/models/sales/fulfilments/pick_pack_line.rb +1 -1
  51. data/lib/dear_inventory/models/sales/fulfilments/ship.rb +1 -1
  52. data/lib/dear_inventory/models/sales/fulfilments/ship_line.rb +1 -1
  53. data/lib/dear_inventory/models/sales/invoice.rb +1 -1
  54. data/lib/dear_inventory/models/sales/invoice_additional_charge.rb +1 -1
  55. data/lib/dear_inventory/models/sales/invoice_line.rb +1 -1
  56. data/lib/dear_inventory/models/sales/line.rb +1 -1
  57. data/lib/dear_inventory/models/sales/manual_journal.rb +1 -1
  58. data/lib/dear_inventory/models/sales/manual_journal_line.rb +1 -1
  59. data/lib/dear_inventory/models/sales/order.rb +1 -1
  60. data/lib/dear_inventory/models/sales/payment_line.rb +1 -1
  61. data/lib/dear_inventory/models/sales/quote.rb +1 -1
  62. data/lib/dear_inventory/models/{sale_lists.rb → sales_results.rb} +4 -4
  63. data/lib/dear_inventory/parameters/advanced_purchase/show.rb +25 -0
  64. data/lib/dear_inventory/parameters/purchase/index.rb +65 -6
  65. data/lib/dear_inventory/parameters/purchase/show.rb +25 -0
  66. data/lib/dear_inventory/parameters/sale/index.rb +95 -11
  67. data/lib/dear_inventory/parameters/sale/show.rb +35 -0
  68. data/lib/dear_inventory/resource.rb +8 -11
  69. data/lib/dear_inventory/resources/{purchase_list.rb → advanced_purchase.rb} +8 -5
  70. data/lib/dear_inventory/resources/customer.rb +2 -0
  71. data/lib/dear_inventory/resources/product.rb +2 -0
  72. data/lib/dear_inventory/resources/purchase.rb +38 -2
  73. data/lib/dear_inventory/resources/sale.rb +38 -2
  74. data/lib/dear_inventory/response.rb +118 -17
  75. data/lib/dear_inventory/version.rb +1 -1
  76. data/sorbet/rbi/hidden-definitions/hidden.rbi +0 -4
  77. metadata +29 -12
  78. data/lib/dear_inventory/parameters/purchase_list/index.rb +0 -84
  79. data/lib/dear_inventory/parameters/sale_list/index.rb +0 -119
  80. data/lib/dear_inventory/resources/sale_list.rb +0 -24
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dear_inventory
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.5
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Adam Rice
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-04-11 00:00:00.000000000 Z
11
+ date: 2020-04-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: http
@@ -59,7 +59,7 @@ dependencies:
59
59
  - !ruby/object:Gem::Version
60
60
  version: '2.0'
61
61
  - !ruby/object:Gem::Dependency
62
- name: dotenv
62
+ name: byebug
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
65
  - - ">="
@@ -73,7 +73,7 @@ dependencies:
73
73
  - !ruby/object:Gem::Version
74
74
  version: '0'
75
75
  - !ruby/object:Gem::Dependency
76
- name: pry-byebug
76
+ name: dotenv
77
77
  requirement: !ruby/object:Gem::Requirement
78
78
  requirements:
79
79
  - - ">="
@@ -218,11 +218,18 @@ files:
218
218
  - bin/console
219
219
  - bin/setup
220
220
  - dear_inventory.gemspec
221
+ - docs/resources/advanced_purchase.md
222
+ - docs/resources/customer.md
223
+ - docs/resources/product.md
224
+ - docs/resources/purchase.md
225
+ - docs/resources/sale.md
221
226
  - lib/dear_inventory.rb
222
227
  - lib/dear_inventory/config.rb
223
228
  - lib/dear_inventory/environment.rb
224
229
  - lib/dear_inventory/error.rb
230
+ - lib/dear_inventory/errors/api_limit.rb
225
231
  - lib/dear_inventory/errors/bad_request.rb
232
+ - lib/dear_inventory/errors/no_more_pages.rb
226
233
  - lib/dear_inventory/errors/not_paginated.rb
227
234
  - lib/dear_inventory/errors/request.rb
228
235
  - lib/dear_inventory/errors/validation.rb
@@ -230,9 +237,11 @@ files:
230
237
  - lib/dear_inventory/lib/endpoint_class.rb
231
238
  - lib/dear_inventory/lib/is_a_subclass.rb
232
239
  - lib/dear_inventory/lib/request.rb
240
+ - lib/dear_inventory/lib/strings/urlize.rb
233
241
  - lib/dear_inventory/model.rb
234
242
  - lib/dear_inventory/models/additional_attributes.rb
235
243
  - lib/dear_inventory/models/address.rb
244
+ - lib/dear_inventory/models/advanced_purchase.rb
236
245
  - lib/dear_inventory/models/attachment.rb
237
246
  - lib/dear_inventory/models/bill_of_materials_product.rb
238
247
  - lib/dear_inventory/models/bill_of_materials_service.rb
@@ -245,9 +254,15 @@ files:
245
254
  - lib/dear_inventory/models/products.rb
246
255
  - lib/dear_inventory/models/products/movement.rb
247
256
  - lib/dear_inventory/models/purchase.rb
248
- - lib/dear_inventory/models/purchase_list.rb
249
- - lib/dear_inventory/models/purchase_lists.rb
257
+ - lib/dear_inventory/models/purchases.rb
250
258
  - lib/dear_inventory/models/purchases/additional_charge.rb
259
+ - lib/dear_inventory/models/purchases/advanced/credit_note.rb
260
+ - lib/dear_inventory/models/purchases/advanced/invoice.rb
261
+ - lib/dear_inventory/models/purchases/advanced/manual_journal.rb
262
+ - lib/dear_inventory/models/purchases/advanced/put_away.rb
263
+ - lib/dear_inventory/models/purchases/advanced/put_away_line.rb
264
+ - lib/dear_inventory/models/purchases/advanced/stock.rb
265
+ - lib/dear_inventory/models/purchases/advanced/stock_line.rb
251
266
  - lib/dear_inventory/models/purchases/credit_note.rb
252
267
  - lib/dear_inventory/models/purchases/inventory_movement.rb
253
268
  - lib/dear_inventory/models/purchases/invoice.rb
@@ -257,14 +272,15 @@ files:
257
272
  - lib/dear_inventory/models/purchases/manual_journal.rb
258
273
  - lib/dear_inventory/models/purchases/manual_journal_line.rb
259
274
  - lib/dear_inventory/models/purchases/order.rb
275
+ - lib/dear_inventory/models/purchases/payment_line.rb
260
276
  - lib/dear_inventory/models/purchases/stock.rb
261
277
  - lib/dear_inventory/models/purchases/stock_line.rb
262
278
  - lib/dear_inventory/models/purchases/unstock_line.rb
279
+ - lib/dear_inventory/models/purchases_results.rb
263
280
  - lib/dear_inventory/models/reorder_level.rb
264
281
  - lib/dear_inventory/models/request.rb
265
282
  - lib/dear_inventory/models/sale.rb
266
- - lib/dear_inventory/models/sale_list.rb
267
- - lib/dear_inventory/models/sale_lists.rb
283
+ - lib/dear_inventory/models/sales.rb
268
284
  - lib/dear_inventory/models/sales/additional_charge.rb
269
285
  - lib/dear_inventory/models/sales/credit_note.rb
270
286
  - lib/dear_inventory/models/sales/fulfilment.rb
@@ -281,23 +297,24 @@ files:
281
297
  - lib/dear_inventory/models/sales/order.rb
282
298
  - lib/dear_inventory/models/sales/payment_line.rb
283
299
  - lib/dear_inventory/models/sales/quote.rb
300
+ - lib/dear_inventory/models/sales_results.rb
284
301
  - lib/dear_inventory/models/shipping_address.rb
285
302
  - lib/dear_inventory/models/supplier.rb
286
303
  - lib/dear_inventory/models/transaction.rb
287
304
  - lib/dear_inventory/parameters.rb
305
+ - lib/dear_inventory/parameters/advanced_purchase/show.rb
288
306
  - lib/dear_inventory/parameters/customer/index.rb
289
307
  - lib/dear_inventory/parameters/product/index.rb
290
308
  - lib/dear_inventory/parameters/purchase/index.rb
291
- - lib/dear_inventory/parameters/purchase_list/index.rb
309
+ - lib/dear_inventory/parameters/purchase/show.rb
292
310
  - lib/dear_inventory/parameters/sale/index.rb
293
- - lib/dear_inventory/parameters/sale_list/index.rb
311
+ - lib/dear_inventory/parameters/sale/show.rb
294
312
  - lib/dear_inventory/resource.rb
313
+ - lib/dear_inventory/resources/advanced_purchase.rb
295
314
  - lib/dear_inventory/resources/customer.rb
296
315
  - lib/dear_inventory/resources/product.rb
297
316
  - lib/dear_inventory/resources/purchase.rb
298
- - lib/dear_inventory/resources/purchase_list.rb
299
317
  - lib/dear_inventory/resources/sale.rb
300
- - lib/dear_inventory/resources/sale_list.rb
301
318
  - lib/dear_inventory/response.rb
302
319
  - lib/dear_inventory/validator.rb
303
320
  - lib/dear_inventory/validators/boolean.rb
@@ -1,84 +0,0 @@
1
- # typed: strict
2
- # frozen_string_literal: true
3
-
4
- module DearInventory
5
- class Parameters
6
- module PurchaseList
7
- class Index < DearInventory::Parameters
8
- extend T::Sig
9
-
10
- fields(
11
- page: {
12
- property: :Page,
13
- type: :Integer,
14
- required: false,
15
- },
16
- limit: {
17
- property: :Limit,
18
- type: :Integer,
19
- required: false,
20
- },
21
- search: {
22
- property: :Search,
23
- type: :String,
24
- required: false,
25
- },
26
- required_by: {
27
- property: :RequiredBy,
28
- type: :DateTime,
29
- required: false,
30
- },
31
- updated_since: {
32
- property: :UpdatedSince,
33
- type: :DateTime,
34
- required: false,
35
- },
36
- order_status: {
37
- property: :OrderStatus,
38
- type: :Enum,
39
- values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE"],
40
- required: false,
41
- },
42
- restock_received_status: {
43
- property: :RestockReceivedStatus,
44
- type: :String,
45
- required: false,
46
- },
47
- invoice_status: {
48
- property: :InvoiceStatus,
49
- type: :Enum,
50
- values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE"],
51
- required: false,
52
- },
53
- credit_note_status: {
54
- property: :CreditNoteStatus,
55
- type: :Enum,
56
- values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE"],
57
- required: false,
58
- },
59
- unstock_status: {
60
- property: :UnstockStatus,
61
- type: :Enum,
62
- values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE"],
63
- required: false,
64
- },
65
- status: {
66
- property: :Status,
67
- type: :Enum,
68
- values: [
69
- "DRAFT", "VOIDED", "ORDERING", "ORDERED", "RECEIVING", "RECEIVED",
70
- "INVOICED", "CREDITED", "RECEIVING / CREDITED",
71
- "RECEIVED / CREDITED", "PARTIALLY INVOICED", "COMPLETED",
72
- ],
73
- required: false,
74
- },
75
- drop_ship_task_id: {
76
- property: :DropShipTaskID,
77
- type: :Guid,
78
- required: false,
79
- }
80
- )
81
- end
82
- end
83
- end
84
- end
@@ -1,119 +0,0 @@
1
- # typed: strict
2
- # frozen_string_literal: true
3
-
4
- module DearInventory
5
- class Parameters
6
- module SaleList
7
- class Index < DearInventory::Parameters
8
- extend T::Sig
9
-
10
- fields(
11
- page: {
12
- property: :Page,
13
- type: :Integer,
14
- required: false,
15
- },
16
- limit: {
17
- property: :Limit,
18
- type: :Integer,
19
- required: false,
20
- },
21
- search: {
22
- property: :Search,
23
- type: :String,
24
- required: false,
25
- },
26
- created_since: {
27
- property: :CreatedSince,
28
- type: :DateTime,
29
- required: false,
30
- },
31
- updated_since: {
32
- property: :UpdatedSince,
33
- type: :DateTime,
34
- required: false,
35
- },
36
- ship_by: {
37
- property: :ShipBy,
38
- type: :DateTime,
39
- required: false,
40
- },
41
- quote_status: {
42
- property: :QuoteStatus,
43
- type: :Enum,
44
- values: ["NOT AVAILABLE", "DRAFT", "AUTHORISED", "VOIDED"],
45
- required: false,
46
- },
47
- order_status: {
48
- property: :OrderStatus,
49
- type: :Enum,
50
- values: [
51
- "NOT AVAILABLE", "DRAFT", "AUTHORISED", "VOIDED", "AUTH_NO_ALLOC",
52
- "FULFILLED", "CLOSED",
53
- ],
54
- required: false,
55
- },
56
- combined_pick_status: {
57
- property: :CombinedPickStatus,
58
- type: :Enum,
59
- values: [
60
- "VOIDED", "NOT AVAILABLE", "PICKED", "PICKING", "NOT PICKED",
61
- "PARTIALLY PICKED",
62
- ],
63
- required: false,
64
- },
65
- combined_pack_status: {
66
- property: :CombinedPackStatus,
67
- type: :Enum,
68
- values: [
69
- "VOIDED", "NOT AVAILABLE", "PACKED", "PACKING", "NOT PACKED",
70
- "PARTIALLY PACKED",
71
- ],
72
- required: false,
73
- },
74
- combined_shipp_status: {
75
- property: :CombinedShippStatus,
76
- type: :Enum,
77
- values: [
78
- "VOIDED", "NOT AVAILABLE", "SHIPPED", "SHIPPING", "NOT SHIPPED",
79
- "PARTIALLY SHIPPED",
80
- ],
81
- required: false,
82
- },
83
- combined_invoice_status: {
84
- property: :CombinedInvoiceStatus,
85
- type: :Enum,
86
- values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE", "PAID"],
87
- required: false,
88
- },
89
- credit_note_status: {
90
- property: :CreditNoteStatus,
91
- type: :Enum,
92
- values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE"],
93
- required: false,
94
- },
95
- external_id: {
96
- property: :ExternalID,
97
- type: :String,
98
- required: false,
99
- },
100
- status: {
101
- property: :Status,
102
- type: :Enum,
103
- values: %w[
104
- DRAFT VOIDED ESTIMATING ESTIMATED ORDERING ORDERED BACKORDERED
105
- PICKING PICKED PACKING PACKED SHIPPING INVOICING INVOICED CREDITED
106
- COMPLETED
107
- ],
108
- required: false,
109
- },
110
- ready_for_shipping: {
111
- property: :ReadyForShipping,
112
- type: :Boolean,
113
- required: false,
114
- }
115
- )
116
- end
117
- end
118
- end
119
- end
@@ -1,24 +0,0 @@
1
- # typed: strict
2
- # frozen_string_literal: true
3
-
4
- module DearInventory
5
- class SaleList < Resource
6
- class << self
7
- extend T::Sig
8
-
9
- # Sale List
10
- #
11
- # @param params [Hash] URL query string parameters that conform to
12
- # DearInventory::Parameters::SaleList::Index
13
- sig do
14
- params(params: T::Hash[Symbol, T.untyped]).
15
- returns(DearInventory::Response)
16
- end
17
- def index(params = {})
18
- new.request(
19
- :get, params: params, model: DearInventory::Models::SaleLists
20
- )
21
- end
22
- end
23
- end
24
- end