korona-cloud-client 1.0.14 → 1.0.16

data/docs/ProductsApi.md

@@ -1,23 +1,25 @@
 # KoronaCloudClient::ProductsApi
 
-All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+All URIs are relative to *http://localhost:8080/web/api/v3*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**add_products**](ProductsApi.md#add_products) | **POST** /accounts/{koronaAccountId}/products | adds a batch of new products |
-| [**delete_product**](ProductsApi.md#delete_product) | **DELETE** /accounts/{koronaAccountId}/products/{productId} | deletes the single product |
-| [**delete_products**](ProductsApi.md#delete_products) | **DELETE** /accounts/{koronaAccountId}/products | deletes a batch of products |
-| [**get_product**](ProductsApi.md#get_product) | **GET** /accounts/{koronaAccountId}/products/{productId} | returns the single product |
-| [**get_product_stocks**](ProductsApi.md#get_product_stocks) | **GET** /accounts/{koronaAccountId}/products/{productId}/stocks | lists the product stocks in different warehouses (KORONA.retail required) |
-| [**get_products**](ProductsApi.md#get_products) | **GET** /accounts/{koronaAccountId}/products | lists all products |
-| [**remove_tag_from_product**](ProductsApi.md#remove_tag_from_product) | **DELETE** /accounts/{koronaAccountId}/products/{productId}/tags/{tagId} | removes the tag from the product |
-| [**update_product**](ProductsApi.md#update_product) | **PATCH** /accounts/{koronaAccountId}/products/{productId} | updates the single product |
-| [**update_products**](ProductsApi.md#update_products) | **PATCH** /accounts/{koronaAccountId}/products | updates a batch of products |
+| [**add_products**](ProductsApi.md#add_products) | **POST** /accounts/{koronaAccountId}/products |  |
+| [**delete_product**](ProductsApi.md#delete_product) | **DELETE** /accounts/{koronaAccountId}/products/{productId} |  |
+| [**delete_products**](ProductsApi.md#delete_products) | **DELETE** /accounts/{koronaAccountId}/products |  |
+| [**get_product**](ProductsApi.md#get_product) | **GET** /accounts/{koronaAccountId}/products/{productId} |  |
+| [**get_product_stocks**](ProductsApi.md#get_product_stocks) | **GET** /accounts/{koronaAccountId}/products/{productId}/stocks |  |
+| [**get_products**](ProductsApi.md#get_products) | **GET** /accounts/{koronaAccountId}/products |  |
+| [**remove_tag_from_product**](ProductsApi.md#remove_tag_from_product) | **DELETE** /accounts/{koronaAccountId}/products/{productId}/tags/{tagId} |  |
+| [**update_product**](ProductsApi.md#update_product) | **PATCH** /accounts/{koronaAccountId}/products/{productId} |  |
+| [**update_products**](ProductsApi.md#update_products) | **PATCH** /accounts/{koronaAccountId}/products |  |
 
 
 ## add_products
 
-> <Array<AddOrUpdateResult>> add_products(korona_account_id, body, opts)
+> <Array<AddOrUpdateResult>> add_products(korona_account_id, product, opts)
+
+
 
 adds a batch of new products
 
@@ -35,15 +37,17 @@ end
 
 api_instance = KoronaCloudClient::ProductsApi.new
 korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
-body = [KoronaCloudClient::Product.new] # Array<Product> | array of new products
+product = [KoronaCloudClient::Product.new] # Array<Product> | array of new products
 opts = {
-  upsert: true, # Boolean | when set to true, updates the object instead of generating a already-exists-error
-  merge_list_items: true # Boolean | if set to true, merges lists instead of replacing them
+  upsert: true, # Boolean | when set to true, updates the object instead of generating a already-exists-error; deprecated, use writeMode ADD_OR_UPDATE instead
+  merge_list_items: true, # Boolean | if set to true, merges lists instead of replacing them
+  merge_tags: true, # Boolean | if set to true, merges tags instead of overwriting the list
+  write_mode: 'DEFAULT' # String | DEFAULT = insert; ADD_OR_UPDATE = insert or update, overwrite all non-null fields; ADD_OR_REPLACE = insert or update, overwrite all fields
 }
 
 begin
-  # adds a batch of new products
-  result = api_instance.add_products(korona_account_id, body, opts)
+  
+  result = api_instance.add_products(korona_account_id, product, opts)
   p result
 rescue KoronaCloudClient::ApiError => e
   puts "Error when calling ProductsApi->add_products: #{e}"
@@ -54,12 +58,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<AddOrUpdateResult>>, Integer, Hash)> add_products_with_http_info(korona_account_id, body, opts)
+> <Array(<Array<AddOrUpdateResult>>, Integer, Hash)> add_products_with_http_info(korona_account_id, product, opts)
 
 ```ruby
 begin
-  # adds a batch of new products
-  data, status_code, headers = api_instance.add_products_with_http_info(korona_account_id, body, opts)
+  
+  data, status_code, headers = api_instance.add_products_with_http_info(korona_account_id, product, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<AddOrUpdateResult>>
@@ -73,9 +77,11 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **korona_account_id** | **String** | account id of the KORONA.cloud account |  |
-| **body** | [**Array&lt;Product&gt;**](Product.md) | array of new products |  |
-| **upsert** | **Boolean** | when set to true, updates the object instead of generating a already-exists-error | [optional] |
+| **product** | [**Array&lt;Product&gt;**](Product.md) | array of new products |  |
+| **upsert** | **Boolean** | when set to true, updates the object instead of generating a already-exists-error; deprecated, use writeMode ADD_OR_UPDATE instead | [optional] |
 | **merge_list_items** | **Boolean** | if set to true, merges lists instead of replacing them | [optional] |
+| **merge_tags** | **Boolean** | if set to true, merges tags instead of overwriting the list | [optional] |
+| **write_mode** | **String** | DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields | [optional] |
 
 ### Return type
 
@@ -95,6 +101,8 @@ end
 
 > delete_product(korona_account_id, product_id)
 
+
+
 deletes the single product
 
 ### Examples
@@ -114,7 +122,7 @@ korona_account_id = 'korona_account_id_example' # String | account id of the KOR
 product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 begin
-  # deletes the single product
+  
   api_instance.delete_product(korona_account_id, product_id)
 rescue KoronaCloudClient::ApiError => e
   puts "Error when calling ProductsApi->delete_product: #{e}"
@@ -129,7 +137,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # deletes the single product
+  
   data, status_code, headers = api_instance.delete_product_with_http_info(korona_account_id, product_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -162,7 +170,9 @@ nil (empty response body)
 
 ## delete_products
 
-> <Array<AddOrUpdateResult>> delete_products(korona_account_id, body)
+> <Array<AddOrUpdateResult>> delete_products(korona_account_id, product)
+
+
 
 deletes a batch of products
 
@@ -180,11 +190,11 @@ end
 
 api_instance = KoronaCloudClient::ProductsApi.new
 korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
-body = [KoronaCloudClient::Product.new] # Array<Product> | array of existing products (id or number required)
+product = [KoronaCloudClient::Product.new] # Array<Product> | array of existing products (id or number required)
 
 begin
-  # deletes a batch of products
-  result = api_instance.delete_products(korona_account_id, body)
+  
+  result = api_instance.delete_products(korona_account_id, product)
   p result
 rescue KoronaCloudClient::ApiError => e
   puts "Error when calling ProductsApi->delete_products: #{e}"
@@ -195,12 +205,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<AddOrUpdateResult>>, Integer, Hash)> delete_products_with_http_info(korona_account_id, body)
+> <Array(<Array<AddOrUpdateResult>>, Integer, Hash)> delete_products_with_http_info(korona_account_id, product)
 
 ```ruby
 begin
-  # deletes a batch of products
-  data, status_code, headers = api_instance.delete_products_with_http_info(korona_account_id, body)
+  
+  data, status_code, headers = api_instance.delete_products_with_http_info(korona_account_id, product)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<AddOrUpdateResult>>
@@ -214,7 +224,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **korona_account_id** | **String** | account id of the KORONA.cloud account |  |
-| **body** | [**Array&lt;Product&gt;**](Product.md) | array of existing products (id or number required) |  |
+| **product** | [**Array&lt;Product&gt;**](Product.md) | array of existing products (id or number required) |  |
 
 ### Return type
 
@@ -234,6 +244,8 @@ end
 
 > <Product> get_product(korona_account_id, product_id)
 
+
+
 returns the single product
 
 ### Examples
@@ -253,7 +265,7 @@ korona_account_id = 'korona_account_id_example' # String | account id of the KOR
 product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 begin
-  # returns the single product
+  
   result = api_instance.get_product(korona_account_id, product_id)
   p result
 rescue KoronaCloudClient::ApiError => e
@@ -269,7 +281,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # returns the single product
+  
   data, status_code, headers = api_instance.get_product_with_http_info(korona_account_id, product_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -304,6 +316,8 @@ end
 
 > <ResultListProductStock> get_product_stocks(korona_account_id, product_id, opts)
 
+
+
 lists the product stocks in different warehouses (KORONA.retail required)
 
 ### Examples
@@ -329,7 +343,7 @@ opts = {
 }
 
 begin
-  # lists the product stocks in different warehouses (KORONA.retail required)
+  
   result = api_instance.get_product_stocks(korona_account_id, product_id, opts)
   p result
 rescue KoronaCloudClient::ApiError => e
@@ -345,7 +359,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # lists the product stocks in different warehouses (KORONA.retail required)
+  
   data, status_code, headers = api_instance.get_product_stocks_with_http_info(korona_account_id, product_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -384,6 +398,8 @@ end
 
 > <ResultListProduct> get_products(korona_account_id, opts)
 
+
+
 lists all products
 
 ### Examples
@@ -415,7 +431,7 @@ opts = {
 }
 
 begin
-  # lists all products
+  
   result = api_instance.get_products(korona_account_id, opts)
   p result
 rescue KoronaCloudClient::ApiError => e
@@ -431,7 +447,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # lists all products
+  
   data, status_code, headers = api_instance.get_products_with_http_info(korona_account_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -476,6 +492,8 @@ end
 
 > remove_tag_from_product(korona_account_id, product_id, tag_id)
 
+
+
 removes the tag from the product
 
 ### Examples
@@ -496,7 +514,7 @@ product_id = 'product_id_example' # String | id of the related object (important
 tag_id = 'tag_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 begin
-  # removes the tag from the product
+  
   api_instance.remove_tag_from_product(korona_account_id, product_id, tag_id)
 rescue KoronaCloudClient::ApiError => e
   puts "Error when calling ProductsApi->remove_tag_from_product: #{e}"
@@ -511,7 +529,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # removes the tag from the product
+  
   data, status_code, headers = api_instance.remove_tag_from_product_with_http_info(korona_account_id, product_id, tag_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -545,11 +563,11 @@ nil (empty response body)
 
 ## update_product
 
-> update_product(korona_account_id, product_id, body, opts)
+> update_product(korona_account_id, product_id, product, opts)
 
-updates the single product
 
-if [number] is set, the number of the object will change and the resource location as well
+
+updates the single product; if [number] is set, the number of the object will change and the resource location as well
 
 ### Examples
 
@@ -566,14 +584,15 @@ end
 api_instance = KoronaCloudClient::ProductsApi.new
 korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
-body = KoronaCloudClient::Product.new # Product | the properties to update of the product
+product = KoronaCloudClient::Product.new # Product | the properties to update of the product
 opts = {
-  merge_list_items: true # Boolean | if set to true, merges lists instead of replacing them
+  merge_list_items: true, # Boolean | if set to true, merges lists instead of replacing them
+  merge_tags: true # Boolean | if set to true, merges tags instead of overwriting the list
 }
 
 begin
-  # updates the single product
-  api_instance.update_product(korona_account_id, product_id, body, opts)
+  
+  api_instance.update_product(korona_account_id, product_id, product, opts)
 rescue KoronaCloudClient::ApiError => e
   puts "Error when calling ProductsApi->update_product: #{e}"
 end
@@ -583,12 +602,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> update_product_with_http_info(korona_account_id, product_id, body, opts)
+> <Array(nil, Integer, Hash)> update_product_with_http_info(korona_account_id, product_id, product, opts)
 
 ```ruby
 begin
-  # updates the single product
-  data, status_code, headers = api_instance.update_product_with_http_info(korona_account_id, product_id, body, opts)
+  
+  data, status_code, headers = api_instance.update_product_with_http_info(korona_account_id, product_id, product, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -603,8 +622,9 @@ end
 | ---- | ---- | ----------- | ----- |
 | **korona_account_id** | **String** | account id of the KORONA.cloud account |  |
 | **product_id** | **String** | id of the related object (important: id should match the uuid-format) |  |
-| **body** | [**Product**](Product.md) | the properties to update of the product |  |
+| **product** | [**Product**](Product.md) | the properties to update of the product |  |
 | **merge_list_items** | **Boolean** | if set to true, merges lists instead of replacing them | [optional] |
+| **merge_tags** | **Boolean** | if set to true, merges tags instead of overwriting the list | [optional] |
 
 ### Return type
 
@@ -622,11 +642,11 @@ nil (empty response body)
 
 ## update_products
 
-> <Array<AddOrUpdateResult>> update_products(korona_account_id, body, opts)
+> <Array<AddOrUpdateResult>> update_products(korona_account_id, product, opts)
+
 
-updates a batch of products
 
-[number] must be set in the objects, otherwise the object cannot be updated
+updates a batch of products; [number] must be set in the objects, otherwise the object cannot be updated
 
 ### Examples
 
@@ -642,14 +662,15 @@ end
 
 api_instance = KoronaCloudClient::ProductsApi.new
 korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
-body = [KoronaCloudClient::Product.new] # Array<Product> | an array of existing products
+product = [KoronaCloudClient::Product.new] # Array<Product> | an array of existing products
 opts = {
-  merge_list_items: true # Boolean | if set to true, merges lists instead of replacing them
+  merge_list_items: true, # Boolean | if set to true, merges lists instead of replacing them
+  merge_tags: true # Boolean | if set to true, merges tags instead of overwriting the list
 }
 
 begin
-  # updates a batch of products
-  result = api_instance.update_products(korona_account_id, body, opts)
+  
+  result = api_instance.update_products(korona_account_id, product, opts)
   p result
 rescue KoronaCloudClient::ApiError => e
   puts "Error when calling ProductsApi->update_products: #{e}"
@@ -660,12 +681,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<AddOrUpdateResult>>, Integer, Hash)> update_products_with_http_info(korona_account_id, body, opts)
+> <Array(<Array<AddOrUpdateResult>>, Integer, Hash)> update_products_with_http_info(korona_account_id, product, opts)
 
 ```ruby
 begin
-  # updates a batch of products
-  data, status_code, headers = api_instance.update_products_with_http_info(korona_account_id, body, opts)
+  
+  data, status_code, headers = api_instance.update_products_with_http_info(korona_account_id, product, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<AddOrUpdateResult>>
@@ -679,8 +700,9 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **korona_account_id** | **String** | account id of the KORONA.cloud account |  |
-| **body** | [**Array&lt;Product&gt;**](Product.md) | an array of existing products |  |
+| **product** | [**Array&lt;Product&gt;**](Product.md) | an array of existing products |  |
 | **merge_list_items** | **Boolean** | if set to true, merges lists instead of replacing them | [optional] |
+| **merge_tags** | **Boolean** | if set to true, merges tags instead of overwriting the list | [optional] |
 
 ### Return type
 

data/docs/PromotionValidity.md

@@ -9,6 +9,8 @@
 | **days_of_week** | **Array<String>** |  | [optional] |
 | **organizational_units** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] |
 | **time_of_day_interval** | [**TimeOfDayInterval**](TimeOfDayInterval.md) |  | [optional] |
+| **org_selection_mode** | **String** |  | [optional] |
+| **pos_types** | **Array<String>** |  | [optional] |
 
 ## Example
 
@@ -20,7 +22,9 @@ instance = KoronaCloudClient::PromotionValidity.new(
   days_of_month: null,
   days_of_week: null,
   organizational_units: null,
-  time_of_day_interval: null
+  time_of_day_interval: null,
+  org_selection_mode: null,
+  pos_types: null
 )
 ```