├── .env.example
├── .gitignore
├── DEPRECATED_CHANGELOG.md
├── Dockerfile
├── ENDPOINTS-COVERAGE.md
├── LICENSE
├── MANIFEST
├── Makefile
├── README.md
├── __tests__
    ├── main.py
    ├── products_voucherify.csv
    ├── spec_utils.py
    ├── test_01_validation.py
    ├── test_02_redemption.py
    ├── test_03_qualifications.py
    ├── test_04_publications.py
    └── test_05_products.py
├── docs
    ├── AccessSettings.md
    ├── AccessSettingsAssign.md
    ├── AccessSettingsCampaignAssignmentsList.md
    ├── AccessSettingsUnassign.md
    ├── ApplicableTo.md
    ├── ApplicableToEffect.md
    ├── ApplicableToOrderItemUnitsItem.md
    ├── ApplicableToResultList.md
    ├── ApplicationDetailsItem.md
    ├── AreaStoreCampaignAssignment.md
    ├── AsyncActionBase.md
    ├── AsyncActionGetResponseBody.md
    ├── AsyncActionsApi.md
    ├── AsyncActionsListResponseBody.md
    ├── BinApi.md
    ├── BusValRuleAssignment.md
    ├── Campaign.md
    ├── CampaignBase.md
    ├── CampaignLoyaltyCard.md
    ├── CampaignLoyaltyCardExpirationRules.md
    ├── CampaignLoyaltyVoucher.md
    ├── CampaignLoyaltyVoucherRedemption.md
    ├── CampaignTemplate.md
    ├── CampaignVoucher.md
    ├── CampaignVoucherRedemption.md
    ├── CampaignsApi.md
    ├── CampaignsCreateRequestBody.md
    ├── CampaignsCreateRequestBodyPromotion.md
    ├── CampaignsCreateRequestBodyVoucher.md
    ├── CampaignsCreateRequestBodyVoucherRedemption.md
    ├── CampaignsCreateResponseBody.md
    ├── CampaignsDeleteResponseBody.md
    ├── CampaignsGetResponseBody.md
    ├── CampaignsImportCreateResponseBody.md
    ├── CampaignsImportCsvCreateResponseBody.md
    ├── CampaignsImportVoucherItem.md
    ├── CampaignsImportVoucherItemRedemption.md
    ├── CampaignsListResponseBody.md
    ├── CampaignsUpdateRequestBody.md
    ├── CampaignsUpdateRequestBodyOptions.md
    ├── CampaignsUpdateResponseBody.md
    ├── CampaignsVouchersCreateCombinedResponseBody.md
    ├── CampaignsVouchersCreateCombinedResponseBodyGift.md
    ├── CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md
    ├── CampaignsVouchersCreateCombinedResponseBodyPublish.md
    ├── CampaignsVouchersCreateCombinedResponseBodyRedemption.md
    ├── CampaignsVouchersCreateInBulkRequestBody.md
    ├── CampaignsVouchersCreateInBulkRequestBodyRedemption.md
    ├── CampaignsVouchersCreateRequestBody.md
    ├── CampaignsVouchersCreateRequestBodyRedemption.md
    ├── CampaignsVouchersCreateResponseBody.md
    ├── CampaignsVouchersCreateResponseBodyGift.md
    ├── CampaignsVouchersCreateResponseBodyLoyaltyCard.md
    ├── CampaignsVouchersCreateResponseBodyPublish.md
    ├── CampaignsVouchersCreateResponseBodyRedemption.md
    ├── CategoriesApi.md
    ├── CategoriesCreateRequestBody.md
    ├── CategoriesCreateResponseBody.md
    ├── CategoriesGetResponseBody.md
    ├── CategoriesListResponseBody.md
    ├── CategoriesUpdateRequestBody.md
    ├── CategoriesUpdateResponseBody.md
    ├── Category.md
    ├── CategoryWithStackingRulesType.md
    ├── ClientEventsCreateRequestBody.md
    ├── ClientEventsCreateRequestBodyLoyalty.md
    ├── ClientEventsCreateRequestBodyReferral.md
    ├── ClientEventsCreateResponseBody.md
    ├── ClientPromotionsTiersListResponseBody.md
    ├── ClientQualificationsCheckEligibilityRequestBody.md
    ├── ClientQualificationsCheckEligibilityResponseBody.md
    ├── ClientRedemptionsRedeemRequestBody.md
    ├── ClientRedemptionsRedeemRequestBodyOptions.md
    ├── ClientRedemptionsRedeemRequestBodyRedeemablesItem.md
    ├── ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md
    ├── ClientRedemptionsRedeemRequestBodyRedeemablesItemReward.md
    ├── ClientRedemptionsRedeemResponseBody.md
    ├── ClientSideApi.md
    ├── ClientValidationsValidateRequestBody.md
    ├── ClientValidationsValidateRequestBodyOptions.md
    ├── ClientValidationsValidateRequestBodyRedeemablesItem.md
    ├── ClientValidationsValidateRequestBodyRedeemablesItemGift.md
    ├── ClientValidationsValidateRequestBodyRedeemablesItemReward.md
    ├── ClientValidationsValidateResponseBody.md
    ├── ClientValidationsValidateResponseBodyRedeemablesItem.md
    ├── ClientValidationsValidateResponseBodyRedeemablesItemResult.md
    ├── ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md
    ├── ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md
    ├── ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md
    ├── ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md
    ├── ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md
    ├── CodeConfig.md
    ├── CreatePublicationCampaign.md
    ├── Customer.md
    ├── CustomerActivity.md
    ├── CustomerAddress.md
    ├── CustomerId.md
    ├── CustomerLoyalty.md
    ├── CustomerRedeemable.md
    ├── CustomerRedeemableRedeemable.md
    ├── CustomerReferrals.md
    ├── CustomerReferralsCampaignsItem.md
    ├── CustomerSummary.md
    ├── CustomerSummaryOrders.md
    ├── CustomerSummaryRedemptions.md
    ├── CustomerSummaryRedemptionsGift.md
    ├── CustomerSummaryRedemptionsLoyaltyCard.md
    ├── CustomerWithSummaryLoyaltyReferrals.md
    ├── CustomerWithSummaryLoyaltyReferralsAddress.md
    ├── CustomerWithSummaryLoyaltyReferralsAssets.md
    ├── CustomersActivityListResponseBody.md
    ├── CustomersApi.md
    ├── CustomersCreateRequestBody.md
    ├── CustomersCreateRequestBodyAddress.md
    ├── CustomersCreateResponseBody.md
    ├── CustomersCreateResponseBodyAddress.md
    ├── CustomersCreateResponseBodyAssets.md
    ├── CustomersGetResponseBody.md
    ├── CustomersGetResponseBodyAddress.md
    ├── CustomersGetResponseBodyAssets.md
    ├── CustomersImportCsvCreateResponseBody.md
    ├── CustomersListResponseBody.md
    ├── CustomersMetadataUpdateInBulkRequestBody.md
    ├── CustomersMetadataUpdateInBulkResponseBody.md
    ├── CustomersPermanentDeletionCreateResponseBody.md
    ├── CustomersPermanentDeletionCreateResponseBodyDataJson.md
    ├── CustomersRedeemablesListResponseBody.md
    ├── CustomersSegmentsListResponseBody.md
    ├── CustomersUpdateInBulkRequestBody.md
    ├── CustomersUpdateInBulkRequestBodyAddress.md
    ├── CustomersUpdateInBulkResponseBody.md
    ├── CustomersUpdateRequestBody.md
    ├── CustomersUpdateRequestBodyAddress.md
    ├── CustomersUpdateResponseBody.md
    ├── CustomersUpdateResponseBodyAddress.md
    ├── CustomersUpdateResponseBodyAssets.md
    ├── Discount.md
    ├── DiscountProduct.md
    ├── DiscountUnitMultipleOneUnit.md
    ├── EarningRule.md
    ├── EarningRuleCustomEvent.md
    ├── EarningRuleLoyalty.md
    ├── EarningRuleLoyaltyCustomEvent.md
    ├── EarningRuleLoyaltyCustomEventMetadata.md
    ├── EarningRuleLoyaltyCustomer.md
    ├── EarningRuleLoyaltyCustomerMetadata.md
    ├── EarningRuleLoyaltyOrder.md
    ├── EarningRuleLoyaltyOrderAmount.md
    ├── EarningRuleLoyaltyOrderItems.md
    ├── EarningRuleLoyaltyOrderItemsAmount.md
    ├── EarningRuleLoyaltyOrderItemsQuantity.md
    ├── EarningRuleLoyaltyOrderItemsSubtotalAmount.md
    ├── EarningRuleLoyaltyOrderMetadata.md
    ├── EarningRuleLoyaltyOrderTotalAmount.md
    ├── EarningRuleLoyaltyTier.md
    ├── EarningRulePendingPoints.md
    ├── EarningRuleSegment.md
    ├── EarningRuleSource.md
    ├── Error.md
    ├── ErrorError.md
    ├── EventSource.md
    ├── EventSourceApiKey.md
    ├── EventSourceUser.md
    ├── EventsApi.md
    ├── EventsCreateRequestBody.md
    ├── EventsCreateRequestBodyLoyalty.md
    ├── EventsCreateRequestBodyReferral.md
    ├── EventsCreateResponseBody.md
    ├── Export.md
    ├── ExportOrderFields.md
    ├── ExportOrderOrder.md
    ├── ExportParameters.md
    ├── ExportParametersFilters.md
    ├── ExportResult.md
    ├── ExportVoucherTransactionsFields.md
    ├── ExportVoucherTransactionsFilters.md
    ├── ExportVoucherTransactionsOrder.md
    ├── ExportsApi.md
    ├── ExportsCreateRequestBody.md
    ├── ExportsCreateRequestBodyParameters.md
    ├── ExportsCreateRequestBodyParametersFilters.md
    ├── ExportsCreateResponseBody.md
    ├── ExportsCreateResponseBodyParameters.md
    ├── ExportsCreateResponseBodyParametersFilters.md
    ├── ExportsGetResponseBody.md
    ├── ExportsGetResponseBodyParameters.md
    ├── ExportsGetResponseBodyParametersFilters.md
    ├── ExportsGetResponseBodyResult.md
    ├── ExportsListResponseBody.md
    ├── FieldConditions.md
    ├── FilterConditionsDateTime.md
    ├── FilterConditionsDateTimeConditions.md
    ├── FilterConditionsString.md
    ├── FiltersCondition.md
    ├── Gift.md
    ├── InapplicableTo.md
    ├── InapplicableToOrderItemUnitsItem.md
    ├── InapplicableToResultList.md
    ├── Junction.md
    ├── ListPublicationsItemVoucher.md
    ├── Location.md
    ├── LocationShape.md
    ├── LocationShapeDistance.md
    ├── LocationShapeGeojson.md
    ├── LocationsApi.md
    ├── LocationsGetResponseBody.md
    ├── LocationsGetResponseBodyShape.md
    ├── LocationsGetResponseBodyShapeDistance.md
    ├── LocationsGetResponseBodyShapeGeojson.md
    ├── LocationsListResponseBody.md
    ├── LoyaltiesApi.md
    ├── LoyaltiesCampaignPendingPointsListResponseBody.md
    ├── LoyaltiesCreateCampaignRequestBody.md
    ├── LoyaltiesCreateCampaignResponseBody.md
    ├── LoyaltiesDeleteResponseBody.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItem.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrder.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderAmount.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmount.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantity.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmount.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderMetadata.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderTotalAmount.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemSegment.md
    ├── LoyaltiesEarningRulesCreateRequestBodyItemSource.md
    ├── LoyaltiesEarningRulesCreateResponseBody.md
    ├── LoyaltiesEarningRulesCreateResponseBodyCustomEvent.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyalty.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md
    ├── LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier.md
    ├── LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md
    ├── LoyaltiesEarningRulesCreateResponseBodySegment.md
    ├── LoyaltiesEarningRulesCreateResponseBodySource.md
    ├── LoyaltiesEarningRulesDisableResponseBody.md
    ├── LoyaltiesEarningRulesDisableResponseBodyCustomEvent.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyalty.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItems.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmount.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantity.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmount.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md
    ├── LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier.md
    ├── LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md
    ├── LoyaltiesEarningRulesDisableResponseBodySegment.md
    ├── LoyaltiesEarningRulesDisableResponseBodySource.md
    ├── LoyaltiesEarningRulesEnableResponseBody.md
    ├── LoyaltiesEarningRulesEnableResponseBodyCustomEvent.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyalty.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEvent.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomer.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrder.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderAmount.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItems.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmount.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantity.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmount.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderMetadata.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderTotalAmount.md
    ├── LoyaltiesEarningRulesEnableResponseBodyLoyaltyTier.md
    ├── LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md
    ├── LoyaltiesEarningRulesEnableResponseBodySegment.md
    ├── LoyaltiesEarningRulesEnableResponseBodySource.md
    ├── LoyaltiesEarningRulesGetResponseBody.md
    ├── LoyaltiesEarningRulesGetResponseBodyCustomEvent.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyalty.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEvent.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomer.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrder.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderAmount.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItems.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmount.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantity.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmount.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderMetadata.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderTotalAmount.md
    ├── LoyaltiesEarningRulesGetResponseBodyLoyaltyTier.md
    ├── LoyaltiesEarningRulesGetResponseBodyPendingPoints.md
    ├── LoyaltiesEarningRulesGetResponseBodySegment.md
    ├── LoyaltiesEarningRulesGetResponseBodySource.md
    ├── LoyaltiesEarningRulesListResponseBody.md
    ├── LoyaltiesEarningRulesUpdateRequestBody.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEvent.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomer.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrder.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderAmount.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItems.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmount.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantity.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmount.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderMetadata.md
    ├── LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderTotalAmount.md
    ├── LoyaltiesEarningRulesUpdateRequestBodySource.md
    ├── LoyaltiesEarningRulesUpdateResponseBody.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyCustomEvent.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEvent.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomer.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrder.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderAmount.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItems.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmount.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier.md
    ├── LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md
    ├── LoyaltiesEarningRulesUpdateResponseBodySegment.md
    ├── LoyaltiesEarningRulesUpdateResponseBodySource.md
    ├── LoyaltiesGetCampaignResponseBody.md
    ├── LoyaltiesListCampaignsResponseBody.md
    ├── LoyaltiesListMembersResponseBody.md
    ├── LoyaltiesLoyaltyTierReward.md
    ├── LoyaltiesMemberActivityListResponseBody.md
    ├── LoyaltiesMembersBalanceUpdateRequestBody.md
    ├── LoyaltiesMembersBalanceUpdateResponseBody.md
    ├── LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md
    ├── LoyaltiesMembersCreateRequestBody.md
    ├── LoyaltiesMembersCreateResponseBody.md
    ├── LoyaltiesMembersCreateResponseBodyLoyaltyCard.md
    ├── LoyaltiesMembersCreateResponseBodyPublish.md
    ├── LoyaltiesMembersCreateResponseBodyRedemption.md
    ├── LoyaltiesMembersGetResponseBody.md
    ├── LoyaltiesMembersGetResponseBodyLoyaltyCard.md
    ├── LoyaltiesMembersGetResponseBodyPublish.md
    ├── LoyaltiesMembersGetResponseBodyRedemption.md
    ├── LoyaltiesMembersPendingPointsActivateResponseBody.md
    ├── LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md
    ├── LoyaltiesMembersPendingPointsListResponseBody.md
    ├── LoyaltiesMembersPointsExpirationListResponseBody.md
    ├── LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md
    ├── LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md
    ├── LoyaltiesMembersRedemptionRedeemRequestBody.md
    ├── LoyaltiesMembersRedemptionRedeemRequestBodyReward.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBody.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyChannel.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyGift.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyLoyaltyCard.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptions.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRedemptionsItem.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyVoucher.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyVoucherGift.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyVoucherPublish.md
    ├── LoyaltiesMembersRedemptionRedeemResponseBodyVoucherRedemption.md
    ├── LoyaltiesMembersRewardsListResponseBody.md
    ├── LoyaltiesMembersRewardsListResponseBodyDataItem.md
    ├── LoyaltiesMembersTiersListResponseBody.md
    ├── LoyaltiesMembersTransactionsExportCreateRequestBody.md
    ├── LoyaltiesMembersTransactionsExportCreateRequestBodyParameters.md
    ├── LoyaltiesMembersTransactionsExportCreateResponseBody.md
    ├── LoyaltiesMembersTransactionsExportCreateResponseBodyParameters.md
    ├── LoyaltiesMembersTransactionsListResponseBody.md
    ├── LoyaltiesMembersTransfersCreateResponseBody.md
    ├── LoyaltiesMembersTransfersCreateResponseBodyAssets.md
    ├── LoyaltiesMembersTransfersCreateResponseBodyAssetsBarcode.md
    ├── LoyaltiesMembersTransfersCreateResponseBodyAssetsQr.md
    ├── LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md
    ├── LoyaltiesMembersTransfersCreateResponseBodyPublish.md
    ├── LoyaltiesMembersTransfersCreateResponseBodyRedemption.md
    ├── LoyaltiesPendingPointsListResponseBody.md
    ├── LoyaltiesPointsExpirationExportCreateRequestBody.md
    ├── LoyaltiesPointsExpirationExportCreateRequestBodyParameters.md
    ├── LoyaltiesPointsExpirationExportCreateRequestBodyParametersFilters.md
    ├── LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersCampaignId.md
    ├── LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersCampaignIdConditions.md
    ├── LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersVoucherId.md
    ├── LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersVoucherIdConditions.md
    ├── LoyaltiesPointsExpirationExportCreateResponseBody.md
    ├── LoyaltiesPointsExpirationExportCreateResponseBodyParameters.md
    ├── LoyaltiesPointsExpirationExportCreateResponseBodyParametersFilters.md
    ├── LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersCampaignId.md
    ├── LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersCampaignIdConditions.md
    ├── LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersVoucherId.md
    ├── LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersVoucherIdConditions.md
    ├── LoyaltiesRewardAssignmentsGetResponseBody.md
    ├── LoyaltiesRewardAssignmentsGetResponseBodyParameters.md
    ├── LoyaltiesRewardAssignmentsGetResponseBodyParametersLoyalty.md
    ├── LoyaltiesRewardAssignmentsListResponseBody.md
    ├── LoyaltiesRewardAssignmentsRewardGetResponseBody.md
    ├── LoyaltiesRewardAssignmentsRewardGetResponseBodyAttributes.md
    ├── LoyaltiesRewardsCreateAssignmentItemRequestBody.md
    ├── LoyaltiesRewardsCreateAssignmentItemRequestBodyParameters.md
    ├── LoyaltiesRewardsCreateAssignmentItemRequestBodyParametersLoyalty.md
    ├── LoyaltiesRewardsCreateAssignmentResponseBody.md
    ├── LoyaltiesRewardsCreateAssignmentResponseBodyParameters.md
    ├── LoyaltiesRewardsCreateAssignmentResponseBodyParametersLoyalty.md
    ├── LoyaltiesRewardsGetResponseBody.md
    ├── LoyaltiesRewardsGetResponseBodyParameters.md
    ├── LoyaltiesRewardsGetResponseBodyParametersLoyalty.md
    ├── LoyaltiesRewardsListAssignmentsResponseBody.md
    ├── LoyaltiesRewardsUpdateAssignmentRequestBody.md
    ├── LoyaltiesRewardsUpdateAssignmentRequestBodyParameters.md
    ├── LoyaltiesRewardsUpdateAssignmentRequestBodyParametersLoyalty.md
    ├── LoyaltiesRewardsUpdateAssignmentResponseBody.md
    ├── LoyaltiesRewardsUpdateAssignmentResponseBodyParameters.md
    ├── LoyaltiesRewardsUpdateAssignmentResponseBodyParametersLoyalty.md
    ├── LoyaltiesTiersCreateInBulkRequestBodyItem.md
    ├── LoyaltiesTiersEarningRulesListResponseBody.md
    ├── LoyaltiesTiersGetResponseBody.md
    ├── LoyaltiesTiersGetResponseBodyConfig.md
    ├── LoyaltiesTiersGetResponseBodyConfigPoints.md
    ├── LoyaltiesTiersGetResponseBodyPoints.md
    ├── LoyaltiesTiersListResponseBody.md
    ├── LoyaltiesTiersRewardsListResponseBody.md
    ├── LoyaltiesTransferPoints.md
    ├── LoyaltiesUpdateCampaignRequestBody.md
    ├── LoyaltiesUpdateCampaignRequestBodyOptions.md
    ├── LoyaltiesUpdateCampaignResponseBody.md
    ├── LoyaltyCampaign.md
    ├── LoyaltyCampaignVoucher.md
    ├── LoyaltyCampaignVoucherRedemption.md
    ├── LoyaltyCardTransaction.md
    ├── LoyaltyCardTransactionDetails.md
    ├── LoyaltyCardTransactionDetailsBalance.md
    ├── LoyaltyCardTransactionDetailsBalanceRelatedObject.md
    ├── LoyaltyCardTransactionDetailsCustomEvent.md
    ├── LoyaltyCardTransactionDetailsEarningRule.md
    ├── LoyaltyCardTransactionDetailsEarningRuleSource.md
    ├── LoyaltyCardTransactionDetailsEvent.md
    ├── LoyaltyCardTransactionDetailsEventSchema.md
    ├── LoyaltyCardTransactionDetailsHolderLoyaltyTier.md
    ├── LoyaltyCardTransactionDetailsLoyaltyTier.md
    ├── LoyaltyCardTransactionDetailsOrder.md
    ├── LoyaltyCardTransactionDetailsRedemption.md
    ├── LoyaltyCardTransactionDetailsReward.md
    ├── LoyaltyCardTransactionDetailsRollback.md
    ├── LoyaltyCardTransactionDetailsSegment.md
    ├── LoyaltyCardTransactionsType.md
    ├── LoyaltyMember.md
    ├── LoyaltyMemberLoyaltyCard.md
    ├── LoyaltyMemberPublish.md
    ├── LoyaltyMemberRedemption.md
    ├── LoyaltyPendingPoints.md
    ├── LoyaltyPendingPointsDetails.md
    ├── LoyaltyPendingPointsDetailsEarningRule.md
    ├── LoyaltyPendingPointsDetailsEarningRuleSource.md
    ├── LoyaltyPendingPointsDetailsEvent.md
    ├── LoyaltyPendingPointsDetailsHolderLoyaltyTier.md
    ├── LoyaltyPendingPointsDetailsLoyaltyTier.md
    ├── LoyaltyPendingPointsDetailsOrder.md
    ├── LoyaltyPointsBucket.md
    ├── LoyaltyPointsBucketBucket.md
    ├── LoyaltyTier.md
    ├── LoyaltyTierBase.md
    ├── LoyaltyTierBasePoints.md
    ├── LoyaltyTierConfig.md
    ├── LoyaltyTierConfigPoints.md
    ├── LoyaltyTierExpiration.md
    ├── LoyaltyTierPoints.md
    ├── LoyaltyTiersExpirationAll.md
    ├── LoyaltyTiersExpirationAllExpirationDate.md
    ├── LoyaltyTiersExpirationAllExpirationDateRounding.md
    ├── LoyaltyTiersExpirationAllStartDate.md
    ├── LuckyDraw.md
    ├── ManagementApi.md
    ├── ManagementProject.md
    ├── ManagementProjectApiUsageNotifications.md
    ├── ManagementProjectDefaultCodeConfig.md
    ├── ManagementProjectLimits.md
    ├── ManagementProjectLimitsApiCallsItem.md
    ├── ManagementProjectLimitsBulkApiCallsItem.md
    ├── ManagementProjectWebhooksCalloutNotifications.md
    ├── ManagementProjectWebhooksCalloutNotificationsDistributions.md
    ├── ManagementProjectWebhooksCalloutNotificationsWebhooks.md
    ├── ManagementProjectsBranding.md
    ├── ManagementProjectsBrandingAddress.md
    ├── ManagementProjectsBrandingBrand.md
    ├── ManagementProjectsBrandingCockpits.md
    ├── ManagementProjectsBrandingContact.md
    ├── ManagementProjectsBrandingCreateRequestBody.md
    ├── ManagementProjectsBrandingCreateRequestBodyAddress.md
    ├── ManagementProjectsBrandingCreateRequestBodyBrand.md
    ├── ManagementProjectsBrandingCreateRequestBodyCockpits.md
    ├── ManagementProjectsBrandingCreateRequestBodyContact.md
    ├── ManagementProjectsBrandingCreateResponseBody.md
    ├── ManagementProjectsBrandingCreateResponseBodyAddress.md
    ├── ManagementProjectsBrandingCreateResponseBodyBrand.md
    ├── ManagementProjectsBrandingCreateResponseBodyCockpits.md
    ├── ManagementProjectsBrandingCreateResponseBodyContact.md
    ├── ManagementProjectsBrandingGetResponseBody.md
    ├── ManagementProjectsBrandingGetResponseBodyAddress.md
    ├── ManagementProjectsBrandingGetResponseBodyBrand.md
    ├── ManagementProjectsBrandingGetResponseBodyCockpits.md
    ├── ManagementProjectsBrandingGetResponseBodyContact.md
    ├── ManagementProjectsBrandingListResponseBody.md
    ├── ManagementProjectsBrandingUpdateRequestBody.md
    ├── ManagementProjectsBrandingUpdateRequestBodyAddress.md
    ├── ManagementProjectsBrandingUpdateRequestBodyBrand.md
    ├── ManagementProjectsBrandingUpdateRequestBodyCockpits.md
    ├── ManagementProjectsBrandingUpdateRequestBodyContact.md
    ├── ManagementProjectsBrandingUpdateResponseBody.md
    ├── ManagementProjectsBrandingUpdateResponseBodyAddress.md
    ├── ManagementProjectsBrandingUpdateResponseBodyBrand.md
    ├── ManagementProjectsBrandingUpdateResponseBodyCockpits.md
    ├── ManagementProjectsBrandingUpdateResponseBodyContact.md
    ├── ManagementProjectsCreateRequestBody.md
    ├── ManagementProjectsCreateRequestBodyApiUsageNotifications.md
    ├── ManagementProjectsCreateRequestBodyUsersItem.md
    ├── ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications.md
    ├── ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsDistributions.md
    ├── ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsWebhooks.md
    ├── ManagementProjectsCreateResponseBody.md
    ├── ManagementProjectsCreateResponseBodyApiUsageNotifications.md
    ├── ManagementProjectsCreateResponseBodyClientSideKey.md
    ├── ManagementProjectsCreateResponseBodyServerSideKey.md
    ├── ManagementProjectsCreateResponseBodyWebhooksCalloutNotifications.md
    ├── ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsDistributions.md
    ├── ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsWebhooks.md
    ├── ManagementProjectsCustomEventSchema.md
    ├── ManagementProjectsCustomEventSchemaSchema.md
    ├── ManagementProjectsCustomEventSchemasCreateRequestBody.md
    ├── ManagementProjectsCustomEventSchemasCreateRequestBodySchema.md
    ├── ManagementProjectsCustomEventSchemasCreateResponseBody.md
    ├── ManagementProjectsCustomEventSchemasCreateResponseBodySchema.md
    ├── ManagementProjectsCustomEventSchemasGetResponseBody.md
    ├── ManagementProjectsCustomEventSchemasGetResponseBodySchema.md
    ├── ManagementProjectsCustomEventSchemasListResponseBody.md
    ├── ManagementProjectsCustomEventSchemasUpdateRequestBody.md
    ├── ManagementProjectsCustomEventSchemasUpdateRequestBodySchema.md
    ├── ManagementProjectsCustomEventSchemasUpdateResponseBody.md
    ├── ManagementProjectsCustomEventSchemasUpdateResponseBodySchema.md
    ├── ManagementProjectsGetResponseBody.md
    ├── ManagementProjectsGetResponseBodyApiUsageNotifications.md
    ├── ManagementProjectsGetResponseBodyDefaultCodeConfig.md
    ├── ManagementProjectsGetResponseBodyLimits.md
    ├── ManagementProjectsGetResponseBodyLimitsApiCallsItem.md
    ├── ManagementProjectsGetResponseBodyLimitsBulkApiCallsItem.md
    ├── ManagementProjectsGetResponseBodyWebhooksCalloutNotifications.md
    ├── ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsDistributions.md
    ├── ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsWebhooks.md
    ├── ManagementProjectsListResponseBody.md
    ├── ManagementProjectsMetadataSchema.md
    ├── ManagementProjectsMetadataSchemasCreateRequestBody.md
    ├── ManagementProjectsMetadataSchemasCreateResponseBody.md
    ├── ManagementProjectsMetadataSchemasGetResponseBody.md
    ├── ManagementProjectsMetadataSchemasListResponseBody.md
    ├── ManagementProjectsMetadataSchemasUpdateRequestBody.md
    ├── ManagementProjectsMetadataSchemasUpdateResponseBody.md
    ├── ManagementProjectsStackingRules.md
    ├── ManagementProjectsStackingRulesCreateRequestBody.md
    ├── ManagementProjectsStackingRulesCreateResponseBody.md
    ├── ManagementProjectsStackingRulesGetResponseBody.md
    ├── ManagementProjectsStackingRulesListResponseBody.md
    ├── ManagementProjectsStackingRulesUpdateRequestBody.md
    ├── ManagementProjectsStackingRulesUpdateResponseBody.md
    ├── ManagementProjectsTemplatesCampaignsCopyCreateRequestBody.md
    ├── ManagementProjectsTemplatesCampaignsCopyCreateResponseBody.md
    ├── ManagementProjectsTemplatesCampaignsListResponseBody.md
    ├── ManagementProjectsUpdateRequestBody.md
    ├── ManagementProjectsUpdateRequestBodyApiUsageNotifications.md
    ├── ManagementProjectsUpdateRequestBodyDefaultCodeConfig.md
    ├── ManagementProjectsUpdateRequestBodyWebhooksCalloutNotifications.md
    ├── ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsDistributions.md
    ├── ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsWebhooks.md
    ├── ManagementProjectsUpdateResponseBody.md
    ├── ManagementProjectsUpdateResponseBodyApiUsageNotifications.md
    ├── ManagementProjectsUpdateResponseBodyDefaultCodeConfig.md
    ├── ManagementProjectsUpdateResponseBodyLimits.md
    ├── ManagementProjectsUpdateResponseBodyLimitsApiCallsItem.md
    ├── ManagementProjectsUpdateResponseBodyLimitsBulkApiCallsItem.md
    ├── ManagementProjectsUpdateResponseBodyWebhooksCalloutNotifications.md
    ├── ManagementProjectsUpdateResponseBodyWebhooksCalloutNotificationsDistributions.md
    ├── ManagementProjectsUpdateResponseBodyWebhooksCalloutNotificationsWebhooks.md
    ├── ManagementProjectsUsersAssignRequestBody.md
    ├── ManagementProjectsUsersAssignResponseBody.md
    ├── ManagementProjectsUsersGetUserResponseBody.md
    ├── ManagementProjectsUsersInviteCreateRequestBody.md
    ├── ManagementProjectsUsersListResponseBody.md
    ├── ManagementProjectsUsersUpdateRoleRequestBody.md
    ├── ManagementProjectsUsersUpdateRoleResponseBody.md
    ├── ManagementProjectsWebhook.md
    ├── ManagementProjectsWebhooksCreateRequestBody.md
    ├── ManagementProjectsWebhooksCreateResponseBody.md
    ├── ManagementProjectsWebhooksGetResponseBody.md
    ├── ManagementProjectsWebhooksListResponseBody.md
    ├── ManagementProjectsWebhooksUpdateRequestBody.md
    ├── ManagementProjectsWebhooksUpdateResponseBody.md
    ├── MemberActivity.md
    ├── MetadataSchema.md
    ├── MetadataSchemaDeprecated.md
    ├── MetadataSchemasApi.md
    ├── MetadataSchemasGetResponseBody.md
    ├── MetadataSchemasListResponseBody.md
    ├── Order.md
    ├── OrderCalculated.md
    ├── OrderCalculatedItem.md
    ├── OrderCalculatedItemProduct.md
    ├── OrderCalculatedItemSku.md
    ├── OrderItem.md
    ├── OrderItemProduct.md
    ├── OrderItemSku.md
    ├── OrdersApi.md
    ├── OrdersCreateRequestBody.md
    ├── OrdersCreateResponseBody.md
    ├── OrdersExportCreateRequestBody.md
    ├── OrdersExportCreateRequestBodyParameters.md
    ├── OrdersExportCreateResponseBody.md
    ├── OrdersExportCreateResponseBodyParameters.md
    ├── OrdersGetResponseBody.md
    ├── OrdersImportCreateRequestBodyItem.md
    ├── OrdersImportCreateResponseBody.md
    ├── OrdersListResponseBody.md
    ├── OrdersUpdateRequestBody.md
    ├── OrdersUpdateResponseBody.md
    ├── ParameterActivityCategory.md
    ├── ParameterCampaignType.md
    ├── ParameterCreatedBeforeAfter.md
    ├── ParameterExpandListCampaigns.md
    ├── ParameterFiltersListBin.md
    ├── ParameterFiltersListBinId.md
    ├── ParameterFiltersListBinResourceId.md
    ├── ParameterFiltersListBinResourceName.md
    ├── ParameterFiltersListBinResourceType.md
    ├── ParameterFiltersListBinResourceTypeConditions.md
    ├── ParameterFiltersListCampaigns.md
    ├── ParameterFiltersListCampaignsCampaignStatus.md
    ├── ParameterFiltersListCampaignsCampaignStatusConditions.md
    ├── ParameterFiltersListCampaignsCategories.md
    ├── ParameterFiltersListCampaignsCategoryIds.md
    ├── ParameterFiltersListCampaignsIsReferralCode.md
    ├── ParameterFiltersListCampaignsValidityTimeframe.md
    ├── ParameterFiltersListCampaignsVoucherType.md
    ├── ParameterFiltersListCustomerRedeemables.md
    ├── ParameterFiltersListCustomerRedeemablesCampaignId.md
    ├── ParameterFiltersListCustomerRedeemablesCampaignType.md
    ├── ParameterFiltersListCustomerRedeemablesCampaignTypeConditions.md
    ├── ParameterFiltersListCustomerRedeemablesCreatedAt.md
    ├── ParameterFiltersListCustomerRedeemablesCreatedAtConditions.md
    ├── ParameterFiltersListCustomerRedeemablesHolderRole.md
    ├── ParameterFiltersListCustomerRedeemablesHolderRoleConditions.md
    ├── ParameterFiltersListCustomerRedeemablesId.md
    ├── ParameterFiltersListCustomerRedeemablesRedeemableId.md
    ├── ParameterFiltersListCustomerRedeemablesRedeemableObject.md
    ├── ParameterFiltersListCustomerRedeemablesRedeemableObjectConditions.md
    ├── ParameterFiltersListCustomerRedeemablesVoucherType.md
    ├── ParameterFiltersListCustomerRedeemablesVoucherTypeConditions.md
    ├── ParameterFiltersListLocations.md
    ├── ParameterFiltersListLocationsCreatedAt.md
    ├── ParameterFiltersListLocationsName.md
    ├── ParameterFiltersListLocationsUpdatedAt.md
    ├── ParameterFiltersListPublications.md
    ├── ParameterFiltersListPublicationsCampaignName.md
    ├── ParameterFiltersListPublicationsCustomerId.md
    ├── ParameterFiltersListPublicationsFailureCode.md
    ├── ParameterFiltersListPublicationsIsReferralCode.md
    ├── ParameterFiltersListPublicationsParentObjectId.md
    ├── ParameterFiltersListPublicationsRelatedObjectId.md
    ├── ParameterFiltersListPublicationsResult.md
    ├── ParameterFiltersListPublicationsSourceId.md
    ├── ParameterFiltersListPublicationsVoucherType.md
    ├── ParameterFiltersListRedemptions.md
    ├── ParameterFiltersListRedemptionsCampaignName.md
    ├── ParameterFiltersListRedemptionsCustomerId.md
    ├── ParameterFiltersListRedemptionsFailureCode.md
    ├── ParameterFiltersListRedemptionsObject.md
    ├── ParameterFiltersListRedemptionsParentRedemptionId.md
    ├── ParameterFiltersListRedemptionsRelatedObjectId.md
    ├── ParameterFiltersListRedemptionsRelatedObjectParentId.md
    ├── ParameterFiltersListRedemptionsResult.md
    ├── ParameterFiltersListRedemptionsUserLogin.md
    ├── ParameterFiltersListRedemptionsVoucherCode.md
    ├── ParameterFiltersListReferralsRedeemableHolders.md
    ├── ParameterFiltersListReferralsRedeemableHoldersCampaignId.md
    ├── ParameterFiltersListReferralsRedeemableHoldersCampaignType.md
    ├── ParameterFiltersListReferralsRedeemableHoldersCreatedAt.md
    ├── ParameterFiltersListReferralsRedeemableHoldersCustomerId.md
    ├── ParameterFiltersListReferralsRedeemableHoldersHolderRole.md
    ├── ParameterFiltersListReferralsRedeemableHoldersHolderRoleConditions.md
    ├── ParameterFiltersListReferralsRedeemableHoldersId.md
    ├── ParameterFiltersListReferralsRedeemableHoldersRedeemableId.md
    ├── ParameterFiltersListReferralsRedeemableHoldersRedeemableObject.md
    ├── ParameterFiltersListReferralsRedeemableHoldersVoucherType.md
    ├── ParameterFiltersListTemplates.md
    ├── ParameterFiltersListTemplatesCampaignType.md
    ├── ParameterFiltersListTemplatesCampaignTypeConditions.md
    ├── ParameterFiltersListTemplatesId.md
    ├── ParameterFiltersListTemplatesName.md
    ├── ParameterOrder.md
    ├── ParameterOrderCreatedAt.md
    ├── ParameterOrderListAllPromotionStacks.md
    ├── ParameterOrderListBin.md
    ├── ParameterOrderListCampaigns.md
    ├── ParameterOrderListCustomers.md
    ├── ParameterOrderListEarningRules.md
    ├── ParameterOrderListExports.md
    ├── ParameterOrderListLocations.md
    ├── ParameterOrderListLoyaltyTiers.md
    ├── ParameterOrderListOrders.md
    ├── ParameterOrderListPendingPoints.md
    ├── ParameterOrderListPromotionTiers.md
    ├── ParameterOrderListPromotionTiersClientSide.md
    ├── ParameterOrderListPublications.md
    ├── ParameterOrderListRedeemables.md
    ├── ParameterOrderListRedemptions.md
    ├── ParameterOrderListTransactions.md
    ├── ParameterOrderListValidationRuleAssignments.md
    ├── ParameterOrderListValidationRules.md
    ├── ParameterOrderVouchers.md
    ├── ParameterResultListPublications.md
    ├── ParameterTemplatesList.md
    ├── ParameterUpdatedBeforeAfter.md
    ├── ParameterVoucherTypeListPublications.md
    ├── PointsExpirationTypes.md
    ├── Product.md
    ├── ProductCollectionsApi.md
    ├── ProductCollectionsCreateRequestBody.md
    ├── ProductCollectionsCreateRequestBodyFilter.md
    ├── ProductCollectionsCreateRequestBodyProductsItem.md
    ├── ProductCollectionsCreateResponseBody.md
    ├── ProductCollectionsCreateResponseBodyFilter.md
    ├── ProductCollectionsCreateResponseBodyProductsItem.md
    ├── ProductCollectionsGetResponseBody.md
    ├── ProductCollectionsGetResponseBodyFilter.md
    ├── ProductCollectionsGetResponseBodyProductsItem.md
    ├── ProductCollectionsItem.md
    ├── ProductCollectionsItemFilter.md
    ├── ProductCollectionsItemProductsItem.md
    ├── ProductCollectionsListResponseBody.md
    ├── ProductCollectionsProductsListResponseBody.md
    ├── ProductCollectionsProductsListResponseBodyDataItem.md
    ├── ProductWithoutSkus.md
    ├── ProductsApi.md
    ├── ProductsCreateRequestBody.md
    ├── ProductsCreateResponseBody.md
    ├── ProductsGetResponseBody.md
    ├── ProductsImportCsvCreateResponseBody.md
    ├── ProductsListResponseBody.md
    ├── ProductsMetadataUpdateInBulkRequestBody.md
    ├── ProductsMetadataUpdateInBulkResponseBody.md
    ├── ProductsSkusCreateRequestBody.md
    ├── ProductsSkusCreateResponseBody.md
    ├── ProductsSkusListResponseBody.md
    ├── ProductsSkusUpdateRequestBody.md
    ├── ProductsSkusUpdateResponseBody.md
    ├── ProductsUpdateInBulkRequestBody.md
    ├── ProductsUpdateInBulkResponseBody.md
    ├── ProductsUpdateRequestBody.md
    ├── ProductsUpdateResponseBody.md
    ├── PromotionStack.md
    ├── PromotionStackBase.md
    ├── PromotionStackBaseTiers.md
    ├── PromotionStackTiers.md
    ├── PromotionTier.md
    ├── PromotionTierAction.md
    ├── PromotionTierCampaign.md
    ├── PromotionTierCreateParams.md
    ├── PromotionTierCreateParamsAction.md
    ├── PromotionTierSummary.md
    ├── PromotionTierSummaryOrders.md
    ├── PromotionTierSummaryRedemptions.md
    ├── PromotionTiersList.md
    ├── PromotionsApi.md
    ├── PromotionsStacksCreateRequestBody.md
    ├── PromotionsStacksCreateRequestBodyTiers.md
    ├── PromotionsStacksCreateResponseBody.md
    ├── PromotionsStacksCreateResponseBodyTiers.md
    ├── PromotionsStacksGetResponseBody.md
    ├── PromotionsStacksGetResponseBodyTiers.md
    ├── PromotionsStacksListResponseBody.md
    ├── PromotionsStacksUpdateRequestBody.md
    ├── PromotionsStacksUpdateRequestBodyTiers.md
    ├── PromotionsStacksUpdateResponseBody.md
    ├── PromotionsStacksUpdateResponseBodyTiers.md
    ├── PromotionsTiersCreateRequestBody.md
    ├── PromotionsTiersCreateRequestBodyAction.md
    ├── PromotionsTiersCreateResponseBody.md
    ├── PromotionsTiersCreateResponseBodyAction.md
    ├── PromotionsTiersCreateResponseBodyCampaign.md
    ├── PromotionsTiersCreateResponseBodySummary.md
    ├── PromotionsTiersCreateResponseBodySummaryOrders.md
    ├── PromotionsTiersCreateResponseBodySummaryRedemptions.md
    ├── PromotionsTiersDisableResponseBody.md
    ├── PromotionsTiersDisableResponseBodyAction.md
    ├── PromotionsTiersDisableResponseBodyCampaign.md
    ├── PromotionsTiersDisableResponseBodySummary.md
    ├── PromotionsTiersDisableResponseBodySummaryOrders.md
    ├── PromotionsTiersDisableResponseBodySummaryRedemptions.md
    ├── PromotionsTiersEnableResponseBody.md
    ├── PromotionsTiersEnableResponseBodyAction.md
    ├── PromotionsTiersEnableResponseBodyCampaign.md
    ├── PromotionsTiersEnableResponseBodySummary.md
    ├── PromotionsTiersEnableResponseBodySummaryOrders.md
    ├── PromotionsTiersEnableResponseBodySummaryRedemptions.md
    ├── PromotionsTiersGetResponseBody.md
    ├── PromotionsTiersGetResponseBodyAction.md
    ├── PromotionsTiersGetResponseBodyCampaign.md
    ├── PromotionsTiersGetResponseBodySummary.md
    ├── PromotionsTiersGetResponseBodySummaryOrders.md
    ├── PromotionsTiersGetResponseBodySummaryRedemptions.md
    ├── PromotionsTiersListResponseBody.md
    ├── PromotionsTiersUpdateRequestBody.md
    ├── PromotionsTiersUpdateRequestBodyAction.md
    ├── PromotionsTiersUpdateResponseBody.md
    ├── PromotionsTiersUpdateResponseBodyAction.md
    ├── PromotionsTiersUpdateResponseBodyCampaign.md
    ├── PromotionsTiersUpdateResponseBodySummary.md
    ├── PromotionsTiersUpdateResponseBodySummaryOrders.md
    ├── PromotionsTiersUpdateResponseBodySummaryRedemptions.md
    ├── PublicationsApi.md
    ├── PublicationsCreateRequestBody.md
    ├── PublicationsCreateRequestBodyCustomer.md
    ├── PublicationsCreateRequestBodyCustomerAddress.md
    ├── PublicationsCreateResponseBody.md
    ├── PublicationsListResponseBody.md
    ├── PublicationsListResponseBodyPublicationsItem.md
    ├── PublicationsListResponseBodyPublicationsItemMetadata.md
    ├── QualificationsApi.md
    ├── QualificationsCheckEligibilityRequestBody.md
    ├── QualificationsCheckEligibilityResponseBody.md
    ├── QualificationsFieldConditions.md
    ├── QualificationsFiltersCondition.md
    ├── QualificationsOption.md
    ├── QualificationsOptionFilters.md
    ├── QualificationsOptionFiltersCampaignType.md
    ├── QualificationsOptionFiltersCampaignTypeConditions.md
    ├── QualificationsOptionFiltersHolderRole.md
    ├── QualificationsOptionFiltersHolderRoleConditions.md
    ├── QualificationsOptionFiltersResourceType.md
    ├── QualificationsOptionFiltersResourceTypeConditions.md
    ├── QualificationsRedeemable.md
    ├── QualificationsRedeemableBase.md
    ├── QualificationsRedeemables.md
    ├── RedeemableGift.md
    ├── RedeemableHolder.md
    ├── RedeemableLoyaltyCard.md
    ├── RedeemableResult.md
    ├── RedeemableVoucher.md
    ├── RedeemableVoucherGift.md
    ├── RedeemableVoucherLoyaltyCard.md
    ├── RedeemableVoucherPublish.md
    ├── RedeemableVoucherRedemption.md
    ├── Redemption.md
    ├── RedemptionChannel.md
    ├── RedemptionEntry.md
    ├── RedemptionEntryChannel.md
    ├── RedemptionEntryCustomer.md
    ├── RedemptionEntryGift.md
    ├── RedemptionEntryLoyaltyCard.md
    ├── RedemptionEntryOrder.md
    ├── RedemptionEntryOrderCustomer.md
    ├── RedemptionEntryOrderReferrer.md
    ├── RedemptionEntryPromotionTier.md
    ├── RedemptionEntryPromotionTierAction.md
    ├── RedemptionEntryPromotionTierCampaign.md
    ├── RedemptionEntryPromotionTierSummary.md
    ├── RedemptionEntryPromotionTierSummaryOrders.md
    ├── RedemptionEntryPromotionTierSummaryRedemptions.md
    ├── RedemptionEntryRelatedRedemptions.md
    ├── RedemptionEntryRelatedRedemptionsRedemptionsItem.md
    ├── RedemptionEntryRelatedRedemptionsRollbacksItem.md
    ├── RedemptionEntryVoucher.md
    ├── RedemptionEntryVoucherGift.md
    ├── RedemptionEntryVoucherLoyaltyCard.md
    ├── RedemptionEntryVoucherPublish.md
    ├── RedemptionEntryVoucherRedemption.md
    ├── RedemptionGift.md
    ├── RedemptionLoyaltyCard.md
    ├── RedemptionRedeem.md
    ├── RedemptionRedeemChannel.md
    ├── RedemptionRedeemGift.md
    ├── RedemptionRedeemLoyaltyCard.md
    ├── RedemptionRedeemRelatedRedemptions.md
    ├── RedemptionRedeemRelatedRedemptionsRedemptionsItem.md
    ├── RedemptionRedeemRelatedRedemptionsRollbacksItem.md
    ├── RedemptionRedeemVoucher.md
    ├── RedemptionRedeemVoucherGift.md
    ├── RedemptionRedeemVoucherLoyaltyCard.md
    ├── RedemptionRedeemVoucherPublish.md
    ├── RedemptionRedeemVoucherRedemption.md
    ├── RedemptionRelatedRedemptions.md
    ├── RedemptionRelatedRedemptionsRedemptionsItem.md
    ├── RedemptionRelatedRedemptionsRollbacksItem.md
    ├── RedemptionRewardResult.md
    ├── RedemptionRewardResultParameters.md
    ├── RedemptionRewardResultParametersCampaign.md
    ├── RedemptionRewardResultParametersCoin.md
    ├── RedemptionRewardResultParametersProduct.md
    ├── RedemptionRollback.md
    ├── RedemptionRollbackChannel.md
    ├── RedemptionRollbackGift.md
    ├── RedemptionRollbackLoyaltyCard.md
    ├── RedemptionRollbackRelatedRedemptions.md
    ├── RedemptionRollbackRelatedRedemptionsRedemptionsItem.md
    ├── RedemptionRollbackRelatedRedemptionsRollbacksItem.md
    ├── RedemptionVoucher.md
    ├── RedemptionVoucherGift.md
    ├── RedemptionVoucherLoyaltyCard.md
    ├── RedemptionVoucherPublish.md
    ├── RedemptionVoucherRedemption.md
    ├── RedemptionsApi.md
    ├── RedemptionsGetResponseBody.md
    ├── RedemptionsGetResponseBodyChannel.md
    ├── RedemptionsGetResponseBodyCustomer.md
    ├── RedemptionsGetResponseBodyGift.md
    ├── RedemptionsGetResponseBodyLoyaltyCard.md
    ├── RedemptionsGetResponseBodyOrder.md
    ├── RedemptionsGetResponseBodyOrderCustomer.md
    ├── RedemptionsGetResponseBodyOrderReferrer.md
    ├── RedemptionsGetResponseBodyPromotionTier.md
    ├── RedemptionsGetResponseBodyPromotionTierAction.md
    ├── RedemptionsGetResponseBodyPromotionTierCampaign.md
    ├── RedemptionsGetResponseBodyPromotionTierSummary.md
    ├── RedemptionsGetResponseBodyPromotionTierSummaryOrders.md
    ├── RedemptionsGetResponseBodyPromotionTierSummaryRedemptions.md
    ├── RedemptionsGetResponseBodyRelatedRedemptions.md
    ├── RedemptionsGetResponseBodyRelatedRedemptionsRedemptionsItem.md
    ├── RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md
    ├── RedemptionsGetResponseBodyVoucher.md
    ├── RedemptionsGetResponseBodyVoucherGift.md
    ├── RedemptionsGetResponseBodyVoucherLoyaltyCard.md
    ├── RedemptionsGetResponseBodyVoucherPublish.md
    ├── RedemptionsGetResponseBodyVoucherRedemption.md
    ├── RedemptionsListResponseBody.md
    ├── RedemptionsListResponseBodyRedemptionsItem.md
    ├── RedemptionsListResponseBodyRedemptionsItemChannel.md
    ├── RedemptionsListResponseBodyRedemptionsItemCustomer.md
    ├── RedemptionsListResponseBodyRedemptionsItemGift.md
    ├── RedemptionsListResponseBodyRedemptionsItemLoyaltyCard.md
    ├── RedemptionsListResponseBodyRedemptionsItemOrder.md
    ├── RedemptionsListResponseBodyRedemptionsItemOrderCustomer.md
    ├── RedemptionsListResponseBodyRedemptionsItemOrderReferrer.md
    ├── RedemptionsListResponseBodyRedemptionsItemPromotionTier.md
    ├── RedemptionsListResponseBodyRedemptionsItemPromotionTierAction.md
    ├── RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md
    ├── RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary.md
    ├── RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders.md
    ├── RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions.md
    ├── RedemptionsListResponseBodyRedemptionsItemRelatedRedemptions.md
    ├── RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem.md
    ├── RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md
    ├── RedemptionsListResponseBodyRedemptionsItemVoucher.md
    ├── RedemptionsListResponseBodyRedemptionsItemVoucherGift.md
    ├── RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md
    ├── RedemptionsListResponseBodyRedemptionsItemVoucherPublish.md
    ├── RedemptionsListResponseBodyRedemptionsItemVoucherRedemption.md
    ├── RedemptionsRedeemRequestBody.md
    ├── RedemptionsRedeemRequestBodyOptions.md
    ├── RedemptionsRedeemRequestBodyRedeemablesItem.md
    ├── RedemptionsRedeemRequestBodyRedeemablesItemGift.md
    ├── RedemptionsRedeemRequestBodyRedeemablesItemReward.md
    ├── RedemptionsRedeemResponseBody.md
    ├── RedemptionsRollbackCreateRequestBody.md
    ├── RedemptionsRollbackCreateResponseBody.md
    ├── RedemptionsRollbackCreateResponseBodyChannel.md
    ├── RedemptionsRollbackCreateResponseBodyGift.md
    ├── RedemptionsRollbackCreateResponseBodyLoyaltyCard.md
    ├── RedemptionsRollbackCreateResponseBodyRelatedRedemptions.md
    ├── RedemptionsRollbackCreateResponseBodyRelatedRedemptionsRedemptionsItem.md
    ├── RedemptionsRollbackCreateResponseBodyRelatedRedemptionsRollbacksItem.md
    ├── RedemptionsRollbacksCreateRequestBody.md
    ├── RedemptionsRollbacksCreateResponseBody.md
    ├── ReferralProgram.md
    ├── ReferralProgramCustomEvent.md
    ├── ReferralProgramRefereeReward.md
    ├── ReferralProgramRefereeRewardRelatedObjectParent.md
    ├── ReferralsApi.md
    ├── ReferralsMembersHoldersCreateInBulkRequestBody.md
    ├── ReferralsMembersHoldersCreateInBulkResponseBody.md
    ├── ReferralsMembersHoldersListResponseBody.md
    ├── Referrer.md
    ├── ReferrerAddress.md
    ├── ReferrerId.md
    ├── ResourceTypes.md
    ├── Reward.md
    ├── RewardAssignment.md
    ├── RewardAssignmentParameters.md
    ├── RewardAssignmentParametersLoyalty.md
    ├── RewardAttributes.md
    ├── RewardType.md
    ├── RewardTypeCampaign.md
    ├── RewardTypeCoin.md
    ├── RewardTypeProduct.md
    ├── RewardsApi.md
    ├── RewardsAssignmentsCreateRequestBody.md
    ├── RewardsAssignmentsCreateRequestBodyParameters.md
    ├── RewardsAssignmentsCreateRequestBodyParametersLoyalty.md
    ├── RewardsAssignmentsCreateResponseBody.md
    ├── RewardsAssignmentsCreateResponseBodyParameters.md
    ├── RewardsAssignmentsCreateResponseBodyParametersLoyalty.md
    ├── RewardsAssignmentsGetResponseBody.md
    ├── RewardsAssignmentsGetResponseBodyParameters.md
    ├── RewardsAssignmentsGetResponseBodyParametersLoyalty.md
    ├── RewardsAssignmentsListResponseBody.md
    ├── RewardsAssignmentsUpdateRequestBody.md
    ├── RewardsAssignmentsUpdateRequestBodyParameters.md
    ├── RewardsAssignmentsUpdateRequestBodyParametersLoyalty.md
    ├── RewardsAssignmentsUpdateResponseBody.md
    ├── RewardsAssignmentsUpdateResponseBodyParameters.md
    ├── RewardsAssignmentsUpdateResponseBodyParametersLoyalty.md
    ├── RewardsCreateRequestBody.md
    ├── RewardsCreateRequestBodyAttributes.md
    ├── RewardsCreateRequestBodyParameters.md
    ├── RewardsCreateRequestBodyParametersCampaign.md
    ├── RewardsCreateRequestBodyParametersCoin.md
    ├── RewardsCreateRequestBodyParametersProduct.md
    ├── RewardsCreateResponseBody.md
    ├── RewardsCreateResponseBodyAttributes.md
    ├── RewardsListResponseBody.md
    ├── RewardsUpdateRequestBody.md
    ├── RewardsUpdateRequestBodyAttributes.md
    ├── RewardsUpdateRequestBodyParameters.md
    ├── RewardsUpdateRequestBodyParametersCampaign.md
    ├── RewardsUpdateRequestBodyParametersCoin.md
    ├── RewardsUpdateRequestBodyParametersProduct.md
    ├── RewardsUpdateResponseBody.md
    ├── RewardsUpdateResponseBodyAttributes.md
    ├── SegmentsApi.md
    ├── SegmentsCreateRequestBody.md
    ├── SegmentsCreateResponseBody.md
    ├── SegmentsGetResponseBody.md
    ├── Session.md
    ├── SimpleCustomer.md
    ├── SimpleCustomerRequiredObjectType.md
    ├── SimpleLoyaltyCard.md
    ├── SimpleProductDiscountUnit.md
    ├── SimpleSegment.md
    ├── SimpleSkuDiscountUnit.md
    ├── SimpleVoucher.md
    ├── SimpleVoucherRedemption.md
    ├── Sku.md
    ├── SkusGetResponseBody.md
    ├── SkusImportCsvCreateResponseBody.md
    ├── SkusListForProduct.md
    ├── StackingRules.md
    ├── TemplatesApi.md
    ├── TemplatesCampaignsCampaignSetupCreateRequestBody.md
    ├── TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher.md
    ├── TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption.md
    ├── TemplatesCampaignsCampaignSetupCreateResponseBody.md
    ├── TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem.md
    ├── TemplatesCampaignsCreateRequestBody.md
    ├── TemplatesCampaignsCreateTemplateResponseBody.md
    ├── TemplatesCampaignsGetResponseBody.md
    ├── TemplatesCampaignsListResponseBody.md
    ├── TemplatesCampaignsTierSetupCreateRequestBody.md
    ├── TemplatesCampaignsTierSetupCreateResponseBody.md
    ├── TemplatesCampaignsTierSetupCreateResponseBodyCreatedResourcesItem.md
    ├── TemplatesCampaignsUpdateRequestBody.md
    ├── TemplatesCampaignsUpdateResponseBody.md
    ├── TrashBinItem.md
    ├── TrashBinListResponseBody.md
    ├── UsageNotifications.md
    ├── User.md
    ├── ValidationRule.md
    ├── ValidationRuleApplicableTo.md
    ├── ValidationRuleAssignment.md
    ├── ValidationRuleAssignmentsList.md
    ├── ValidationRuleError.md
    ├── ValidationRulesApi.md
    ├── ValidationRulesAssignmentsCreateRequestBody.md
    ├── ValidationRulesAssignmentsCreateResponseBody.md
    ├── ValidationRulesAssignmentsList.md
    ├── ValidationRulesAssignmentsListResponseBody.md
    ├── ValidationRulesCreateRequestBody.md
    ├── ValidationRulesCreateRequestBodyApplicableTo.md
    ├── ValidationRulesCreateRequestBodyError.md
    ├── ValidationRulesCreateResponseBody.md
    ├── ValidationRulesCreateResponseBodyApplicableTo.md
    ├── ValidationRulesCreateResponseBodyError.md
    ├── ValidationRulesGetResponseBody.md
    ├── ValidationRulesGetResponseBodyApplicableTo.md
    ├── ValidationRulesGetResponseBodyError.md
    ├── ValidationRulesListResponseBody.md
    ├── ValidationRulesUpdateRequestBody.md
    ├── ValidationRulesUpdateRequestBodyApplicableTo.md
    ├── ValidationRulesUpdateRequestBodyError.md
    ├── ValidationRulesUpdateResponseBody.md
    ├── ValidationRulesUpdateResponseBodyApplicableTo.md
    ├── ValidationRulesUpdateResponseBodyError.md
    ├── ValidationsApi.md
    ├── ValidationsRedeemableInapplicable.md
    ├── ValidationsRedeemableInapplicableResult.md
    ├── ValidationsRedeemableInapplicableResultDetails.md
    ├── ValidationsRedeemableSkipped.md
    ├── ValidationsRedeemableSkippedResult.md
    ├── ValidationsRedeemableSkippedResultDetails.md
    ├── ValidationsValidateRequestBody.md
    ├── ValidationsValidateRequestBodyOptions.md
    ├── ValidationsValidateRequestBodyRedeemablesItem.md
    ├── ValidationsValidateRequestBodyRedeemablesItemGift.md
    ├── ValidationsValidateRequestBodyRedeemablesItemReward.md
    ├── ValidationsValidateResponseBody.md
    ├── ValidationsValidateResponseBodyRedeemablesItem.md
    ├── ValidationsValidateResponseBodyRedeemablesItemResult.md
    ├── ValidationsValidateResponseBodyRedeemablesItemResultDetails.md
    ├── ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md
    ├── ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md
    ├── ValidationsValidateResponseBodyRedeemablesItemResultGift.md
    ├── ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md
    ├── ValidityHours.md
    ├── ValidityHoursDailyItem.md
    ├── ValidityTimeframe.md
    ├── Voucher.md
    ├── VoucherAssets.md
    ├── VoucherAssetsBarcode.md
    ├── VoucherAssetsQr.md
    ├── VoucherBalance.md
    ├── VoucherBalanceRelatedObject.md
    ├── VoucherGift.md
    ├── VoucherLoyaltyCard.md
    ├── VoucherPublish.md
    ├── VoucherRedemption.md
    ├── VoucherTransaction.md
    ├── VoucherTransactionDetails.md
    ├── VoucherTransactionDetailsBalance.md
    ├── VoucherTransactionDetailsBalanceRelatedObject.md
    ├── VoucherTransactionDetailsCustomEvent.md
    ├── VoucherTransactionDetailsEarningRule.md
    ├── VoucherTransactionDetailsEarningRuleSource.md
    ├── VoucherTransactionDetailsEvent.md
    ├── VoucherTransactionDetailsEventSchema.md
    ├── VoucherTransactionDetailsHolderLoyaltyTier.md
    ├── VoucherTransactionDetailsLoyaltyTier.md
    ├── VoucherTransactionDetailsOrder.md
    ├── VoucherTransactionDetailsRedemption.md
    ├── VoucherTransactionDetailsReward.md
    ├── VoucherTransactionDetailsRollback.md
    ├── VoucherTransactionDetailsSegment.md
    ├── VoucherTransactionsExportFilterConditions.md
    ├── VoucherTransactionsExportFilterConditionsVoucherId.md
    ├── VoucherTransactionsExportFilterConditionsVoucherIdConditions.md
    ├── VoucherTransactionsExportParameters.md
    ├── VoucherTransactionsFilters.md
    ├── VoucherWithCategories.md
    ├── VoucherWithCategoriesGift.md
    ├── VoucherWithCategoriesLoyaltyCard.md
    ├── VoucherWithCategoriesPublish.md
    ├── VoucherWithCategoriesRedemption.md
    ├── VouchersApi.md
    ├── VouchersBalanceUpdateRequestBody.md
    ├── VouchersBalanceUpdateResponseBody.md
    ├── VouchersBalanceUpdateResponseBodyRelatedObject.md
    ├── VouchersCreateRequestBody.md
    ├── VouchersCreateRequestBodyRedemption.md
    ├── VouchersCreateResponseBody.md
    ├── VouchersCreateResponseBodyGift.md
    ├── VouchersCreateResponseBodyLoyaltyCard.md
    ├── VouchersCreateResponseBodyPublish.md
    ├── VouchersCreateResponseBodyRedemption.md
    ├── VouchersCreateWithSpecificCodeRequestBody.md
    ├── VouchersCreateWithSpecificCodeRequestBodyRedemption.md
    ├── VouchersDisableResponseBody.md
    ├── VouchersDisableResponseBodyGift.md
    ├── VouchersDisableResponseBodyLoyaltyCard.md
    ├── VouchersDisableResponseBodyPublish.md
    ├── VouchersDisableResponseBodyRedemption.md
    ├── VouchersEnableResponseBody.md
    ├── VouchersEnableResponseBodyGift.md
    ├── VouchersEnableResponseBodyLoyaltyCard.md
    ├── VouchersEnableResponseBodyPublish.md
    ├── VouchersEnableResponseBodyRedemption.md
    ├── VouchersGetResponseBody.md
    ├── VouchersGetResponseBodyGift.md
    ├── VouchersGetResponseBodyLoyaltyCard.md
    ├── VouchersGetResponseBodyPublish.md
    ├── VouchersGetResponseBodyRedemption.md
    ├── VouchersImportCreateItemRequestBody.md
    ├── VouchersImportCreateItemRequestBodyRedemption.md
    ├── VouchersImportCreateResponseBody.md
    ├── VouchersImportCsvCreateResponseBody.md
    ├── VouchersListResponseBody.md
    ├── VouchersMetadataUpdateInBulkRequestBody.md
    ├── VouchersMetadataUpdateInBulkResponseBody.md
    ├── VouchersRedemptionGetResponseBody.md
    ├── VouchersTransactionsExportCreateRequestBody.md
    ├── VouchersTransactionsExportCreateResponseBody.md
    ├── VouchersTransactionsExportCreateResponseBodyResult.md
    ├── VouchersTransactionsListResponseBody.md
    ├── VouchersUpdateInBulkItemRequestBody.md
    ├── VouchersUpdateInBulkResponseBody.md
    ├── VouchersUpdateRequestBody.md
    ├── VouchersUpdateResponseBody.md
    ├── VouchersUpdateResponseBodyGift.md
    ├── VouchersUpdateResponseBodyLoyaltyCard.md
    ├── VouchersUpdateResponseBodyPublish.md
    └── VouchersUpdateResponseBodyRedemption.md
├── pyproject.toml
├── requirements.txt
├── running_code_example.py
├── setup.cfg
├── setup.py
├── test-requirements.txt
├── tox.ini
├── voucherify-python-sdk.png
└── voucherify
    ├── __init__.py
    ├── api
        ├── __init__.py
        ├── async_actions_api.py
        ├── bin_api.py
        ├── campaigns_api.py
        ├── categories_api.py
        ├── client_side_api.py
        ├── customers_api.py
        ├── events_api.py
        ├── exports_api.py
        ├── locations_api.py
        ├── loyalties_api.py
        ├── management_api.py
        ├── metadata_schemas_api.py
        ├── orders_api.py
        ├── product_collections_api.py
        ├── products_api.py
        ├── promotions_api.py
        ├── publications_api.py
        ├── qualifications_api.py
        ├── redemptions_api.py
        ├── referrals_api.py
        ├── rewards_api.py
        ├── segments_api.py
        ├── templates_api.py
        ├── validation_rules_api.py
        ├── validations_api.py
        └── vouchers_api.py
    ├── api_client.py
    ├── api_response.py
    ├── configuration.py
    ├── exceptions.py
    ├── models
        ├── __init__.py
        ├── access_settings.py
        ├── access_settings_assign.py
        ├── access_settings_campaign_assignments_list.py
        ├── access_settings_unassign.py
        ├── applicable_to.py
        ├── applicable_to_effect.py
        ├── applicable_to_order_item_units_item.py
        ├── applicable_to_result_list.py
        ├── application_details_item.py
        ├── area_store_campaign_assignment.py
        ├── async_action_base.py
        ├── async_action_get_response_body.py
        ├── async_actions_list_response_body.py
        ├── bus_val_rule_assignment.py
        ├── campaign.py
        ├── campaign_base.py
        ├── campaign_loyalty_card.py
        ├── campaign_loyalty_card_expiration_rules.py
        ├── campaign_loyalty_voucher.py
        ├── campaign_loyalty_voucher_redemption.py
        ├── campaign_template.py
        ├── campaign_voucher.py
        ├── campaign_voucher_redemption.py
        ├── campaigns_create_request_body.py
        ├── campaigns_create_request_body_promotion.py
        ├── campaigns_create_request_body_voucher.py
        ├── campaigns_create_request_body_voucher_redemption.py
        ├── campaigns_create_response_body.py
        ├── campaigns_delete_response_body.py
        ├── campaigns_get_response_body.py
        ├── campaigns_import_create_response_body.py
        ├── campaigns_import_csv_create_response_body.py
        ├── campaigns_import_voucher_item.py
        ├── campaigns_import_voucher_item_redemption.py
        ├── campaigns_list_response_body.py
        ├── campaigns_update_request_body.py
        ├── campaigns_update_request_body_options.py
        ├── campaigns_update_response_body.py
        ├── campaigns_vouchers_create_combined_response_body.py
        ├── campaigns_vouchers_create_combined_response_body_gift.py
        ├── campaigns_vouchers_create_combined_response_body_loyalty_card.py
        ├── campaigns_vouchers_create_combined_response_body_publish.py
        ├── campaigns_vouchers_create_combined_response_body_redemption.py
        ├── campaigns_vouchers_create_in_bulk_request_body.py
        ├── campaigns_vouchers_create_in_bulk_request_body_redemption.py
        ├── campaigns_vouchers_create_request_body.py
        ├── campaigns_vouchers_create_request_body_redemption.py
        ├── campaigns_vouchers_create_response_body.py
        ├── campaigns_vouchers_create_response_body_gift.py
        ├── campaigns_vouchers_create_response_body_loyalty_card.py
        ├── campaigns_vouchers_create_response_body_publish.py
        ├── campaigns_vouchers_create_response_body_redemption.py
        ├── categories_create_request_body.py
        ├── categories_create_response_body.py
        ├── categories_get_response_body.py
        ├── categories_list_response_body.py
        ├── categories_update_request_body.py
        ├── categories_update_response_body.py
        ├── category.py
        ├── category_with_stacking_rules_type.py
        ├── client_events_create_request_body.py
        ├── client_events_create_request_body_loyalty.py
        ├── client_events_create_request_body_referral.py
        ├── client_events_create_response_body.py
        ├── client_promotions_tiers_list_response_body.py
        ├── client_qualifications_check_eligibility_request_body.py
        ├── client_qualifications_check_eligibility_response_body.py
        ├── client_redemptions_redeem_request_body.py
        ├── client_redemptions_redeem_request_body_options.py
        ├── client_redemptions_redeem_request_body_redeemables_item.py
        ├── client_redemptions_redeem_request_body_redeemables_item_gift.py
        ├── client_redemptions_redeem_request_body_redeemables_item_reward.py
        ├── client_redemptions_redeem_response_body.py
        ├── client_validations_validate_request_body.py
        ├── client_validations_validate_request_body_options.py
        ├── client_validations_validate_request_body_redeemables_item.py
        ├── client_validations_validate_request_body_redeemables_item_gift.py
        ├── client_validations_validate_request_body_redeemables_item_reward.py
        ├── client_validations_validate_response_body.py
        ├── client_validations_validate_response_body_redeemables_item.py
        ├── client_validations_validate_response_body_redeemables_item_result.py
        ├── client_validations_validate_response_body_redeemables_item_result_details.py
        ├── client_validations_validate_response_body_redeemables_item_result_discount.py
        ├── client_validations_validate_response_body_redeemables_item_result_discount_product.py
        ├── client_validations_validate_response_body_redeemables_item_result_gift.py
        ├── client_validations_validate_response_body_redeemables_item_result_loyalty_card.py
        ├── code_config.py
        ├── create_publication_campaign.py
        ├── customer.py
        ├── customer_activity.py
        ├── customer_address.py
        ├── customer_id.py
        ├── customer_loyalty.py
        ├── customer_redeemable.py
        ├── customer_redeemable_redeemable.py
        ├── customer_referrals.py
        ├── customer_referrals_campaigns_item.py
        ├── customer_summary.py
        ├── customer_summary_orders.py
        ├── customer_summary_redemptions.py
        ├── customer_summary_redemptions_gift.py
        ├── customer_summary_redemptions_loyalty_card.py
        ├── customer_with_summary_loyalty_referrals.py
        ├── customer_with_summary_loyalty_referrals_address.py
        ├── customer_with_summary_loyalty_referrals_assets.py
        ├── customers_activity_list_response_body.py
        ├── customers_create_request_body.py
        ├── customers_create_request_body_address.py
        ├── customers_create_response_body.py
        ├── customers_create_response_body_address.py
        ├── customers_create_response_body_assets.py
        ├── customers_get_response_body.py
        ├── customers_get_response_body_address.py
        ├── customers_get_response_body_assets.py
        ├── customers_import_csv_create_response_body.py
        ├── customers_list_response_body.py
        ├── customers_metadata_update_in_bulk_request_body.py
        ├── customers_metadata_update_in_bulk_response_body.py
        ├── customers_permanent_deletion_create_response_body.py
        ├── customers_permanent_deletion_create_response_body_data_json.py
        ├── customers_redeemables_list_response_body.py
        ├── customers_segments_list_response_body.py
        ├── customers_update_in_bulk_request_body.py
        ├── customers_update_in_bulk_request_body_address.py
        ├── customers_update_in_bulk_response_body.py
        ├── customers_update_request_body.py
        ├── customers_update_request_body_address.py
        ├── customers_update_response_body.py
        ├── customers_update_response_body_address.py
        ├── customers_update_response_body_assets.py
        ├── discount.py
        ├── discount_product.py
        ├── discount_unit_multiple_one_unit.py
        ├── earning_rule.py
        ├── earning_rule_custom_event.py
        ├── earning_rule_loyalty.py
        ├── earning_rule_loyalty_custom_event.py
        ├── earning_rule_loyalty_custom_event_metadata.py
        ├── earning_rule_loyalty_customer.py
        ├── earning_rule_loyalty_customer_metadata.py
        ├── earning_rule_loyalty_order.py
        ├── earning_rule_loyalty_order_amount.py
        ├── earning_rule_loyalty_order_items.py
        ├── earning_rule_loyalty_order_items_amount.py
        ├── earning_rule_loyalty_order_items_quantity.py
        ├── earning_rule_loyalty_order_items_subtotal_amount.py
        ├── earning_rule_loyalty_order_metadata.py
        ├── earning_rule_loyalty_order_total_amount.py
        ├── earning_rule_loyalty_tier.py
        ├── earning_rule_pending_points.py
        ├── earning_rule_segment.py
        ├── earning_rule_source.py
        ├── error.py
        ├── error_error.py
        ├── event_source.py
        ├── event_source_api_key.py
        ├── event_source_user.py
        ├── events_create_request_body.py
        ├── events_create_request_body_loyalty.py
        ├── events_create_request_body_referral.py
        ├── events_create_response_body.py
        ├── export.py
        ├── export_order_fields.py
        ├── export_order_order.py
        ├── export_parameters.py
        ├── export_parameters_filters.py
        ├── export_result.py
        ├── export_voucher_transactions_fields.py
        ├── export_voucher_transactions_filters.py
        ├── export_voucher_transactions_order.py
        ├── exports_create_request_body.py
        ├── exports_create_request_body_parameters.py
        ├── exports_create_request_body_parameters_filters.py
        ├── exports_create_response_body.py
        ├── exports_create_response_body_parameters.py
        ├── exports_create_response_body_parameters_filters.py
        ├── exports_get_response_body.py
        ├── exports_get_response_body_parameters.py
        ├── exports_get_response_body_parameters_filters.py
        ├── exports_get_response_body_result.py
        ├── exports_list_response_body.py
        ├── field_conditions.py
        ├── filter_conditions_date_time.py
        ├── filter_conditions_date_time_conditions.py
        ├── filter_conditions_string.py
        ├── filters_condition.py
        ├── gift.py
        ├── inapplicable_to.py
        ├── inapplicable_to_order_item_units_item.py
        ├── inapplicable_to_result_list.py
        ├── junction.py
        ├── list_publications_item_voucher.py
        ├── location.py
        ├── location_shape.py
        ├── location_shape_distance.py
        ├── location_shape_geojson.py
        ├── locations_get_response_body.py
        ├── locations_get_response_body_shape.py
        ├── locations_get_response_body_shape_distance.py
        ├── locations_get_response_body_shape_geojson.py
        ├── locations_list_response_body.py
        ├── loyalties_campaign_pending_points_list_response_body.py
        ├── loyalties_create_campaign_request_body.py
        ├── loyalties_create_campaign_response_body.py
        ├── loyalties_delete_response_body.py
        ├── loyalties_earning_rules_create_request_body_item.py
        ├── loyalties_earning_rules_create_request_body_item_custom_event.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_custom_event.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_custom_event_metadata.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_customer.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_customer_metadata.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order_amount.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order_items.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order_items_subtotal_amount.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order_metadata.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_order_total_amount.py
        ├── loyalties_earning_rules_create_request_body_item_loyalty_tier.py
        ├── loyalties_earning_rules_create_request_body_item_segment.py
        ├── loyalties_earning_rules_create_request_body_item_source.py
        ├── loyalties_earning_rules_create_response_body.py
        ├── loyalties_earning_rules_create_response_body_custom_event.py
        ├── loyalties_earning_rules_create_response_body_loyalty.py
        ├── loyalties_earning_rules_create_response_body_loyalty_custom_event.py
        ├── loyalties_earning_rules_create_response_body_loyalty_custom_event_metadata.py
        ├── loyalties_earning_rules_create_response_body_loyalty_customer.py
        ├── loyalties_earning_rules_create_response_body_loyalty_customer_metadata.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order_amount.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order_items.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order_items_amount.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order_items_quantity.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order_items_subtotal_amount.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order_metadata.py
        ├── loyalties_earning_rules_create_response_body_loyalty_order_total_amount.py
        ├── loyalties_earning_rules_create_response_body_loyalty_tier.py
        ├── loyalties_earning_rules_create_response_body_pending_points.py
        ├── loyalties_earning_rules_create_response_body_segment.py
        ├── loyalties_earning_rules_create_response_body_source.py
        ├── loyalties_earning_rules_disable_response_body.py
        ├── loyalties_earning_rules_disable_response_body_custom_event.py
        ├── loyalties_earning_rules_disable_response_body_loyalty.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_custom_event.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_custom_event_metadata.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_customer.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_customer_metadata.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order_amount.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order_items.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order_items_amount.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order_items_subtotal_amount.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order_metadata.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_order_total_amount.py
        ├── loyalties_earning_rules_disable_response_body_loyalty_tier.py
        ├── loyalties_earning_rules_disable_response_body_pending_points.py
        ├── loyalties_earning_rules_disable_response_body_segment.py
        ├── loyalties_earning_rules_disable_response_body_source.py
        ├── loyalties_earning_rules_enable_response_body.py
        ├── loyalties_earning_rules_enable_response_body_custom_event.py
        ├── loyalties_earning_rules_enable_response_body_loyalty.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_custom_event.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_custom_event_metadata.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_customer.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_customer_metadata.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order_amount.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order_items.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order_items_amount.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order_items_subtotal_amount.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order_metadata.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_order_total_amount.py
        ├── loyalties_earning_rules_enable_response_body_loyalty_tier.py
        ├── loyalties_earning_rules_enable_response_body_pending_points.py
        ├── loyalties_earning_rules_enable_response_body_segment.py
        ├── loyalties_earning_rules_enable_response_body_source.py
        ├── loyalties_earning_rules_get_response_body.py
        ├── loyalties_earning_rules_get_response_body_custom_event.py
        ├── loyalties_earning_rules_get_response_body_loyalty.py
        ├── loyalties_earning_rules_get_response_body_loyalty_custom_event.py
        ├── loyalties_earning_rules_get_response_body_loyalty_custom_event_metadata.py
        ├── loyalties_earning_rules_get_response_body_loyalty_customer.py
        ├── loyalties_earning_rules_get_response_body_loyalty_customer_metadata.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order_amount.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order_items.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order_items_amount.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order_items_quantity.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order_metadata.py
        ├── loyalties_earning_rules_get_response_body_loyalty_order_total_amount.py
        ├── loyalties_earning_rules_get_response_body_loyalty_tier.py
        ├── loyalties_earning_rules_get_response_body_pending_points.py
        ├── loyalties_earning_rules_get_response_body_segment.py
        ├── loyalties_earning_rules_get_response_body_source.py
        ├── loyalties_earning_rules_list_response_body.py
        ├── loyalties_earning_rules_update_request_body.py
        ├── loyalties_earning_rules_update_request_body_loyalty.py
        ├── loyalties_earning_rules_update_request_body_loyalty_custom_event.py
        ├── loyalties_earning_rules_update_request_body_loyalty_custom_event_metadata.py
        ├── loyalties_earning_rules_update_request_body_loyalty_customer.py
        ├── loyalties_earning_rules_update_request_body_loyalty_customer_metadata.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order_amount.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order_items.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order_items_amount.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order_items_quantity.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order_items_subtotal_amount.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order_metadata.py
        ├── loyalties_earning_rules_update_request_body_loyalty_order_total_amount.py
        ├── loyalties_earning_rules_update_request_body_source.py
        ├── loyalties_earning_rules_update_response_body.py
        ├── loyalties_earning_rules_update_response_body_custom_event.py
        ├── loyalties_earning_rules_update_response_body_loyalty.py
        ├── loyalties_earning_rules_update_response_body_loyalty_custom_event.py
        ├── loyalties_earning_rules_update_response_body_loyalty_custom_event_metadata.py
        ├── loyalties_earning_rules_update_response_body_loyalty_customer.py
        ├── loyalties_earning_rules_update_response_body_loyalty_customer_metadata.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order_amount.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order_items.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order_items_amount.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order_items_quantity.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order_items_subtotal_amount.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order_metadata.py
        ├── loyalties_earning_rules_update_response_body_loyalty_order_total_amount.py
        ├── loyalties_earning_rules_update_response_body_loyalty_tier.py
        ├── loyalties_earning_rules_update_response_body_pending_points.py
        ├── loyalties_earning_rules_update_response_body_segment.py
        ├── loyalties_earning_rules_update_response_body_source.py
        ├── loyalties_get_campaign_response_body.py
        ├── loyalties_list_campaigns_response_body.py
        ├── loyalties_list_members_response_body.py
        ├── loyalties_loyalty_tier_reward.py
        ├── loyalties_member_activity_list_response_body.py
        ├── loyalties_members_balance_update_request_body.py
        ├── loyalties_members_balance_update_response_body.py
        ├── loyalties_members_balance_update_response_body_related_object.py
        ├── loyalties_members_create_request_body.py
        ├── loyalties_members_create_response_body.py
        ├── loyalties_members_create_response_body_loyalty_card.py
        ├── loyalties_members_create_response_body_publish.py
        ├── loyalties_members_create_response_body_redemption.py
        ├── loyalties_members_get_response_body.py
        ├── loyalties_members_get_response_body_loyalty_card.py
        ├── loyalties_members_get_response_body_publish.py
        ├── loyalties_members_get_response_body_redemption.py
        ├── loyalties_members_pending_points_activate_response_body.py
        ├── loyalties_members_pending_points_activate_response_body_related_object.py
        ├── loyalties_members_pending_points_list_response_body.py
        ├── loyalties_members_points_expiration_list_response_body.py
        ├── loyalties_members_points_expiration_list_response_body_data_item.py
        ├── loyalties_members_points_expiration_list_response_body_data_item_bucket.py
        ├── loyalties_members_redemption_redeem_request_body.py
        ├── loyalties_members_redemption_redeem_request_body_reward.py
        ├── loyalties_members_redemption_redeem_response_body.py
        ├── loyalties_members_redemption_redeem_response_body_channel.py
        ├── loyalties_members_redemption_redeem_response_body_gift.py
        ├── loyalties_members_redemption_redeem_response_body_loyalty_card.py
        ├── loyalties_members_redemption_redeem_response_body_related_redemptions.py
        ├── loyalties_members_redemption_redeem_response_body_related_redemptions_redemptions_item.py
        ├── loyalties_members_redemption_redeem_response_body_related_redemptions_rollbacks_item.py
        ├── loyalties_members_redemption_redeem_response_body_voucher.py
        ├── loyalties_members_redemption_redeem_response_body_voucher_gift.py
        ├── loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.py
        ├── loyalties_members_redemption_redeem_response_body_voucher_publish.py
        ├── loyalties_members_redemption_redeem_response_body_voucher_redemption.py
        ├── loyalties_members_rewards_list_response_body.py
        ├── loyalties_members_rewards_list_response_body_data_item.py
        ├── loyalties_members_tiers_list_response_body.py
        ├── loyalties_members_transactions_export_create_request_body.py
        ├── loyalties_members_transactions_export_create_request_body_parameters.py
        ├── loyalties_members_transactions_export_create_response_body.py
        ├── loyalties_members_transactions_export_create_response_body_parameters.py
        ├── loyalties_members_transactions_list_response_body.py
        ├── loyalties_members_transfers_create_response_body.py
        ├── loyalties_members_transfers_create_response_body_assets.py
        ├── loyalties_members_transfers_create_response_body_assets_barcode.py
        ├── loyalties_members_transfers_create_response_body_assets_qr.py
        ├── loyalties_members_transfers_create_response_body_loyalty_card.py
        ├── loyalties_members_transfers_create_response_body_publish.py
        ├── loyalties_members_transfers_create_response_body_redemption.py
        ├── loyalties_pending_points_list_response_body.py
        ├── loyalties_points_expiration_export_create_request_body.py
        ├── loyalties_points_expiration_export_create_request_body_parameters.py
        ├── loyalties_points_expiration_export_create_request_body_parameters_filters.py
        ├── loyalties_points_expiration_export_create_request_body_parameters_filters_campaign_id.py
        ├── loyalties_points_expiration_export_create_request_body_parameters_filters_campaign_id_conditions.py
        ├── loyalties_points_expiration_export_create_request_body_parameters_filters_voucher_id.py
        ├── loyalties_points_expiration_export_create_request_body_parameters_filters_voucher_id_conditions.py
        ├── loyalties_points_expiration_export_create_response_body.py
        ├── loyalties_points_expiration_export_create_response_body_parameters.py
        ├── loyalties_points_expiration_export_create_response_body_parameters_filters.py
        ├── loyalties_points_expiration_export_create_response_body_parameters_filters_campaign_id.py
        ├── loyalties_points_expiration_export_create_response_body_parameters_filters_campaign_id_conditions.py
        ├── loyalties_points_expiration_export_create_response_body_parameters_filters_voucher_id.py
        ├── loyalties_points_expiration_export_create_response_body_parameters_filters_voucher_id_conditions.py
        ├── loyalties_reward_assignments_get_response_body.py
        ├── loyalties_reward_assignments_get_response_body_parameters.py
        ├── loyalties_reward_assignments_get_response_body_parameters_loyalty.py
        ├── loyalties_reward_assignments_list_response_body.py
        ├── loyalties_reward_assignments_reward_get_response_body.py
        ├── loyalties_reward_assignments_reward_get_response_body_attributes.py
        ├── loyalties_rewards_create_assignment_item_request_body.py
        ├── loyalties_rewards_create_assignment_item_request_body_parameters.py
        ├── loyalties_rewards_create_assignment_item_request_body_parameters_loyalty.py
        ├── loyalties_rewards_create_assignment_response_body.py
        ├── loyalties_rewards_create_assignment_response_body_parameters.py
        ├── loyalties_rewards_create_assignment_response_body_parameters_loyalty.py
        ├── loyalties_rewards_get_response_body.py
        ├── loyalties_rewards_get_response_body_parameters.py
        ├── loyalties_rewards_get_response_body_parameters_loyalty.py
        ├── loyalties_rewards_list_assignments_response_body.py
        ├── loyalties_rewards_update_assignment_request_body.py
        ├── loyalties_rewards_update_assignment_request_body_parameters.py
        ├── loyalties_rewards_update_assignment_request_body_parameters_loyalty.py
        ├── loyalties_rewards_update_assignment_response_body.py
        ├── loyalties_rewards_update_assignment_response_body_parameters.py
        ├── loyalties_rewards_update_assignment_response_body_parameters_loyalty.py
        ├── loyalties_tiers_create_in_bulk_request_body_item.py
        ├── loyalties_tiers_earning_rules_list_response_body.py
        ├── loyalties_tiers_get_response_body.py
        ├── loyalties_tiers_get_response_body_config.py
        ├── loyalties_tiers_get_response_body_config_points.py
        ├── loyalties_tiers_get_response_body_points.py
        ├── loyalties_tiers_list_response_body.py
        ├── loyalties_tiers_rewards_list_response_body.py
        ├── loyalties_transfer_points.py
        ├── loyalties_update_campaign_request_body.py
        ├── loyalties_update_campaign_request_body_options.py
        ├── loyalties_update_campaign_response_body.py
        ├── loyalty_campaign.py
        ├── loyalty_campaign_voucher.py
        ├── loyalty_campaign_voucher_redemption.py
        ├── loyalty_card_transaction.py
        ├── loyalty_card_transaction_details.py
        ├── loyalty_card_transaction_details_balance.py
        ├── loyalty_card_transaction_details_balance_related_object.py
        ├── loyalty_card_transaction_details_custom_event.py
        ├── loyalty_card_transaction_details_earning_rule.py
        ├── loyalty_card_transaction_details_earning_rule_source.py
        ├── loyalty_card_transaction_details_event.py
        ├── loyalty_card_transaction_details_event_schema.py
        ├── loyalty_card_transaction_details_holder_loyalty_tier.py
        ├── loyalty_card_transaction_details_loyalty_tier.py
        ├── loyalty_card_transaction_details_order.py
        ├── loyalty_card_transaction_details_redemption.py
        ├── loyalty_card_transaction_details_reward.py
        ├── loyalty_card_transaction_details_rollback.py
        ├── loyalty_card_transaction_details_segment.py
        ├── loyalty_card_transactions_type.py
        ├── loyalty_member.py
        ├── loyalty_member_loyalty_card.py
        ├── loyalty_member_publish.py
        ├── loyalty_member_redemption.py
        ├── loyalty_pending_points.py
        ├── loyalty_pending_points_details.py
        ├── loyalty_pending_points_details_earning_rule.py
        ├── loyalty_pending_points_details_earning_rule_source.py
        ├── loyalty_pending_points_details_event.py
        ├── loyalty_pending_points_details_holder_loyalty_tier.py
        ├── loyalty_pending_points_details_loyalty_tier.py
        ├── loyalty_pending_points_details_order.py
        ├── loyalty_points_bucket.py
        ├── loyalty_points_bucket_bucket.py
        ├── loyalty_tier.py
        ├── loyalty_tier_base.py
        ├── loyalty_tier_base_points.py
        ├── loyalty_tier_config.py
        ├── loyalty_tier_config_points.py
        ├── loyalty_tier_expiration.py
        ├── loyalty_tier_points.py
        ├── loyalty_tiers_expiration_all.py
        ├── loyalty_tiers_expiration_all_expiration_date.py
        ├── loyalty_tiers_expiration_all_expiration_date_rounding.py
        ├── loyalty_tiers_expiration_all_start_date.py
        ├── lucky_draw.py
        ├── management_project.py
        ├── management_project_api_usage_notifications.py
        ├── management_project_default_code_config.py
        ├── management_project_limits.py
        ├── management_project_limits_api_calls_item.py
        ├── management_project_limits_bulk_api_calls_item.py
        ├── management_project_webhooks_callout_notifications.py
        ├── management_project_webhooks_callout_notifications_distributions.py
        ├── management_project_webhooks_callout_notifications_webhooks.py
        ├── management_projects_branding.py
        ├── management_projects_branding_address.py
        ├── management_projects_branding_brand.py
        ├── management_projects_branding_cockpits.py
        ├── management_projects_branding_contact.py
        ├── management_projects_branding_create_request_body.py
        ├── management_projects_branding_create_request_body_address.py
        ├── management_projects_branding_create_request_body_brand.py
        ├── management_projects_branding_create_request_body_cockpits.py
        ├── management_projects_branding_create_request_body_contact.py
        ├── management_projects_branding_create_response_body.py
        ├── management_projects_branding_create_response_body_address.py
        ├── management_projects_branding_create_response_body_brand.py
        ├── management_projects_branding_create_response_body_cockpits.py
        ├── management_projects_branding_create_response_body_contact.py
        ├── management_projects_branding_get_response_body.py
        ├── management_projects_branding_get_response_body_address.py
        ├── management_projects_branding_get_response_body_brand.py
        ├── management_projects_branding_get_response_body_cockpits.py
        ├── management_projects_branding_get_response_body_contact.py
        ├── management_projects_branding_list_response_body.py
        ├── management_projects_branding_update_request_body.py
        ├── management_projects_branding_update_request_body_address.py
        ├── management_projects_branding_update_request_body_brand.py
        ├── management_projects_branding_update_request_body_cockpits.py
        ├── management_projects_branding_update_request_body_contact.py
        ├── management_projects_branding_update_response_body.py
        ├── management_projects_branding_update_response_body_address.py
        ├── management_projects_branding_update_response_body_brand.py
        ├── management_projects_branding_update_response_body_cockpits.py
        ├── management_projects_branding_update_response_body_contact.py
        ├── management_projects_create_request_body.py
        ├── management_projects_create_request_body_api_usage_notifications.py
        ├── management_projects_create_request_body_users_item.py
        ├── management_projects_create_request_body_webhooks_callout_notifications.py
        ├── management_projects_create_request_body_webhooks_callout_notifications_distributions.py
        ├── management_projects_create_request_body_webhooks_callout_notifications_webhooks.py
        ├── management_projects_create_response_body.py
        ├── management_projects_create_response_body_api_usage_notifications.py
        ├── management_projects_create_response_body_client_side_key.py
        ├── management_projects_create_response_body_server_side_key.py
        ├── management_projects_create_response_body_webhooks_callout_notifications.py
        ├── management_projects_create_response_body_webhooks_callout_notifications_distributions.py
        ├── management_projects_create_response_body_webhooks_callout_notifications_webhooks.py
        ├── management_projects_custom_event_schema.py
        ├── management_projects_custom_event_schema_schema.py
        ├── management_projects_custom_event_schemas_create_request_body.py
        ├── management_projects_custom_event_schemas_create_request_body_schema.py
        ├── management_projects_custom_event_schemas_create_response_body.py
        ├── management_projects_custom_event_schemas_create_response_body_schema.py
        ├── management_projects_custom_event_schemas_get_response_body.py
        ├── management_projects_custom_event_schemas_get_response_body_schema.py
        ├── management_projects_custom_event_schemas_list_response_body.py
        ├── management_projects_custom_event_schemas_update_request_body.py
        ├── management_projects_custom_event_schemas_update_request_body_schema.py
        ├── management_projects_custom_event_schemas_update_response_body.py
        ├── management_projects_custom_event_schemas_update_response_body_schema.py
        ├── management_projects_get_response_body.py
        ├── management_projects_get_response_body_api_usage_notifications.py
        ├── management_projects_get_response_body_default_code_config.py
        ├── management_projects_get_response_body_limits.py
        ├── management_projects_get_response_body_limits_api_calls_item.py
        ├── management_projects_get_response_body_limits_bulk_api_calls_item.py
        ├── management_projects_get_response_body_webhooks_callout_notifications.py
        ├── management_projects_get_response_body_webhooks_callout_notifications_distributions.py
        ├── management_projects_get_response_body_webhooks_callout_notifications_webhooks.py
        ├── management_projects_list_response_body.py
        ├── management_projects_metadata_schema.py
        ├── management_projects_metadata_schemas_create_request_body.py
        ├── management_projects_metadata_schemas_create_response_body.py
        ├── management_projects_metadata_schemas_get_response_body.py
        ├── management_projects_metadata_schemas_list_response_body.py
        ├── management_projects_metadata_schemas_update_request_body.py
        ├── management_projects_metadata_schemas_update_response_body.py
        ├── management_projects_stacking_rules.py
        ├── management_projects_stacking_rules_create_request_body.py
        ├── management_projects_stacking_rules_create_response_body.py
        ├── management_projects_stacking_rules_get_response_body.py
        ├── management_projects_stacking_rules_list_response_body.py
        ├── management_projects_stacking_rules_update_request_body.py
        ├── management_projects_stacking_rules_update_response_body.py
        ├── management_projects_templates_campaigns_copy_create_request_body.py
        ├── management_projects_templates_campaigns_copy_create_response_body.py
        ├── management_projects_templates_campaigns_list_response_body.py
        ├── management_projects_update_request_body.py
        ├── management_projects_update_request_body_api_usage_notifications.py
        ├── management_projects_update_request_body_default_code_config.py
        ├── management_projects_update_request_body_webhooks_callout_notifications.py
        ├── management_projects_update_request_body_webhooks_callout_notifications_distributions.py
        ├── management_projects_update_request_body_webhooks_callout_notifications_webhooks.py
        ├── management_projects_update_response_body.py
        ├── management_projects_update_response_body_api_usage_notifications.py
        ├── management_projects_update_response_body_default_code_config.py
        ├── management_projects_update_response_body_limits.py
        ├── management_projects_update_response_body_limits_api_calls_item.py
        ├── management_projects_update_response_body_limits_bulk_api_calls_item.py
        ├── management_projects_update_response_body_webhooks_callout_notifications.py
        ├── management_projects_update_response_body_webhooks_callout_notifications_distributions.py
        ├── management_projects_update_response_body_webhooks_callout_notifications_webhooks.py
        ├── management_projects_users_assign_request_body.py
        ├── management_projects_users_assign_response_body.py
        ├── management_projects_users_get_user_response_body.py
        ├── management_projects_users_invite_create_request_body.py
        ├── management_projects_users_list_response_body.py
        ├── management_projects_users_update_role_request_body.py
        ├── management_projects_users_update_role_response_body.py
        ├── management_projects_webhook.py
        ├── management_projects_webhooks_create_request_body.py
        ├── management_projects_webhooks_create_response_body.py
        ├── management_projects_webhooks_get_response_body.py
        ├── management_projects_webhooks_list_response_body.py
        ├── management_projects_webhooks_update_request_body.py
        ├── management_projects_webhooks_update_response_body.py
        ├── member_activity.py
        ├── metadata_schema.py
        ├── metadata_schema_deprecated.py
        ├── metadata_schemas_get_response_body.py
        ├── metadata_schemas_list_response_body.py
        ├── order.py
        ├── order_calculated.py
        ├── order_calculated_item.py
        ├── order_calculated_item_product.py
        ├── order_calculated_item_sku.py
        ├── order_item.py
        ├── order_item_product.py
        ├── order_item_sku.py
        ├── orders_create_request_body.py
        ├── orders_create_response_body.py
        ├── orders_export_create_request_body.py
        ├── orders_export_create_request_body_parameters.py
        ├── orders_export_create_response_body.py
        ├── orders_export_create_response_body_parameters.py
        ├── orders_get_response_body.py
        ├── orders_import_create_request_body_item.py
        ├── orders_import_create_response_body.py
        ├── orders_list_response_body.py
        ├── orders_update_request_body.py
        ├── orders_update_response_body.py
        ├── parameter_activity_category.py
        ├── parameter_campaign_type.py
        ├── parameter_created_before_after.py
        ├── parameter_expand_list_campaigns.py
        ├── parameter_filters_list_bin.py
        ├── parameter_filters_list_bin_id.py
        ├── parameter_filters_list_bin_resource_id.py
        ├── parameter_filters_list_bin_resource_name.py
        ├── parameter_filters_list_bin_resource_type.py
        ├── parameter_filters_list_bin_resource_type_conditions.py
        ├── parameter_filters_list_campaigns.py
        ├── parameter_filters_list_campaigns_campaign_status.py
        ├── parameter_filters_list_campaigns_campaign_status_conditions.py
        ├── parameter_filters_list_campaigns_categories.py
        ├── parameter_filters_list_campaigns_category_ids.py
        ├── parameter_filters_list_campaigns_is_referral_code.py
        ├── parameter_filters_list_campaigns_validity_timeframe.py
        ├── parameter_filters_list_campaigns_voucher_type.py
        ├── parameter_filters_list_customer_redeemables.py
        ├── parameter_filters_list_customer_redeemables_campaign_id.py
        ├── parameter_filters_list_customer_redeemables_campaign_type.py
        ├── parameter_filters_list_customer_redeemables_campaign_type_conditions.py
        ├── parameter_filters_list_customer_redeemables_created_at.py
        ├── parameter_filters_list_customer_redeemables_created_at_conditions.py
        ├── parameter_filters_list_customer_redeemables_holder_role.py
        ├── parameter_filters_list_customer_redeemables_holder_role_conditions.py
        ├── parameter_filters_list_customer_redeemables_id.py
        ├── parameter_filters_list_customer_redeemables_redeemable_id.py
        ├── parameter_filters_list_customer_redeemables_redeemable_object.py
        ├── parameter_filters_list_customer_redeemables_redeemable_object_conditions.py
        ├── parameter_filters_list_customer_redeemables_voucher_type.py
        ├── parameter_filters_list_customer_redeemables_voucher_type_conditions.py
        ├── parameter_filters_list_locations.py
        ├── parameter_filters_list_locations_created_at.py
        ├── parameter_filters_list_locations_name.py
        ├── parameter_filters_list_locations_updated_at.py
        ├── parameter_filters_list_publications.py
        ├── parameter_filters_list_publications_campaign_name.py
        ├── parameter_filters_list_publications_customer_id.py
        ├── parameter_filters_list_publications_failure_code.py
        ├── parameter_filters_list_publications_is_referral_code.py
        ├── parameter_filters_list_publications_parent_object_id.py
        ├── parameter_filters_list_publications_related_object_id.py
        ├── parameter_filters_list_publications_result.py
        ├── parameter_filters_list_publications_source_id.py
        ├── parameter_filters_list_publications_voucher_type.py
        ├── parameter_filters_list_redemptions.py
        ├── parameter_filters_list_redemptions_campaign_name.py
        ├── parameter_filters_list_redemptions_customer_id.py
        ├── parameter_filters_list_redemptions_failure_code.py
        ├── parameter_filters_list_redemptions_object.py
        ├── parameter_filters_list_redemptions_parent_redemption_id.py
        ├── parameter_filters_list_redemptions_related_object_id.py
        ├── parameter_filters_list_redemptions_related_object_parent_id.py
        ├── parameter_filters_list_redemptions_result.py
        ├── parameter_filters_list_redemptions_user_login.py
        ├── parameter_filters_list_redemptions_voucher_code.py
        ├── parameter_filters_list_referrals_redeemable_holders.py
        ├── parameter_filters_list_referrals_redeemable_holders_campaign_id.py
        ├── parameter_filters_list_referrals_redeemable_holders_campaign_type.py
        ├── parameter_filters_list_referrals_redeemable_holders_created_at.py
        ├── parameter_filters_list_referrals_redeemable_holders_customer_id.py
        ├── parameter_filters_list_referrals_redeemable_holders_holder_role.py
        ├── parameter_filters_list_referrals_redeemable_holders_holder_role_conditions.py
        ├── parameter_filters_list_referrals_redeemable_holders_id.py
        ├── parameter_filters_list_referrals_redeemable_holders_redeemable_id.py
        ├── parameter_filters_list_referrals_redeemable_holders_redeemable_object.py
        ├── parameter_filters_list_referrals_redeemable_holders_voucher_type.py
        ├── parameter_filters_list_templates.py
        ├── parameter_filters_list_templates_campaign_type.py
        ├── parameter_filters_list_templates_campaign_type_conditions.py
        ├── parameter_filters_list_templates_id.py
        ├── parameter_filters_list_templates_name.py
        ├── parameter_order.py
        ├── parameter_order_created_at.py
        ├── parameter_order_list_all_promotion_stacks.py
        ├── parameter_order_list_bin.py
        ├── parameter_order_list_campaigns.py
        ├── parameter_order_list_customers.py
        ├── parameter_order_list_earning_rules.py
        ├── parameter_order_list_exports.py
        ├── parameter_order_list_locations.py
        ├── parameter_order_list_loyalty_tiers.py
        ├── parameter_order_list_orders.py
        ├── parameter_order_list_pending_points.py
        ├── parameter_order_list_promotion_tiers.py
        ├── parameter_order_list_promotion_tiers_client_side.py
        ├── parameter_order_list_publications.py
        ├── parameter_order_list_redeemables.py
        ├── parameter_order_list_redemptions.py
        ├── parameter_order_list_transactions.py
        ├── parameter_order_list_validation_rule_assignments.py
        ├── parameter_order_list_validation_rules.py
        ├── parameter_order_vouchers.py
        ├── parameter_result_list_publications.py
        ├── parameter_templates_list.py
        ├── parameter_updated_before_after.py
        ├── parameter_voucher_type_list_publications.py
        ├── points_expiration_types.py
        ├── product.py
        ├── product_collections_create_request_body.py
        ├── product_collections_create_request_body_filter.py
        ├── product_collections_create_request_body_products_item.py
        ├── product_collections_create_response_body.py
        ├── product_collections_create_response_body_filter.py
        ├── product_collections_create_response_body_products_item.py
        ├── product_collections_get_response_body.py
        ├── product_collections_get_response_body_filter.py
        ├── product_collections_get_response_body_products_item.py
        ├── product_collections_item.py
        ├── product_collections_item_filter.py
        ├── product_collections_item_products_item.py
        ├── product_collections_list_response_body.py
        ├── product_collections_products_list_response_body.py
        ├── product_collections_products_list_response_body_data_item.py
        ├── product_without_skus.py
        ├── products_create_request_body.py
        ├── products_create_response_body.py
        ├── products_get_response_body.py
        ├── products_import_csv_create_response_body.py
        ├── products_list_response_body.py
        ├── products_metadata_update_in_bulk_request_body.py
        ├── products_metadata_update_in_bulk_response_body.py
        ├── products_skus_create_request_body.py
        ├── products_skus_create_response_body.py
        ├── products_skus_list_response_body.py
        ├── products_skus_update_request_body.py
        ├── products_skus_update_response_body.py
        ├── products_update_in_bulk_request_body.py
        ├── products_update_in_bulk_response_body.py
        ├── products_update_request_body.py
        ├── products_update_response_body.py
        ├── promotion_stack.py
        ├── promotion_stack_base.py
        ├── promotion_stack_base_tiers.py
        ├── promotion_stack_tiers.py
        ├── promotion_tier.py
        ├── promotion_tier_action.py
        ├── promotion_tier_campaign.py
        ├── promotion_tier_create_params.py
        ├── promotion_tier_create_params_action.py
        ├── promotion_tier_summary.py
        ├── promotion_tier_summary_orders.py
        ├── promotion_tier_summary_redemptions.py
        ├── promotion_tiers_list.py
        ├── promotions_stacks_create_request_body.py
        ├── promotions_stacks_create_request_body_tiers.py
        ├── promotions_stacks_create_response_body.py
        ├── promotions_stacks_create_response_body_tiers.py
        ├── promotions_stacks_get_response_body.py
        ├── promotions_stacks_get_response_body_tiers.py
        ├── promotions_stacks_list_response_body.py
        ├── promotions_stacks_update_request_body.py
        ├── promotions_stacks_update_request_body_tiers.py
        ├── promotions_stacks_update_response_body.py
        ├── promotions_stacks_update_response_body_tiers.py
        ├── promotions_tiers_create_request_body.py
        ├── promotions_tiers_create_request_body_action.py
        ├── promotions_tiers_create_response_body.py
        ├── promotions_tiers_create_response_body_action.py
        ├── promotions_tiers_create_response_body_campaign.py
        ├── promotions_tiers_create_response_body_summary.py
        ├── promotions_tiers_create_response_body_summary_orders.py
        ├── promotions_tiers_create_response_body_summary_redemptions.py
        ├── promotions_tiers_disable_response_body.py
        ├── promotions_tiers_disable_response_body_action.py
        ├── promotions_tiers_disable_response_body_campaign.py
        ├── promotions_tiers_disable_response_body_summary.py
        ├── promotions_tiers_disable_response_body_summary_orders.py
        ├── promotions_tiers_disable_response_body_summary_redemptions.py
        ├── promotions_tiers_enable_response_body.py
        ├── promotions_tiers_enable_response_body_action.py
        ├── promotions_tiers_enable_response_body_campaign.py
        ├── promotions_tiers_enable_response_body_summary.py
        ├── promotions_tiers_enable_response_body_summary_orders.py
        ├── promotions_tiers_enable_response_body_summary_redemptions.py
        ├── promotions_tiers_get_response_body.py
        ├── promotions_tiers_get_response_body_action.py
        ├── promotions_tiers_get_response_body_campaign.py
        ├── promotions_tiers_get_response_body_summary.py
        ├── promotions_tiers_get_response_body_summary_orders.py
        ├── promotions_tiers_get_response_body_summary_redemptions.py
        ├── promotions_tiers_list_response_body.py
        ├── promotions_tiers_update_request_body.py
        ├── promotions_tiers_update_request_body_action.py
        ├── promotions_tiers_update_response_body.py
        ├── promotions_tiers_update_response_body_action.py
        ├── promotions_tiers_update_response_body_campaign.py
        ├── promotions_tiers_update_response_body_summary.py
        ├── promotions_tiers_update_response_body_summary_orders.py
        ├── promotions_tiers_update_response_body_summary_redemptions.py
        ├── publications_create_request_body.py
        ├── publications_create_request_body_customer.py
        ├── publications_create_request_body_customer_address.py
        ├── publications_create_response_body.py
        ├── publications_list_response_body.py
        ├── publications_list_response_body_publications_item.py
        ├── publications_list_response_body_publications_item_metadata.py
        ├── qualifications_check_eligibility_request_body.py
        ├── qualifications_check_eligibility_response_body.py
        ├── qualifications_field_conditions.py
        ├── qualifications_filters_condition.py
        ├── qualifications_option.py
        ├── qualifications_option_filters.py
        ├── qualifications_option_filters_campaign_type.py
        ├── qualifications_option_filters_campaign_type_conditions.py
        ├── qualifications_option_filters_holder_role.py
        ├── qualifications_option_filters_holder_role_conditions.py
        ├── qualifications_option_filters_resource_type.py
        ├── qualifications_option_filters_resource_type_conditions.py
        ├── qualifications_redeemable.py
        ├── qualifications_redeemable_base.py
        ├── qualifications_redeemables.py
        ├── redeemable_gift.py
        ├── redeemable_holder.py
        ├── redeemable_loyalty_card.py
        ├── redeemable_result.py
        ├── redeemable_voucher.py
        ├── redeemable_voucher_gift.py
        ├── redeemable_voucher_loyalty_card.py
        ├── redeemable_voucher_publish.py
        ├── redeemable_voucher_redemption.py
        ├── redemption.py
        ├── redemption_channel.py
        ├── redemption_entry.py
        ├── redemption_entry_channel.py
        ├── redemption_entry_customer.py
        ├── redemption_entry_gift.py
        ├── redemption_entry_loyalty_card.py
        ├── redemption_entry_order.py
        ├── redemption_entry_order_customer.py
        ├── redemption_entry_order_referrer.py
        ├── redemption_entry_promotion_tier.py
        ├── redemption_entry_promotion_tier_action.py
        ├── redemption_entry_promotion_tier_campaign.py
        ├── redemption_entry_promotion_tier_summary.py
        ├── redemption_entry_promotion_tier_summary_orders.py
        ├── redemption_entry_promotion_tier_summary_redemptions.py
        ├── redemption_entry_related_redemptions.py
        ├── redemption_entry_related_redemptions_redemptions_item.py
        ├── redemption_entry_related_redemptions_rollbacks_item.py
        ├── redemption_entry_voucher.py
        ├── redemption_entry_voucher_gift.py
        ├── redemption_entry_voucher_loyalty_card.py
        ├── redemption_entry_voucher_publish.py
        ├── redemption_entry_voucher_redemption.py
        ├── redemption_gift.py
        ├── redemption_loyalty_card.py
        ├── redemption_redeem.py
        ├── redemption_redeem_channel.py
        ├── redemption_redeem_gift.py
        ├── redemption_redeem_loyalty_card.py
        ├── redemption_redeem_related_redemptions.py
        ├── redemption_redeem_related_redemptions_redemptions_item.py
        ├── redemption_redeem_related_redemptions_rollbacks_item.py
        ├── redemption_redeem_voucher.py
        ├── redemption_redeem_voucher_gift.py
        ├── redemption_redeem_voucher_loyalty_card.py
        ├── redemption_redeem_voucher_publish.py
        ├── redemption_redeem_voucher_redemption.py
        ├── redemption_related_redemptions.py
        ├── redemption_related_redemptions_redemptions_item.py
        ├── redemption_related_redemptions_rollbacks_item.py
        ├── redemption_reward_result.py
        ├── redemption_reward_result_parameters.py
        ├── redemption_reward_result_parameters_campaign.py
        ├── redemption_reward_result_parameters_coin.py
        ├── redemption_reward_result_parameters_product.py
        ├── redemption_rollback.py
        ├── redemption_rollback_channel.py
        ├── redemption_rollback_gift.py
        ├── redemption_rollback_loyalty_card.py
        ├── redemption_rollback_related_redemptions.py
        ├── redemption_rollback_related_redemptions_redemptions_item.py
        ├── redemption_rollback_related_redemptions_rollbacks_item.py
        ├── redemption_voucher.py
        ├── redemption_voucher_gift.py
        ├── redemption_voucher_loyalty_card.py
        ├── redemption_voucher_publish.py
        ├── redemption_voucher_redemption.py
        ├── redemptions_get_response_body.py
        ├── redemptions_get_response_body_channel.py
        ├── redemptions_get_response_body_customer.py
        ├── redemptions_get_response_body_gift.py
        ├── redemptions_get_response_body_loyalty_card.py
        ├── redemptions_get_response_body_order.py
        ├── redemptions_get_response_body_order_customer.py
        ├── redemptions_get_response_body_order_referrer.py
        ├── redemptions_get_response_body_promotion_tier.py
        ├── redemptions_get_response_body_promotion_tier_action.py
        ├── redemptions_get_response_body_promotion_tier_campaign.py
        ├── redemptions_get_response_body_promotion_tier_summary.py
        ├── redemptions_get_response_body_promotion_tier_summary_orders.py
        ├── redemptions_get_response_body_promotion_tier_summary_redemptions.py
        ├── redemptions_get_response_body_related_redemptions.py
        ├── redemptions_get_response_body_related_redemptions_redemptions_item.py
        ├── redemptions_get_response_body_related_redemptions_rollbacks_item.py
        ├── redemptions_get_response_body_voucher.py
        ├── redemptions_get_response_body_voucher_gift.py
        ├── redemptions_get_response_body_voucher_loyalty_card.py
        ├── redemptions_get_response_body_voucher_publish.py
        ├── redemptions_get_response_body_voucher_redemption.py
        ├── redemptions_list_response_body.py
        ├── redemptions_list_response_body_redemptions_item.py
        ├── redemptions_list_response_body_redemptions_item_channel.py
        ├── redemptions_list_response_body_redemptions_item_customer.py
        ├── redemptions_list_response_body_redemptions_item_gift.py
        ├── redemptions_list_response_body_redemptions_item_loyalty_card.py
        ├── redemptions_list_response_body_redemptions_item_order.py
        ├── redemptions_list_response_body_redemptions_item_order_customer.py
        ├── redemptions_list_response_body_redemptions_item_order_referrer.py
        ├── redemptions_list_response_body_redemptions_item_promotion_tier.py
        ├── redemptions_list_response_body_redemptions_item_promotion_tier_action.py
        ├── redemptions_list_response_body_redemptions_item_promotion_tier_campaign.py
        ├── redemptions_list_response_body_redemptions_item_promotion_tier_summary.py
        ├── redemptions_list_response_body_redemptions_item_promotion_tier_summary_orders.py
        ├── redemptions_list_response_body_redemptions_item_promotion_tier_summary_redemptions.py
        ├── redemptions_list_response_body_redemptions_item_related_redemptions.py
        ├── redemptions_list_response_body_redemptions_item_related_redemptions_redemptions_item.py
        ├── redemptions_list_response_body_redemptions_item_related_redemptions_rollbacks_item.py
        ├── redemptions_list_response_body_redemptions_item_voucher.py
        ├── redemptions_list_response_body_redemptions_item_voucher_gift.py
        ├── redemptions_list_response_body_redemptions_item_voucher_loyalty_card.py
        ├── redemptions_list_response_body_redemptions_item_voucher_publish.py
        ├── redemptions_list_response_body_redemptions_item_voucher_redemption.py
        ├── redemptions_redeem_request_body.py
        ├── redemptions_redeem_request_body_options.py
        ├── redemptions_redeem_request_body_redeemables_item.py
        ├── redemptions_redeem_request_body_redeemables_item_gift.py
        ├── redemptions_redeem_request_body_redeemables_item_reward.py
        ├── redemptions_redeem_response_body.py
        ├── redemptions_rollback_create_request_body.py
        ├── redemptions_rollback_create_response_body.py
        ├── redemptions_rollback_create_response_body_channel.py
        ├── redemptions_rollback_create_response_body_gift.py
        ├── redemptions_rollback_create_response_body_loyalty_card.py
        ├── redemptions_rollback_create_response_body_related_redemptions.py
        ├── redemptions_rollback_create_response_body_related_redemptions_redemptions_item.py
        ├── redemptions_rollback_create_response_body_related_redemptions_rollbacks_item.py
        ├── redemptions_rollbacks_create_request_body.py
        ├── redemptions_rollbacks_create_response_body.py
        ├── referral_program.py
        ├── referral_program_custom_event.py
        ├── referral_program_referee_reward.py
        ├── referral_program_referee_reward_related_object_parent.py
        ├── referrals_members_holders_create_in_bulk_request_body.py
        ├── referrals_members_holders_create_in_bulk_response_body.py
        ├── referrals_members_holders_list_response_body.py
        ├── referrer.py
        ├── referrer_address.py
        ├── referrer_id.py
        ├── resource_types.py
        ├── reward.py
        ├── reward_assignment.py
        ├── reward_assignment_parameters.py
        ├── reward_assignment_parameters_loyalty.py
        ├── reward_attributes.py
        ├── reward_type.py
        ├── reward_type_campaign.py
        ├── reward_type_coin.py
        ├── reward_type_product.py
        ├── rewards_assignments_create_request_body.py
        ├── rewards_assignments_create_request_body_parameters.py
        ├── rewards_assignments_create_request_body_parameters_loyalty.py
        ├── rewards_assignments_create_response_body.py
        ├── rewards_assignments_create_response_body_parameters.py
        ├── rewards_assignments_create_response_body_parameters_loyalty.py
        ├── rewards_assignments_get_response_body.py
        ├── rewards_assignments_get_response_body_parameters.py
        ├── rewards_assignments_get_response_body_parameters_loyalty.py
        ├── rewards_assignments_list_response_body.py
        ├── rewards_assignments_update_request_body.py
        ├── rewards_assignments_update_request_body_parameters.py
        ├── rewards_assignments_update_request_body_parameters_loyalty.py
        ├── rewards_assignments_update_response_body.py
        ├── rewards_assignments_update_response_body_parameters.py
        ├── rewards_assignments_update_response_body_parameters_loyalty.py
        ├── rewards_create_request_body.py
        ├── rewards_create_request_body_attributes.py
        ├── rewards_create_request_body_parameters.py
        ├── rewards_create_request_body_parameters_campaign.py
        ├── rewards_create_request_body_parameters_coin.py
        ├── rewards_create_request_body_parameters_product.py
        ├── rewards_create_response_body.py
        ├── rewards_create_response_body_attributes.py
        ├── rewards_list_response_body.py
        ├── rewards_update_request_body.py
        ├── rewards_update_request_body_attributes.py
        ├── rewards_update_request_body_parameters.py
        ├── rewards_update_request_body_parameters_campaign.py
        ├── rewards_update_request_body_parameters_coin.py
        ├── rewards_update_request_body_parameters_product.py
        ├── rewards_update_response_body.py
        ├── rewards_update_response_body_attributes.py
        ├── segments_create_request_body.py
        ├── segments_create_response_body.py
        ├── segments_get_response_body.py
        ├── session.py
        ├── simple_customer.py
        ├── simple_customer_required_object_type.py
        ├── simple_loyalty_card.py
        ├── simple_product_discount_unit.py
        ├── simple_segment.py
        ├── simple_sku_discount_unit.py
        ├── simple_voucher.py
        ├── simple_voucher_redemption.py
        ├── sku.py
        ├── skus_get_response_body.py
        ├── skus_import_csv_create_response_body.py
        ├── skus_list_for_product.py
        ├── stacking_rules.py
        ├── templates_campaigns_campaign_setup_create_request_body.py
        ├── templates_campaigns_campaign_setup_create_request_body_voucher.py
        ├── templates_campaigns_campaign_setup_create_request_body_voucher_redemption.py
        ├── templates_campaigns_campaign_setup_create_response_body.py
        ├── templates_campaigns_campaign_setup_create_response_body_created_resources_item.py
        ├── templates_campaigns_create_request_body.py
        ├── templates_campaigns_create_template_response_body.py
        ├── templates_campaigns_get_response_body.py
        ├── templates_campaigns_list_response_body.py
        ├── templates_campaigns_tier_setup_create_request_body.py
        ├── templates_campaigns_tier_setup_create_response_body.py
        ├── templates_campaigns_tier_setup_create_response_body_created_resources_item.py
        ├── templates_campaigns_update_request_body.py
        ├── templates_campaigns_update_response_body.py
        ├── trash_bin_item.py
        ├── trash_bin_list_response_body.py
        ├── usage_notifications.py
        ├── user.py
        ├── validation_rule.py
        ├── validation_rule_applicable_to.py
        ├── validation_rule_assignment.py
        ├── validation_rule_assignments_list.py
        ├── validation_rule_error.py
        ├── validation_rules_assignments_create_request_body.py
        ├── validation_rules_assignments_create_response_body.py
        ├── validation_rules_assignments_list.py
        ├── validation_rules_assignments_list_response_body.py
        ├── validation_rules_create_request_body.py
        ├── validation_rules_create_request_body_applicable_to.py
        ├── validation_rules_create_request_body_error.py
        ├── validation_rules_create_response_body.py
        ├── validation_rules_create_response_body_applicable_to.py
        ├── validation_rules_create_response_body_error.py
        ├── validation_rules_get_response_body.py
        ├── validation_rules_get_response_body_applicable_to.py
        ├── validation_rules_get_response_body_error.py
        ├── validation_rules_list_response_body.py
        ├── validation_rules_update_request_body.py
        ├── validation_rules_update_request_body_applicable_to.py
        ├── validation_rules_update_request_body_error.py
        ├── validation_rules_update_response_body.py
        ├── validation_rules_update_response_body_applicable_to.py
        ├── validation_rules_update_response_body_error.py
        ├── validations_redeemable_inapplicable.py
        ├── validations_redeemable_inapplicable_result.py
        ├── validations_redeemable_inapplicable_result_details.py
        ├── validations_redeemable_skipped.py
        ├── validations_redeemable_skipped_result.py
        ├── validations_redeemable_skipped_result_details.py
        ├── validations_validate_request_body.py
        ├── validations_validate_request_body_options.py
        ├── validations_validate_request_body_redeemables_item.py
        ├── validations_validate_request_body_redeemables_item_gift.py
        ├── validations_validate_request_body_redeemables_item_reward.py
        ├── validations_validate_response_body.py
        ├── validations_validate_response_body_redeemables_item.py
        ├── validations_validate_response_body_redeemables_item_result.py
        ├── validations_validate_response_body_redeemables_item_result_details.py
        ├── validations_validate_response_body_redeemables_item_result_discount.py
        ├── validations_validate_response_body_redeemables_item_result_discount_product.py
        ├── validations_validate_response_body_redeemables_item_result_gift.py
        ├── validations_validate_response_body_redeemables_item_result_loyalty_card.py
        ├── validity_hours.py
        ├── validity_hours_daily_item.py
        ├── validity_timeframe.py
        ├── voucher.py
        ├── voucher_assets.py
        ├── voucher_assets_barcode.py
        ├── voucher_assets_qr.py
        ├── voucher_balance.py
        ├── voucher_balance_related_object.py
        ├── voucher_gift.py
        ├── voucher_loyalty_card.py
        ├── voucher_publish.py
        ├── voucher_redemption.py
        ├── voucher_transaction.py
        ├── voucher_transaction_details.py
        ├── voucher_transaction_details_balance.py
        ├── voucher_transaction_details_balance_related_object.py
        ├── voucher_transaction_details_custom_event.py
        ├── voucher_transaction_details_earning_rule.py
        ├── voucher_transaction_details_earning_rule_source.py
        ├── voucher_transaction_details_event.py
        ├── voucher_transaction_details_event_schema.py
        ├── voucher_transaction_details_holder_loyalty_tier.py
        ├── voucher_transaction_details_loyalty_tier.py
        ├── voucher_transaction_details_order.py
        ├── voucher_transaction_details_redemption.py
        ├── voucher_transaction_details_reward.py
        ├── voucher_transaction_details_rollback.py
        ├── voucher_transaction_details_segment.py
        ├── voucher_transactions_export_filter_conditions.py
        ├── voucher_transactions_export_filter_conditions_voucher_id.py
        ├── voucher_transactions_export_filter_conditions_voucher_id_conditions.py
        ├── voucher_transactions_export_parameters.py
        ├── voucher_transactions_filters.py
        ├── voucher_with_categories.py
        ├── voucher_with_categories_gift.py
        ├── voucher_with_categories_loyalty_card.py
        ├── voucher_with_categories_publish.py
        ├── voucher_with_categories_redemption.py
        ├── vouchers_balance_update_request_body.py
        ├── vouchers_balance_update_response_body.py
        ├── vouchers_balance_update_response_body_related_object.py
        ├── vouchers_create_request_body.py
        ├── vouchers_create_request_body_redemption.py
        ├── vouchers_create_response_body.py
        ├── vouchers_create_response_body_gift.py
        ├── vouchers_create_response_body_loyalty_card.py
        ├── vouchers_create_response_body_publish.py
        ├── vouchers_create_response_body_redemption.py
        ├── vouchers_create_with_specific_code_request_body.py
        ├── vouchers_create_with_specific_code_request_body_redemption.py
        ├── vouchers_disable_response_body.py
        ├── vouchers_disable_response_body_gift.py
        ├── vouchers_disable_response_body_loyalty_card.py
        ├── vouchers_disable_response_body_publish.py
        ├── vouchers_disable_response_body_redemption.py
        ├── vouchers_enable_response_body.py
        ├── vouchers_enable_response_body_gift.py
        ├── vouchers_enable_response_body_loyalty_card.py
        ├── vouchers_enable_response_body_publish.py
        ├── vouchers_enable_response_body_redemption.py
        ├── vouchers_get_response_body.py
        ├── vouchers_get_response_body_gift.py
        ├── vouchers_get_response_body_loyalty_card.py
        ├── vouchers_get_response_body_publish.py
        ├── vouchers_get_response_body_redemption.py
        ├── vouchers_import_create_item_request_body.py
        ├── vouchers_import_create_item_request_body_redemption.py
        ├── vouchers_import_create_response_body.py
        ├── vouchers_import_csv_create_response_body.py
        ├── vouchers_list_response_body.py
        ├── vouchers_metadata_update_in_bulk_request_body.py
        ├── vouchers_metadata_update_in_bulk_response_body.py
        ├── vouchers_redemption_get_response_body.py
        ├── vouchers_transactions_export_create_request_body.py
        ├── vouchers_transactions_export_create_response_body.py
        ├── vouchers_transactions_export_create_response_body_result.py
        ├── vouchers_transactions_list_response_body.py
        ├── vouchers_update_in_bulk_item_request_body.py
        ├── vouchers_update_in_bulk_response_body.py
        ├── vouchers_update_request_body.py
        ├── vouchers_update_response_body.py
        ├── vouchers_update_response_body_gift.py
        ├── vouchers_update_response_body_loyalty_card.py
        ├── vouchers_update_response_body_publish.py
        └── vouchers_update_response_body_redemption.py
    ├── py.typed
    └── rest.py


/.env.example:
--------------------------------------------------------------------------------
1 | VOUCHERIFY_HOST=https://api.voucherify.io
2 | X_APP_ID=
3 | X_APP_TOKEN=
4 | 


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
 1 | # Use an official Python runtime as a parent image
 2 | FROM python:3.8
 3 | 
 4 | # Set the working directory in the container
 5 | WORKDIR /app
 6 | 
 7 | # Copy only the requirements files first to leverage Docker caching
 8 | COPY requirements.txt test-requirements.txt ./
 9 | 
10 | # Install dependencies
11 | RUN pip install --no-cache-dir -r requirements.txt && \
12 |     pip install --no-cache-dir -r test-requirements.txt
13 | 
14 | # Set up a volume to store data
15 | VOLUME /app/data
16 | 
17 | # Copy the rest of the application code
18 | COPY . .
19 | 
20 | # Run the application
21 | CMD ["python", "./__tests__/main.py"]
22 | 


--------------------------------------------------------------------------------
/MANIFEST:
--------------------------------------------------------------------------------
1 | # file GENERATED by distutils, do NOT edit
2 | setup.py
3 | voucherify/__init__.py
4 | voucherify/client.py
5 | voucherify/utils.py
6 | include LICENSE
7 | include README.md
8 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | init:
2 | 	pip install -r requirements.txt
3 | 
4 | 


--------------------------------------------------------------------------------
/__tests__/main.py:
--------------------------------------------------------------------------------
 1 | import unittest
 2 | 
 3 | 
 4 | loader = unittest.TestLoader()
 5 | suite = loader.discover(start_dir='./__tests__/', pattern='test_*.py')
 6 | runner = unittest.TextTestRunner()
 7 | 
 8 | if __name__ == "__main__":
 9 |     runner.run(suite)
10 | 


--------------------------------------------------------------------------------
/__tests__/products_voucherify.csv:
--------------------------------------------------------------------------------
1 | name,source_id,price,attributes,image_url,Fashion
2 | T-Shirt,productSourceID11,21,"color,size,ranking",https://images.com/original.jpg,slim


--------------------------------------------------------------------------------
/docs/ApplicableToEffect.md:
--------------------------------------------------------------------------------
 1 | # ApplicableToEffect
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `APPLY_TO_EVERY` (value: `'APPLY_TO_EVERY'`)
 7 | 
 8 | * `APPLY_TO_CHEAPEST` (value: `'APPLY_TO_CHEAPEST'`)
 9 | 
10 | * `APPLY_FROM_CHEAPEST` (value: `'APPLY_FROM_CHEAPEST'`)
11 | 
12 | * `APPLY_TO_MOST_EXPENSIVE` (value: `'APPLY_TO_MOST_EXPENSIVE'`)
13 | 
14 | * `APPLY_FROM_MOST_EXPENSIVE` (value: `'APPLY_FROM_MOST_EXPENSIVE'`)
15 | 
16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/docs/CampaignLoyaltyVoucherRedemption.md:
--------------------------------------------------------------------------------
 1 | # CampaignLoyaltyVoucherRedemption
 2 | 
 3 | Defines the redemption limits on vouchers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CampaignVoucherRedemption.md:
--------------------------------------------------------------------------------
 1 | # CampaignVoucherRedemption
 2 | 
 3 | Defines the redemption limits on vouchers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CampaignsCreateRequestBodyPromotion.md:
--------------------------------------------------------------------------------
 1 | # CampaignsCreateRequestBodyPromotion
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **tiers** | [**List[PromotionTierCreateParams]**](PromotionTierCreateParams.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CampaignsCreateRequestBodyVoucherRedemption.md:
--------------------------------------------------------------------------------
 1 | # CampaignsCreateRequestBodyVoucherRedemption
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CampaignsDeleteResponseBody.md:
--------------------------------------------------------------------------------
 1 | # CampaignsDeleteResponseBody
 2 | 
 3 | Response body schema for **DELETE** `/campaigns/{campaignId}`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CampaignsImportCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # CampaignsImportCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/campaigns/{campaignId}/import`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CampaignsImportCsvCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # CampaignsImportCsvCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/campaigns/{campaignId}/importCSV`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CampaignsImportVoucherItemRedemption.md:
--------------------------------------------------------------------------------
 1 | # CampaignsImportVoucherItemRedemption
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CampaignsUpdateRequestBodyOptions.md:
--------------------------------------------------------------------------------
 1 | # CampaignsUpdateRequestBodyOptions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **recalculate_tiers** | **bool** | Determine if tiers should be recalculated or no. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CampaignsVouchersCreateInBulkRequestBodyRedemption.md:
--------------------------------------------------------------------------------
 1 | # CampaignsVouchersCreateInBulkRequestBodyRedemption
 2 | 
 3 | Stores the quantity of redemptions that can be applied to the voucher.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CampaignsVouchersCreateRequestBodyRedemption.md:
--------------------------------------------------------------------------------
 1 | # CampaignsVouchersCreateRequestBodyRedemption
 2 | 
 3 | Stores the quantity of redemptions that can be applied to the voucher.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CategoriesCreateRequestBody.md:
--------------------------------------------------------------------------------
 1 | # CategoriesCreateRequestBody
 2 | 
 3 | Request body schema for **POST** `v1/categories`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **name** | **str** | Category name. | [optional] 
10 | **hierarchy** | **int** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/CategoriesUpdateRequestBody.md:
--------------------------------------------------------------------------------
 1 | # CategoriesUpdateRequestBody
 2 | 
 3 | Request body schema for **PUT** `v1/categories/{categoryId}`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **name** | **str** | Category name. | [optional] 
10 | **hierarchy** | **int** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md:
--------------------------------------------------------------------------------
 1 | # ClientValidationsValidateResponseBodyRedeemablesItemResultDetails
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **message** | **str** |  | [optional] 
 9 | **key** | **str** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **points** | **int** | Total number of loyalty points to be applied in the redemption. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CreatePublicationCampaign.md:
--------------------------------------------------------------------------------
 1 | # CreatePublicationCampaign
 2 | 
 3 | Create publication with campaign.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **name** | **str** | Name of voucher's parent campaign or unique campaign ID that was assigned by Voucherify. | [optional] 
10 | **count** | **int** | Number of vouchers to be published to customer. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/CustomerId.md:
--------------------------------------------------------------------------------
 1 | # CustomerId
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomerSummary.md:
--------------------------------------------------------------------------------
 1 | # CustomerSummary
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **redemptions** | [**CustomerSummaryRedemptions**](CustomerSummaryRedemptions.md) |  | 
 9 | **orders** | [**CustomerSummaryOrders**](CustomerSummaryOrders.md) |  | 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomerSummaryRedemptionsLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # CustomerSummaryRedemptionsLoyaltyCard
 2 | 
 3 | Summary of loyalty points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **redeemed_points** | **int** | Total number of loyalty points redeemed by the customer. | [optional] 
10 | **points_to_go** | **int** | Sum of remaining available point balance across all loyalty cards. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/CustomerWithSummaryLoyaltyReferralsAssets.md:
--------------------------------------------------------------------------------
 1 | # CustomerWithSummaryLoyaltyReferralsAssets
 2 | 
 3 | Contains information about the customer's cockpit.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **cockpit_url** | **str** | Customer's cockpit URL address. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomersCreateResponseBodyAssets.md:
--------------------------------------------------------------------------------
 1 | # CustomersCreateResponseBodyAssets
 2 | 
 3 | Contains information about the customer's cockpit.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **cockpit_url** | **str** | Customer's cockpit URL address. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomersGetResponseBodyAssets.md:
--------------------------------------------------------------------------------
 1 | # CustomersGetResponseBodyAssets
 2 | 
 3 | Contains information about the customer's cockpit.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **cockpit_url** | **str** | Customer's cockpit URL address. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomersImportCsvCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # CustomersImportCsvCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/customers/importCSV`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomersMetadataUpdateInBulkResponseBody.md:
--------------------------------------------------------------------------------
 1 | # CustomersMetadataUpdateInBulkResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/customers/metadata/async`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomersUpdateInBulkResponseBody.md:
--------------------------------------------------------------------------------
 1 | # CustomersUpdateInBulkResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/customers/bulk/async`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomersUpdateResponseBodyAssets.md:
--------------------------------------------------------------------------------
 1 | # CustomersUpdateResponseBodyAssets
 2 | 
 3 | Contains information about the customer's cockpit.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **cockpit_url** | **str** | Customer's cockpit URL address. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/DiscountProduct.md:
--------------------------------------------------------------------------------
 1 | # DiscountProduct
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique product ID, assigned by Voucherify. | [optional] 
 9 | **source_id** | **str** | Product's source ID. | [optional] 
10 | **name** | **str** | Product name. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/EarningRuleCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # EarningRuleCustomEvent
 2 | 
 3 | Contains details about the custom event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **schema_id** | **str** | Unique identifier of the custom event schema | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/EarningRuleLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # EarningRuleLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**EarningRuleLoyaltyCustomEventMetadata**](EarningRuleLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/EarningRuleLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # EarningRuleLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**EarningRuleLoyaltyCustomerMetadata**](EarningRuleLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/EarningRuleLoyaltyTier.md:
--------------------------------------------------------------------------------
 1 | # EarningRuleLoyaltyTier
 2 | 
 3 | Defines the tier associated with the earning rule definition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/EarningRuleSegment.md:
--------------------------------------------------------------------------------
 1 | # EarningRuleSegment
 2 | 
 3 | Contains the ID of a customer segment. Required for the `customer.segment.entered` option in the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ErrorError.md:
--------------------------------------------------------------------------------
 1 | # ErrorError
 2 | 
 3 | Includes additional information about the error.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **message** | **str** | The message configured by the user in a validation rule. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/EventSource.md:
--------------------------------------------------------------------------------
 1 | # EventSource
 2 | 
 3 | Contains the source of the object that initiated the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **channel** | **str** | Determines the channel that initiated the event. | [optional] 
10 | **user** | [**EventSourceUser**](EventSourceUser.md) |  | [optional] 
11 | **api_key** | [**EventSourceApiKey**](EventSourceApiKey.md) |  | [optional] 
12 | 
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/EventSourceApiKey.md:
--------------------------------------------------------------------------------
 1 | # EventSourceApiKey
 2 | 
 3 | Determines the API key used to initiate the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **name** | **str** | Channel name in the application keys. | [optional] 
10 | **app_id** | **str** | Contains the application ID from the Voucherify API key pair. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/EventSourceUser.md:
--------------------------------------------------------------------------------
 1 | # EventSourceUser
 2 | 
 3 | Determines the Voucherify user who triggered the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique identifier of the user. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ExportOrderOrder.md:
--------------------------------------------------------------------------------
 1 | # ExportOrderOrder
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 7 | 
 8 | * `CREATED_AT` (value: `'created_at'`)
 9 | 
10 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
11 | 
12 | * `UPDATED_AT` (value: `'updated_at'`)
13 | 
14 | * `MINUS_STATUS` (value: `'-status'`)
15 | 
16 | * `STATUS` (value: `'status'`)
17 | 
18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/ExportResult.md:
--------------------------------------------------------------------------------
 1 | # ExportResult
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **url** | **str** | URL of the CSV file location. It contains the token used for authorization in the Download export method. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ExportVoucherTransactionsOrder.md:
--------------------------------------------------------------------------------
 1 | # ExportVoucherTransactionsOrder
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 7 | 
 8 | * `CREATED_AT` (value: `'created_at'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ExportsCreateRequestBody.md:
--------------------------------------------------------------------------------
 1 | # ExportsCreateRequestBody
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **exported_object** | **str** |  | [optional] 
 9 | **parameters** | [**ExportsCreateRequestBodyParameters**](ExportsCreateRequestBodyParameters.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ExportsGetResponseBodyResult.md:
--------------------------------------------------------------------------------
 1 | # ExportsGetResponseBodyResult
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **url** | **str** | URL of the CSV file location. It contains the token used for authorization in the Download export method. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/FieldConditions.md:
--------------------------------------------------------------------------------
 1 | # FieldConditions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **conditions** | [**FiltersCondition**](FiltersCondition.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LocationShape.md:
--------------------------------------------------------------------------------
 1 | # LocationShape
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **type** | **str** |  | [optional] 
 9 | **format** | **str** |  | [optional] 
10 | **distance** | [**LocationShapeDistance**](LocationShapeDistance.md) |  | [optional] 
11 | **geojson** | [**LocationShapeGeojson**](LocationShapeGeojson.md) |  | [optional] 
12 | 
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/LocationShapeDistance.md:
--------------------------------------------------------------------------------
 1 | # LocationShapeDistance
 2 | 
 3 | Defines the parameters for the circle.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **center** | **str** | Center of the circle identified by GPS coordinates in decimal degrees. | [optional] 
10 | **radius** | **str** | Defines the radius of the circle. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LocationShapeGeojson.md:
--------------------------------------------------------------------------------
 1 | # LocationShapeGeojson
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **type** | **str** |  | [optional] 
 9 | **coordinates** | **List[List[int]]** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LocationsGetResponseBodyShapeDistance.md:
--------------------------------------------------------------------------------
 1 | # LocationsGetResponseBodyShapeDistance
 2 | 
 3 | Defines the parameters for the circle.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **center** | **str** | Center of the circle identified by GPS coordinates in decimal degrees. | [optional] 
10 | **radius** | **str** | Defines the radius of the circle. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LocationsGetResponseBodyShapeGeojson.md:
--------------------------------------------------------------------------------
 1 | # LocationsGetResponseBodyShapeGeojson
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **type** | **str** |  | [optional] 
 9 | **coordinates** | **List[List[int]]** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesDeleteResponseBody.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesDeleteResponseBody
 2 | 
 3 | Response body schema for **DELETE** `/loyalties/{campaignId}`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent
 2 | 
 3 | Contains the schema id of a custom event. **Required** for the custom event option in `event`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **schema_id** | **str** | Contains a unique identifier of a custom event schema. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata**](LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier
 2 | 
 3 | Defines the tier associated with the earning rule definition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateRequestBodyItemSegment.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateRequestBodyItemSegment
 2 | 
 3 | Contains the ID of a customer segment. **Required** for the `customer.segment.entered` option in `event`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateRequestBodyItemSource.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateRequestBodyItemSource
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **banner** | **str** | Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateResponseBodyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateResponseBodyCustomEvent
 2 | 
 3 | Contains details about the custom event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **schema_id** | **str** | Unique identifier of the custom event schema | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier
 2 | 
 3 | Defines the tier associated with the earning rule definition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesCreateResponseBodySegment.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesCreateResponseBodySegment
 2 | 
 3 | Contains the ID of a customer segment. Required for the `customer.segment.entered` option in the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesDisableResponseBodyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesDisableResponseBodyCustomEvent
 2 | 
 3 | Contains details about the custom event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **schema_id** | **str** | Unique identifier of the custom event schema | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier
 2 | 
 3 | Defines the tier associated with the earning rule definition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesDisableResponseBodySegment.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesDisableResponseBodySegment
 2 | 
 3 | Contains the ID of a customer segment. Required for the `customer.segment.entered` option in the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesEnableResponseBodyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesEnableResponseBodyCustomEvent
 2 | 
 3 | Contains details about the custom event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **schema_id** | **str** | Unique identifier of the custom event schema | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyTier.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesEnableResponseBodyLoyaltyTier
 2 | 
 3 | Defines the tier associated with the earning rule definition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesEnableResponseBodySegment.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesEnableResponseBodySegment
 2 | 
 3 | Contains the ID of a customer segment. Required for the `customer.segment.entered` option in the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesGetResponseBodyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesGetResponseBodyCustomEvent
 2 | 
 3 | Contains details about the custom event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **schema_id** | **str** | Unique identifier of the custom event schema | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyTier.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesGetResponseBodyLoyaltyTier
 2 | 
 3 | Defines the tier associated with the earning rule definition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesGetResponseBodySegment.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesGetResponseBodySegment
 2 | 
 3 | Contains the ID of a customer segment. Required for the `customer.segment.entered` option in the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateRequestBodySource.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateRequestBodySource
 2 | 
 3 | Contains the custom earning rule name and parent campaign.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **banner** | **str** | Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateResponseBodyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateResponseBodyCustomEvent
 2 | 
 3 | Contains details about the custom event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **schema_id** | **str** | Unique identifier of the custom event schema | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEvent
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomer.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **metadata** | [**LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier
 2 | 
 3 | Defines the tier associated with the earning rule definition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique loyalty tier ID associated with the earning rule.      - `__ANY__`: any loyalty tier within the campaign | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesEarningRulesUpdateResponseBodySegment.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesEarningRulesUpdateResponseBodySegment
 2 | 
 3 | Contains the ID of a customer segment. Required for the `customer.segment.entered` option in the event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Contains a unique identifier of a customer segment. Assigned by the Voucherify API. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket
 2 | 
 3 | Defines the number of points stored in this loyalty point bucket.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_points** | **int** | Total number of points in the loyalty point bucket. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesMembersRedemptionRedeemResponseBodyLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesMembersRedemptionRedeemResponseBodyLoyaltyCard
 2 | 
 3 | Contains the number of points subtracted from the loyalty card for the redemption.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **points** | **int** | Number of points subtracted from the loyalty card as a result of the redemption. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesRewardAssignmentsGetResponseBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesRewardAssignmentsGetResponseBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**LoyaltiesRewardAssignmentsGetResponseBodyParametersLoyalty**](LoyaltiesRewardAssignmentsGetResponseBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesRewardsCreateAssignmentItemRequestBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesRewardsCreateAssignmentItemRequestBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**LoyaltiesRewardsCreateAssignmentItemRequestBodyParametersLoyalty**](LoyaltiesRewardsCreateAssignmentItemRequestBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesRewardsCreateAssignmentItemRequestBodyParametersLoyalty.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesRewardsCreateAssignmentItemRequestBodyParametersLoyalty
 2 | 
 3 | Defines the equivalent points value of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **points** | **int** | Number of points that will be subtracted from the loyalty card points balance if the reward is redeemed. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesRewardsCreateAssignmentResponseBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesRewardsCreateAssignmentResponseBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**LoyaltiesRewardsCreateAssignmentResponseBodyParametersLoyalty**](LoyaltiesRewardsCreateAssignmentResponseBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesRewardsGetResponseBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesRewardsGetResponseBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**LoyaltiesRewardsGetResponseBodyParametersLoyalty**](LoyaltiesRewardsGetResponseBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesRewardsUpdateAssignmentRequestBody.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesRewardsUpdateAssignmentRequestBody
 2 | 
 3 | Response body schema for **PUT** `v1/v1/loyalties/{campaignId}/rewards/{assignmentId}`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **parameters** | [**LoyaltiesRewardsUpdateAssignmentRequestBodyParameters**](LoyaltiesRewardsUpdateAssignmentRequestBodyParameters.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesRewardsUpdateAssignmentResponseBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesRewardsUpdateAssignmentResponseBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**LoyaltiesRewardsUpdateAssignmentResponseBodyParametersLoyalty**](LoyaltiesRewardsUpdateAssignmentResponseBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesTiersGetResponseBodyConfig.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesTiersGetResponseBodyConfig
 2 | 
 3 | Defines loyalty tier range in points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **points** | [**LoyaltiesTiersGetResponseBodyConfigPoints**](LoyaltiesTiersGetResponseBodyConfigPoints.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesTiersGetResponseBodyConfigPoints.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesTiersGetResponseBodyConfigPoints
 2 | 
 3 | Defines range of loyalty tier in points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **var_from** | **int** | Bottom points threshold value. | [optional] 
10 | **to** | **int** | Top points threshold value. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesTiersGetResponseBodyPoints.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesTiersGetResponseBodyPoints
 2 | 
 3 | Defines range of loyalty tier in points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **var_from** | **int** | Bottom points threshold value. | [optional] 
10 | **to** | **int** | Top points threshold value. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltiesUpdateCampaignRequestBodyOptions.md:
--------------------------------------------------------------------------------
 1 | # LoyaltiesUpdateCampaignRequestBodyOptions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **recalculate_tiers** | **bool** | Determine if tiers should be recalculated or no. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCampaignVoucherRedemption.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCampaignVoucherRedemption
 2 | 
 3 | Defines the redemption limits on vouchers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsCustomEvent
 2 | 
 3 | Contains information about the custom event that triggers the point accrual.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique event ID. | [optional] 
10 | **type** | **str** | Type of custom event. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsEarningRuleSource.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsEarningRuleSource
 2 | 
 3 | Contains the custom earning rule name.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **banner** | **str** | Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsEvent.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsEvent
 2 | 
 3 | Contains information about the event that triggers the point accrual.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique event ID. | [optional] 
10 | **type** | **str** | Type of event. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsEventSchema.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsEventSchema
 2 | 
 3 | Contains information about the custom event metadata schema.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique metadata schema ID. | [optional] 
10 | **name** | **str** | Type of custom event. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsRedemption.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsRedemption
 2 | 
 3 | Contains information about the original redemption.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique redemption ID. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsReward.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsReward
 2 | 
 3 | Contains information about the pay with points reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique reward ID. | [optional] 
10 | **name** | **str** | Reward name. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsRollback.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsRollback
 2 | 
 3 | Contains information about the redemption rollback.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique redemption rollback ID. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltyCardTransactionDetailsSegment.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyCardTransactionDetailsSegment
 2 | 
 3 | Contains information about the segment.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** |  | [optional] 
10 | **name** | **str** |  | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyPendingPointsDetailsEarningRuleSource
 2 | 
 3 | Contains the custom earning rule name.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **banner** | **str** | Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltyPendingPointsDetailsOrder.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyPendingPointsDetailsOrder
 2 | 
 3 | Details about the order that caused adding pending points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique order identifier, assigned by Voucherify. | [optional] 
10 | **source_id** | **str** | User-defined order identifier. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyPointsBucketBucket.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyPointsBucketBucket
 2 | 
 3 | Defines the number of points stored in this loyalty point bucket.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_points** | **int** | Total number of points in the loyalty point bucket. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltyTierBasePoints.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyTierBasePoints
 2 | 
 3 | Defines range of loyalty tier in points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **var_from** | **int** | Bottom points threshold value. | [optional] 
10 | **to** | **int** | Top points threshold value. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyTierConfig.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyTierConfig
 2 | 
 3 | Defines loyalty tier range in points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **points** | [**LoyaltyTierConfigPoints**](LoyaltyTierConfigPoints.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LoyaltyTierConfigPoints.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyTierConfigPoints
 2 | 
 3 | Defines range of loyalty tier in points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **var_from** | **int** | Bottom points threshold value. | [optional] 
10 | **to** | **int** | Top points threshold value. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/LoyaltyTierPoints.md:
--------------------------------------------------------------------------------
 1 | # LoyaltyTierPoints
 2 | 
 3 | Defines range of loyalty tier in points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **var_from** | **int** | Bottom points threshold value. | [optional] 
10 | **to** | **int** | Top points threshold value. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectDefaultCodeConfig.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectDefaultCodeConfig
 2 | 
 3 | Determines the character set that is used as default for vouchers. It is affected by the `\"case_sensitive_codes\"` setting.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **charset** | **str** | Lists all characters that are used as default for vouchers | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsBrandingContact.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsBrandingContact
 2 | 
 3 | Defines contact details.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **email** | **str** | Defines the brand's email address. It must be a valid email format. | [optional] 
10 | **phone** | **str** | Defines the brand's phone number. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsBrandingCreateRequestBodyContact.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsBrandingCreateRequestBodyContact
 2 | 
 3 | Defines contact details.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **email** | **str** | Defines the brand's email address. It must be a valid email format. | [optional] 
10 | **phone** | **str** | Defines the brand's phone number. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsBrandingCreateResponseBodyContact.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsBrandingCreateResponseBodyContact
 2 | 
 3 | Defines contact details.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **email** | **str** | Defines the brand's email address. It must be a valid email format. | [optional] 
10 | **phone** | **str** | Defines the brand's phone number. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsBrandingGetResponseBodyContact.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsBrandingGetResponseBodyContact
 2 | 
 3 | Defines contact details.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **email** | **str** | Defines the brand's email address. It must be a valid email format. | [optional] 
10 | **phone** | **str** | Defines the brand's phone number. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsBrandingUpdateRequestBodyContact.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsBrandingUpdateRequestBodyContact
 2 | 
 3 | Defines contact details.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **email** | **str** | Defines the brand's email address. It must be a valid email format. | [optional] 
10 | **phone** | **str** | Defines the brand's phone number. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsBrandingUpdateResponseBodyContact.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsBrandingUpdateResponseBodyContact
 2 | 
 3 | Defines contact details.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **email** | **str** | Defines the brand's email address. It must be a valid email format. | [optional] 
10 | **phone** | **str** | Defines the brand's phone number. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsCustomEventSchemaSchema.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsCustomEventSchemaSchema
 2 | 
 3 | Object containing custom event schema and its custom attributes (metadata).
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **properties** | **object** | Defines custom event custom attributes (metadata). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsCustomEventSchemasCreateRequestBodySchema.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsCustomEventSchemasCreateRequestBodySchema
 2 | 
 3 | Object containing custom event schema and its custom attributes (metadata).
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **properties** | **object** | Defines custom event custom attributes (metadata). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsCustomEventSchemasCreateResponseBodySchema.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsCustomEventSchemasCreateResponseBodySchema
 2 | 
 3 | Object containing custom event schema and its custom attributes (metadata).
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **properties** | **object** | Defines custom event custom attributes (metadata). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsCustomEventSchemasGetResponseBodySchema.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsCustomEventSchemasGetResponseBodySchema
 2 | 
 3 | Object containing custom event schema and its custom attributes (metadata).
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **properties** | **object** | Defines custom event custom attributes (metadata). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsCustomEventSchemasUpdateRequestBodySchema.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsCustomEventSchemasUpdateRequestBodySchema
 2 | 
 3 | Object containing custom event schema and its custom attributes (metadata).
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **properties** | **object** | Defines custom event custom attributes (metadata). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsCustomEventSchemasUpdateResponseBodySchema.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsCustomEventSchemasUpdateResponseBodySchema
 2 | 
 3 | Object containing custom event schema and its custom attributes (metadata).
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **properties** | **object** | Defines custom event custom attributes (metadata). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsGetResponseBodyDefaultCodeConfig.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsGetResponseBodyDefaultCodeConfig
 2 | 
 3 | Determines the character set that is used as default for vouchers. It is affected by the `\"case_sensitive_codes\"` setting.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **charset** | **str** | Lists all characters that are used as default for vouchers | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsUpdateRequestBodyDefaultCodeConfig.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsUpdateRequestBodyDefaultCodeConfig
 2 | 
 3 | Determines the character set that is used as default for vouchers. It is affected by the `\"case_sensitive_codes\"` setting.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **charset** | **str** | Lists all characters that are used as default for vouchers | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsUpdateResponseBodyDefaultCodeConfig.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsUpdateResponseBodyDefaultCodeConfig
 2 | 
 3 | Determines the character set that is used as default for vouchers. It is affected by the `\"case_sensitive_codes\"` setting.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **charset** | **str** | Lists all characters that are used as default for vouchers | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ManagementProjectsUsersUpdateRoleRequestBody.md:
--------------------------------------------------------------------------------
 1 | # ManagementProjectsUsersUpdateRoleRequestBody
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **role** | **str** | The role of the user to be added. It can be a custom role or one of following predefined roles: `ADMIN`, `USER`, `VIEWER`, `MERCHANT` or an ID of a custom role.. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/OrdersExportCreateRequestBody.md:
--------------------------------------------------------------------------------
 1 | # OrdersExportCreateRequestBody
 2 | 
 3 | Request body schema for **POST** `v1/orders/export`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **parameters** | [**OrdersExportCreateRequestBodyParameters**](OrdersExportCreateRequestBodyParameters.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/OrdersImportCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # OrdersImportCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/orders/import`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterActivityCategory.md:
--------------------------------------------------------------------------------
 1 | # ParameterActivityCategory
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `ACTION` (value: `'ACTION'`)
 7 | 
 8 | * `EFFECT` (value: `'EFFECT'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterCampaignType.md:
--------------------------------------------------------------------------------
 1 | # ParameterCampaignType
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `PROMOTION` (value: `'PROMOTION'`)
 7 | 
 8 | * `GIFT_VOUCHERS` (value: `'GIFT_VOUCHERS'`)
 9 | 
10 | * `REFERRAL_PROGRAM` (value: `'REFERRAL_PROGRAM'`)
11 | 
12 | * `DISCOUNT_COUPONS` (value: `'DISCOUNT_COUPONS'`)
13 | 
14 | * `LOYALTY_PROGRAM` (value: `'LOYALTY_PROGRAM'`)
15 | 
16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/docs/ParameterExpandListCampaigns.md:
--------------------------------------------------------------------------------
 1 | # ParameterExpandListCampaigns
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CATEGORY` (value: `'category'`)
 7 | 
 8 | * `ACCESS_SETTINGS_ASSIGNMENTS` (value: `'access_settings_assignments'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListBinId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListBinId
 2 | 
 3 | Unique identifier of the bin entry.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListBinResourceId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListBinResourceId
 2 | 
 3 | Unique identifier of the resource moved to the bin.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListBinResourceName.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListBinResourceName
 2 | 
 3 | Name of the resource moved to the bin: the name of the campaign, voucher, product, or SKU.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListBinResourceType.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListBinResourceType
 2 | 
 3 | Resource type of the resource moved to the bin.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**ParameterFiltersListBinResourceTypeConditions**](ParameterFiltersListBinResourceTypeConditions.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCampaignsCampaignStatus.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCampaignsCampaignStatus
 2 | 
 3 | Type of the campaign. Allowed values: `DONE`, `IN_PROGRESS`, `DRAFT`, `FAILED` `MODIFYING`
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**ParameterFiltersListCampaignsCampaignStatusConditions**](ParameterFiltersListCampaignsCampaignStatusConditions.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCampaignsCategories.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCampaignsCategories
 2 | 
 3 | Filter by categories names
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCampaignsCategoryIds.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCampaignsCategoryIds
 2 | 
 3 | Filter by categories ids
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCampaignsIsReferralCode.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCampaignsIsReferralCode
 2 | 
 3 | 
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **var_is** | **str** | Value is exactly this value (single value). | [optional] 
10 | **is_not** | **str** | Results omit this value (single value). | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCampaignsValidityTimeframe.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCampaignsValidityTimeframe
 2 | 
 3 | Filter by validity timeframe
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsDateTime**](FilterConditionsDateTime.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCampaignsVoucherType.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCampaignsVoucherType
 2 | 
 3 | Filter by voucher type
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCustomerRedeemablesCampaignId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCustomerRedeemablesCampaignId
 2 | 
 3 | Unique campaign identifer, e.g. `camp_bfrwAVsP6Q1EM1ZjgHwheKYr`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCustomerRedeemablesCreatedAt.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCustomerRedeemablesCreatedAt
 2 | 
 3 | Timestamp representing the date and time when the customer redeemable was created. The value is shown in the ISO 8601 format.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsDateTime**](FilterConditionsDateTime.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCustomerRedeemablesId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCustomerRedeemablesId
 2 | 
 3 | Unique redeemable holder ID, i.e. `rh_0e77502f84f0f4a6a8`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCustomerRedeemablesRedeemableId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCustomerRedeemablesRedeemableId
 2 | 
 3 | Unique redeemable ID, e.g. `v_hS8JFl8S6lNcd1L69wLIoXgTio7eWEgk`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListCustomerRedeemablesRedeemableObject.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListCustomerRedeemablesRedeemableObject
 2 | 
 3 | Unique related object, i.e. `voucher`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**ParameterFiltersListCustomerRedeemablesRedeemableObjectConditions**](ParameterFiltersListCustomerRedeemablesRedeemableObjectConditions.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListLocationsCreatedAt.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListLocationsCreatedAt
 2 | 
 3 | Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsDateTime**](FilterConditionsDateTime.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListLocationsName.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListLocationsName
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListLocationsUpdatedAt.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListLocationsUpdatedAt
 2 | 
 3 | Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsDateTime**](FilterConditionsDateTime.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsCampaignName.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsCampaignName
 2 | 
 3 | Filter publications by campaign names.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsCustomerId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsCustomerId
 2 | 
 3 | Filter publications by customer ids.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsFailureCode.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsFailureCode
 2 | 
 3 | Filter publications by ids.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsIsReferralCode.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsIsReferralCode
 2 | 
 3 | Filter publications by is referall code.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsParentObjectId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsParentObjectId
 2 | 
 3 | Filter publications by parent object id.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsRelatedObjectId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsRelatedObjectId
 2 | 
 3 | Filter publications by related object id.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsResult.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsResult
 2 | 
 3 | Filter publications by names.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsSourceId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsSourceId
 2 | 
 3 | Filter publications by source id.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListPublicationsVoucherType.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListPublicationsVoucherType
 2 | 
 3 | Filter publications by voucher types.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsCampaignName.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsCampaignName
 2 | 
 3 | Campaign name.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsCustomerId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsCustomerId
 2 | 
 3 | Unique customer ID, i.e. cust_sehkNIi8Uq2qQuRqSr7xn4Zi.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsFailureCode.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsFailureCode
 2 | 
 3 | Failure code, i.e. quantity_exceeded.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsObject.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsObject
 2 | 
 3 | Specify which type of object to return, i.e. `redemption` or `redemption_rollback`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsParentRedemptionId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsParentRedemptionId
 2 | 
 3 | Unique parent redemption ID, i.e. r_0c5952900bcbfd54b6.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsRelatedObjectId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsRelatedObjectId
 2 | 
 3 | Unique related object ID, i.e. v_hS8JFl8S6lNcd1L69wLIoXgTio7eWEgk.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsRelatedObjectParentId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsRelatedObjectParentId
 2 | 
 3 | Unique related object parent ID, i.e. camp_22noMlhTADb7Fq2UL3vWu3d1.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsResult.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsResult
 2 | 
 3 | Result, i.e. `SUCCESS` or `FAILURE`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsUserLogin.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsUserLogin
 2 | 
 3 | User login used to login to Voucherify, i.e. name.lastname@email.com
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListRedemptionsVoucherCode.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListRedemptionsVoucherCode
 2 | 
 3 | Unique voucher code.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListReferralsRedeemableHoldersCampaignId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListReferralsRedeemableHoldersCampaignId
 2 | 
 3 | Unique customer ID, i.e. `cust_sehkNIi8Uq2qQuRqSr7xn4Zi`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListReferralsRedeemableHoldersCustomerId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListReferralsRedeemableHoldersCustomerId
 2 | 
 3 | Unique customer ID, i.e. `cust_sehkNIi8Uq2qQuRqSr7xn4Zi`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListReferralsRedeemableHoldersId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListReferralsRedeemableHoldersId
 2 | 
 3 | Unique redeemable holder ID, i.e. `rh_0e77502f84f0f4a6a8`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListReferralsRedeemableHoldersRedeemableId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListReferralsRedeemableHoldersRedeemableId
 2 | 
 3 | Unique customer ID, i.e. `cust_sehkNIi8Uq2qQuRqSr7xn4Zi`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListReferralsRedeemableHoldersRedeemableObject.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListReferralsRedeemableHoldersRedeemableObject
 2 | 
 3 | Unique customer ID, i.e. `cust_sehkNIi8Uq2qQuRqSr7xn4Zi`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListTemplatesCampaignType.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListTemplatesCampaignType
 2 | 
 3 | Campaign template campaign type.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**ParameterFiltersListTemplatesCampaignTypeConditions**](ParameterFiltersListTemplatesCampaignTypeConditions.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListTemplatesId.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListTemplatesId
 2 | 
 3 | Unique template ID.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterFiltersListTemplatesName.md:
--------------------------------------------------------------------------------
 1 | # ParameterFiltersListTemplatesName
 2 | 
 3 | Unique user-defined template name.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderCreatedAt.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderCreatedAt
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListAllPromotionStacks.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListAllPromotionStacks
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | * `NAME` (value: `'name'`)
15 | 
16 | * `MINUS_NAME` (value: `'-name'`)
17 | 
18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListBin.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListBin
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `ID` (value: `'id'`)
 7 | 
 8 | * `MINUS_ID` (value: `'-id'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListCampaigns.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListCampaigns
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListCustomers.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListCustomers
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | * `SOURCE_ID` (value: `'source_id'`)
15 | 
16 | * `MINUS_SOURCE_ID` (value: `'-source_id'`)
17 | 
18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListEarningRules.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListEarningRules
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListExports.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListExports
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `STATUS` (value: `'status'`)
11 | 
12 | * `MINUS_STATUS` (value: `'-status'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListLocations.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListLocations
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListLoyaltyTiers.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListLoyaltyTiers
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListOrders.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListOrders
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListPendingPoints.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListPendingPoints
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `ID` (value: `'id'`)
 7 | 
 8 | * `MINUS_ID` (value: `'-id'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListPromotionTiers.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListPromotionTiers
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListPromotionTiersClientSide.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListPromotionTiersClientSide
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListRedeemables.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListRedeemables
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `ID` (value: `'id'`)
 7 | 
 8 | * `MINUS_ID` (value: `'-id'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListTransactions.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListTransactions
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `ID` (value: `'id'`)
 7 | 
 8 | * `MINUS_ID` (value: `'-id'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListValidationRuleAssignments.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListValidationRuleAssignments
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderListValidationRules.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderListValidationRules
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | * `NAME` (value: `'name'`)
15 | 
16 | * `MINUS_NAME` (value: `'-name'`)
17 | 
18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/ParameterOrderVouchers.md:
--------------------------------------------------------------------------------
 1 | # ParameterOrderVouchers
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `CREATED_AT` (value: `'created_at'`)
 7 | 
 8 | * `MINUS_CREATED_AT` (value: `'-created_at'`)
 9 | 
10 | * `UPDATED_AT` (value: `'updated_at'`)
11 | 
12 | * `MINUS_UPDATED_AT` (value: `'-updated_at'`)
13 | 
14 | * `CODE` (value: `'code'`)
15 | 
16 | * `MINUS_CODE` (value: `'-code'`)
17 | 
18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/ParameterResultListPublications.md:
--------------------------------------------------------------------------------
 1 | # ParameterResultListPublications
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `SUCCESS` (value: `'SUCCESS'`)
 7 | 
 8 | * `FAILURE` (value: `'FAILURE'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterTemplatesList.md:
--------------------------------------------------------------------------------
 1 | # ParameterTemplatesList
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `ID` (value: `'id'`)
 7 | 
 8 | * `MINUS_ID` (value: `'-id'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ParameterVoucherTypeListPublications.md:
--------------------------------------------------------------------------------
 1 | # ParameterVoucherTypeListPublications
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `DISCOUNT` (value: `'discount'`)
 7 | 
 8 | * `LOYALTY` (value: `'loyalty'`)
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/PointsExpirationTypes.md:
--------------------------------------------------------------------------------
 1 | # PointsExpirationTypes
 2 | 
 3 | 
 4 | ## Enum
 5 | 
 6 | * `PROGRAM_RULES` (value: `'PROGRAM_RULES'`)
 7 | 
 8 | * `CUSTOM_DATE` (value: `'CUSTOM_DATE'`)
 9 | 
10 | * `NON_EXPIRING` (value: `'NON_EXPIRING'`)
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ProductCollectionsCreateRequestBodyProductsItem.md:
--------------------------------------------------------------------------------
 1 | # ProductCollectionsCreateRequestBodyProductsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | The product ID. | 
 9 | **product_id** | **str** | Product ID for SKUs. | [optional] 
10 | **object** | **str** | Denotes the type of the object represented by the ID. | 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ProductCollectionsCreateResponseBodyProductsItem.md:
--------------------------------------------------------------------------------
 1 | # ProductCollectionsCreateResponseBodyProductsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | The product ID. | 
 9 | **product_id** | **str** | Product ID for SKUs. | [optional] 
10 | **object** | **str** | Denotes the type of the object represented by the ID. | 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ProductCollectionsGetResponseBodyProductsItem.md:
--------------------------------------------------------------------------------
 1 | # ProductCollectionsGetResponseBodyProductsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | The product ID. | 
 9 | **product_id** | **str** | Product ID for SKUs. | [optional] 
10 | **object** | **str** | Denotes the type of the object represented by the ID. | 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ProductCollectionsItemProductsItem.md:
--------------------------------------------------------------------------------
 1 | # ProductCollectionsItemProductsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | The product ID. | 
 9 | **product_id** | **str** | Product ID for SKUs. | [optional] 
10 | **object** | **str** | Denotes the type of the object represented by the ID. | 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ProductsImportCsvCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # ProductsImportCsvCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/products/importCSV`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ProductsMetadataUpdateInBulkResponseBody.md:
--------------------------------------------------------------------------------
 1 | # ProductsMetadataUpdateInBulkResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/products/metadata/async`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ProductsUpdateInBulkResponseBody.md:
--------------------------------------------------------------------------------
 1 | # ProductsUpdateInBulkResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/products/bulk/async`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionStackBase.md:
--------------------------------------------------------------------------------
 1 | # PromotionStackBase
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **name** | **str** | Promotion stack name. | [optional] 
 9 | **tiers** | [**PromotionStackBaseTiers**](PromotionStackBaseTiers.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionStackBaseTiers.md:
--------------------------------------------------------------------------------
 1 | # PromotionStackBaseTiers
 2 | 
 3 | Contains the tier configuration. A promotion stack can include up to 30 tiers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **ids** | **List[str]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
10 | **hierarchy_mode** | **str** |  | [optional] [default to 'MANUAL']
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionStackTiers.md:
--------------------------------------------------------------------------------
 1 | # PromotionStackTiers
 2 | 
 3 | Contains the tier configuration. A promotion stack can include up to 30 tiers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **ids** | **List[str]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
10 | **hierarchy_mode** | **str** |  | [optional] [default to 'MANUAL']
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionTierAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionTierAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionTierCreateParamsAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionTierCreateParamsAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionTierSummary.md:
--------------------------------------------------------------------------------
 1 | # PromotionTierSummary
 2 | 
 3 | Contains statistics about promotion tier redemptions and orders.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **redemptions** | [**PromotionTierSummaryRedemptions**](PromotionTierSummaryRedemptions.md) |  | [optional] 
10 | **orders** | [**PromotionTierSummaryOrders**](PromotionTierSummaryOrders.md) |  | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionTierSummaryOrders.md:
--------------------------------------------------------------------------------
 1 | # PromotionTierSummaryOrders
 2 | 
 3 | Contains statistics about orders related to the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_amount** | **int** | Sum of order totals. | [optional] 
10 | **total_discount_amount** | **int** | Sum of total discount applied using the promotion tier. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionTierSummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # PromotionTierSummaryRedemptions
 2 | 
 3 | Contains statistics about promotion tier redemptions.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsStacksCreateRequestBodyTiers.md:
--------------------------------------------------------------------------------
 1 | # PromotionsStacksCreateRequestBodyTiers
 2 | 
 3 | Contains the tier configuration. A promotion stack can include up to 30 tiers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **ids** | **List[str]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
10 | **hierarchy_mode** | **str** |  | [optional] [default to 'MANUAL']
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionsStacksCreateResponseBodyTiers.md:
--------------------------------------------------------------------------------
 1 | # PromotionsStacksCreateResponseBodyTiers
 2 | 
 3 | Contains the tier configuration. A promotion stack can include up to 30 tiers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **ids** | **List[str]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
10 | **hierarchy_mode** | **str** |  | [optional] [default to 'MANUAL']
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionsStacksGetResponseBodyTiers.md:
--------------------------------------------------------------------------------
 1 | # PromotionsStacksGetResponseBodyTiers
 2 | 
 3 | Contains the tier configuration. A promotion stack can include up to 30 tiers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **ids** | **List[str]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
10 | **hierarchy_mode** | **str** |  | [optional] [default to 'MANUAL']
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionsStacksUpdateResponseBodyTiers.md:
--------------------------------------------------------------------------------
 1 | # PromotionsStacksUpdateResponseBodyTiers
 2 | 
 3 | Contains the tier configuration. A promotion stack can include up to 30 tiers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **ids** | **List[str]** | Contains the list of tiers in a pre-defined sequence. | [optional] 
10 | **hierarchy_mode** | **str** |  | [optional] [default to 'MANUAL']
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersCreateRequestBodyAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersCreateRequestBodyAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersCreateResponseBodyAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersCreateResponseBodyAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersCreateResponseBodySummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersCreateResponseBodySummaryRedemptions
 2 | 
 3 | Contains statistics about promotion tier redemptions.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersDisableResponseBodyAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersDisableResponseBodyAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersDisableResponseBodySummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersDisableResponseBodySummaryRedemptions
 2 | 
 3 | Contains statistics about promotion tier redemptions.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersEnableResponseBodyAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersEnableResponseBodyAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersEnableResponseBodySummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersEnableResponseBodySummaryRedemptions
 2 | 
 3 | Contains statistics about promotion tier redemptions.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersGetResponseBodyAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersGetResponseBodyAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersGetResponseBodySummaryOrders.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersGetResponseBodySummaryOrders
 2 | 
 3 | Contains statistics about orders related to the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_amount** | **int** | Sum of order totals. | [optional] 
10 | **total_discount_amount** | **int** | Sum of total discount applied using the promotion tier. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersGetResponseBodySummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersGetResponseBodySummaryRedemptions
 2 | 
 3 | Contains statistics about promotion tier redemptions.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersUpdateRequestBodyAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersUpdateRequestBodyAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersUpdateResponseBodyAction.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersUpdateResponseBodyAction
 2 | 
 3 | Contains details about the discount applied by the promotion tier.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **discount** | [**Discount**](Discount.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/PromotionsTiersUpdateResponseBodySummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # PromotionsTiersUpdateResponseBodySummaryRedemptions
 2 | 
 3 | Contains statistics about promotion tier redemptions.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/QualificationsFieldConditions.md:
--------------------------------------------------------------------------------
 1 | # QualificationsFieldConditions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **conditions** | [**QualificationsFiltersCondition**](QualificationsFiltersCondition.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/QualificationsOptionFiltersHolderRole.md:
--------------------------------------------------------------------------------
 1 | # QualificationsOptionFiltersHolderRole
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **conditions** | [**QualificationsOptionFiltersHolderRoleConditions**](QualificationsOptionFiltersHolderRoleConditions.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/QualificationsOptionFiltersResourceType.md:
--------------------------------------------------------------------------------
 1 | # QualificationsOptionFiltersResourceType
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **conditions** | [**QualificationsOptionFiltersResourceTypeConditions**](QualificationsOptionFiltersResourceTypeConditions.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryChannel.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryChannel
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **channel_id** | **str** |  | [optional] 
 9 | **channel_type** | **str** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryLoyaltyCard
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **points** | **int** | Number of points subtracted from the loyalty card as a result of the redemption. and Number of points being returned to the loyalty card for the reward redemption rollback. It is expressed as a negative integer. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryOrderCustomer.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryOrderCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryOrderReferrer.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryOrderReferrer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryPromotionTierAction.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryPromotionTierAction
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **discount** | [**Discount**](Discount.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryPromotionTierSummaryOrders.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryPromotionTierSummaryOrders
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **total_amount** | **int** | Sum of order totals. | [optional] 
 9 | **total_discount_amount** | **int** | Sum of total discount applied using the promotion tier. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryPromotionTierSummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryPromotionTierSummaryRedemptions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryRelatedRedemptionsRedemptionsItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryRelatedRedemptionsRedemptionsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique redemption ID. | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionEntryRelatedRedemptionsRollbacksItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionEntryRelatedRedemptionsRollbacksItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** |  | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionGift.md:
--------------------------------------------------------------------------------
 1 | # RedemptionGift
 2 | 
 3 | Contains the amount subtracted from the gift card for the redemption.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **amount** | **int** | Amount subtracted from the gift card as a result of the redemption. The amount is expressed as the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # RedemptionLoyaltyCard
 2 | 
 3 | Contains the number of points subtracted from the loyalty card for the redemption.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **points** | **int** | Number of points subtracted from the loyalty card as a result of the redemption. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRedeemGift.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRedeemGift
 2 | 
 3 | Contains the amount subtracted from the gift card for the redemption.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **amount** | **int** | Amount subtracted from the gift card as a result of the redemption. The amount is expressed as the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRedeemLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRedeemLoyaltyCard
 2 | 
 3 | Contains the number of points subtracted from the loyalty card for the redemption.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **points** | **int** | Number of points subtracted from the loyalty card as a result of the redemption. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRedeemRelatedRedemptionsRedemptionsItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRedeemRelatedRedemptionsRedemptionsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique redemption ID. | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRedeemRelatedRedemptionsRollbacksItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRedeemRelatedRedemptionsRollbacksItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique rollback redemption ID. | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRelatedRedemptions.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRelatedRedemptions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **rollbacks** | [**List[RedemptionRelatedRedemptionsRollbacksItem]**](RedemptionRelatedRedemptionsRollbacksItem.md) |  | [optional] 
 9 | **redemptions** | [**List[RedemptionRelatedRedemptionsRedemptionsItem]**](RedemptionRelatedRedemptionsRedemptionsItem.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRelatedRedemptionsRedemptionsItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRelatedRedemptionsRedemptionsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique redemption ID. | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRelatedRedemptionsRollbacksItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRelatedRedemptionsRollbacksItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique rollback redemption ID. | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionRewardResultParametersProduct.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRewardResultParametersProduct
 2 | 
 3 | Defines the product redeemed as a reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique product ID, assigned by Voucherify.  | [optional] 
10 | **sku_id** | **str** | Unique identifier of the SKU. It is assigned by Voucherify. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RedemptionRollbackRelatedRedemptionsRedemptionsItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionRollbackRelatedRedemptionsRedemptionsItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique redemption ID. | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyChannel.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyChannel
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **channel_id** | **str** |  | [optional] 
 9 | **channel_type** | **str** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyLoyaltyCard
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **points** | **int** | Number of points subtracted from the loyalty card as a result of the redemption. and Number of points being returned to the loyalty card for the reward redemption rollback. It is expressed as a negative integer. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyOrderCustomer.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyOrderCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyOrderReferrer.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyOrderReferrer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyPromotionTierAction.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyPromotionTierAction
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **discount** | [**Discount**](Discount.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyPromotionTierSummaryOrders.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyPromotionTierSummaryOrders
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **total_amount** | **int** | Sum of order totals. | [optional] 
 9 | **total_discount_amount** | **int** | Sum of total discount applied using the promotion tier. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyPromotionTierSummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyPromotionTierSummaryRedemptions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** |  | [optional] 
 9 | **var_date** | **datetime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsListResponseBodyRedemptionsItemChannel.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsListResponseBodyRedemptionsItemChannel
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **channel_id** | **str** |  | [optional] 
 9 | **channel_type** | **str** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsListResponseBodyRedemptionsItemOrderCustomer.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsListResponseBodyRedemptionsItemOrderCustomer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsListResponseBodyRedemptionsItemOrderReferrer.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsListResponseBodyRedemptionsItemOrderReferrer
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierAction.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsListResponseBodyRedemptionsItemPromotionTierAction
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **discount** | [**Discount**](Discount.md) |  | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **total_amount** | **int** | Sum of order totals. | [optional] 
 9 | **total_discount_amount** | **int** | Sum of total discount applied using the promotion tier. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions.md:
--------------------------------------------------------------------------------
 1 | # RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **total_redeemed** | **int** | Number of times the promotion tier was redeemed. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ReferralProgramCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # ReferralProgramCustomEvent
 2 | 
 3 | Contains details about the custom event.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique custom event ID. | [optional] 
10 | **name** | **str** | Custom event name. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ReferrerId.md:
--------------------------------------------------------------------------------
 1 | # ReferrerId
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | A unique identifier of an existing customer. | [optional] 
 9 | **object** | **str** | The type of the object represented by JSON. | [optional] [default to 'customer']
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ResourceTypes.md:
--------------------------------------------------------------------------------
 1 | # ResourceTypes
 2 | 
 3 | Types of usable resources.
 4 | 
 5 | ## Enum
 6 | 
 7 | * `CAMPAIGN` (value: `'campaign'`)
 8 | 
 9 | * `VOUCHER` (value: `'voucher'`)
10 | 
11 | * `PROMOTION_TIER` (value: `'promotion_tier'`)
12 | 
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/RewardAssignmentParameters.md:
--------------------------------------------------------------------------------
 1 | # RewardAssignmentParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**RewardAssignmentParametersLoyalty**](RewardAssignmentParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RewardAttributes.md:
--------------------------------------------------------------------------------
 1 | # RewardAttributes
 2 | 
 3 | These properties are configurable for **material rewards**.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **image_url** | **str** | The HTTPS URL pointing to the .png or .jpg file. | [optional] 
10 | **description** | **str** | An arbitrary string that you can attach to a material reward. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RewardType.md:
--------------------------------------------------------------------------------
 1 | # RewardType
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **campaign** | [**RewardTypeCampaign**](RewardTypeCampaign.md) |  | [optional] 
 9 | **coin** | [**RewardTypeCoin**](RewardTypeCoin.md) |  | [optional] 
10 | **product** | [**RewardTypeProduct**](RewardTypeProduct.md) |  | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RewardTypeProduct.md:
--------------------------------------------------------------------------------
 1 | # RewardTypeProduct
 2 | 
 3 | Contains information about the product given as a reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique product ID, assigned by Voucherify. | [optional] 
10 | **sku_id** | **str** | Unique SKU ID, assigned by Voucherify, of the SKU given as a reward. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RewardsAssignmentsCreateRequestBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # RewardsAssignmentsCreateRequestBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**RewardsAssignmentsCreateRequestBodyParametersLoyalty**](RewardsAssignmentsCreateRequestBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RewardsAssignmentsCreateResponseBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # RewardsAssignmentsCreateResponseBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**RewardsAssignmentsCreateResponseBodyParametersLoyalty**](RewardsAssignmentsCreateResponseBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RewardsAssignmentsGetResponseBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # RewardsAssignmentsGetResponseBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**RewardsAssignmentsGetResponseBodyParametersLoyalty**](RewardsAssignmentsGetResponseBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RewardsAssignmentsUpdateRequestBody.md:
--------------------------------------------------------------------------------
 1 | # RewardsAssignmentsUpdateRequestBody
 2 | 
 3 | Request body schema for **PUT** `v1/rewards/{rewardId}/assignments/{assignmentId}`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **parameters** | [**RewardsAssignmentsUpdateRequestBodyParameters**](RewardsAssignmentsUpdateRequestBodyParameters.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RewardsAssignmentsUpdateRequestBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # RewardsAssignmentsUpdateRequestBodyParameters
 2 | 
 3 | An object that defines the price of the reward in loyalty points.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**RewardsAssignmentsUpdateRequestBodyParametersLoyalty**](RewardsAssignmentsUpdateRequestBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RewardsAssignmentsUpdateResponseBodyParameters.md:
--------------------------------------------------------------------------------
 1 | # RewardsAssignmentsUpdateResponseBodyParameters
 2 | 
 3 | Defines the cost of the reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **loyalty** | [**RewardsAssignmentsUpdateResponseBodyParametersLoyalty**](RewardsAssignmentsUpdateResponseBodyParametersLoyalty.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RewardsCreateRequestBodyAttributes.md:
--------------------------------------------------------------------------------
 1 | # RewardsCreateRequestBodyAttributes
 2 | 
 3 | Attributes of a material reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **image_url** | **str** | HTTPS URL pointing to a .png or .jpg file. | [optional] 
10 | **description** | **str** | Description of a material reward. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RewardsCreateRequestBodyParametersProduct.md:
--------------------------------------------------------------------------------
 1 | # RewardsCreateRequestBodyParametersProduct
 2 | 
 3 | Define the product given as a reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique product ID, assigned by Voucherify, given as a reward. | [optional] 
10 | **sku_id** | **str** | Unique SKU ID, assigned by Voucherify, of the SKU given as a reward. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RewardsCreateResponseBodyAttributes.md:
--------------------------------------------------------------------------------
 1 | # RewardsCreateResponseBodyAttributes
 2 | 
 3 | These properties are configurable for **material rewards**.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **image_url** | **str** | The HTTPS URL pointing to the .png or .jpg file. | [optional] 
10 | **description** | **str** | An arbitrary string that you can attach to a material reward. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RewardsUpdateRequestBodyAttributes.md:
--------------------------------------------------------------------------------
 1 | # RewardsUpdateRequestBodyAttributes
 2 | 
 3 | Attributes of a material reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **image_url** | **str** | HTTPS URL pointing to a .png or .jpg file. | [optional] 
10 | **description** | **str** | Description of a material reward. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SimpleProductDiscountUnit.md:
--------------------------------------------------------------------------------
 1 | # SimpleProductDiscountUnit
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique product ID, assigned by Voucherify. | [optional] 
 9 | **source_id** | **str** | Product's source ID. | [optional] 
10 | **name** | **str** | Product name. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SimpleSegment.md:
--------------------------------------------------------------------------------
 1 | # SimpleSegment
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique segment ID. | [optional] 
 9 | **name** | **str** | Segment name. | [optional] 
10 | **object** | **str** | The type of the object represented by the ID. | [optional] [default to 'segment']
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SimpleSkuDiscountUnit.md:
--------------------------------------------------------------------------------
 1 | # SimpleSkuDiscountUnit
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique SKU ID, assigned by Voucherify. | [optional] 
 9 | **source_id** | **str** | Product variant's source ID. | [optional] 
10 | **name** | **str** | Sku name | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SimpleVoucherRedemption.md:
--------------------------------------------------------------------------------
 1 | # SimpleVoucherRedemption
 2 | 
 3 | Defines the redemption limits on vouchers.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
10 | **redeemed_quantity** | **int** | How many times a voucher has already been redeemed. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SkusImportCsvCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # SkusImportCsvCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/skus/importCSV`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption.md:
--------------------------------------------------------------------------------
 1 | # TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption
 2 | 
 3 | Stores the quantity of redemptions that can be applied to the voucher.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem.md:
--------------------------------------------------------------------------------
 1 | # TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique identifier assigned to the created resource. It is assigned by Voucherify. | [optional] 
 9 | **object** | **str** | The type of the created resource. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TemplatesCampaignsTierSetupCreateResponseBodyCreatedResourcesItem.md:
--------------------------------------------------------------------------------
 1 | # TemplatesCampaignsTierSetupCreateResponseBodyCreatedResourcesItem
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **id** | **str** | Unique identifier assigned to the created resource. It is assigned by Voucherify. | [optional] 
 9 | **object** | **str** | The type of the created resource. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ValidationRuleError.md:
--------------------------------------------------------------------------------
 1 | # ValidationRuleError
 2 | 
 3 | Contains the error message returned from API when validation / redemption fails to meet requirements of defined rules.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **message** | **str** | The error message returned from API when validation / redemption fails to meet requirements of defined rules. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ValidationsRedeemableSkippedResult.md:
--------------------------------------------------------------------------------
 1 | # ValidationsRedeemableSkippedResult
 2 | 
 3 | Provides details about the reason why the redeemable is skipped.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **details** | [**ValidationsRedeemableSkippedResultDetails**](ValidationsRedeemableSkippedResultDetails.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ValidationsRedeemableSkippedResultDetails.md:
--------------------------------------------------------------------------------
 1 | # ValidationsRedeemableSkippedResultDetails
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **key** | **str** |  | [optional] 
 9 | **message** | **str** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ValidationsValidateResponseBodyRedeemablesItemResultDetails.md:
--------------------------------------------------------------------------------
 1 | # ValidationsValidateResponseBodyRedeemablesItemResultDetails
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **message** | **str** |  | [optional] 
 9 | **key** | **str** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md:
--------------------------------------------------------------------------------
 1 | # ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **points** | **int** | Total number of loyalty points to be applied in the redemption. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/ValidityHours.md:
--------------------------------------------------------------------------------
 1 | # ValidityHours
 2 | 
 3 | Determines the hours of validity, e.g. to create a happy hours scenario.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **daily** | [**List[ValidityHoursDailyItem]**](ValidityHoursDailyItem.md) | Defines the reccuring period(s) when the resource is active. The periods should not overlap. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VoucherAssets.md:
--------------------------------------------------------------------------------
 1 | # VoucherAssets
 2 | 
 3 | Stores links to images of QR and barcode that correspond to an encrypted voucher code.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **qr** | [**VoucherAssetsQr**](VoucherAssetsQr.md) |  | [optional] 
10 | **barcode** | [**VoucherAssetsBarcode**](VoucherAssetsBarcode.md) |  | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsCustomEvent.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsCustomEvent
 2 | 
 3 | Contains information about the custom event that triggers the point accrual.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique identifier of the event. | [optional] 
10 | **type** | **str** | Type of the custom event. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsEarningRuleSource.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsEarningRuleSource
 2 | 
 3 | Contains the custom earning rule name.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **banner** | **str** | Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsEvent.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsEvent
 2 | 
 3 | Contains information about the event that triggers the point accrual.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique event ID. | [optional] 
10 | **type** | **str** | Type of event. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsEventSchema.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsEventSchema
 2 | 
 3 | Contains information about the custom event metadata schema.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique identifier of the metadata schema. | [optional] 
10 | **name** | **str** | Type of the custom event. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsRedemption.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsRedemption
 2 | 
 3 | Contains information about the original redemption.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique redemption ID. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsReward.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsReward
 2 | 
 3 | Contains information about the pay with points reward.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique reward ID. | [optional] 
10 | **name** | **str** | Reward name. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsRollback.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsRollback
 2 | 
 3 | Contains information about the redemption rollback.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique identifier of the redemption rollback. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionDetailsSegment.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionDetailsSegment
 2 | 
 3 | Contains information about the segment.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **id** | **str** | Unique identifier of the segment. | [optional] 
10 | **name** | **str** | Name of the segment. | [optional] 
11 | 
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionsExportFilterConditions.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionsExportFilterConditions
 2 | 
 3 | Filter condition.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **voucher_id** | [**VoucherTransactionsExportFilterConditionsVoucherId**](VoucherTransactionsExportFilterConditionsVoucherId.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VoucherTransactionsExportFilterConditionsVoucherIdConditions.md:
--------------------------------------------------------------------------------
 1 | # VoucherTransactionsExportFilterConditionsVoucherIdConditions
 2 | 
 3 | Data filters used to narrow down the data records to be returned in the result.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **var_in** | **List[str]** |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VouchersCreateRequestBodyRedemption.md:
--------------------------------------------------------------------------------
 1 | # VouchersCreateRequestBodyRedemption
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/VouchersCreateWithSpecificCodeRequestBodyRedemption.md:
--------------------------------------------------------------------------------
 1 | # VouchersCreateWithSpecificCodeRequestBodyRedemption
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/VouchersImportCreateItemRequestBodyRedemption.md:
--------------------------------------------------------------------------------
 1 | # VouchersImportCreateItemRequestBodyRedemption
 2 | 
 3 | 
 4 | ## Properties
 5 | 
 6 | Name | Type | Description | Notes
 7 | ------------ | ------------- | ------------- | -------------
 8 | **quantity** | **int** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
 9 | 
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/VouchersImportCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # VouchersImportCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/vouchers/import`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VouchersImportCsvCreateResponseBody.md:
--------------------------------------------------------------------------------
 1 | # VouchersImportCsvCreateResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/vouchers/importCSV`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VouchersMetadataUpdateInBulkResponseBody.md:
--------------------------------------------------------------------------------
 1 | # VouchersMetadataUpdateInBulkResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/vouchers/metadata/async`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VouchersTransactionsExportCreateRequestBody.md:
--------------------------------------------------------------------------------
 1 | # VouchersTransactionsExportCreateRequestBody
 2 | 
 3 | Request body schema for **POST** `v1/vouchers/transactions/export`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **parameters** | [**VoucherTransactionsExportParameters**](VoucherTransactionsExportParameters.md) |  | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VouchersUpdateInBulkResponseBody.md:
--------------------------------------------------------------------------------
 1 | # VouchersUpdateInBulkResponseBody
 2 | 
 3 | Response body schema for **POST** `v1/vouchers/bulk/async`.
 4 | 
 5 | ## Properties
 6 | 
 7 | Name | Type | Description | Notes
 8 | ------------ | ------------- | ------------- | -------------
 9 | **async_action_id** | **str** | The ID of the scheduled asynchronous action. | [optional] 
10 | 
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | python_dateutil >= 2.5.3
2 | setuptools >= 21.0.0
3 | urllib3 >= 1.25.3, < 2.1.0
4 | pydantic >= 2
5 | typing-extensions >= 4.7.1
6 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [flake8]
2 | max-line-length=99
3 | 


--------------------------------------------------------------------------------
/test-requirements.txt:
--------------------------------------------------------------------------------
1 | pytest~=7.1.3
2 | pytest-cov>=2.8.1
3 | pytest-randomly>=3.12.0
4 | mypy>=1.4.1
5 | types-python-dateutil>=2.8.19
6 | python-dotenv >= 1.0.0
7 | responses >= 0.24.0, < 1.0.0
8 | 


--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
 1 | [tox]
 2 | envlist = py3
 3 | 
 4 | [testenv]
 5 | deps=-r{toxinidir}/requirements.txt
 6 |      -r{toxinidir}/test-requirements.txt
 7 | 
 8 | commands=
 9 |    pytest --cov=voucherify
10 | 


--------------------------------------------------------------------------------
/voucherify-python-sdk.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/voucherifyio/voucherify-python-sdk/24c04a544016eac50af6bf90cc40614584927d13/voucherify-python-sdk.png


--------------------------------------------------------------------------------
/voucherify/py.typed:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/voucherifyio/voucherify-python-sdk/24c04a544016eac50af6bf90cc40614584927d13/voucherify/py.typed


--------------------------------------------------------------------------------