pnap_invoicing_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a32817deaf98f40b7bde7e579154b8eb31809d06294e6843338863785b601b62
+  data.tar.gz: 98d2ee76805c252b167388ae87941dc9712c33036d9047ad6c8827941b7ee1dd
+SHA512:
+  metadata.gz: 805036b6f1e81cd471f2bacda5d862aea306319c87fdda326a06cd20b7628e9ee2f29217639cfb1c3bee52d9984ce58c85eecc12a7da0c5d6baa64c458e28d4f
+  data.tar.gz: ca9aa3410d1d4a2063eada1ffbf8440219da161ca65cdbc19abd1c5cba30ff83dcfda2f885015cfaf3e8164e2127b7a9a7fc9ff140e4375f5ee17f3fc48d6f12

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,153 @@
+# pnap_invoicing_api
+
+InvoicingApi - the Ruby gem for the Invoicing API
+
+List, fetch and pay invoices with the Invoicing API.
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+For more information, please visit [https://phoenixnap.com/](https://phoenixnap.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_invoicing_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_invoicing_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_invoicing_api-<VERSION>.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 'pnap_invoicing_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_invoicing_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'InvoicingApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_invoicing_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'InvoicingApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### 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 'pnap_invoicing_api'
+
+# Setup authorization
+InvoicingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+end
+
+api_instance = InvoicingApi::InvoicesApi.new
+opts = {
+  number: '13218-1180326', # String | A user-friendly reference number assigned to the invoice.
+  status: 'PAID', # String | Payment status of the invoice.
+  sent_on_from: Time.parse('2020-04-13T00:00:00.000Z'), # Time | Minimum value to filter invoices by sent on date.
+  sent_on_to: Time.parse('2022-04-13T00:00:00.000Z'), # Time | Maximum value to filter invoices by sent on date.
+  limit: 25, # Integer | The limit of the number of results returned. The number of records returned may be smaller than the limit.
+  offset: 5, # Integer | The number of items to skip in the results.
+  sort_field: 'number', # String | If a sortField is requested, pagination will be done after sorting. Default sorting is by number.
+  sort_direction: 'ASC' # String | Sort Given Field depending on the desired direction. Default sorting is descending.
+}
+
+begin
+  #List invoices.
+  result = api_instance.invoices_get(opts)
+  p result
+rescue InvoicingApi::ApiError => e
+  puts "Exception when calling InvoicesApi->invoices_get: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_invoicing_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+# Setup authorization
+InvoicingApi.configure do |config|
+  # Retrieve the token using OAuth2.
+  client = OAuth2::Client.new(client_id, client_secret, token_url: auth_url)
+  token = client.client_credentials.get_token
+
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = token.token
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/invoicing/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*InvoicingApi::InvoicesApi* | [**invoices_get**](docs/InvoicesApi.md#invoices_get) | **GET** /invoices | List invoices.
+*InvoicingApi::InvoicesApi* | [**invoices_invoice_id_generate_pdf_post**](docs/InvoicesApi.md#invoices_invoice_id_generate_pdf_post) | **POST** /invoices/{invoiceId}/actions/generate-pdf | Generate invoice details as PDF.
+*InvoicingApi::InvoicesApi* | [**invoices_invoice_id_get**](docs/InvoicesApi.md#invoices_invoice_id_get) | **GET** /invoices/{invoiceId} | Get invoice details.
+*InvoicingApi::InvoicesApi* | [**invoices_invoice_id_pay_post**](docs/InvoicesApi.md#invoices_invoice_id_pay_post) | **POST** /invoices/{invoiceId}/actions/pay | Pay an invoice.
+
+
+## Documentation for Models
+
+ - [InvoicingApi::Error](docs/Error.md)
+ - [InvoicingApi::Invoice](docs/Invoice.md)
+ - [InvoicingApi::PaginatedInvoices](docs/PaginatedInvoices.md)
+ - [InvoicingApi::PaginatedResponse](docs/PaginatedResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - invoices: Grants full access to Invoicing API.
+  - invoices.read: Grants read only access to Invoicing API.
+

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/docs/Error.md

@@ -0,0 +1,20 @@
+# InvoicingApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The description detailing the cause of the error code. | [readonly] |
+| **validation_errors** | **Array<String>** | Validation errors, if any. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_invoicing_api'
+
+instance = InvoicingApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/Invoice.md

@@ -0,0 +1,32 @@
+# InvoicingApi::Invoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique resource identifier of the Invoice. |  |
+| **number** | **String** | A user-friendly reference number assigned to the invoice. |  |
+| **currency** | **String** | The currency of the invoice. Currently, this field should be set to `EUR` or `USD`. |  |
+| **amount** | **Float** | The invoice amount. |  |
+| **outstanding_amount** | **Float** | The invoice outstanding amount. |  |
+| **status** | **String** | The status of the invoice. Currently, this field should be set to `PAID`, `OVERDUE`, `PROCESSING_PAYMENT`, or `UNPAID`. |  |
+| **sent_on** | **Time** | Date and time when the invoice was sent. |  |
+| **due_date** | **Time** | Date and time when the invoice payment is due. |  |
+
+## Example
+
+```ruby
+require 'pnap_invoicing_api'
+
+instance = InvoicingApi::Invoice.new(
+  id: 5fa54d1e91867c03a0a7b4a4,
+  number: 34440-2488782,
+  currency: EUR,
+  amount: 100.99,
+  outstanding_amount: 100.99,
+  status: UNPAID,
+  sent_on: 2021-03-13T20:24:32.491Z,
+  due_date: 2021-04-13T20:24:32.491Z
+)
+```
+

data/docs/InvoicesApi.md

@@ -0,0 +1,307 @@
+# InvoicingApi::InvoicesApi
+
+All URIs are relative to *https://api.phoenixnap.com/invoicing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**invoices_get**](InvoicesApi.md#invoices_get) | **GET** /invoices | List invoices. |
+| [**invoices_invoice_id_generate_pdf_post**](InvoicesApi.md#invoices_invoice_id_generate_pdf_post) | **POST** /invoices/{invoiceId}/actions/generate-pdf | Generate invoice details as PDF. |
+| [**invoices_invoice_id_get**](InvoicesApi.md#invoices_invoice_id_get) | **GET** /invoices/{invoiceId} | Get invoice details. |
+| [**invoices_invoice_id_pay_post**](InvoicesApi.md#invoices_invoice_id_pay_post) | **POST** /invoices/{invoiceId}/actions/pay | Pay an invoice. |
+
+
+## invoices_get
+
+> <PaginatedInvoices> invoices_get(opts)
+
+List invoices.
+
+List invoices.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_invoicing_api'
+# setup authorization
+InvoicingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = InvoicingApi::InvoicesApi.new
+opts = {
+  number: '13218-1180326', # String | A user-friendly reference number assigned to the invoice.
+  status: 'PAID', # String | Payment status of the invoice.
+  sent_on_from: Time.parse('2020-04-13T00:00:00.000Z'), # Time | Minimum value to filter invoices by sent on date.
+  sent_on_to: Time.parse('2022-04-13T00:00:00.000Z'), # Time | Maximum value to filter invoices by sent on date.
+  limit: 25, # Integer | The limit of the number of results returned. The number of records returned may be smaller than the limit.
+  offset: 5, # Integer | The number of items to skip in the results.
+  sort_field: 'number', # String | If a sortField is requested, pagination will be done after sorting. Default sorting is by number.
+  sort_direction: 'ASC' # String | Sort Given Field depending on the desired direction. Default sorting is descending.
+}
+
+begin
+  # List invoices.
+  result = api_instance.invoices_get(opts)
+  p result
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_get: #{e}"
+end
+```
+
+#### Using the invoices_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedInvoices>, Integer, Hash)> invoices_get_with_http_info(opts)
+
+```ruby
+begin
+  # List invoices.
+  data, status_code, headers = api_instance.invoices_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedInvoices>
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** | A user-friendly reference number assigned to the invoice. | [optional] |
+| **status** | **String** | Payment status of the invoice. | [optional] |
+| **sent_on_from** | **Time** | Minimum value to filter invoices by sent on date. | [optional] |
+| **sent_on_to** | **Time** | Maximum value to filter invoices by sent on date. | [optional] |
+| **limit** | **Integer** | The limit of the number of results returned. The number of records returned may be smaller than the limit. | [optional][default to 100] |
+| **offset** | **Integer** | The number of items to skip in the results. | [optional][default to 0] |
+| **sort_field** | **String** | If a sortField is requested, pagination will be done after sorting. Default sorting is by number. | [optional][default to &#39;sentOn&#39;] |
+| **sort_direction** | **String** | Sort Given Field depending on the desired direction. Default sorting is descending. | [optional][default to &#39;DESC&#39;] |
+
+### Return type
+
+[**PaginatedInvoices**](PaginatedInvoices.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invoices_invoice_id_generate_pdf_post
+
+> File invoices_invoice_id_generate_pdf_post(invoice_id)
+
+Generate invoice details as PDF.
+
+Generate invoice details as PDF.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_invoicing_api'
+# setup authorization
+InvoicingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = InvoicingApi::InvoicesApi.new
+invoice_id = '5fa54d1e91867c03a0a7b4a4' # String | The unique resource identifier of the Invoice.
+
+begin
+  # Generate invoice details as PDF.
+  result = api_instance.invoices_invoice_id_generate_pdf_post(invoice_id)
+  p result
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_invoice_id_generate_pdf_post: #{e}"
+end
+```
+
+#### Using the invoices_invoice_id_generate_pdf_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> invoices_invoice_id_generate_pdf_post_with_http_info(invoice_id)
+
+```ruby
+begin
+  # Generate invoice details as PDF.
+  data, status_code, headers = api_instance.invoices_invoice_id_generate_pdf_post_with_http_info(invoice_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_invoice_id_generate_pdf_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** | The unique resource identifier of the Invoice. |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
+
+
+## invoices_invoice_id_get
+
+> <Invoice> invoices_invoice_id_get(invoice_id)
+
+Get invoice details.
+
+Get invoice details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_invoicing_api'
+# setup authorization
+InvoicingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = InvoicingApi::InvoicesApi.new
+invoice_id = '5fa54d1e91867c03a0a7b4a4' # String | The unique resource identifier of the Invoice.
+
+begin
+  # Get invoice details.
+  result = api_instance.invoices_invoice_id_get(invoice_id)
+  p result
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_invoice_id_get: #{e}"
+end
+```
+
+#### Using the invoices_invoice_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Invoice>, Integer, Hash)> invoices_invoice_id_get_with_http_info(invoice_id)
+
+```ruby
+begin
+  # Get invoice details.
+  data, status_code, headers = api_instance.invoices_invoice_id_get_with_http_info(invoice_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Invoice>
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_invoice_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** | The unique resource identifier of the Invoice. |  |
+
+### Return type
+
+[**Invoice**](Invoice.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invoices_invoice_id_pay_post
+
+> Object invoices_invoice_id_pay_post(invoice_id, opts)
+
+Pay an invoice.
+
+Manually pay an invoice.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_invoicing_api'
+# setup authorization
+InvoicingApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = InvoicingApi::InvoicesApi.new
+invoice_id = '5fa54d1e91867c03a0a7b4a4' # String | The unique resource identifier of the Invoice.
+opts = {
+  body: { ... } # Object | 
+}
+
+begin
+  # Pay an invoice.
+  result = api_instance.invoices_invoice_id_pay_post(invoice_id, opts)
+  p result
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_invoice_id_pay_post: #{e}"
+end
+```
+
+#### Using the invoices_invoice_id_pay_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> invoices_invoice_id_pay_post_with_http_info(invoice_id, opts)
+
+```ruby
+begin
+  # Pay an invoice.
+  data, status_code, headers = api_instance.invoices_invoice_id_pay_post_with_http_info(invoice_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue InvoicingApi::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_invoice_id_pay_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** | The unique resource identifier of the Invoice. |  |
+| **body** | **Object** |  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PaginatedInvoices.md

@@ -0,0 +1,24 @@
+# InvoicingApi::PaginatedInvoices
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **results** | [**Array<Invoice>**](Invoice.md) |  |  |
+| **limit** | **Integer** | Maximum number of items in the page (actual returned length can be less). |  |
+| **offset** | **Integer** | The number of returned items skipped. |  |
+| **total** | **Integer** | The total number of records available for retrieval. |  |
+
+## Example
+
+```ruby
+require 'pnap_invoicing_api'
+
+instance = InvoicingApi::PaginatedInvoices.new(
+  results: null,
+  limit: 5,
+  offset: 25,
+  total: 400
+)
+```
+

data/docs/PaginatedResponse.md

@@ -0,0 +1,22 @@
+# InvoicingApi::PaginatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Maximum number of items in the page (actual returned length can be less). |  |
+| **offset** | **Integer** | The number of returned items skipped. |  |
+| **total** | **Integer** | The total number of records available for retrieval. |  |
+
+## Example
+
+```ruby
+require 'pnap_invoicing_api'
+
+instance = InvoicingApi::PaginatedResponse.new(
+  limit: 5,
+  offset: 25,
+  total: 400
+)
+```
+