voucherify 5.0.1 → 6.0.0

data/docs/ProductsApi.md

@@ -15,8 +15,8 @@ All URIs are relative to *https://api.voucherify.io*
 | [**list_products**](ProductsApi.md#list_products) | **GET** /v1/products | List Products |
 | [**list_skus_in_product**](ProductsApi.md#list_skus_in_product) | **GET** /v1/products/{productId}/skus | List SKUs in Product |
 | [**update_product**](ProductsApi.md#update_product) | **PUT** /v1/products/{productId} | Update Product |
-| [**update_products_in_bulk**](ProductsApi.md#update_products_in_bulk) | **POST** /v1/products/bulk/async | Update Products in bulk |
-| [**update_products_metadata_in_bulk**](ProductsApi.md#update_products_metadata_in_bulk) | **POST** /v1/products/metadata/async | Update Products' Metadata in bulk |
+| [**update_products_in_bulk**](ProductsApi.md#update_products_in_bulk) | **POST** /v1/products/bulk/async | Update Products in Bulk |
+| [**update_products_metadata_in_bulk**](ProductsApi.md#update_products_metadata_in_bulk) | **POST** /v1/products/metadata/async | Update Products' Metadata in Bulk |
 | [**update_sku**](ProductsApi.md#update_sku) | **PUT** /v1/products/{productId}/skus/{skuId} | Update SKU |
 
 
@@ -148,7 +148,7 @@ end
 
 Delete Product
 
-This method deletes a product.
+Deletes a product and all related SKUs. This operation cannot be undone.  If the force parameter is set to false or not set at all, the product and all related SKUs will be moved to the bin.
 
 ### Examples
 
@@ -171,7 +171,7 @@ end
 api_instance = VoucherifySdk::ProductsApi.new
 product_id = 'product_id_example' # String | A Voucherify product ID or source ID.
 opts = {
-  force: true # Boolean | If this flag is set to true, the product will be removed permanently. Going forward, the user will be able to create another product with exactly the same source_id.
+  force: true # Boolean | If this flag is set to true, the product and all related SKUs will be removed permanently. If it is set to false or not set at all, the product and all related SKUs will be moved to the bin. Going forward, the user will be able to create another product with exactly the same source_id.
 }
 
 begin
@@ -187,7 +187,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **product_id** | **String** | A Voucherify product ID or source ID. |  |
-| **force** | **Boolean** | If this flag is set to true, the product will be removed permanently. Going forward, the user will be able to create another product with exactly the same source_id. | [optional] |
+| **force** | **Boolean** | If this flag is set to true, the product and all related SKUs will be removed permanently. If it is set to false or not set at all, the product and all related SKUs will be moved to the bin. Going forward, the user will be able to create another product with exactly the same source_id. | [optional] |
 
 ### Return type
 
@@ -209,7 +209,7 @@ nil (empty response body)
 
 Delete SKU
 
-This method deletes a product SKU.
+Deletes a product SKU. This operation cannot be undone.  If the force parameter is set to false or not set at all, the SKU will be moved to the bin.
 
 ### Examples
 
@@ -233,7 +233,7 @@ api_instance = VoucherifySdk::ProductsApi.new
 product_id = 'product_id_example' # String | A unique Voucherify product ID or product source ID.
 sku_id = 'sku_id_example' # String | A Voucherify SKU ID or SKU source ID.
 opts = {
-  force: true # Boolean | If this flag is set to true, the SKU will be removed permanently. Going forward, the user will be able to create another SKU with exactly the same source_id.
+  force: true # Boolean | If this flag is set to true, the SKU will be removed permanently. If it is set to false or not set at all, the SKU will be moved to the bin. Going forward, the user will be able to create another SKU with exactly the same source_id.
 }
 
 begin
@@ -250,7 +250,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **product_id** | **String** | A unique Voucherify product ID or product source ID. |  |
 | **sku_id** | **String** | A Voucherify SKU ID or SKU source ID. |  |
-| **force** | **Boolean** | If this flag is set to true, the SKU will be removed permanently. Going forward, the user will be able to create another SKU with exactly the same source_id. | [optional] |
+| **force** | **Boolean** | If this flag is set to true, the SKU will be removed permanently. If it is set to false or not set at all, the SKU will be moved to the bin. Going forward, the user will be able to create another SKU with exactly the same source_id. | [optional] |
 
 ### Return type
 
@@ -384,7 +384,7 @@ end
 
 ## import_products_using_csv
 
-> <ProductsImportCsvCreateResponseBody> import_products_using_csv(file)
+> <ProductsImportCsvCreateResponseBody> import_products_using_csv(opts)
 
 Import Products using CSV
 
@@ -409,11 +409,13 @@ VoucherifySdk.configure do |config|
 end
 
 api_instance = VoucherifySdk::ProductsApi.new
-file = File.new('/path/to/some/file') # File | File path.
+opts = {
+  file: File.new('/path/to/some/file') # File | File path.
+}
 
 begin
   # Import Products using CSV
-  result = api_instance.import_products_using_csv(file)
+  result = api_instance.import_products_using_csv(opts)
   p result
 rescue VoucherifySdk::ApiError => e
   puts "Error when calling ProductsApi->import_products_using_csv: #{e}"
@@ -424,7 +426,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **file** | **File** | File path. |  |
+| **file** | **File** | File path. | [optional] |
 
 ### Return type
 
@@ -442,7 +444,7 @@ end
 
 ## import_skus_using_csv
 
-> <SkusImportCsvCreateResponseBody> import_skus_using_csv(file)
+> <SkusImportCsvCreateResponseBody> import_skus_using_csv(opts)
 
 Import SKUs using CSV
 
@@ -467,11 +469,13 @@ VoucherifySdk.configure do |config|
 end
 
 api_instance = VoucherifySdk::ProductsApi.new
-file = File.new('/path/to/some/file') # File | File path.
+opts = {
+  file: File.new('/path/to/some/file') # File | File path.
+}
 
 begin
   # Import SKUs using CSV
-  result = api_instance.import_skus_using_csv(file)
+  result = api_instance.import_skus_using_csv(opts)
   p result
 rescue VoucherifySdk::ApiError => e
   puts "Error when calling ProductsApi->import_skus_using_csv: #{e}"
@@ -482,7 +486,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **file** | **File** | File path. |  |
+| **file** | **File** | File path. | [optional] |
 
 ### Return type
 
@@ -526,8 +530,8 @@ end
 
 api_instance = VoucherifySdk::ProductsApi.new
 opts = {
-  limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
-  page: 56, # Integer | Which page of results to return.
+  limit: 56, # Integer | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
+  page: 56, # Integer | Which page of results to return. The lowest value is 1.
   order: VoucherifySdk::ParameterOrder::CREATED_AT, # ParameterOrder | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
   start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
   end_date: Time.parse('2013-10-20T19:20:30+01:00') # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
@@ -546,8 +550,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
-| **page** | **Integer** | Which page of results to return. | [optional] |
+| **limit** | **Integer** | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] |
+| **page** | **Integer** | Which page of results to return. The lowest value is 1. | [optional] |
 | **order** | [**ParameterOrder**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
 | **start_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
 | **end_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
@@ -595,8 +599,8 @@ end
 api_instance = VoucherifySdk::ProductsApi.new
 product_id = 'product_id_example' # String | A Voucherify product ID or product source ID.
 opts = {
-  limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
-  page: 56, # Integer | Which page of results to return.
+  limit: 56, # Integer | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
+  page: 56, # Integer | Which page of results to return. The lowest value is 1.
   order: VoucherifySdk::ParameterOrder::CREATED_AT, # ParameterOrder | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
   start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
   end_date: Time.parse('2013-10-20T19:20:30+01:00') # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
@@ -616,8 +620,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **product_id** | **String** | A Voucherify product ID or product source ID. |  |
-| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
-| **page** | **Integer** | Which page of results to return. | [optional] |
+| **limit** | **Integer** | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] |
+| **page** | **Integer** | Which page of results to return. The lowest value is 1. | [optional] |
 | **order** | [**ParameterOrder**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
 | **start_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
 | **end_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
@@ -702,9 +706,9 @@ end
 
 > <ProductsUpdateInBulkResponseBody> update_products_in_bulk(opts)
 
-Update Products in bulk
+Update Products in Bulk
 
-Update several products in one asynchronous operation.  In one request, it is possible to update a maximum of **100** records. In the response body, you get a unique async action identifier. If a requested product object is not found, then an **upsert** occurs. This is reflected in the Get Async Action endpoint as follows:    This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this API request.
+Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the GET Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
 
 ### Examples
 
@@ -726,11 +730,11 @@ end
 
 api_instance = VoucherifySdk::ProductsApi.new
 opts = {
-  products_update_in_bulk_request_body: [VoucherifySdk::ProductsUpdateInBulkRequestBody.new({source_id: 'test_prod_id_1'})] # Array<ProductsUpdateInBulkRequestBody> | Create an array of product objects, each with the parameters which you want to update.
+  products_update_in_bulk_request_body: [VoucherifySdk::ProductsUpdateInBulkRequestBody.new] # Array<ProductsUpdateInBulkRequestBody> | List the product fields to be updated in each customer object.
 }
 
 begin
-  # Update Products in bulk
+  # Update Products in Bulk
   result = api_instance.update_products_in_bulk(opts)
   p result
 rescue VoucherifySdk::ApiError => e
@@ -742,7 +746,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **products_update_in_bulk_request_body** | [**Array&lt;ProductsUpdateInBulkRequestBody&gt;**](ProductsUpdateInBulkRequestBody.md) | Create an array of product objects, each with the parameters which you want to update. | [optional] |
+| **products_update_in_bulk_request_body** | [**Array&lt;ProductsUpdateInBulkRequestBody&gt;**](ProductsUpdateInBulkRequestBody.md) | List the product fields to be updated in each customer object. | [optional] |
 
 ### Return type
 
@@ -762,9 +766,9 @@ end
 
 > <ProductsMetadataUpdateInBulkResponseBody> update_products_metadata_in_bulk(opts)
 
-Update Products' Metadata in bulk
+Update Products' Metadata in Bulk
 
-Update several product metadata properties in one asynchronous operation.  In one request, it is possible to update a maximum of **100** records. In the response body, you get a unique async action identifier. If a requested product object is not found, then an **upsert** occurs. This is reflected in the Get Async Action endpoint as follows:    This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this API request.
+Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the GET Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
 
 ### Examples
 
@@ -786,11 +790,11 @@ end
 
 api_instance = VoucherifySdk::ProductsApi.new
 opts = {
-  products_metadata_update_in_bulk_request_body: VoucherifySdk::ProductsMetadataUpdateInBulkRequestBody.new({source_ids: ['source_ids_example'], metadata: 3.56}) # ProductsMetadataUpdateInBulkRequestBody | Specify the list of product source IDs and the metadata key value pairs to be udpated for these products.
+  products_metadata_update_in_bulk_request_body: VoucherifySdk::ProductsMetadataUpdateInBulkRequestBody.new # ProductsMetadataUpdateInBulkRequestBody | List the source_ids of the products you would like to update with the metadata key/value pairs.
 }
 
 begin
-  # Update Products' Metadata in bulk
+  # Update Products' Metadata in Bulk
   result = api_instance.update_products_metadata_in_bulk(opts)
   p result
 rescue VoucherifySdk::ApiError => e
@@ -802,7 +806,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **products_metadata_update_in_bulk_request_body** | [**ProductsMetadataUpdateInBulkRequestBody**](ProductsMetadataUpdateInBulkRequestBody.md) | Specify the list of product source IDs and the metadata key value pairs to be udpated for these products. | [optional] |
+| **products_metadata_update_in_bulk_request_body** | [**ProductsMetadataUpdateInBulkRequestBody**](ProductsMetadataUpdateInBulkRequestBody.md) | List the source_ids of the products you would like to update with the metadata key/value pairs. | [optional] |
 
 ### Return type
 

data/docs/ProductsCreateResponseBody.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique product ID assigned by Voucherify. |  |
-| **source_id** | **String** | Unique product source ID. |  |
-| **name** | **String** | Unique user-defined product name. |  |
-| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. |  |
-| **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. |  |
+| **id** | **String** | Unique product ID assigned by Voucherify. | [optional] |
+| **source_id** | **String** | Unique product source ID. | [optional] |
+| **name** | **String** | Unique user-defined product name. | [optional] |
+| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
+| **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] |
 | **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the product was created in ISO 8601 format. | [optional] |
-| **updated_at** | **Time** | Timestamp representing the date and time when the product was updated in ISO 8601 format. | [optional] |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the product. | [default to 'product'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the product. | [optional][default to 'product'] |
 | **skus** | [**SkusListForProduct**](SkusListForProduct.md) |  | [optional] |
 

data/docs/ProductsGetResponseBody.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique product ID assigned by Voucherify. |  |
-| **source_id** | **String** | Unique product source ID. |  |
-| **name** | **String** | Unique user-defined product name. |  |
-| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. |  |
-| **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. |  |
+| **id** | **String** | Unique product ID assigned by Voucherify. | [optional] |
+| **source_id** | **String** | Unique product source ID. | [optional] |
+| **name** | **String** | Unique user-defined product name. | [optional] |
+| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
+| **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] |
 | **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the product was created in ISO 8601 format. | [optional] |
-| **updated_at** | **Time** | Timestamp representing the date and time when the product was updated in ISO 8601 format. | [optional] |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the product. | [default to 'product'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the product. | [optional][default to 'product'] |
 | **skus** | [**SkusListForProduct**](SkusListForProduct.md) |  | [optional] |
 

data/docs/ProductsImportCsvCreateResponseBody.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **async_action_id** | **String** | The ID of the scheduled asynchronous action. |  |
+| **async_action_id** | **String** | The ID of the scheduled asynchronous action. | [optional] |
 

data/docs/ProductsListResponseBody.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about products in a dictionary. | [default to 'list'] |
-| **data_ref** | **String** | Identifies the name of the attribute that contains the array of product objects. | [default to 'products'] |
-| **products** | [**Array<Product>**](Product.md) | Contains array of product objects. |  |
-| **total** | **Integer** | Total number of product objects. |  |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about products in a dictionary. | [optional][default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the attribute that contains the array of product objects. | [optional][default to 'products'] |
+| **products** | [**Array<Product>**](Product.md) | Contains array of product objects. | [optional] |
+| **total** | **Integer** | Total number of product objects. | [optional] |
 

data/docs/ProductsMetadataUpdateInBulkRequestBody.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **source_ids** | **Array<String>** | Array of unique product source IDs. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. |  |
+| **source_ids** | **Array<String>** | Array of unique product source IDs. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] |
 

data/docs/ProductsMetadataUpdateInBulkResponseBody.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **async_action_id** | **String** | The ID of the scheduled asynchronous action. |  |
+| **async_action_id** | **String** | The ID of the scheduled asynchronous action. | [optional] |
 

data/docs/ProductsSkusCreateResponseBody.md

@@ -4,16 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. |  |
-| **source_id** | **String** | A unique SKU identifier from your inventory system. |  |
-| **product_id** | **String** | The parent product's unique ID. |  |
-| **sku** | **String** | Unique user-defined SKU name. |  |
-| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. |  |
+| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] |
+| **source_id** | **String** | A unique SKU identifier from your inventory system. | [optional] |
+| **product_id** | **String** | The parent product's unique ID. | [optional] |
+| **sku** | **String** | Unique user-defined SKU name. | [optional] |
+| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
 | **currency** | **String** | SKU price currency. | [optional] |
-| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. |  |
-| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. |  |
-| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated in ISO 8601 format. |  |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the `SKU`. | [default to 'sku'] |
+| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] |
+| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the `SKU`. | [optional][default to 'sku'] |
 

data/docs/ProductsSkusListResponseBody.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about SKUs. | [default to 'list'] |
-| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of SKUs. | [default to 'data'] |
-| **skus** | [**Array<Sku>**](Sku.md) | A dictionary that contains an array of SKUs. |  |
-| **total** | **Integer** | Total number of SKUs in the product. |  |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about SKUs. | [optional][default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of SKUs. | [optional][default to 'data'] |
+| **skus** | [**Array<Sku>**](Sku.md) | A dictionary that contains an array of SKUs. | [optional] |
+| **total** | **Integer** | Total number of SKUs in the product. | [optional] |
 

data/docs/ProductsSkusUpdateResponseBody.md

@@ -4,16 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. |  |
-| **source_id** | **String** | A unique SKU identifier from your inventory system. |  |
-| **product_id** | **String** | The parent product's unique ID. |  |
-| **sku** | **String** | Unique user-defined SKU name. |  |
-| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. |  |
+| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] |
+| **source_id** | **String** | A unique SKU identifier from your inventory system. | [optional] |
+| **product_id** | **String** | The parent product's unique ID. | [optional] |
+| **sku** | **String** | Unique user-defined SKU name. | [optional] |
+| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
 | **currency** | **String** | SKU price currency. | [optional] |
-| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. |  |
-| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. |  |
-| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated in ISO 8601 format. |  |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the `SKU`. | [default to 'sku'] |
+| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] |
+| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the `SKU`. | [optional][default to 'sku'] |
 

data/docs/ProductsUpdateInBulkRequestBody.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **source_id** | **String** | Unique product source ID from your inventory system. |  |
+| **source_id** | **String** | Unique product source ID from your inventory system. | [optional] |
 | **name** | **String** | Unique user-defined product name. | [optional] |
 | **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
 | **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] |

data/docs/ProductsUpdateInBulkResponseBody.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **async_action_id** | **String** | The ID of the scheduled asynchronous action. |  |
+| **async_action_id** | **String** | The ID of the scheduled asynchronous action. | [optional] |
 

data/docs/ProductsUpdateResponseBody.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique product ID assigned by Voucherify. |  |
-| **source_id** | **String** | Unique product source ID. |  |
-| **name** | **String** | Unique user-defined product name. |  |
-| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. |  |
-| **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. |  |
+| **id** | **String** | Unique product ID assigned by Voucherify. | [optional] |
+| **source_id** | **String** | Unique product source ID. | [optional] |
+| **name** | **String** | Unique user-defined product name. | [optional] |
+| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
+| **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | [optional] |
 | **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the product was created in ISO 8601 format. | [optional] |
-| **updated_at** | **Time** | Timestamp representing the date and time when the product was updated in ISO 8601 format. | [optional] |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the product. | [default to 'product'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the product. | [optional][default to 'product'] |
 | **skus** | [**SkusListForProduct**](SkusListForProduct.md) |  | [optional] |
 

data/docs/PromotionStack.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Promotion stack name. |  |
-| **tiers** | [**PromotionStackBaseTiers**](PromotionStackBaseTiers.md) |  |  |
-| **id** | **String** | Unique promotion stack ID. |  |
-| **created_at** | **Time** | Timestamp representing the date and time when the promotion stack was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the promotion stack was updated in ISO 8601 format. | [optional] |
-| **campaign_id** | **String** | Promotion stack's parent campaign's unique ID. |  |
-| **object** | **String** | The type of object represented by JSON.  | [default to 'promotion_stack'] |
-| **category_id** | **String** | Promotion stack category ID. |  |
-| **categories** | [**Array<Category>**](Category.md) | Details about the category assigned to the promotion stack. |  |
+| **name** | **String** | Promotion stack name. | [optional] |
+| **tiers** | [**PromotionStackTiers**](PromotionStackTiers.md) |  | [optional] |
+| **id** | **String** | Unique promotion stack ID. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the promotion stack was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the promotion stack was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **campaign_id** | **String** | Promotion stack's parent campaign's unique ID. | [optional] |
+| **object** | **String** | The type of the object represented by JSON.  | [optional][default to 'promotion_stack'] |
+| **category_id** | **String** | Promotion stack category ID. | [optional] |
+| **categories** | [**Array<Category>**](Category.md) | Details about the category assigned to the promotion stack. | [optional] |
 

data/docs/PromotionStackBase.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Promotion stack name. |  |
-| **tiers** | [**PromotionStackBaseTiers**](PromotionStackBaseTiers.md) |  |  |
+| **name** | **String** | Promotion stack name. | [optional] |
+| **tiers** | [**PromotionStackBaseTiers**](PromotionStackBaseTiers.md) |  | [optional] |
 

data/docs/PromotionStackBaseTiers.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ids** | **Array<String>** | Contains the list of tiers in a pre-defined sequence. |  |
+| **ids** | **Array<String>** | Contains the list of tiers in a pre-defined sequence. | [optional] |
 | **hierarchy_mode** | **String** |  | [optional][default to 'MANUAL'] |
 

data/docs/PromotionStackTiers.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::PromotionStackTiers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | Contains the list of tiers in a pre-defined sequence. | [optional] |
+| **hierarchy_mode** | **String** |  | [optional][default to 'MANUAL'] |
+

data/docs/PromotionTier.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Unique promotion tier ID. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the promotion tier was created in ISO 8601 format. | [optional] |
-| **updated_at** | **Time** | Timestamp representing the date and time when the promotion tier was updated in ISO 8601 format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format. | [optional] |
 | **name** | **String** | Name of the promotion tier. | [optional] |
 | **banner** | **String** | Text to be displayed to your customers on your website. | [optional] |
 | **action** | [**PromotionTierAction**](PromotionTierAction.md) |  | [optional] |
@@ -18,10 +18,11 @@
 | **active** | **Boolean** | A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier | [optional] |
 | **start_date** | **Time** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] |
 | **expiration_date** | **Time** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is *inactive after* this date.  | [optional] |
-| **validity_timeframe** | [**PromotionTierValidityTimeframe**](PromotionTierValidityTimeframe.md) |  | [optional] |
-| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the promotion tier is valid.  - `0`  Sunday   - `1`  Monday   - `2`  Tuesday   - `3`  Wednesday   - `4`  Thursday   - `5`  Friday   - `6`  Saturday   | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
 | **summary** | [**PromotionTierSummary**](PromotionTierSummary.md) |  | [optional] |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the promotion tier. | [optional][default to 'promotion_tier'] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the promotion tier. | [optional][default to 'promotion_tier'] |
 | **validation_rule_assignments** | [**ValidationRuleAssignmentsList**](ValidationRuleAssignmentsList.md) |  | [optional] |
 | **category_id** | **String** | Promotion tier category ID. | [optional] |
 | **categories** | [**Array<Category>**](Category.md) |  | [optional] |

data/docs/PromotionTierCampaign.md

@@ -7,9 +7,10 @@
 | **id** | **String** | Unique campaign ID. | [optional] |
 | **start_date** | **Time** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] |
 | **expiration_date** | **Time** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] |
-| **validity_timeframe** | [**PromotionTierCampaignValidityTimeframe**](PromotionTierCampaignValidityTimeframe.md) |  | [optional] |
-| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the campaign is valid.  - `0`  Sunday   - `1`  Monday   - `2`  Tuesday   - `3`  Wednesday   - `4`  Thursday   - `5`  Friday   - `6`  Saturday   | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
 | **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
 | **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
-| **object** | **String** | The type of object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
+| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |