korona-cloud-client 1.0.0

data/docs/ResultListTimeTrackingEntry.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::ResultListTimeTrackingEntry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<TimeTrackingEntry>**](TimeTrackingEntry.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultListTimeTrackingEntry.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+

data/docs/RevenueData.md

@@ -0,0 +1,25 @@
+# KoronaCloudClient::RevenueData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**net_value** | **Float** |  | [optional] 
+**gross_value** | **Float** |  | [optional] 
+**average_net_value** | **Float** |  | [optional] 
+**average_gross_value** | **Float** |  | [optional] 
+**customers_total** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::RevenueData.new(net_value: null,
+                                 gross_value: null,
+                                 average_net_value: null,
+                                 average_gross_value: null,
+                                 customers_total: null)
+```
+
+

data/docs/SalesTax.md

@@ -0,0 +1,31 @@
+# KoronaCloudClient::SalesTax
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] [readonly] 
+**economic_zone** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**included** | **Boolean** |  | [optional] 
+**name** | **String** |  | [optional] 
+**rates** | [**Array<SalesTaxRate>**](SalesTaxRate.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::SalesTax.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 economic_zone: null,
+                                 included: null,
+                                 name: null,
+                                 rates: null)
+```
+
+

data/docs/SalesTaxRate.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::SalesTaxRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate** | **Float** |  | [optional] 
+**valid_from** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::SalesTaxRate.new(rate: null,
+                                 valid_from: null)
+```
+
+

data/docs/SalesTaxesApi.md

@@ -0,0 +1,128 @@
+# KoronaCloudClient::SalesTaxesApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_sales_tax**](SalesTaxesApi.md#get_sales_tax) | **GET** /accounts/{koronaAccountId}/salesTaxes/{salesTaxId} | returns the single sales tax
+[**get_sales_taxes**](SalesTaxesApi.md#get_sales_taxes) | **GET** /accounts/{koronaAccountId}/salesTaxes | lists all sales taxes
+
+
+
+## get_sales_tax
+
+> SalesTax get_sales_tax(korona_account_id, sales_tax_id)
+
+returns the single sales tax
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SalesTaxesApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+sales_tax_id = 'sales_tax_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single sales tax
+  result = api_instance.get_sales_tax(korona_account_id, sales_tax_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SalesTaxesApi->get_sales_tax: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **sales_tax_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**SalesTax**](SalesTax.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sales_taxes
+
+> ResultListSalesTax get_sales_taxes(korona_account_id, opts)
+
+lists all sales taxes
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SalesTaxesApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+opts = {
+  page: 56, # Integer | number of the page to fetch
+  size: 56, # Integer | amount of objects to return per page
+  sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
+  revision: 56, # Integer | last revision number, objects with a greater revision than this will be returned
+  include_deleted: true, # Boolean | indicates deleted objects should be loaded or not (default: false)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all sales taxes
+  result = api_instance.get_sales_taxes(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SalesTaxesApi->get_sales_taxes: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **page** | **Integer**| number of the page to fetch | [optional] 
+ **size** | **Integer**| amount of objects to return per page | [optional] 
+ **sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional] 
+ **revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional] 
+ **include_deleted** | **Boolean**| indicates deleted objects should be loaded or not (default: false) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
+
+### Return type
+
+[**ResultListSalesTax**](ResultListSalesTax.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Sector.md

@@ -0,0 +1,29 @@
+# KoronaCloudClient::Sector
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] [readonly] 
+**name** | **String** |  | [optional] 
+**sales_taxes** | [**Array<SectorSalesTaxItem>**](SectorSalesTaxItem.md) |  | [optional] 
+**revenue_accounts** | [**Array<SectorRevenueAccountItem>**](SectorRevenueAccountItem.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Sector.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 name: null,
+                                 sales_taxes: null,
+                                 revenue_accounts: null)
+```
+
+

data/docs/SectorRevenueAccountItem.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::SectorRevenueAccountItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**revenue_account** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**economic_zone** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::SectorRevenueAccountItem.new(revenue_account: null,
+                                 economic_zone: null)
+```
+
+

data/docs/SectorSalesTaxItem.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::SectorSalesTaxItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** |  | [optional] 
+**sales_tax** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::SectorSalesTaxItem.new(index: null,
+                                 sales_tax: null)
+```
+
+

data/docs/SectorsApi.md

@@ -0,0 +1,240 @@
+# KoronaCloudClient::SectorsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_sectors**](SectorsApi.md#add_sectors) | **POST** /accounts/{koronaAccountId}/sectors | adds a batch of new sectors
+[**get_sector**](SectorsApi.md#get_sector) | **GET** /accounts/{koronaAccountId}/sectors/{sectorId} | returns the single sector
+[**get_sectors**](SectorsApi.md#get_sectors) | **GET** /accounts/{koronaAccountId}/sectors | lists all sectors
+[**update_sectors**](SectorsApi.md#update_sectors) | **PATCH** /accounts/{koronaAccountId}/sectors | updates a batch of sectors
+
+
+
+## add_sectors
+
+> Array<AddOrUpdateResult> add_sectors(korona_account_id, body, opts)
+
+adds a batch of new sectors
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SectorsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::Sector.new] # Array<Sector> | array of new sectors
+opts = {
+  upsert: true # Boolean | when set to true, updates the object instead of generating a already-exists-error
+}
+
+begin
+  #adds a batch of new sectors
+  result = api_instance.add_sectors(korona_account_id, body, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SectorsApi->add_sectors: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Sector&gt;**](Sector.md)| array of new sectors | 
+ **upsert** | **Boolean**| when set to true, updates the object instead of generating a already-exists-error | [optional] 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_sector
+
+> Sector get_sector(korona_account_id, sector_id)
+
+returns the single sector
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SectorsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+sector_id = 'sector_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single sector
+  result = api_instance.get_sector(korona_account_id, sector_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SectorsApi->get_sector: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **sector_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**Sector**](Sector.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sectors
+
+> ResultListSector get_sectors(korona_account_id, opts)
+
+lists all sectors
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SectorsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+opts = {
+  page: 56, # Integer | number of the page to fetch
+  size: 56, # Integer | amount of objects to return per page
+  sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
+  revision: 56, # Integer | last revision number, objects with a greater revision than this will be returned
+  include_deleted: true, # Boolean | indicates deleted objects should be loaded or not (default: false)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all sectors
+  result = api_instance.get_sectors(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SectorsApi->get_sectors: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **page** | **Integer**| number of the page to fetch | [optional] 
+ **size** | **Integer**| amount of objects to return per page | [optional] 
+ **sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional] 
+ **revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional] 
+ **include_deleted** | **Boolean**| indicates deleted objects should be loaded or not (default: false) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
+
+### Return type
+
+[**ResultListSector**](ResultListSector.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_sectors
+
+> Array&lt;AddOrUpdateResult&gt; update_sectors(korona_account_id, body)
+
+updates a batch of sectors
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SectorsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::Sector.new] # Array<Sector> | array of existing sectors (id or number required)
+
+begin
+  #updates a batch of sectors
+  result = api_instance.update_sectors(korona_account_id, body)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SectorsApi->update_sectors: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Sector&gt;**](Sector.md)| array of existing sectors (id or number required) | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+