lightspeed_ruby 0.1.4 → 0.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +24 -6
- data/lib/lightspeed/api/items.rb +4 -0
- data/lib/lightspeed/api/sales.rb +4 -0
- data/lib/lightspeed/client.rb +4 -0
- data/lib/lightspeed/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 24292e2be0e108391527b5a082702ed2469972ca
|
4
|
+
data.tar.gz: 200dca39d1a5bddb8ab0062e196bcbd73993a508
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ba1fb6f34da8fc8035f95e0acb4d7228d533a74ac7fee632783078eb93cd577b6e4b395fd034c9655c6af555b5e2eeca56d740e9c3c40fad20d8f09dc3144943
|
7
|
+
data.tar.gz: fec09d4ad79081243c3cf0e84632f5c0806ef50ec20a74a48068012ae4fa163b12a8b55c319f58ee44d0502c863b7a6597c32b38d9e9c48ae25a714f230db794
|
data/README.md
CHANGED
@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
|
|
9
9
|
Add this line to your application's Gemfile:
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
gem
|
12
|
+
gem "lightspeed_ruby", require: "lightspeed"
|
13
13
|
```
|
14
14
|
|
15
15
|
And then execute:
|
@@ -18,17 +18,35 @@ And then execute:
|
|
18
18
|
|
19
19
|
Or install it yourself as:
|
20
20
|
|
21
|
-
$ gem install
|
21
|
+
$ gem install lightspeed_ruby
|
22
22
|
|
23
23
|
## Usage
|
24
24
|
|
25
|
-
|
25
|
+
Lightspeed ruby follows a namespacing pattern, in which every layer of the
|
26
|
+
Lightspeed's API creates a new namespace.
|
26
27
|
|
27
|
-
|
28
|
+
### Items
|
28
29
|
|
29
|
-
|
30
|
+
**Find an item**
|
30
31
|
|
31
|
-
|
32
|
+
```ruby
|
33
|
+
client.items.find("20")
|
34
|
+
```
|
35
|
+
|
36
|
+
**Create an item**
|
37
|
+
|
38
|
+
```ruby
|
39
|
+
client.items.create(description: "blah blah", itemType: "non_inventory")
|
40
|
+
```
|
41
|
+
|
42
|
+
### Relations
|
43
|
+
|
44
|
+
Whenever the API allows it, you can ask for certain relations to be sideloaded.
|
45
|
+
For example, you may wish to get the category of an item.
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
client.items.find("20", with: [:category])
|
49
|
+
```
|
32
50
|
|
33
51
|
## Contributing
|
34
52
|
|
data/lib/lightspeed/api/items.rb
CHANGED
data/lib/lightspeed/api/sales.rb
CHANGED
data/lib/lightspeed/client.rb
CHANGED
data/lib/lightspeed/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: lightspeed_ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Zamith
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-07-
|
11
|
+
date: 2017-07-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|