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:

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 procedure and then run the following code:

Application config

Adding the code bellow in your application.rb file

# 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


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

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
accept_language	String		[optional] [default to en]

3. Create delivery booking api

ResponseDefault deliveries_post(body, opts)

Example


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
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
Deliveree::DelivereeApi	cancel_booking	POST /deliveries/id/cancel
Deliveree::DelivereeApi	deliveries_get_quote	POST /deliveries/get_quote
Deliveree::DelivereeApi	deliveries_post	POST /deliveries

Documentation for Models

Documentation for Authorization

ApiKeyAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header