RubyGems - voucherify - Versions diffs - 5.0.1 → 6.0.0 - Mend

voucherify 5.0.1 → 6.0.0

Files changed (2465) hide show

data/docs/CampaignsApi.md CHANGED Viewed

@@ -44,7 +44,7 @@ VoucherifySdk.configure do |config|
 end
 api_instance = VoucherifySdk::CampaignsApi.new
-campaign_id = 'ABC' # String | The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
+campaign_id = 'campaign_id_example' # String | The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
 code = 'code_example' # String | A custom **code** that identifies the voucher.
 opts = {
   campaigns_vouchers_create_request_body: VoucherifySdk::CampaignsVouchersCreateRequestBody.new # CampaignsVouchersCreateRequestBody | Specify the voucher parameters that you would like to overwrite.
@@ -83,7 +83,7 @@ end
 ## add_vouchers_to_campaign
-> <CampaignsVouchersCreateResponseBody> add_vouchers_to_campaign(campaign_id, opts)
+> <CampaignsVouchersCreateCombinedResponseBody> add_vouchers_to_campaign(campaign_id, opts)
 Add Vouchers to Campaign
@@ -133,7 +133,7 @@ end
 ### Return type
-[**CampaignsVouchersCreateResponseBody**](CampaignsVouchersCreateResponseBody.md)
+[**CampaignsVouchersCreateCombinedResponseBody**](CampaignsVouchersCreateCombinedResponseBody.md)
 ### Authorization
@@ -173,7 +173,7 @@ end
 api_instance = VoucherifySdk::CampaignsApi.new
 opts = {
-  campaigns_create_request_body: VoucherifySdk::CampaignsCreateDiscountCouponsCampaign.new # CampaignsCreateRequestBody | Specify the details of the campaign that you would like to create.
+  campaigns_create_request_body: VoucherifySdk::CampaignsCreateRequestBody.new # CampaignsCreateRequestBody | Specify the details of the campaign that you would like to create.
 }
 begin
@@ -211,7 +211,7 @@ end
 Delete Campaign
-Permanently deletes a campaign and all related vouchers. This action cannot be undone. Also, this method immediately removes any redemptions on the voucher. 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.
+Deletes a campaign and all related vouchers. This action cannot be undone. Also, this method immediately removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the campaign and all related vouchers will be moved to the bin. 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.
 ### Examples
@@ -234,7 +234,7 @@ end
 api_instance = VoucherifySdk::CampaignsApi.new
 campaign_id = 'campaign_id_example' # String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
 opts = {
-  force: true # Boolean | If this flag is set to true, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with exactly the same name.
+  force: true # Boolean | If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the campaign and related vouchers will be moved to the bin. Going forward, the user will be able to create the next campaign with exactly the same name.
 }
 begin
@@ -251,7 +251,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **campaign_id** | **String** | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. |  |
-| **force** | **Boolean** | If this flag is set to true, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with exactly the same name. | [optional] |
+| **force** | **Boolean** | If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the campaign and related vouchers will be moved to the bin. Going forward, the user will be able to create the next campaign with exactly the same name. | [optional] |
 ### Return type
@@ -269,7 +269,7 @@ end
 ## disable_campaign
-> <CampaignsDisableResponseBody> disable_campaign(campaign_id)
+> Object disable_campaign(campaign_id)
 Disable Campaign
@@ -313,7 +313,7 @@ end
 ### Return type
-[**CampaignsDisableResponseBody**](CampaignsDisableResponseBody.md)
+**Object**
 ### Authorization
@@ -327,7 +327,7 @@ end
 ## enable_campaign
-> <CampaignsEnableResponseBody> enable_campaign(campaign_id)
+> Object enable_campaign(campaign_id)
 Enable Campaign
@@ -371,7 +371,7 @@ end
 ### Return type
-[**CampaignsEnableResponseBody**](CampaignsEnableResponseBody.md)
+**Object**
 ### Authorization
@@ -470,7 +470,7 @@ end
 api_instance = VoucherifySdk::CampaignsApi.new
 campaign_id = 'campaign_id_example' # String | The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
 opts = {
-  campaigns_import_voucher_item: [VoucherifySdk::CampaignsImportVoucherItem.new({code: 'code_example'})] # Array<CampaignsImportVoucherItem> | Discount type, expiration date and the remaining attributes will be taken from the Campaign settings.
+  campaigns_import_voucher_item: [VoucherifySdk::CampaignsImportVoucherItem.new] # Array<CampaignsImportVoucherItem> | Discount type, expiration date and the remaining attributes will be taken from the Campaign settings.
 }
 begin
@@ -505,7 +505,7 @@ end
 ## import_vouchers_to_campaign_using_csv
-> <CampaignsImportCsvCreateResponseBody> import_vouchers_to_campaign_using_csv(campaign_id, file)
+> <CampaignsImportCsvCreateResponseBody> import_vouchers_to_campaign_using_csv(campaign_id, opts)
 Import Vouchers to Campaign by CSV
@@ -531,11 +531,13 @@ end
 api_instance = VoucherifySdk::CampaignsApi.new
 campaign_id = 'campaign_id_example' # String | The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.
-file = File.new('/path/to/some/file') # File | File path.
+opts = {
+  file: File.new('/path/to/some/file') # File | File path.
+}
 begin
   # Import Vouchers to Campaign by CSV
-  result = api_instance.import_vouchers_to_campaign_using_csv(campaign_id, file)
+  result = api_instance.import_vouchers_to_campaign_using_csv(campaign_id, opts)
   p result
 rescue VoucherifySdk::ApiError => e
   puts "Error when calling CampaignsApi->import_vouchers_to_campaign_using_csv: #{e}"
@@ -547,7 +549,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **campaign_id** | **String** | The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value. |  |
-| **file** | **File** | File path. |  |
+| **file** | **File** | File path. | [optional] |
 ### Return type
@@ -591,8 +593,8 @@ end
 api_instance = VoucherifySdk::CampaignsApi.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.
   campaign_type: VoucherifySdk::ParameterCampaignType::PROMOTION, # ParameterCampaignType | This attribute allows filtering by campaign type.
   expand: VoucherifySdk::ParameterExpandListCampaigns::CATEGORY, # ParameterExpandListCampaigns | Include an expanded categories object in the response.
   order: VoucherifySdk::ParameterOrderListCampaigns::CREATED_AT # ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
@@ -611,8 +613,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] |
 | **campaign_type** | [**ParameterCampaignType**](.md) | This attribute allows filtering by campaign type. | [optional] |
 | **expand** | [**ParameterExpandListCampaigns**](.md) | Include an expanded categories object in the response. | [optional][default to &#39;category&#39;] |
 | **order** | [**ParameterOrderListCampaigns**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
@@ -660,7 +662,7 @@ end
 api_instance = VoucherifySdk::CampaignsApi.new
 campaign_id = 'campaign_id_example' # String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
 opts = {
-  campaigns_update_request_body: VoucherifySdk::CampaignsUpdateDiscountCouponsCampaign.new # CampaignsUpdateRequestBody | Specify the campaign parameters to be updated.
+  campaigns_update_request_body: VoucherifySdk::CampaignsUpdateRequestBody.new # CampaignsUpdateRequestBody | Specify the campaign parameters to be updated.
 }
 begin

data/docs/CampaignsCreateRequestBody.md CHANGED Viewed

@@ -1,57 +1,29 @@
 # VoucherifySdk::CampaignsCreateRequestBody
-## Class instance methods
-### `openapi_one_of`
-Returns the list of classes defined in oneOf.
-#### Example
-```ruby
-require 'VoucherifySdk'
-VoucherifySdk::CampaignsCreateRequestBody.openapi_one_of
-# =>
-# [
-#   :'CampaignsCreateDiscountCouponsCampaign',
-#   :'CampaignsCreateGiftCampaign',
-#   :'CampaignsCreateGiveawayCampaign',
-#   :'CampaignsCreateLoyaltyCampaign',
-#   :'CampaignsCreatePromotionCampaign',
-#   :'CampaignsCreateReferralCampaign'
-# ]
-```
-### build
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-#### Example
-```ruby
-require 'VoucherifySdk'
-VoucherifySdk::CampaignsCreateRequestBody.build(data)
-# => #<CampaignsCreateDiscountCouponsCampaign:0x00007fdd4aab02a0>
-VoucherifySdk::CampaignsCreateRequestBody.build(data_that_doesnt_match)
-# => nil
-```
-#### Parameters
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-#### Return type
-- `CampaignsCreateDiscountCouponsCampaign`
-- `CampaignsCreateGiftCampaign`
-- `CampaignsCreateGiveawayCampaign`
-- `CampaignsCreateLoyaltyCampaign`
-- `CampaignsCreatePromotionCampaign`
-- `CampaignsCreateReferralCampaign`
-- `nil` (if no type matches)
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - &#x60;AUTO_UPDATE&#x60;: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).     -  &#x60;STATIC&#x60;: vouchers need to be manually published. | [optional] |
+| **join_once** | **Boolean** | If this value is set to &#x60;true&#x60;, customers will be able to join the campaign only once. | [optional] |
+| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
+| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher&#39;s metadata schema instead of the campaign metadata schema. | [optional] |
+| **vouchers_count** | **Integer** | Total number of unique vouchers in campaign (size of campaign). | [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** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - &#x60;0&#x60; Sunday - &#x60;1&#x60; Monday - &#x60;2&#x60; Tuesday - &#x60;3&#x60; Wednesday - &#x60;4&#x60; Thursday - &#x60;5&#x60; Friday - &#x60;6&#x60; Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
+| **validation_rules** | **Array&lt;String&gt;** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
+| **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the &#x60;category&#x60;. | [optional] |
+| **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the &#x60;category_id&#x60;. | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **campaign_type** | **String** |  | [optional] |
+| **voucher** | [**CampaignsCreateRequestBodyVoucher**](CampaignsCreateRequestBodyVoucher.md) |  | [optional] |
+| **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
+| **promotion** | [**CampaignsCreateRequestBodyPromotion**](CampaignsCreateRequestBodyPromotion.md) |  | [optional] |
+| **lucky_draw** | [**LuckyDraw**](LuckyDraw.md) |  | [optional] |

data/docs/CampaignsCreateRequestBodyPromotion.md ADDED Viewed

@@ -0,0 +1,8 @@
+# VoucherifySdk::CampaignsCreateRequestBodyPromotion
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tiers** | [**Array&lt;PromotionTierCreateParams&gt;**](PromotionTierCreateParams.md) |  | [optional] |

data/docs/CampaignsCreateRequestBodyVoucher.md ADDED Viewed

@@ -0,0 +1,14 @@
+# VoucherifySdk::CampaignsCreateRequestBodyVoucher
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **discount** | [**Discount**](Discount.md) |  | [optional] |
+| **code_config** | [**CodeConfig**](CodeConfig.md) |  | [optional] |
+| **redemption** | [**CampaignsCreateRequestBodyVoucherRedemption**](CampaignsCreateRequestBodyVoucherRedemption.md) |  | [optional] |
+| **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; &#x60;true&#x60; for campaign type &#x60;REFERRAL_PROGRAM&#x60;. | [optional] |
+| **gift** | [**Gift**](Gift.md) |  | [optional] |
+| **loyalty_card** | [**CampaignLoyaltyCard**](CampaignLoyaltyCard.md) |  | [optional] |

data/docs/CampaignsCreateRequestBodyVoucherRedemption.md ADDED Viewed

@@ -0,0 +1,8 @@
+# VoucherifySdk::CampaignsCreateRequestBodyVoucherRedemption
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **quantity** | **Integer** | How many times a voucher can be redeemed. A &#x60;null&#x60; value means unlimited. | [optional] |

data/docs/CampaignsCreateResponseBody.md CHANGED Viewed

@@ -4,34 +4,36 @@
 | 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.      - &#x60;AUTO_UPDATE&#x60;: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  &#x60;STATIC&#x60;: 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.      - &#x60;AUTO_UPDATE&#x60;: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  &#x60;STATIC&#x60;: 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 &#x60;true&#x60;, 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&#39;s metadata schema instead of the campaign metadata schema. |  |
-| **validity_timeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.md) |  | [optional] |
-| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the campaign is valid.  - &#x60;0&#x60;  Sunday   - &#x60;1&#x60;  Monday   - &#x60;2&#x60;  Tuesday   - &#x60;3&#x60;  Wednesday   - &#x60;4&#x60;  Thursday   - &#x60;5&#x60;  Friday   - &#x60;6&#x60;  Saturday   | [optional] |
-| **activity_duration_after_publishing** | **String** | Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a &#x60;duration&#x60; of &#x60;P24D&#x60; will be valid for a duration of 24 days. | [optional] |
+| **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 &#x60;true&#x60;, 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&#39;s metadata schema instead of the campaign metadata schema. | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - &#x60;0&#x60; Sunday - &#x60;1&#x60; Monday - &#x60;2&#x60; Tuesday - &#x60;3&#x60; Wednesday - &#x60;4&#x60; Thursday - &#x60;5&#x60; Friday - &#x60;6&#x60; Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
 | **vouchers_count** | **Integer** | Total number of unique vouchers in campaign. | [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] |
 | **active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it&#39;s within the active period defined by the &#x60;start_date&#x60; and &#x60;expiration_date&#x60;.    - &#x60;true&#x60; indicates an *active* campaign - &#x60;false&#x60; 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 in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the voucher was updated in ISO 8601 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. | [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&#39;s vouchers. |  |
-| **protected** | **Boolean** | Indicates whether the resource can be deleted. |  |
-| **category_id** | **String** | Unique category ID that this campaign belongs to. |  |
-| **categories** | [**Array&lt;Category&gt;**](Category.md) | Contains details about the category. |  |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the campaign. | [default to &#39;campaign&#39;] |
+| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
+| **vouchers_generation_status** | **String** | Indicates the status of the campaign&#39;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&lt;Category&gt;**](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 &#39;campaign&#39;] |
 | **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
 | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |

data/docs/CampaignsGetResponseBody.md CHANGED Viewed

@@ -4,34 +4,36 @@
 | 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.      - &#x60;AUTO_UPDATE&#x60;: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  &#x60;STATIC&#x60;: 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.      - &#x60;AUTO_UPDATE&#x60;: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  &#x60;STATIC&#x60;: 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 &#x60;true&#x60;, 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&#39;s metadata schema instead of the campaign metadata schema. |  |
-| **validity_timeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.md) |  | [optional] |
-| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the campaign is valid.  - &#x60;0&#x60;  Sunday   - &#x60;1&#x60;  Monday   - &#x60;2&#x60;  Tuesday   - &#x60;3&#x60;  Wednesday   - &#x60;4&#x60;  Thursday   - &#x60;5&#x60;  Friday   - &#x60;6&#x60;  Saturday   | [optional] |
-| **activity_duration_after_publishing** | **String** | Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a &#x60;duration&#x60; of &#x60;P24D&#x60; will be valid for a duration of 24 days. | [optional] |
+| **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 &#x60;true&#x60;, 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&#39;s metadata schema instead of the campaign metadata schema. | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - &#x60;0&#x60; Sunday - &#x60;1&#x60; Monday - &#x60;2&#x60; Tuesday - &#x60;3&#x60; Wednesday - &#x60;4&#x60; Thursday - &#x60;5&#x60; Friday - &#x60;6&#x60; Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
 | **vouchers_count** | **Integer** | Total number of unique vouchers in campaign. | [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] |
 | **active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it&#39;s within the active period defined by the &#x60;start_date&#x60; and &#x60;expiration_date&#x60;.    - &#x60;true&#x60; indicates an *active* campaign - &#x60;false&#x60; 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 in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the voucher was updated in ISO 8601 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. | [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&#39;s vouchers. |  |
-| **protected** | **Boolean** | Indicates whether the resource can be deleted. |  |
-| **category_id** | **String** | Unique category ID that this campaign belongs to. |  |
-| **categories** | [**Array&lt;Category&gt;**](Category.md) | Contains details about the category. |  |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the campaign. | [default to &#39;campaign&#39;] |
+| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
+| **vouchers_generation_status** | **String** | Indicates the status of the campaign&#39;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&lt;Category&gt;**](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 &#39;campaign&#39;] |
 | **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
 | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |

data/docs/CampaignsImportCreateResponseBody.md CHANGED Viewed

@@ -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/CampaignsImportCsvCreateResponseBody.md CHANGED Viewed

@@ -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/CampaignsImportVoucherItem.md CHANGED Viewed

@@ -4,17 +4,18 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | Unique custom voucher code. |  |
-| **type** | **String** | Type of voucher. | [optional] |
+| **code** | **String** | Value representing the imported code. | [optional] |
 | **redemption** | [**CampaignsImportVoucherItemRedemption**](CampaignsImportVoucherItemRedemption.md) |  | [optional] |
 | **active** | **Boolean** | A flag to toggle the voucher on or off. You can disable a voucher even though it&#39;s within the active period defined by the &#x60;start_date&#x60; and &#x60;expiration_date&#x60;.    - &#x60;true&#x60; indicates an *active* voucher - &#x60;false&#x60; indicates an *inactive* voucher | [optional] |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the voucher. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] |
-| **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the &#x60;category_id&#x60;. | [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] |
-| **validity_timeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.md) |  | [optional] |
-| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the campaign is valid.  - &#x60;0&#x60;  Sunday   - &#x60;1&#x60;  Monday   - &#x60;2&#x60;  Tuesday   - &#x60;3&#x60;  Wednesday   - &#x60;4&#x60;  Thursday   - &#x60;5&#x60;  Friday   - &#x60;6&#x60;  Saturday   | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **category** | **String** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the [List Vouchers](ref:list-vouchers) endpoint. | [optional] |
+| **start_date** | **Time** | Activation timestamp presented in the ISO 8601 format. Voucher is *inactive before* this date. Start date defines when the code starts to be active. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ | [optional] |
+| **expiration_date** | **Time** | Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format.  Voucher is *inactive after* this date. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - &#x60;0&#x60; Sunday - &#x60;1&#x60; Monday - &#x60;2&#x60; Tuesday - &#x60;3&#x60; Wednesday - &#x60;4&#x60; Thursday - &#x60;5&#x60; Friday - &#x60;6&#x60; Saturday | [optional] |
 | **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
-| **discount** | [**Discount**](Discount.md) |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **loyalty_card** | [**SimpleLoyaltyCard**](SimpleLoyaltyCard.md) |  | [optional] |
 | **gift** | [**Gift**](Gift.md) |  | [optional] |
-| **loyalty_card** | [**CampaignsImportVoucherLoyaltyCard**](CampaignsImportVoucherLoyaltyCard.md) |  | [optional] |
+| **discount** | [**Discount**](Discount.md) |  | [optional] |

data/docs/CampaignsListResponseBody.md CHANGED Viewed

@@ -4,7 +4,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about campaigns in a dictionary. | [optional][default to &#39;list&#39;] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about campaigns in a dictionary. | [optional][default to &#39;list&#39;] |
 | **data_ref** | **String** | Identifies the name of the attribute that contains the array of campaign objects. | [optional][default to &#39;campaigns&#39;] |
 | **campaigns** | [**Array&lt;CampaignBase&gt;**](CampaignBase.md) | Contains array of campaign objects. | [optional] |
 | **total** | **Integer** | Total number of campaigns. | [optional] |

data/docs/CampaignsUpdateRequestBody.md CHANGED Viewed

@@ -1,57 +1,29 @@
 # VoucherifySdk::CampaignsUpdateRequestBody
-## Class instance methods
-### `openapi_one_of`
-Returns the list of classes defined in oneOf.
-#### Example
-```ruby
-require 'VoucherifySdk'
-VoucherifySdk::CampaignsUpdateRequestBody.openapi_one_of
-# =>
-# [
-#   :'CampaignsUpdateDiscountCouponsCampaign',
-#   :'CampaignsUpdateGiftCampaign',
-#   :'CampaignsUpdateGiveawayCampaign',
-#   :'CampaignsUpdateLoyaltyCampaign',
-#   :'CampaignsUpdatePromotionCampaign',
-#   :'CampaignsUpdateReferralCampaign'
-# ]
-```
-### build
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-#### Example
-```ruby
-require 'VoucherifySdk'
-VoucherifySdk::CampaignsUpdateRequestBody.build(data)
-# => #<CampaignsUpdateDiscountCouponsCampaign:0x00007fdd4aab02a0>
-VoucherifySdk::CampaignsUpdateRequestBody.build(data_that_doesnt_match)
-# => nil
-```
-#### Parameters
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-#### Return type
-- `CampaignsUpdateDiscountCouponsCampaign`
-- `CampaignsUpdateGiftCampaign`
-- `CampaignsUpdateGiveawayCampaign`
-- `CampaignsUpdateLoyaltyCampaign`
-- `CampaignsUpdatePromotionCampaign`
-- `CampaignsUpdateReferralCampaign`
-- `nil` (if no type matches)
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array&lt;Integer&gt;** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - &#x60;0&#x60; Sunday - &#x60;1&#x60; Monday - &#x60;2&#x60; Tuesday - &#x60;3&#x60; Wednesday - &#x60;4&#x60; Thursday - &#x60;5&#x60; Friday - &#x60;6&#x60; Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
+| **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the &#x60;category_id&#x60;. | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **unset_metadata_fields** | **Array&lt;String&gt;** | Determine which metadata should be removed from campaign. | [optional] |
+| **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the &#x60;category&#x60;. | [optional] |
+| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
+| **join_once** | **Boolean** | If this value is set to &#x60;true&#x60;, customers will be able to join the campaign only once. | [optional] |
+| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - &#x60;AUTO_UPDATE&#x60;: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).     -  &#x60;STATIC&#x60;: vouchers need to be manually published. | [optional] |
+| **discount** | **Object** |  | [optional] |
+| **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
+| **gift** | [**Gift**](Gift.md) |  | [optional] |
+| **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] |
+| **options** | [**CampaignsUpdateRequestBodyOptions**](CampaignsUpdateRequestBodyOptions.md) |  | [optional] |
+| **winners_count** | **String** | It represents the total number of winners in a lucky draw. | [optional] |
+| **unique_winners_per_draw** | **String** | It indicates whether each winner in a draw is unique or not. | [optional] |
+| **unique_winners** | **String** | Specifies whether each participant can win only once across multiple draws. | [optional] |

data/docs/CampaignsUpdateRequestBodyOptions.md ADDED Viewed

@@ -0,0 +1,8 @@
+# VoucherifySdk::CampaignsUpdateRequestBodyOptions
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recalculate_tiers** | **Boolean** | Determine if tiers should be recalculated or no. | [optional] |