@voucherify/sdk 2.9.3 → 3.0.0

package/docs/CampaignsCreateRequestBody.md

@@ -0,0 +1,79 @@
+# Voucherify.CampaignsCreateRequestBody
+
+## 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 or if the campaign consists of generic (standalone) vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published | [optional] 
+**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. For loyalty campaigns, it's forced to `true`, even if `join_once: false` is passed in the request. | [optional] 
+**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
+**useVoucherMetadataSchema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
+**vouchersCount** | **Number** | Total number of unique vouchers in campaign (size of campaign). | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | 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] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**activityDurationAfterPublishing** | **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] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] 
+**category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [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] 
+**accessSettings** | [**AccessSettings**](AccessSettings.md) |  | [optional] 
+**validationRules** | **[String]** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] 
+**campaignType** | **String** |  | [optional] 
+**voucher** | [**CampaignsCreateRequestBodyVoucher**](CampaignsCreateRequestBodyVoucher.md) |  | [optional] 
+**referralProgram** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
+**promotion** | [**CampaignsCreateRequestBodyPromotion**](CampaignsCreateRequestBodyPromotion.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
+* `STATIC` (value: `"STATIC"`)
+
+
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `REFERRAL_PROGRAM` (value: `"REFERRAL_PROGRAM"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+* `LOYALTY_PROGRAM` (value: `"LOYALTY_PROGRAM"`)
+
+* `PROMOTION` (value: `"PROMOTION"`)
+
+
+
+

package/docs/CampaignsCreateRequestBodyPromotion.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsCreateRequestBodyPromotion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tiers** | [**[PromotionTierCreateParams]**](PromotionTierCreateParams.md) |  | [optional] 
+
+

package/docs/CampaignsCreateRequestBodyVoucher.md

@@ -0,0 +1,28 @@
+# Voucherify.CampaignsCreateRequestBodyVoucher
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+**codeConfig** | [**CodeConfig**](CodeConfig.md) |  | [optional] 
+**redemption** | [**CampaignsCreateRequestBodyVoucherRedemption**](CampaignsCreateRequestBodyVoucherRedemption.md) |  | [optional] 
+**isReferralCode** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] 
+**gift** | [**Gift**](Gift.md) |  | [optional] 
+**loyaltyCard** | [**CampaignLoyaltyCard**](CampaignLoyaltyCard.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `DISCOUNT_VOUCHER` (value: `"DISCOUNT_VOUCHER"`)
+
+* `GIFT_VOUCHER` (value: `"GIFT_VOUCHER"`)
+
+* `LOYALTY_CARD` (value: `"LOYALTY_CARD"`)
+
+
+
+

package/docs/CampaignsCreateRequestBodyVoucherRedemption.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsCreateRequestBodyVoucherRedemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Number** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
+
+

package/docs/CampaignsCreateResponseBody.md

@@ -0,0 +1,126 @@
+# Voucherify.CampaignsCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**campaignType** | **String** | Type of campaign. | [optional] 
+**type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] 
+**voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] 
+**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
+**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. | [optional] 
+**useVoucherMetadataSchema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | 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] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**activityDurationAfterPublishing** | **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] 
+**vouchersCount** | **Number** | Total number of unique vouchers in campaign. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | 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] 
+**createdAt** | **Date** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] 
+**category** | **String** | Unique category name. | [optional] 
+**creationStatus** | **String** | Indicates the status of the campaign creation. | [optional] 
+**vouchersGenerationStatus** | **String** | Indicates the status of the campaign's voucher generation. | [optional] 
+**readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the [GET Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint. | [optional] 
+**_protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the campaign category. For the GET [List campaigns](/api-reference/campaigns/list-campaigns) endpoint, this is returned only if the `expand=category` query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET [Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint, it is always returned as an empty array. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
+**referralProgram** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
+**loyaltyTiersExpiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**accessSettingsAssignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
+**promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `LOYALTY_PROGRAM` (value: `"LOYALTY_PROGRAM"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `PROMOTION` (value: `"PROMOTION"`)
+
+* `REFERRAL_PROGRAM` (value: `"REFERRAL_PROGRAM"`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
+* `STATIC` (value: `"STATIC"`)
+
+* `STANDALONE` (value: `"STANDALONE"`)
+
+
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+
+
+## Enum: CreationStatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `DRAFT` (value: `"DRAFT"`)
+
+* `MODIFYING` (value: `"MODIFYING"`)
+
+
+
+
+
+## Enum: VouchersGenerationStatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `DRAFT` (value: `"DRAFT"`)
+
+* `MODIFYING` (value: `"MODIFYING"`)
+
+
+
+

package/docs/CampaignsDeleteResponseBody.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsDeleteResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | [optional] 
+
+

package/docs/CampaignsGetResponseBody.md

@@ -0,0 +1,126 @@
+# Voucherify.CampaignsGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**campaignType** | **String** | Type of campaign. | [optional] 
+**type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] 
+**voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] 
+**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
+**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. | [optional] 
+**useVoucherMetadataSchema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | 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] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**activityDurationAfterPublishing** | **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] 
+**vouchersCount** | **Number** | Total number of unique vouchers in campaign. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | 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] 
+**createdAt** | **Date** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] 
+**category** | **String** | Unique category name. | [optional] 
+**creationStatus** | **String** | Indicates the status of the campaign creation. | [optional] 
+**vouchersGenerationStatus** | **String** | Indicates the status of the campaign's voucher generation. | [optional] 
+**readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the [GET Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint. | [optional] 
+**_protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**categories** | [**[Category]**](Category.md) | Contains details about the campaign category. For the GET [List campaigns](/api-reference/campaigns/list-campaigns) endpoint, this is returned only if the `expand=category` query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET [Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint, it is always returned as an empty array. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional] [default to 'campaign']
+**referralProgram** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] 
+**loyaltyTiersExpiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] 
+**accessSettingsAssignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] 
+**promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] 
+**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] 
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `LOYALTY_PROGRAM` (value: `"LOYALTY_PROGRAM"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `PROMOTION` (value: `"PROMOTION"`)
+
+* `REFERRAL_PROGRAM` (value: `"REFERRAL_PROGRAM"`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
+* `STATIC` (value: `"STATIC"`)
+
+* `STANDALONE` (value: `"STANDALONE"`)
+
+
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+
+
+## Enum: CreationStatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `DRAFT` (value: `"DRAFT"`)
+
+* `MODIFYING` (value: `"MODIFYING"`)
+
+
+
+
+
+## Enum: VouchersGenerationStatusEnum
+
+
+* `DONE` (value: `"DONE"`)
+
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+
+* `FAILED` (value: `"FAILED"`)
+
+* `DRAFT` (value: `"DRAFT"`)
+
+* `MODIFYING` (value: `"MODIFYING"`)
+
+
+
+

package/docs/CampaignsImportCreateResponseBody.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsImportCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | [optional] 
+
+

package/docs/CampaignsImportCsvCreateResponseBody.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsImportCsvCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | [optional] 
+
+

package/docs/CampaignsImportVoucherItem.md

@@ -0,0 +1,56 @@
+# Voucherify.CampaignsImportVoucherItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the code. 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** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. | [optional] 
+**startDate** | **Date** | 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] 
+**expirationDate** | **Date** | 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] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | 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] 
+**additionalInfo** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] 
+**type** | **String** |  | [optional] 
+**loyaltyCard** | [**SimpleLoyaltyCard**](SimpleLoyaltyCard.md) |  | [optional] 
+**gift** | [**Gift**](Gift.md) |  | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+
+
+## Enum: TypeEnum
+
+
+* `LOYALTY_CARD` (value: `"LOYALTY_CARD"`)
+
+* `GIFT_VOUCHER` (value: `"GIFT_VOUCHER"`)
+
+* `DISCOUNT_VOUCHER` (value: `"DISCOUNT_VOUCHER"`)
+
+
+
+

package/docs/CampaignsImportVoucherItemRedemption.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsImportVoucherItemRedemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Number** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
+
+

package/docs/CampaignsListResponseBody.md

@@ -0,0 +1,12 @@
+# Voucherify.CampaignsListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about campaigns in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of campaign objects. | [optional] [default to 'campaigns']
+**campaigns** | [**[CampaignBase]**](CampaignBase.md) | Contains array of campaign objects. | [optional] 
+**total** | **Number** | Total number of campaigns. | [optional] 
+
+

package/docs/CampaignsSummaryGetResponseBody.md

@@ -0,0 +1,58 @@
+# Voucherify.CampaignsSummaryGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object, which is `campaign_summary`. | [optional] [default to 'campaign_summary']
+**campaign** | [**CampaignBase**](CampaignBase.md) |  | [optional] 
+**redemptions** | **Number** | Total number of redemptions, which includes successful and failed redemptions. | [optional] 
+**redemptionsSucceeded** | **Number** | Total number of successful redemptions. | [optional] 
+**redemptionsFailed** | **Number** | Total number of failed redemptions. | [optional] 
+**rollbacks** | **Number** | Total number of rollbacks, which includes successful and failed rollbacks. | [optional] 
+**rollbacksSucceeded** | **Number** | Total number of successful rollbacks. | [optional] 
+**rollbacksFailed** | **Number** | Total number of failed rollbacks. | [optional] 
+**validations** | **Number** | Total number of validations, which includes successful and failed validations. | [optional] 
+**validationsSucceeded** | **Number** | Total number of successful validations. | [optional] 
+**validationsFailed** | **Number** | Total number of failed validations. | [optional] 
+**ordersAmount** | **Number** | Total amount of orders related to the campaign. This amount is not reduced by `orders_rolledback_amount`. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**ordersRolledbackAmount** | **Number** | Total amount of orders that were rolled back and are related to the campaign. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**vouchersCreated** | **Number** | Total number of vouchers created within the campaign. Includes vouchers generated when the campaign was created, vouchers added manually, or vouchers generated automatically when a new customer joined the campaign. | [optional] 
+**vouchersDeleted** | **Number** | Total number of vouchers deleted within the campaign. Includes vouchers moved to the bin and vouchers deleted permanently. Vouchers moved to the bin and then deleted permanently are counted once. | [optional] 
+**publications** | **Number** | Total number of publications, which includes successful and failed publications. | [optional] 
+**publicationsSucceeded** | **Number** | Total number of successful publications. | [optional] 
+**publicationsFailed** | **Number** | Total number of failed publications. | [optional] 
+**discountedAmount** | **Number** | Total amount of discounts related to the campaign. This amount is not reduced by the `rolledback_discounted_amount`. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**rolledbackDiscountedAmount** | **Number** | Total amount of discounts orders that were rolled back and are related to the campaign. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**createdVouchersAmount** | **Number** | The total credit amount for all created gift cards. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**amountAdded** | **Number** | The total credit amount that was added. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**amountDeleted** | **Number** | The total credit amount that was deleted by deleting gift cards. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**amountRedeemed** | **Number** | The total credit amount that was redeemed. This amount is not reduced by the `amount_rolledback`. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**amountRolledback** | **Number** | The total credit amount that was rolled back. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**amountSubtracted** | **Number** | The total credit amount that was subtracted. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] 
+**createdVouchersPoints** | **Number** | Total number of points added to newly created loyalty cards. This also counts points added for the loyalty cards which are created by importing a CSV file to a campaign. | [optional] 
+**pointsDeleted** | **Number** | Total number of points that were deleted. | [optional] 
+**pointsSubtracted** | **Number** | Total number of points that were subtracted. | [optional] 
+**pointsAdded** | **Number** | Total number of points that were added. This includes points added manually or automatically by redeeming a reward that adds loyalty points to cards in this campaign. | [optional] 
+**pointsRewarded** | **Number** | Total number of points that were rewarded to loyalty cards through earning rules. This includes pending points that were activated. | [optional] 
+**pointsRedeemed** | **Number** | Total number of points that were redeemed for rewards. | [optional] 
+**pointsRolledback** | **Number** | Total number of points that were rolled back for reward redemptions. | [optional] 
+**pointsExpired** | **Number** | Total number of points that have expired. | [optional] 
+**pointsTransferredOut** | **Number** | Total number of points transferred out of loyalty cards covered by the campaign. | [optional] 
+**pointsTransferredIn** | **Number** | Total number of points transferred into loyalty cards covered by the campaign. | [optional] 
+**pendingPointsAdded** | **Number** | Total number of pending points that were added either as part of earning rules or added manually to an existing pending point bucket. Pending points that were activated manually or automatically or that were canceled do not affect this number. | [optional] 
+**pendingPointsSubtracted** | **Number** | Total number of pending points that were subtracted from existing pending point buckets. | [optional] 
+**pendingPointsActivated** | **Number** | Total number of pending points that were activated manually or automatically. | [optional] 
+**pendingPointsCanceled** | **Number** | Total number of pending points that were canceled. | [optional] 
+**referredCustomers** | **Number** | Total number of all referred customers. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `campaign_summary` (value: `"campaign_summary"`)
+
+
+
+

package/docs/CampaignsTransactionsExportCreateRequestBody.md

@@ -0,0 +1,9 @@
+# Voucherify.CampaignsTransactionsExportCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**CampaignsTransactionsExportCreateRequestBodyParameters**](CampaignsTransactionsExportCreateRequestBodyParameters.md) |  | [optional] 
+
+

package/docs/CampaignsTransactionsExportCreateRequestBodyParameters.md

@@ -0,0 +1,51 @@
+# Voucherify.CampaignsTransactionsExportCreateRequestBodyParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | **String** | How the export is ordered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] 
+**fields** | **[String]** | Data fields that will be exported for the transactions that are associated with balance movements on cards in a campaign. | [optional] 
+**filters** | [**ExportCampaignTransactionsFilters**](ExportCampaignTransactionsFilters.md) |  | [optional] 
+
+
+
+## Enum: OrderEnum
+
+
+* `-created_at` (value: `"-created_at"`)
+
+* `created_at` (value: `"created_at"`)
+
+
+
+
+
+## Enum: [FieldsEnum]
+
+
+* `id` (value: `"id"`)
+
+* `type` (value: `"type"`)
+
+* `source_id` (value: `"source_id"`)
+
+* `reason` (value: `"reason"`)
+
+* `balance` (value: `"balance"`)
+
+* `amount` (value: `"amount"`)
+
+* `created_at` (value: `"created_at"`)
+
+* `voucher_id` (value: `"voucher_id"`)
+
+* `source` (value: `"source"`)
+
+* `details` (value: `"details"`)
+
+* `related_transaction_id` (value: `"related_transaction_id"`)
+
+
+
+