in progress

docs/ApplicableTo.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | This object stores information about the product collection. |  |
-| **id** | **String** | Unique product collection ID assigned by Voucherify. |  |
+| **object** | **String** | This object stores information about the product collection. | [optional] |
+| **id** | **String** | Unique product collection ID assigned by Voucherify. | [optional] |
 | **source_id** | **String** | The source ID from your inventory system. | [optional] |
 | **product_id** | **String** | Parent product's unique ID assigned by Voucherify. | [optional] |
 | **product_source_id** | **String** | Parent product's source ID from your inventory system. | [optional] |
-| **strict** | **Boolean** |  |  |
+| **strict** | **Boolean** |  | [optional] |
 | **price** | **Float** | New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price. | [optional] |
 | **price_formula** | **Float** | Formula used to calculate the discounted price of an item. | [optional] |
 | **effect** | [**ApplicableToEffect**](ApplicableToEffect.md) |  |  |

docs/ApplicableToResultList.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**Array<ApplicableTo>**](ApplicableTo.md) | Contains array of items to which the discount can apply. |  |
-| **total** | **Integer** | Total number of objects defining included products, SKUs, or product collections. |  |
-| **object** | **String** | The type of the object represented by JSON. | [default to 'list'] |
-| **data_ref** | **String** | The type of the object represented by JSON. | [default to 'data'] |
+| **data** | [**Array<ApplicableTo>**](ApplicableTo.md) | Contains array of items to which the discount can apply. | [optional] |
+| **total** | **Integer** | Total number of objects defining included products, SKUs, or product collections. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'list'] |
+| **data_ref** | **String** | The type of the object represented by JSON. | [optional][default to 'data'] |
 

docs/AsyncActions.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] |
 

docs/BusValRuleAssignment.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The unique identifier for a assignment |  |
-| **rule_id** | **String** | The unique identifier for a rule |  |
-| **related_object_id** | **String** | The unique identifier for a related object |  |
-| **related_object_type** | **String** | The type of related object |  |
+| **id** | **String** | The unique identifier for a assignment | [optional] |
+| **rule_id** | **String** | The unique identifier for a rule | [optional] |
+| **related_object_id** | **String** | The unique identifier for a related object | [optional] |
+| **related_object_type** | **String** | The type of related object | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
 | **updated_at** | **Time** | Timestamp representing the date and time when the object was last updated in ISO 8601 format. | [optional] |
-| **object** | **String** | The type of the object represented by JSON. | [default to 'validation_rules_assignment'] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'validation_rules_assignment'] |
 | **validation_status** | **String** | The validation status of the assignment | [optional] |
 | **validation_omitted_rules** | **Array<String>** | The list of omitted rules | [optional] |
 

docs/Campaign.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique campaign ID, assigned by Voucherify. |  |
-| **name** | **String** | Campaign name. |  |
+| **id** | **String** | Unique campaign ID, assigned by Voucherify. | [optional] |
+| **name** | **String** | Campaign name. | [optional] |
 | **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
-| **campaign_type** | **String** | Type of campaign. |  |
-| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published |  |
+| **campaign_type** | **String** | Type of campaign. | [optional] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] |
 | **voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] |
-| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. |  |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. |  |
-| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. |  |
+| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
 | **validity_timeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.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_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
@@ -22,15 +22,15 @@
 | **expiration_date** | **Time** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] |
 | **active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
 | **metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. |  |
+| **created_at** | **Time** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] |
 | **updated_at** | **Time** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] |
 | **category** | **String** | Unique category name. | [optional] |
-| **creation_status** | **String** | Indicates the status of the campaign creation. |  |
-| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. |  |
-| **protected** | **Boolean** | Indicates whether the resource can be deleted. |  |
-| **category_id** | **String** | Unique category ID that this campaign belongs to. |  |
-| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. |  |
-| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [default to 'campaign'] |
+| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
+| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
+| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
+| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
+| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional][default to 'campaign'] |
 | **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
 | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |

docs/CampaignBase.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique campaign ID, assigned by Voucherify. |  |
-| **name** | **String** | Campaign name. |  |
+| **id** | **String** | Unique campaign ID, assigned by Voucherify. | [optional] |
+| **name** | **String** | Campaign name. | [optional] |
 | **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
-| **campaign_type** | **String** | Type of campaign. |  |
-| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published |  |
+| **campaign_type** | **String** | Type of campaign. | [optional] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] |
 | **voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] |
-| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. |  |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. |  |
-| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. |  |
+| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
 | **validity_timeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.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_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
@@ -22,15 +22,15 @@
 | **expiration_date** | **Time** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] |
 | **active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
 | **metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. |  |
+| **created_at** | **Time** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] |
 | **updated_at** | **Time** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] |
 | **category** | **String** | Unique category name. | [optional] |
-| **creation_status** | **String** | Indicates the status of the campaign creation. |  |
-| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. |  |
-| **protected** | **Boolean** | Indicates whether the resource can be deleted. |  |
-| **category_id** | **String** | Unique category ID that this campaign belongs to. |  |
-| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. |  |
-| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [default to 'campaign'] |
+| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
+| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
+| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
+| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
+| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional][default to 'campaign'] |
 | **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
 | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] |
 

docs/CampaignLoyaltyCard.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **points** | **Integer** | The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card. |  |
+| **points** | **Integer** | The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card. | [optional] |
 | **expiration_rules** | [**CampaignLoyaltyCardExpirationRules**](CampaignLoyaltyCardExpirationRules.md) |  | [optional] |
 

docs/CampaignLoyaltyCardExpirationRules.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **period_type** | **String** | Type of period |  |
-| **period_value** | **Integer** | Value of the period |  |
-| **rounding_type** | **String** | Type of rounding |  |
-| **rounding_value** | **Integer** | Value of rounding |  |
+| **period_type** | **String** | Type of period | [optional] |
+| **period_value** | **Integer** | Value of the period | [optional] |
+| **rounding_type** | **String** | Type of rounding | [optional] |
+| **rounding_value** | **Integer** | Value of rounding | [optional] |
 

docs/CampaignVoucher.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** | Type of voucher. | [default to 'DISCOUNT_VOUCHER'] |
+| **type** | **String** | Type of voucher. | [optional][default to 'DISCOUNT_VOUCHER'] |
 | **discount** | [**Discount**](Discount.md) |  | [optional] |
 | **gift** | [**Gift**](Gift.md) |  | [optional] |
 | **loyalty_card** | [**CampaignLoyaltyCard**](CampaignLoyaltyCard.md) |  | [optional] |
-| **redemption** | [**CampaignVoucherRedemption**](CampaignVoucherRedemption.md) |  |  |
+| **redemption** | [**CampaignVoucherRedemption**](CampaignVoucherRedemption.md) |  | [optional] |
 | **code_config** | [**CodeConfigRequiredLengthCharsetPattern**](CodeConfigRequiredLengthCharsetPattern.md) |  |  |
-| **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. |  |
+| **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [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** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.md) |  | [optional] |

docs/CampaignVoucherRedemption.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **quantity** | **Integer** | How many times a voucher can be redeemed. A `null` value means unlimited. |  |
+| **quantity** | **Integer** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] |