siwapp-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8888467300043fff4ae81a39dc2dc4ff8b2cb32d
+  data.tar.gz: 140fb1e8fd8bdbf2b6fce52ce6a07eb520c1585f
+SHA512:
+  metadata.gz: 4285c800c96593de8bf00c8a4189b9562819d455e45a63a32f361febf6a89528fb0a14242d908812243f3f307697beaf1692fe18183fb4d354ac7bdee3698d4a
+  data.tar.gz: 1e6342a49c6202eabb03919e0c6569660d156f450accd74ac5e4aa73f3ef49929e02276d1fd5aeeccdafa90e013f9748717a3df9c2d1035cb65e7c72d8b6f2aa

data/Gemfile

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

data/README.md

@@ -0,0 +1,112 @@
+# 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](https://github.com/swagger-api/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:
+
+```shell
+gem build siwapp-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# 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**](docs/DefaultApi.md#create_invoice) | **POST** /invoices | 
+*SiwappClient::DefaultApi* | [**get_invoice_pdf**](docs/DefaultApi.md#get_invoice_pdf) | **GET** /invoices/print_template/{template_id}/invoice/{id}?format=pdf | 
+
+
+## Documentation for Models
+
+ - [SiwappClient::Invoice](docs/Invoice.md)
+ - [SiwappClient::InvoiceData](docs/InvoiceData.md)
+ - [SiwappClient::InvoiceDataAttributes](docs/InvoiceDataAttributes.md)
+ - [SiwappClient::InvoiceDataMeta](docs/InvoiceDataMeta.md)
+ - [SiwappClient::InvoiceDataRelationships](docs/InvoiceDataRelationships.md)
+ - [SiwappClient::InvoiceDataRelationshipsItems](docs/InvoiceDataRelationshipsItems.md)
+ - [SiwappClient::InvoiceDataRelationshipsPayments](docs/InvoiceDataRelationshipsPayments.md)
+ - [SiwappClient::InvoiceItem](docs/InvoiceItem.md)
+ - [SiwappClient::InvoiceItemAttributes](docs/InvoiceItemAttributes.md)
+ - [SiwappClient::InvoicePayment](docs/InvoicePayment.md)
+ - [SiwappClient::InvoicePaymentAttributes](docs/InvoicePaymentAttributes.md)
+
+
+## Documentation for Authorization
+
+
+### Token
+
+- **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/docs/DefaultApi.md

@@ -0,0 +1,119 @@
+# SiwappClient::DefaultApi
+
+All URIs are relative to *https://siwapp.ifni.sology.eu/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_invoice**](DefaultApi.md#create_invoice) | **POST** /invoices | 
+[**get_invoice_pdf**](DefaultApi.md#get_invoice_pdf) | **GET** /invoices/print_template/{template_id}/invoice/{id}?format=pdf | 
+
+
+# **create_invoice**
+> Invoice create_invoice(invoice)
+
+
+
+Creating invoice.
+
+### Example
+```ruby
+# 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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **invoice** | [**Invoice**](Invoice.md)| Invoice. | 
+
+### Return type
+
+[**Invoice**](Invoice.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_invoice_pdf**
+> File get_invoice_pdf(template_id, id)
+
+
+
+Get invoice in pdf file.
+
+### Example
+```ruby
+# 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
+
+template_id = 789 # Integer | ID of print template
+
+id = 789 # Integer | ID of invoice
+
+
+begin
+  result = api_instance.get_invoice_pdf(template_id, id)
+  p result
+rescue SiwappClient::ApiError => e
+  puts "Exception when calling DefaultApi->get_invoice_pdf: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **Integer**| ID of print template | 
+ **id** | **Integer**| ID of invoice | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Invoice.md

@@ -0,0 +1,8 @@
+# SiwappClient::Invoice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**InvoiceData**](InvoiceData.md) |  | [optional] 
+
+

data/docs/InvoiceData.md

@@ -0,0 +1,11 @@
+# SiwappClient::InvoiceData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Invoice ID. | [optional] 
+**attributes** | [**InvoiceDataAttributes**](InvoiceDataAttributes.md) |  | [optional] 
+**meta** | [**InvoiceDataMeta**](InvoiceDataMeta.md) |  | [optional] 
+**relationships** | [**InvoiceDataRelationships**](InvoiceDataRelationships.md) |  | [optional] 
+
+

data/docs/InvoiceDataAttributes.md

@@ -0,0 +1,13 @@
+# SiwappClient::InvoiceDataAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Customer's (company) name. | 
+**invoicing_address** | **String** | Customer's (company) invoicing address. | [optional] 
+**issue_date** | **String** | Invoice's issue date. Eg '2017-08-08' | [optional] 
+**series_id** | **Integer** | Series ID for numbering invoices (has to be set in Siwapp first). | 
+**currency** | **String** | Eg 'gbp' | [optional] 
+**status** | **String** | Inoice status. | [optional] 
+
+

data/docs/InvoiceDataMeta.md

@@ -0,0 +1,8 @@
+# SiwappClient::InvoiceDataMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**issued_by** | **String** | Who issued an invoice possibly with an email address. | [optional] 
+
+

data/docs/InvoiceDataRelationships.md

@@ -0,0 +1,9 @@
+# SiwappClient::InvoiceDataRelationships
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**InvoiceDataRelationshipsItems**](InvoiceDataRelationshipsItems.md) |  | [optional] 
+**payments** | [**InvoiceDataRelationshipsPayments**](InvoiceDataRelationshipsPayments.md) |  | [optional] 
+
+

data/docs/InvoiceDataRelationshipsItems.md

@@ -0,0 +1,8 @@
+# SiwappClient::InvoiceDataRelationshipsItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<InvoiceItem>**](InvoiceItem.md) |  | [optional] 
+
+

data/docs/InvoiceDataRelationshipsPayments.md

@@ -0,0 +1,8 @@
+# SiwappClient::InvoiceDataRelationshipsPayments
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<InvoicePayment>**](InvoicePayment.md) |  | [optional] 
+
+

data/docs/InvoiceItem.md

@@ -0,0 +1,8 @@
+# SiwappClient::InvoiceItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**InvoiceItemAttributes**](InvoiceItemAttributes.md) |  | [optional] 
+
+

data/docs/InvoiceItemAttributes.md

@@ -0,0 +1,12 @@
+# SiwappClient::InvoiceItemAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Items' description. | [optional] 
+**quantity** | **Integer** | Items' quantity. | [optional] 
+**discount** | **Integer** | Items' discount (eg 22 equals 22% discount). | [optional] 
+**tax_ids** | **Array<Integer>** | Array of tax ids (have to be already defined in Siwapp). | 
+**unitary_cost** | **Float** | Items' unitary cost. | [optional] 
+
+

data/docs/InvoicePayment.md

@@ -0,0 +1,8 @@
+# SiwappClient::InvoicePayment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**InvoicePaymentAttributes**](InvoicePaymentAttributes.md) |  | [optional] 
+
+

data/docs/InvoicePaymentAttributes.md

@@ -0,0 +1,10 @@
+# SiwappClient::InvoicePaymentAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notes** | **String** | Payment's notes. | [optional] 
+**amount** | **Float** | Payment's amount. | [optional] 
+**date** | **String** | Payment's date eg '2017-02-03'. | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/siwapp-client.rb

@@ -0,0 +1,51 @@
+=begin
+#Siwapp API Client
+
+#Access Siwapp data via API.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+# Common files
+require 'siwapp-client/api_client'
+require 'siwapp-client/api_error'
+require 'siwapp-client/version'
+require 'siwapp-client/configuration'
+
+# Models
+require 'siwapp-client/models/invoice'
+require 'siwapp-client/models/invoice_data'
+require 'siwapp-client/models/invoice_data_attributes'
+require 'siwapp-client/models/invoice_data_meta'
+require 'siwapp-client/models/invoice_data_relationships'
+require 'siwapp-client/models/invoice_data_relationships_items'
+require 'siwapp-client/models/invoice_data_relationships_payments'
+require 'siwapp-client/models/invoice_item'
+require 'siwapp-client/models/invoice_item_attributes'
+require 'siwapp-client/models/invoice_payment'
+require 'siwapp-client/models/invoice_payment_attributes'
+
+# APIs
+require 'siwapp-client/api/default_api'
+
+module SiwappClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SiwappClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end