korona_client 1.0.0 → 1.1.0

data/docs/StockReceipt.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **product_stock_order** | [**ModelReference**](ModelReference.md) |  | [optional] 
 **source_organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
 **supplier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**comment** | **String** |  | [optional] 
 **status** | **String** |  | [optional] 
 
 

data/docs/StockReceiptsApi.md

@@ -0,0 +1,687 @@
+# KoronaClient::StockReceiptsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_stock_receipt_items**](StockReceiptsApi.md#add_stock_receipt_items) | **POST** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId}/items | adds stock-receipt items
+[**add_stock_receipts**](StockReceiptsApi.md#add_stock_receipts) | **POST** /accounts/{koronaAccountId}/stockReceipts | adds stock-receipts
+[**book_stock_receipt**](StockReceiptsApi.md#book_stock_receipt) | **PATCH** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId}/book | book the single stock-receipt
+[**delete_stock_receipt_item**](StockReceiptsApi.md#delete_stock_receipt_item) | **DELETE** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId}/items/{productId} | deletes the single stock-receipt item
+[**get_stock_receipt**](StockReceiptsApi.md#get_stock_receipt) | **GET** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId} | returns the single stock-receipt
+[**get_stock_receipt_item**](StockReceiptsApi.md#get_stock_receipt_item) | **GET** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId}/items/{productId} | returns the single stock-receipt item
+[**get_stock_receipt_items**](StockReceiptsApi.md#get_stock_receipt_items) | **GET** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId}/items | lists all stock-receipt items
+[**get_stock_receipts**](StockReceiptsApi.md#get_stock_receipts) | **GET** /accounts/{koronaAccountId}/stockReceipts | lists all stock-receipts
+[**update_stock_receipt**](StockReceiptsApi.md#update_stock_receipt) | **PATCH** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId} | updates the single stock-receipt
+[**update_stock_receipt_item**](StockReceiptsApi.md#update_stock_receipt_item) | **PATCH** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId}/items/{productId} | updates the single stock-receipt item
+[**update_stock_receipt_items**](StockReceiptsApi.md#update_stock_receipt_items) | **PATCH** /accounts/{koronaAccountId}/stockReceipts/{stockReceiptId}/items | updates stock-receipt items
+
+
+# **add_stock_receipt_items**
+> Array<AddOrUpdateResult> add_stock_receipt_items(korona_account_id, stock_receipt_id, body)
+
+adds stock-receipt items
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+body = [KoronaClient::StockReceiptItem.new] # Array<StockReceiptItem> | data to add
+
+
+begin
+  #adds stock-receipt items
+  result = api_instance.add_stock_receipt_items(korona_account_id, stock_receipt_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->add_stock_receipt_items: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**Array&lt;StockReceiptItem&gt;**](StockReceiptItem.md)| data to add | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **add_stock_receipts**
+> Array&lt;AddOrUpdateResult&gt; add_stock_receipts(korona_account_id, body)
+
+adds stock-receipts
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::StockReceipt.new] # Array<StockReceipt> | data to add
+
+
+begin
+  #adds stock-receipts
+  result = api_instance.add_stock_receipts(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->add_stock_receipts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;StockReceipt&gt;**](StockReceipt.md)| data to add | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **book_stock_receipt**
+> book_stock_receipt(korona_account_id, stock_receipt_id)
+
+book the single stock-receipt
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #book the single stock-receipt
+  api_instance.book_stock_receipt(korona_account_id, stock_receipt_id)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->book_stock_receipt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_stock_receipt_item**
+> delete_stock_receipt_item(korona_account_id, stock_receipt_id, product_id)
+
+deletes the single stock-receipt item
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #deletes the single stock-receipt item
+  api_instance.delete_stock_receipt_item(korona_account_id, stock_receipt_id, product_id)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->delete_stock_receipt_item: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **product_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_stock_receipt**
+> StockReceipt get_stock_receipt(korona_account_id, stock_receipt_id)
+
+returns the single stock-receipt
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #returns the single stock-receipt
+  result = api_instance.get_stock_receipt(korona_account_id, stock_receipt_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->get_stock_receipt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**StockReceipt**](StockReceipt.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_stock_receipt_item**
+> StockReceiptItem get_stock_receipt_item(korona_account_id, stock_receipt_id, product_id)
+
+returns the single stock-receipt item
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #returns the single stock-receipt item
+  result = api_instance.get_stock_receipt_item(korona_account_id, stock_receipt_id, product_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->get_stock_receipt_item: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **product_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**StockReceiptItem**](StockReceiptItem.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_stock_receipt_items**
+> ResultListStockReceiptItem get_stock_receipt_items(korona_account_id, stock_receipt_id, opts)
+
+lists all stock-receipt items
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+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
+}
+
+begin
+  #lists all stock-receipt items
+  result = api_instance.get_stock_receipt_items(korona_account_id, stock_receipt_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->get_stock_receipt_items: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **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] 
+
+### Return type
+
+[**ResultListStockReceiptItem**](ResultListStockReceiptItem.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_stock_receipts**
+> ResultListStockReceipt get_stock_receipts(korona_account_id, opts)
+
+lists all stock-receipts
+
+
+
+### 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::StockReceiptsApi.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)
+  min_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
+  max_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
+  min_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
+  max_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
+  organizational_unit: 'organizational_unit_example', # String | organizational unit
+  source_organizational_unit: 'source_organizational_unit_example', # String | source organizational unit
+  booking_status: 'booking_status_example', # String | booking status (possible values: BOOKED, IN_PROGRESS)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all stock-receipts
+  result = api_instance.get_stock_receipts(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->get_stock_receipts: #{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] 
+ **min_create_time** | **DateTime**| min (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **max_create_time** | **DateTime**| max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **min_booking_time** | **DateTime**| min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **max_booking_time** | **DateTime**| max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **organizational_unit** | **String**| organizational unit | [optional] 
+ **source_organizational_unit** | **String**| source organizational unit | [optional] 
+ **booking_status** | **String**| booking status (possible values: BOOKED, IN_PROGRESS) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
+
+### Return type
+
+[**ResultListStockReceipt**](ResultListStockReceipt.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_stock_receipt**
+> update_stock_receipt(korona_account_id, stock_receipt_id, body)
+
+updates the single stock-receipt
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+body = KoronaClient::StockReceipt.new # StockReceipt | data to update
+
+
+begin
+  #updates the single stock-receipt
+  api_instance.update_stock_receipt(korona_account_id, stock_receipt_id, body)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->update_stock_receipt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**StockReceipt**](StockReceipt.md)| data to update | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_stock_receipt_item**
+> update_stock_receipt_item(korona_account_id, stock_receipt_id, product_id, body)
+
+updates the single stock-receipt item
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+body = KoronaClient::StockReceiptItem.new # StockReceiptItem | data to update
+
+
+begin
+  #updates the single stock-receipt item
+  api_instance.update_stock_receipt_item(korona_account_id, stock_receipt_id, product_id, body)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->update_stock_receipt_item: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **product_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**StockReceiptItem**](StockReceiptItem.md)| data to update | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_stock_receipt_items**
+> Array&lt;AddOrUpdateResult&gt; update_stock_receipt_items(korona_account_id, stock_receipt_id, body)
+
+updates stock-receipt items
+
+
+
+### 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::StockReceiptsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+stock_receipt_id = 'stock_receipt_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+body = [KoronaClient::StockReceiptItem.new] # Array<StockReceiptItem> | data to update
+
+
+begin
+  #updates stock-receipt items
+  result = api_instance.update_stock_receipt_items(korona_account_id, stock_receipt_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling StockReceiptsApi->update_stock_receipt_items: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **stock_receipt_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**Array&lt;StockReceiptItem&gt;**](StockReceiptItem.md)| data to update | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+