dear_inventory 1.2.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/dear_inventory.gemspec +2 -1
- data/docs/resources/sale.md +28 -0
- data/lib/dear_inventory/lib/date_time.rb +1 -1
- data/lib/dear_inventory/lib/request.rb +1 -1
- data/lib/dear_inventory/parameters/sale/delete.rb +25 -0
- data/lib/dear_inventory/resources/sale.rb +20 -3
- data/lib/dear_inventory/version.rb +1 -1
- data/lib/dear_inventory.rb +1 -0
- metadata +25 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c9c77cee55f30ac5aa4b5484b178363db30d6663eb172ba429d3be826ac37219
|
4
|
+
data.tar.gz: 115c30635a886a41f6c93d3e8bb063679a97c39ae9d336c839105d396a5bc0bb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e1765c2d3e0a524c3c5a1227f78771277e8b9638b0437e036d3ece6f2a543e583e72b6b90026aa61a96b4569e944b3bd13223ca06a5722da19e364a427405c10
|
7
|
+
data.tar.gz: b117b2fde79191b2a5f160088093b35b8d6941652fcd2bc4c2efe3265689ee3e6374b35e25b2c3de5e1332bd5c7dfddcf6c03cdc889670c0a7e21d7ce7babdf0
|
data/.gitignore
CHANGED
data/dear_inventory.gemspec
CHANGED
@@ -28,12 +28,13 @@ Gem::Specification.new do |spec|
|
|
28
28
|
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
29
29
|
spec.require_paths = ["lib"]
|
30
30
|
|
31
|
-
spec.add_dependency "http", ">=
|
31
|
+
spec.add_dependency "http", ">= 5.0", "< 6.0"
|
32
32
|
spec.add_dependency "sorbet-runtime"
|
33
33
|
|
34
34
|
spec.add_development_dependency "bundler", "~> 2.0"
|
35
35
|
spec.add_development_dependency "byebug"
|
36
36
|
spec.add_development_dependency "dotenv"
|
37
|
+
spec.add_development_dependency "pry-byebug"
|
37
38
|
spec.add_development_dependency "rake", ">= 12.3.3"
|
38
39
|
spec.add_development_dependency "rspec", "~> 3.0"
|
39
40
|
spec.add_development_dependency "rubocop", "~> 0.71"
|
data/docs/resources/sale.md
CHANGED
@@ -87,3 +87,31 @@ response.fields # [:id, :customer, :customer_id, :contact, :phone, :email, :defa
|
|
87
87
|
id = response.id # abcdef01-2345-6789-abcd-ef0123456789
|
88
88
|
```
|
89
89
|
|
90
|
+
|
91
|
+
|
92
|
+
## Delete DELETE
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
DearInventory::Sale.delete
|
96
|
+
```
|
97
|
+
|
98
|
+
### Parameters
|
99
|
+
|
100
|
+
| Name | Type | Required | Default |
|
101
|
+
| --- | --- | --- | --- |
|
102
|
+
| id | String | true | N/A |
|
103
|
+
| void | Boolean | false | false |
|
104
|
+
|
105
|
+
### Response
|
106
|
+
|
107
|
+
A new copy of the record is returned. To see what data is available in the
|
108
|
+
response, you can call the `field` method:
|
109
|
+
|
110
|
+
```ruby
|
111
|
+
response = DearInventory::Sale.delete(
|
112
|
+
id: "abcdef01-2345-6789-abcd-ef0123456789",
|
113
|
+
void: true
|
114
|
+
)
|
115
|
+
response.fields # [:id, :customer, :customer_id, :contact, :phone, :email, :default_account, :skip_quote, :billing_address, :shipping_address, :base_currency, :customer_currency, :tax_rule, :tax_calculation, :terms, :price_tier, :ship_by, :location, :sale_order_date, :last_modified_on, :note, :customer_reference, :cogs_amount, :status, :combined_picking_status, :combined_packing_status, :combined_shipping_status, :fulfilment_status, :combined_invoice_status, :combined_payment_status, :combined_tracking_numbers, :carrier, :currency_rate, :sales_representative, :type, :source_channel, :external_id, :service_only, :quote, :order, :fulfilments, :invoices, :credit_notes, :manual_journals, :additional_attributes, :attachments, :inventory_movements, :transactions]
|
116
|
+
id = response.id # abcdef01-2345-6789-abcd-ef0123456789
|
117
|
+
```
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# typed: strict
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module DearInventory
|
5
|
+
class Parameters
|
6
|
+
module Sale
|
7
|
+
class Delete < DearInventory::Parameters
|
8
|
+
extend T::Sig
|
9
|
+
|
10
|
+
fields(
|
11
|
+
id: {
|
12
|
+
property: :ID,
|
13
|
+
type: :String,
|
14
|
+
required: true,
|
15
|
+
},
|
16
|
+
void: {
|
17
|
+
property: :Void,
|
18
|
+
type: :Boolean,
|
19
|
+
required: false,
|
20
|
+
}
|
21
|
+
)
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -41,6 +41,23 @@ module DearInventory
|
|
41
41
|
params: params
|
42
42
|
)
|
43
43
|
end
|
44
|
+
|
45
|
+
# Sale
|
46
|
+
#
|
47
|
+
# @param params [Hash] URL query string parameters that conform to
|
48
|
+
# DearInventory::Parameters::Sale::Delete
|
49
|
+
sig do
|
50
|
+
params(params: T::Hash[Symbol, T.untyped]).
|
51
|
+
returns(DearInventory::Response)
|
52
|
+
end
|
53
|
+
def delete(params = {})
|
54
|
+
new.request(
|
55
|
+
:delete,
|
56
|
+
endpoint: "delete",
|
57
|
+
model: DearInventory::Models::Sale,
|
58
|
+
params: params
|
59
|
+
)
|
60
|
+
end
|
44
61
|
end
|
45
62
|
|
46
63
|
private
|
@@ -49,9 +66,9 @@ module DearInventory
|
|
49
66
|
def resource_uri(endpoint)
|
50
67
|
case endpoint
|
51
68
|
when "index"
|
52
|
-
self.class.const_get(:URI_BASE)
|
53
|
-
when "show"
|
54
|
-
self.class.const_get(:URI_BASE)
|
69
|
+
"#{self.class.const_get(:URI_BASE)}/salelist"
|
70
|
+
when "show", "delete"
|
71
|
+
"#{self.class.const_get(:URI_BASE)}/sale"
|
55
72
|
end
|
56
73
|
end
|
57
74
|
end
|
data/lib/dear_inventory.rb
CHANGED
@@ -106,6 +106,7 @@ require "dear_inventory/parameters/product/index"
|
|
106
106
|
require "dear_inventory/parameters/product_availability/index"
|
107
107
|
require "dear_inventory/parameters/purchase/index"
|
108
108
|
require "dear_inventory/parameters/purchase/show"
|
109
|
+
require "dear_inventory/parameters/sale/delete"
|
109
110
|
require "dear_inventory/parameters/sale/index"
|
110
111
|
require "dear_inventory/parameters/sale/show"
|
111
112
|
|
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: 1.
|
4
|
+
version: 1.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Adam Rice
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-08-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: http
|
@@ -16,20 +16,20 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
19
|
+
version: '5.0'
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: '
|
22
|
+
version: '6.0'
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version:
|
29
|
+
version: '5.0'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: '
|
32
|
+
version: '6.0'
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: sorbet-runtime
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -86,6 +86,20 @@ dependencies:
|
|
86
86
|
- - ">="
|
87
87
|
- !ruby/object:Gem::Version
|
88
88
|
version: '0'
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: pry-byebug
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - ">="
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '0'
|
96
|
+
type: :development
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - ">="
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '0'
|
89
103
|
- !ruby/object:Gem::Dependency
|
90
104
|
name: rake
|
91
105
|
requirement: !ruby/object:Gem::Requirement
|
@@ -312,6 +326,7 @@ files:
|
|
312
326
|
- lib/dear_inventory/parameters/product_availability/index.rb
|
313
327
|
- lib/dear_inventory/parameters/purchase/index.rb
|
314
328
|
- lib/dear_inventory/parameters/purchase/show.rb
|
329
|
+
- lib/dear_inventory/parameters/sale/delete.rb
|
315
330
|
- lib/dear_inventory/parameters/sale/index.rb
|
316
331
|
- lib/dear_inventory/parameters/sale/show.rb
|
317
332
|
- lib/dear_inventory/resource.rb
|
@@ -381,7 +396,7 @@ homepage: https://morningcoffee.com.au
|
|
381
396
|
licenses:
|
382
397
|
- MIT
|
383
398
|
metadata: {}
|
384
|
-
post_install_message:
|
399
|
+
post_install_message:
|
385
400
|
rdoc_options: []
|
386
401
|
require_paths:
|
387
402
|
- lib
|
@@ -396,8 +411,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
396
411
|
- !ruby/object:Gem::Version
|
397
412
|
version: 1.8.11
|
398
413
|
requirements: []
|
399
|
-
rubygems_version: 3.
|
400
|
-
signing_key:
|
414
|
+
rubygems_version: 3.2.32
|
415
|
+
signing_key:
|
401
416
|
specification_version: 4
|
402
417
|
summary: Library for connecting to the DEAR Inventory API
|
403
418
|
test_files: []
|