deliveree_sdk 1.0.0 → 1.0.1
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/README.md +22 -15
- data/deliveree_sdk-1.0.0.gem +0 -0
- data/deliveree_sdk.gemspec +1 -1
- data/lib/deliveree_client/version.rb +1 -1
- metadata +5 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bd7ee6d1c1f8ad22f946d69cb5efd6093e0b89115c49266acc3ff8963763fb87
|
4
|
+
data.tar.gz: f34d8e759f0985ae5c5e710199e2d1298a8480ec93e2bc510b51e6ddfdbc8674
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8a57872586afb9512c47a1ed9ec4edb3126fe1e065f6ab6e03b80b2ae8e050a38a01bbeb77d092a9ca32be69122d0f985f619c1cb9baa31df36a0fcb059c7a4d
|
7
|
+
data.tar.gz: fa13be845d0d54e7a30c1ff8ced9e565b46524e20dc896ec59b589af3fea2ea972880b7dda3b94ccd5bcab7905f340cd803e0eae147bc9e38912fab00c725886
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
# Deliveree SDK
|
1
|
+
# Deliveree SDK guideline
|
2
2
|
|
3
|
-
Deliveree -
|
3
|
+
Deliveree - The Ruby gem for the Deliveree SDK
|
4
4
|
|
5
5
|
With Deliveree SDK, developers can integrate our on-demand local delivery platform into their applications. The SDK is designed for developers to check prices, book an immediate or scheduled delivery and follow updates until delivery completion.
|
6
6
|
|
@@ -9,18 +9,25 @@ With Deliveree SDK, developers can integrate our on-demand local delivery platfo
|
|
9
9
|
## Installation
|
10
10
|
|
11
11
|
### Install the gem locally:
|
12
|
+
Please follow 2 step bellow.
|
12
13
|
|
14
|
+
1 . Adding SDK into Gemfile in your project follow command bellow.
|
15
|
+
```shell script
|
16
|
+
# Require sdk into Gemfile
|
17
|
+
gem 'deliveree_sdk', '~> 1.0.0'
|
18
|
+
```
|
19
|
+
2 . Run command install `deliveree_sdk` from your local directory. Make sure this SDK available in your computer.
|
13
20
|
```shell
|
14
|
-
|
21
|
+
#Install sdk from local compute in to your project
|
22
|
+
gem install ~/Local_path/deliveree_sdk-1.0.0.gem
|
15
23
|
```
|
16
|
-
(for development, run `gem install --dev ./deliveree_sdk-1.0.0.gem` to install the development dependencies)
|
17
24
|
|
18
25
|
## Getting Started
|
19
26
|
|
20
27
|
Please follow the [installation](#installation) procedure and then run the following code:
|
21
28
|
|
22
29
|
### Application config
|
23
|
-
Adding the code bellow in your application.rb file
|
30
|
+
Adding the code bellow in your `Project/config/application.rb` file.
|
24
31
|
```ruby
|
25
32
|
# Load the gem in your application
|
26
33
|
require 'deliveree_sdk'
|
@@ -33,7 +40,7 @@ end
|
|
33
40
|
|
34
41
|
```
|
35
42
|
|
36
|
-
# **1. Cancel booking
|
43
|
+
# **1. Cancel booking**
|
37
44
|
> cancel_booking(id, opts)
|
38
45
|
|
39
46
|
### Example
|
@@ -58,13 +65,13 @@ end
|
|
58
65
|
Name | Type | Description | Notes
|
59
66
|
------------- | ------------- | ------------- | -------------
|
60
67
|
**id** | **Integer**| ID of delivery |
|
61
|
-
**accept_language** | **String**|
|
68
|
+
**accept_language** | **String**| en
|
62
69
|
|
63
70
|
### Return type
|
64
71
|
|
65
72
|
nil (empty response body)
|
66
73
|
|
67
|
-
# **2. Deliveries get quote
|
74
|
+
# **2. Deliveries get quote**
|
68
75
|
> ResponseWithData deliveries_get_quote(body, opts)
|
69
76
|
|
70
77
|
### Example
|
@@ -78,8 +85,8 @@ opts = {
|
|
78
85
|
}
|
79
86
|
|
80
87
|
begin
|
81
|
-
result = api_instance.deliveries_get_quote(body, opts)
|
82
|
-
|
88
|
+
@result = api_instance.deliveries_get_quote(body, opts)
|
89
|
+
puts @result
|
83
90
|
rescue Deliveree::ApiError => e
|
84
91
|
puts "Exception when calling DelivereeApi->deliveries_get_quote: #{e}"
|
85
92
|
end
|
@@ -90,10 +97,10 @@ end
|
|
90
97
|
Name | Type | Description | Notes
|
91
98
|
------------- | ------------- | ------------- | -------------
|
92
99
|
**body** | [**Quote**](Quote.md)| |
|
93
|
-
**accept_language** | **String**|
|
100
|
+
**accept_language** | **String**| en |
|
94
101
|
|
95
102
|
|
96
|
-
# **3. Create delivery booking
|
103
|
+
# **3. Create delivery booking**
|
97
104
|
> ResponseDefault deliveries_post(body, opts)
|
98
105
|
|
99
106
|
### Example
|
@@ -108,8 +115,8 @@ opts = {
|
|
108
115
|
}
|
109
116
|
|
110
117
|
begin
|
111
|
-
result = api_instance.deliveries_post(body, opts)
|
112
|
-
|
118
|
+
@result = api_instance.deliveries_post(body, opts)
|
119
|
+
puts @result
|
113
120
|
rescue Deliveree::ApiError => e
|
114
121
|
puts "Exception when calling DelivereeApi->deliveries_post: #{e}"
|
115
122
|
end
|
@@ -120,7 +127,7 @@ end
|
|
120
127
|
Name | Type | Description | Notes
|
121
128
|
------------- | ------------- | ------------- | -------------
|
122
129
|
**body** | [**Delivery**](Delivery.md)| |
|
123
|
-
**accept_language** | **String**| |
|
130
|
+
**accept_language** | **String**| |
|
124
131
|
|
125
132
|
|
126
133
|
## Documentation for API Endpoints
|
Binary file
|
data/deliveree_sdk.gemspec
CHANGED
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
|
|
12
12
|
s.name = "deliveree_sdk"
|
13
13
|
s.version = Deliveree::VERSION
|
14
14
|
s.platform = Gem::Platform::RUBY
|
15
|
-
s.authors = ["
|
15
|
+
s.authors = ["Deliveree"]
|
16
16
|
s.email = ["duke@deliveree.com"]
|
17
17
|
s.homepage = "http://deliveree.com"
|
18
18
|
s.summary = "Deliveree SDK "
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: deliveree_sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
|
-
-
|
7
|
+
- Deliveree
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-06-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -84,6 +84,7 @@ files:
|
|
84
84
|
- Gemfile.lock
|
85
85
|
- README.md
|
86
86
|
- Rakefile
|
87
|
+
- deliveree_sdk-1.0.0.gem
|
87
88
|
- deliveree_sdk.gemspec
|
88
89
|
- docs/DelivereeApi.md
|
89
90
|
- docs/Delivery.md
|
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
123
124
|
version: '0'
|
124
125
|
requirements: []
|
125
126
|
rubyforge_project:
|
126
|
-
rubygems_version: 2.7.
|
127
|
+
rubygems_version: 2.7.6
|
127
128
|
signing_key:
|
128
129
|
specification_version: 4
|
129
130
|
summary: Deliveree SDK
|