siwapp-client

SiwappClient - the Ruby gem for the Siwapp API Client

Access Siwapp data via API.

This SDK is automatically generated by the Swagger Codegen project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build siwapp-client.gemspec

Then either install the gem locally:

gem install ./siwapp-client-1.0.0.gem

(for development, run gem install --dev ./siwapp-client-1.0.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 'siwapp-client', '~> 1.0.0'

Install from Git

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

gem 'siwapp-client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.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 'siwapp-client'

# Setup authorization
SiwappClient.configure do |config|
  # Configure API key authorization: Token
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SiwappClient::DefaultApi.new

invoice = SiwappClient::Invoice.new # Invoice | Invoice.


begin
  result = api_instance.create_invoice(invoice)
  p result
rescue SiwappClient::ApiError => e
  puts "Exception when calling DefaultApi->create_invoice: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://siwapp.ifni.sology.eu/api/v1

Class	Method	HTTP request	Description
SiwappClient::DefaultApi	create_invoice	POST /invoices
SiwappClient::DefaultApi	get_invoice_pdf	GET /invoices/print_template/template_id/invoice/id?format=pdf

Documentation for Models

• SiwappClient::Invoice
• SiwappClient::InvoiceData
• SiwappClient::InvoiceDataAttributes
• SiwappClient::InvoiceDataMeta
• SiwappClient::InvoiceDataRelationships
• SiwappClient::InvoiceDataRelationshipsItems
• SiwappClient::InvoiceDataRelationshipsPayments
• SiwappClient::InvoiceItem
• SiwappClient::InvoiceItemAttributes
• SiwappClient::InvoicePayment
• SiwappClient::InvoicePaymentAttributes

Documentation for Authorization

Token

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