deliveree_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 771d30372fca7c547f44fa62e3433261449a7165216a5275cb43582fe76565b6
+  data.tar.gz: 24d37298e0b48a4f324ab49e06bae1f8836c278cc2ce8778ede33b6e4d7892ba
+SHA512:
+  metadata.gz: df3144092c6e870e12ad370304a8d13a07e96a3e7b8ce65f08876363e29e516f73f255dbbb68ebb72e15e00d701eb2011b7fe5ebfa10708308bd53e55aa79aa2
+  data.tar.gz: b807f3ccedae3b145ea8271315d8ebf1220a8b7413596e6a399e09a0d849556162df10b50cb31a04a54d4e5ab9aac81b0f113b2734021159743a15074a3575f7

data/BUILD_GEM.md

@@ -0,0 +1,11 @@
+# Deliverree SDK build gem
+
+### Build a gem 
+
+Run command to build the Ruby code into a gem:
+
+```shell
+bundle install
+
+gem build deliveree_sdk.gemspec
+```

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    deliveree_sdk (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.11.3)
+    json (2.2.0)
+    rake (12.0.0)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  deliveree_sdk!
+  rake (~> 12.0.0)
+  vcr (~> 3.0, >= 3.0.1)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,153 @@
+# Deliveree SDK guidelines
+
+Deliveree - the Ruby gem for the Deliveree SDK
+
+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.
+
+- API version: 1.0.0
+- Package version: 1.0.0
+## Installation
+
+### Install the gem locally:
+
+```shell
+gem install ./deliveree_sdk-1.0.0.gem
+```
+(for development, run `gem install --dev ./deliveree_sdk-1.0.0.gem` to install the development dependencies)
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+### Application config
+Adding the code bellow in your application.rb file
+```ruby
+# Load the gem in your application
+require 'deliveree_sdk'
+
+# setup authorization
+Deliveree.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+end
+
+```
+
+# **1. Cancel booking api**
+> cancel_booking(id, opts)
+
+### Example
+```ruby
+
+api_instance = Deliveree::DelivereeApi.new
+id = 56 # Integer | ID of delivery
+
+opts = { 
+  accept_language: 'en' # String | 
+}
+
+begin
+  api_instance.cancel_booking(id, opts)
+rescue Deliveree::ApiError => e
+  puts "Exception when calling DelivereeApi->cancel_booking: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of delivery | 
+ **accept_language** | **String**|  | [optional] [default to en]
+
+### Return type
+
+nil (empty response body)
+
+# **2. Deliveries get quote api**
+> ResponseWithData deliveries_get_quote(body, opts)
+
+### Example
+```ruby
+api_instance = Deliveree::DelivereeApi.new
+
+body = Deliveree::Quote.new # Quote | 
+
+opts = { 
+  accept_language: 'en' # String | 
+}
+
+begin
+  result = api_instance.deliveries_get_quote(body, opts)
+  p result
+rescue Deliveree::ApiError => e
+  puts "Exception when calling DelivereeApi->deliveries_get_quote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Quote**](Quote.md)|  | 
+ **accept_language** | **String**|  | [optional] [default to en]
+
+
+# **3. Create delivery booking api**
+> ResponseDefault deliveries_post(body, opts)
+
+### Example
+```ruby
+
+api_instance = Deliveree::DelivereeApi.new
+
+body = Deliveree::Delivery.new # Delivery | 
+
+opts = { 
+  accept_language: 'en' # String | 
+}
+
+begin
+  result = api_instance.deliveries_post(body, opts)
+  p result
+rescue Deliveree::ApiError => e
+  puts "Exception when calling DelivereeApi->deliveries_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Delivery**](Delivery.md)|  | 
+ **accept_language** | **String**|  | [optional] [default to en]
+
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https:api.sandbox.deliveree.com//public_api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Deliveree::DelivereeApi* | [**cancel_booking**](docs/DelivereeApi.md#cancel_booking) | **POST** /deliveries/{id}/cancel | 
+*Deliveree::DelivereeApi* | [**deliveries_get_quote**](docs/DelivereeApi.md#deliveries_get_quote) | **POST** /deliveries/get_quote | 
+*Deliveree::DelivereeApi* | [**deliveries_post**](docs/DelivereeApi.md#deliveries_post) | **POST** /deliveries | 
+
+
+## Documentation for Models
+
+ - [Deliveree::Delivery](docs/Delivery.md)
+ - [Deliveree::Location](docs/Location.md)
+ - [Deliveree::PositionTracking](docs/PositionTracking.md)
+ - [Deliveree::Quote](docs/Quote.md)
+
+
+## Documentation for Authorization
+
+
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/deliveree_sdk.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+=begin
+#Deliveree SDK
+#With Deliveree API, developers can integrate our on-demand local delivery platform into their applications. The API is designed for developers to check prices, book an immediate or scheduled delivery and follow updates until delivery completion.
+Contact: duke@deliveree.com
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "deliveree_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "deliveree_sdk"
+  s.version     = Deliveree::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["TMA Team"]
+  s.email       = ["duke@deliveree.com"]
+  s.homepage    = "http://deliveree.com"
+  s.summary     = "Deliveree SDK "
+  s.description = "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"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/DelivereeApi.md

@@ -0,0 +1,153 @@
+# Deliveree::DelivereeApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_booking**](DelivereeApi.md#cancel_booking) | **POST** /deliveries/{id}/cancel | 
+[**deliveries_get_quote**](DelivereeApi.md#deliveries_get_quote) | **POST** /deliveries/get_quote | 
+[**deliveries_post**](DelivereeApi.md#deliveries_post) | **POST** /deliveries | 
+
+
+# **cancel_booking**
+> cancel_booking(id, opts)
+
+
+### Example
+```ruby
+# load the gem
+require 'deliveree_sdk'
+# setup authorization
+Deliveree.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+end
+
+api_instance = Deliveree::DelivereeApi.new
+
+id = 56 # Integer | ID of delivery
+
+opts = { 
+  accept_language: 'en' # String | 
+}
+
+begin
+  api_instance.cancel_booking(id, opts)
+rescue Deliveree::ApiError => e
+  puts "Exception when calling DelivereeApi->cancel_booking: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of delivery | 
+ **accept_language** | **String**|  | [optional] [default to en]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **deliveries_get_quote**
+> ResponseWithData deliveries_get_quote(body, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'deliveree_sdk'
+# setup authorization
+Deliveree.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+end
+
+api_instance = Deliveree::DelivereeApi.new
+
+body = Deliveree::Quote.new # Quote | 
+
+opts = { 
+  accept_language: 'en' # String | 
+}
+
+begin
+  result = api_instance.deliveries_get_quote(body, opts)
+  p result
+rescue Deliveree::ApiError => e
+  puts "Exception when calling DelivereeApi->deliveries_get_quote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Quote**](Quote.md)|  | 
+ **accept_language** | **String**|  | [optional] [default to en]
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+# **deliveries_post**
+> ResponseDefault deliveries_post(body, opts)
+
+
+### Example
+```ruby
+# load the gem
+require 'deliveree_sdk'
+# setup authorization
+Deliveree.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+end
+
+api_instance = Deliveree::DelivereeApi.new
+
+body = Deliveree::Delivery.new # Delivery | 
+
+opts = { 
+  accept_language: 'en' # String | 
+}
+
+begin
+  result = api_instance.deliveries_post(body, opts)
+  p result
+rescue Deliveree::ApiError => e
+  puts "Exception when calling DelivereeApi->deliveries_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Delivery**](Delivery.md)|  | 
+ **accept_language** | **String**|  | [optional] [default to en]
+
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Delivery.md

@@ -0,0 +1,18 @@
+# Deliveree::Delivery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vehicle_type_id** | **Integer** |  | [required] 
+**note** | **String** |  | [optional] 
+**time_type** | **String** |  | [required] 
+**pickup_time** | **DateTime** |  | [optional] 
+**job_order_number** | **String** |  | [optional] 
+**allow_parking_fees** | **BOOLEAN** |  | [optional] 
+**allow_tolls_fees** | **BOOLEAN** |  | [optional] 
+**allow_waiting_time_fees** | **BOOLEAN** |  | [optional] 
+**fleet_partner_id** | **Integer** |  | [optional] 
+**container_size** | **String** |  | [optional] 
+**locations** | [**Array<Location>**](Location.md) |  | [required] 
+
+

data/docs/Location.md

@@ -0,0 +1,19 @@
+# Deliveree::Location
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** |  | [required] 
+**latitude** | **Float** |  | [required] 
+**longitude** | **Float** |  | [required] 
+**recipient_name** | **String** |  | [required] 
+**recipient_phone** | **String** |  | [required] 
+**note** | **String** |  | [optional] 
+**need_cod** | **BOOLEAN** |  | [optional] 
+**cod_note** | **String** |  | [optional] 
+**cod_invoice_fees** | **Float** |  | [optional] 
+**need_pod** | **BOOLEAN** |  | [optional] 
+**pod_note** | **String** |  | [optional] 
+**position_trackings** | [**Array<PositionTracking>**](PositionTracking.md) |  | [optional] 
+
+