noths

Noths - the Ruby gem for the Noths

www.notonthehighstreet.com API client

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 0.1.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build noths.gemspec

Then either install the gem locally:

gem install ./noths-0.1.0.gem

(for development, run gem install --dev ./noths-0.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'noths', '~> 0.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/veeqo/noths, then add the following in the Gemfile:

gem 'noths', :git => 'https://github.com/veeqo/noths.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'noths'

# Setup authorization
Noths.configure do |config|
  # Configure API key authorization: token
  config.api_key['token'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['token'] = 'Bearer'
end

api_instance = Noths::OrdersApi.new

id = 56 # Integer | Order id

estimated_delivery_date = Date.parse("2013-10-20") # Date | 'yyyy-mm-dd'

estimated_dispatch_at = Date.parse("2013-10-20") # Date | 'yyyy-mm-dd'

opts = { 
  confirmation_note: "confirmation_note_example" # String | 
}

begin
  #Accept an order
  api_instance.orders_acceptance(id, estimated_delivery_date, estimated_dispatch_at, opts)
rescue Noths::ApiError => e
  puts "Exception when calling OrdersApi->orders_acceptance: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
Noths::OrdersApi orders_acceptance POST /api/v1/orders/id/accept Accept an order
Noths::OrdersApi orders_acceptance_bulk POST /api/v1/orders/accept Accept multiple orders
Noths::OrdersApi orders_decline POST /api/v1/orders/id/decline Decline an order
Noths::OrdersApi orders_decline_bulk POST /api/v1/orders/decline Decline multiple orders
Noths::OrdersApi orders_dispatch_note GET /api/v1/orders/id/dispatch_note Generate a dispatch note pdf or gift note pdf.
Noths::OrdersApi orders_dispatch_notes_bulk POST /api/v1/orders/dispatch_notes Generate pdf with dispatch note for each order
Noths::OrdersApi orders_dispatch_order POST /api/v1/orders/id/dispatch Dispatch an order
Noths::OrdersApi orders_dispatch_orders_bulk POST /api/v1/orders/dispatch Dispatch multiple orders
Noths::OrdersApi orders_index GET /api/v1/orders Fetch orders
Noths::OrdersApi orders_invoice GET /api/v1/orders/id/invoice Generate a vat invoice pdf.
Noths::OrdersApi orders_order_details GET /api/v1/orders/id/order_details Generate an order details pdf
Noths::OrdersApi orders_order_details_bulk POST /api/v1/orders/order_details Generate pdf with order details for each order
Noths::OrdersApi orders_show GET /api/v1/orders/id Fetch a single Order
Noths::RefundsApi refunds_create POST /api/v1/orders/order_id/refunds Refund an order

Documentation for Models

Documentation for Authorization

token

  • Type: API key
  • API key parameter name: token
  • Location: URL query string