korona_client 1.0.0 → 1.1.0

data/docs/TimeTrackingApi.md

@@ -0,0 +1,388 @@
+# KoronaClient::TimeTrackingApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_entities**](TimeTrackingApi.md#add_entities) | **POST** /accounts/{koronaAccountId}/timeTrackingEntities | adds a batch of new time tracking entities
+[**add_entries**](TimeTrackingApi.md#add_entries) | **POST** /accounts/{koronaAccountId}/timeTrackingEntries | adds a batch of new time tracking entries
+[**get_entities**](TimeTrackingApi.md#get_entities) | **GET** /accounts/{koronaAccountId}/timeTrackingEntities | lists time tracking entities
+[**get_entries**](TimeTrackingApi.md#get_entries) | **GET** /accounts/{koronaAccountId}/timeTrackingEntries | lists time tracking entries
+[**get_time_tracking_entity**](TimeTrackingApi.md#get_time_tracking_entity) | **GET** /accounts/{koronaAccountId}/timeTrackingEntities/{timeTrackingEntityId} | returns a single time tracking entity
+[**get_time_tracking_entry**](TimeTrackingApi.md#get_time_tracking_entry) | **GET** /accounts/{koronaAccountId}/timeTrackingEntries/{timeTrackingEntryId} | returns a single time tracking entry
+
+
+# **add_entities**
+> Array<AddOrUpdateResult> add_entities(korona_account_id, body, opts)
+
+adds a batch of new time tracking entities
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TimeTrackingApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::TimeTrackingEntity.new] # Array<TimeTrackingEntity> | array of new time tracking entities
+
+opts = { 
+  upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
+}
+
+begin
+  #adds a batch of new time tracking entities
+  result = api_instance.add_entities(korona_account_id, body, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TimeTrackingApi->add_entities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;TimeTrackingEntity&gt;**](TimeTrackingEntity.md)| array of new time tracking entities | 
+ **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
+
+
+
+# **add_entries**
+> Array&lt;AddOrUpdateResult&gt; add_entries(korona_account_id, body, opts)
+
+adds a batch of new time tracking entries
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TimeTrackingApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::TimeTrackingEntry.new] # Array<TimeTrackingEntry> | array of new time tracking entries
+
+opts = { 
+  upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
+}
+
+begin
+  #adds a batch of new time tracking entries
+  result = api_instance.add_entries(korona_account_id, body, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TimeTrackingApi->add_entries: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;TimeTrackingEntry&gt;**](TimeTrackingEntry.md)| array of new time tracking entries | 
+ **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_entities**
+> ResultListTimeTrackingEntity get_entities(korona_account_id, opts)
+
+lists time tracking entities
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TimeTrackingApi.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: 789, # 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 time tracking entities
+  result = api_instance.get_entities(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TimeTrackingApi->get_entities: #{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
+
+[**ResultListTimeTrackingEntity**](ResultListTimeTrackingEntity.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_entries**
+> ResultListTimeTrackingEntry get_entries(korona_account_id, opts)
+
+lists time tracking entries
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TimeTrackingApi.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: 789, # Integer | last revision number, objects with a greater revision than this will be returned
+  time_tracking_entity: 'time_tracking_entity_example', # String | time tracking entity id to filter by
+  cashier: 'cashier_example', # String | cashier id to filter by
+  organizational_unit: 'organizational_unit_example', # String | organizational unit
+  min_timestamp: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) timestamp (ISO 8601; date, time and timezone)
+  max_timestamp: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) timestamp (ISO 8601; date, time and timezone)
+  include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+}
+
+begin
+  #lists time tracking entries
+  result = api_instance.get_entries(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TimeTrackingApi->get_entries: #{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] 
+ **time_tracking_entity** | **String**| time tracking entity id to filter by | [optional] 
+ **cashier** | **String**| cashier id to filter by | [optional] 
+ **organizational_unit** | **String**| organizational unit | [optional] 
+ **min_timestamp** | **DateTime**| min (inclusive) timestamp (ISO 8601; date, time and timezone) | [optional] 
+ **max_timestamp** | **DateTime**| max (inclusive) timestamp (ISO 8601; date, time and timezone) | [optional] 
+ **include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional] 
+
+### Return type
+
+[**ResultListTimeTrackingEntry**](ResultListTimeTrackingEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_time_tracking_entity**
+> TimeTrackingEntity get_time_tracking_entity(korona_account_id, time_tracking_entity_id)
+
+returns a single time tracking entity
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TimeTrackingApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+time_tracking_entity_id = 'time_tracking_entity_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #returns a single time tracking entity
+  result = api_instance.get_time_tracking_entity(korona_account_id, time_tracking_entity_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TimeTrackingApi->get_time_tracking_entity: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **time_tracking_entity_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**TimeTrackingEntity**](TimeTrackingEntity.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_time_tracking_entry**
+> TimeTrackingEntry get_time_tracking_entry(korona_account_id, time_tracking_entry_id)
+
+returns a single time tracking entry
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TimeTrackingApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+time_tracking_entry_id = 'time_tracking_entry_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #returns a single time tracking entry
+  result = api_instance.get_time_tracking_entry(korona_account_id, time_tracking_entry_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TimeTrackingApi->get_time_tracking_entry: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **time_tracking_entry_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**TimeTrackingEntry**](TimeTrackingEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/TimeTrackingEntity.md

@@ -0,0 +1,13 @@
+# KoronaClient::TimeTrackingEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** | indicates whether the object is active for use or not | [optional] 
+**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] 
+**name** | **String** |  | [optional] 
+**paid_time** | **BOOLEAN** |  | [optional] 
+
+

data/docs/TimeTrackingEntry.md

@@ -0,0 +1,14 @@
+# KoronaClient::TimeTrackingEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**active** | **BOOLEAN** | indicates whether the object is active for use or not | [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] 
+**time_stamp** | **DateTime** |  | [optional] 
+**cashier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**time_tracking_entity** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+

data/docs/TotalPeriod.md

@@ -0,0 +1,9 @@
+# KoronaClient::TotalPeriod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **DateTime** |  | [optional] 
+**to** | **DateTime** |  | [optional] 
+
+

data/docs/Validity.md

@@ -0,0 +1,11 @@
+# KoronaClient::Validity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**daily** | [**DayTimePeriod**](DayTimePeriod.md) |  | [optional] 
+**days_of_month** | **Array<Integer>** |  | [optional] 
+**days_of_week** | **Array<String>** |  | [optional] 
+**total** | [**TotalPeriod**](TotalPeriod.md) |  | [optional] 
+
+

data/korona_client.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-#
+
 =begin
 #KORONA.cloud API v3
 
 #Our api provides access to our cloud services
 
-OpenAPI spec version: 3
-Contact: support@combase.net
+OpenAPI spec version: 2.11.21
+
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.8
 
 =end
 
@@ -20,12 +20,11 @@ Gem::Specification.new do |s|
   s.version     = KoronaClient::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Swagger-Codegen"]
-  s.email       = ["support@combase.net"]
+  s.email       = [""]
   s.homepage    = "https://github.com/swagger-api/swagger-codegen"
   s.summary     = "KORONA.cloud API v3 Ruby Gem"
   s.description = "Our api provides access to our cloud services"
-  # TODO uncommnet and update below with a proper license 
-  #s.license     = "Apache 2.0"
+  s.license     = "Unlicense"
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
@@ -39,7 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
   s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
 
-  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]