voucherify 8.1.0 → 8.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +192 -56
- data/Gemfile.lock +7 -7
- data/README.md +422 -0
- data/__tests__/LOYALTY_V2_COVERAGE.md +161 -0
- data/__tests__/lib/config.rb +20 -0
- data/__tests__/lib/loyalty_v2_fixture.rb +199 -0
- data/__tests__/lib/loyalty_v2_http.rb +209 -0
- data/__tests__/spec/13_management_spec.rb +6 -1
- data/__tests__/spec/15_loyalty_v2_spec.rb +403 -0
- data/docs/ActivitySource.md +10 -0
- data/docs/ActivitySourceApiKey.md +10 -0
- data/docs/ActivitySourceUser.md +8 -0
- data/docs/BenefitPointsProportionalApplicableTo.md +11 -0
- data/docs/BenefitPointsProportionalCustomEvent.md +8 -0
- data/docs/BenefitPointsProportionalCustomEventMetadata.md +10 -0
- data/docs/BenefitPointsProportionalCustomer.md +8 -0
- data/docs/BenefitPointsProportionalCustomerMetadata.md +10 -0
- data/docs/BenefitPointsProportionalOrder.md +10 -0
- data/docs/BenefitPointsProportionalOrderAmount.md +9 -0
- data/docs/BenefitPointsProportionalOrderItems.md +10 -0
- data/docs/BenefitPointsProportionalOrderItemsAmount.md +10 -0
- data/docs/BenefitPointsProportionalOrderItemsQuantity.md +10 -0
- data/docs/BenefitPointsProportionalOrderItemsSubtotalAmount.md +10 -0
- data/docs/BenefitPointsProportionalOrderMetadata.md +10 -0
- data/docs/BenefitPointsProportionalOrderTotalAmount.md +9 -0
- data/docs/BenefitTransaction.md +18 -0
- data/docs/BenefitTransactionDetails.md +11 -0
- data/docs/BenefitTransactionDetailsMetadata.md +9 -0
- data/docs/BenefitTransactionDetailsResult.md +8 -0
- data/docs/BenefitTransactionRejection.md +9 -0
- data/docs/CampaignsApi.md +7 -7
- data/docs/Card.md +19 -0
- data/docs/CardActivity.md +14 -0
- data/docs/CardActivityData.md +12 -0
- data/docs/CardBalance.md +9 -0
- data/docs/CardCodeGenerationFailureResult.md +8 -0
- data/docs/CardDailyReportEntry.md +24 -0
- data/docs/CardDefinitionIdFilterConditions.md +8 -0
- data/docs/CardDefinitionIdFilterConditionsConditions.md +11 -0
- data/docs/CardLifetimeBucket.md +9 -0
- data/docs/CardLifetimeBucketPendingPoints.md +10 -0
- data/docs/CardLifetimeBucketPoints.md +19 -0
- data/docs/CardNextActivation.md +11 -0
- data/docs/CardNextExpiration.md +9 -0
- data/docs/CardPendingPointsBucket.md +20 -0
- data/docs/CardPendingPointsBucketPoints.md +8 -0
- data/docs/CardPointsBucket.md +21 -0
- data/docs/CardPointsBucketPoints.md +8 -0
- data/docs/CardSimple.md +16 -0
- data/docs/CardTransaction.md +19 -0
- data/docs/CardTransactionDetails.md +22 -0
- data/docs/CardTransactionDetailsCardTransaction.md +8 -0
- data/docs/CardTransactionDetailsOrder.md +8 -0
- data/docs/CardTransactionDetailsOrderTransaction.md +8 -0
- data/docs/CardTransactionDetailsPoints.md +12 -0
- data/docs/CardTransactionDetailsPurchase.md +9 -0
- data/docs/CardTransactionDetailsPurchaseCardTransaction.md +8 -0
- data/docs/CardTransactionDetailsPurchaseRewardTransaction.md +8 -0
- data/docs/CardTransactionDetailsPurchaseTransaction.md +8 -0
- data/docs/CardTransactionDetailsRejection.md +9 -0
- data/docs/CardTransactionDetailsReward.md +8 -0
- data/docs/CardTransactionDetailsRewardTransaction.md +8 -0
- data/docs/CardTransactionDetailsTargetCard.md +8 -0
- data/docs/ClientRedemptionsRedeemRequestBody.md +1 -1
- data/docs/ClientSideApi.md +2 -2
- data/docs/ClientValidationsValidateRequestBody.md +1 -1
- data/docs/ClientValidationsValidateResponseBody.md +1 -1
- data/docs/CustomerLoyaltyMembership.md +11 -0
- data/docs/CustomerLoyaltyMembershipCard.md +13 -0
- data/docs/CustomerLoyaltyMembershipMember.md +11 -0
- data/docs/CustomerLoyaltyMembershipTier.md +12 -0
- data/docs/CustomerWithSummaryLoyaltyReferrals.md +1 -0
- data/docs/CustomersApi.md +8 -6
- data/docs/CustomersCreateResponseBody.md +1 -0
- data/docs/CustomersGetResponseBody.md +1 -0
- data/docs/CustomersRedeemablesListResponseBody.md +1 -1
- data/docs/CustomersUpdateResponseBody.md +1 -0
- data/docs/DateFilter.md +8 -0
- data/docs/DateFilterConditions.md +14 -0
- data/docs/EarningRuleDailyReportEntry.md +10 -0
- data/docs/EarningRuleEarning.md +12 -0
- data/docs/EarningRuleEffect.md +11 -0
- data/docs/EarningRuleEffectPoints.md +10 -0
- data/docs/EarningRuleEffectPointsExpiration.md +11 -0
- data/docs/EarningRuleEffectPointsExpirationCalendarExpiration.md +8 -0
- data/docs/EarningRuleEffectPointsExpirationRollingExpiration.md +9 -0
- data/docs/EarningRuleEffectPointsExpirationSlidingExpiration.md +9 -0
- data/docs/EarningRuleEffectPointsProportional.md +14 -0
- data/docs/EarningRuleIdFilterConditions.md +8 -0
- data/docs/EarningRuleIdFilterConditionsConditions.md +11 -0
- data/docs/EarningRulePointsProportionalApplicableTo.md +11 -0
- data/docs/EarningRulePointsProportionalCustomEvent.md +8 -0
- data/docs/EarningRulePointsProportionalCustomer.md +8 -0
- data/docs/EarningRulePointsProportionalOrder.md +10 -0
- data/docs/EarningRulePointsProportionalOrderItems.md +10 -0
- data/docs/EarningRulePointsProportionalOrderItemsCalculation.md +10 -0
- data/docs/EarningRuleTierRules.md +9 -0
- data/docs/EarningRuleTrigger.md +10 -0
- data/docs/EarningRuleTriggerLimitsCooldown.md +9 -0
- data/docs/EarningRuleTriggerLimitsCooldownFixedCooldown.md +8 -0
- data/docs/EarningRuleTriggerLimitsFrequency.md +9 -0
- data/docs/EarningRuleValidityHours.md +9 -0
- data/docs/EarningRulesReportDailyEntry.md +13 -0
- data/docs/EarningRulesReportFailuresBreakdown.md +9 -0
- data/docs/EarningRulesReportListFilters.md +9 -0
- data/docs/EarningRulesReportSummaryEntry.md +13 -0
- data/docs/ErrorError.md +1 -1
- data/docs/ExamineCardReference.md +12 -0
- data/docs/ExamineCustomerIdentification.md +11 -0
- data/docs/ExamineCustomerReference.md +11 -0
- data/docs/ExamineMemberReference.md +12 -0
- data/docs/ExamineProgramReference.md +11 -0
- data/docs/ExportParameters.md +2 -2
- data/docs/ExportsApi.md +6 -6
- data/docs/ExportsCreateRequestBodyParameters.md +2 -2
- data/docs/ExportsCreateResponseBodyParameters.md +2 -2
- data/docs/ExportsGetResponseBodyParameters.md +2 -2
- data/docs/LV2BenefitsApi.md +66 -0
- data/docs/LV2EarningRulesApi.md +66 -0
- data/docs/LV2ExamineApi.md +129 -0
- data/docs/LV2ProgramsApi.md +2935 -0
- data/docs/LV2RewardsApi.md +66 -0
- data/docs/ListCursor.md +9 -0
- data/docs/LoyaltiesApi.md +52 -52
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBody.md +12 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomEventAll.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomEventSpecific.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomer.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerCustomEvent.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerCustomEventAll.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerCustomEventSpecific.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerOrderPaid.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerSegmentEntered.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyMember.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrder.md +12 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrderItem.md +19 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrderItemProduct.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrderItemSku.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyTrigger.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyTriggerSpecific.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBody.md +12 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyBenefitEarningRuleEstimation.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyBenefitEstimation.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyBenefitReference.md +11 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyCardEarningRuleEstimation.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyCardEstimation.md +11 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyEarningRuleDetail.md +11 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyEarningRuleReference.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyMembership.md +12 -0
- data/docs/LoyaltiesExamineRewardsExamineRequestBody.md +10 -0
- data/docs/LoyaltiesExamineRewardsExamineRequestBodyCustomer.md +8 -0
- data/docs/LoyaltiesExamineRewardsExamineRequestBodyMember.md +8 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBody.md +11 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyCardEstimation.md +10 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyCardRewardEstimation.md +12 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyMembership.md +11 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardCost.md +9 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardDetail.md +13 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardReference.md +9 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardUnavailabilityReason.md +10 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersId.md +8 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersType.md +8 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersTypeConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersBenefitsTransactionsListRequestQueryBenefitId.md +8 -0
- data/docs/LoyaltiesProgramsMembersBenefitsTransactionsListRequestQueryBenefitIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersId.md +8 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersType.md +8 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersTypeConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersCardsReportsDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsMembersCardsTransactionsListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersCardsTransactionsListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryCustomerId.md +8 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryCustomerIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryStatus.md +8 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryStatusConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBody.md +10 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBodyTransaction.md +20 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBodyTransactionDetails.md +12 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBodyLimit.md +10 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBody.md +10 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBodyTransaction.md +20 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBodyTransactionDetails.md +12 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryCardDefinitionId.md +8 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryCardDefinitionIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryRewardId.md +8 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryRewardIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardDefinitionId.md +8 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardDefinitionIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardId.md +8 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsReportsMembersDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsMembersSummaryListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsSpendingsDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsSpendingsSummaryListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsSummaryListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsSpendingDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsSpendingSummaryListResponseBody.md +9 -0
- data/docs/LoyaltyV2ActivityBenefitPointsProportionalApplicableToProduct.md +8 -0
- data/docs/LoyaltyV2ActivityBenefitPointsProportionalApplicableToProductsCollection.md +8 -0
- data/docs/LoyaltyV2ActivityBenefitPointsProportionalApplicableToSku.md +8 -0
- data/docs/LoyaltyV2ActivityBenefitStockLimited.md +8 -0
- data/docs/LoyaltyV2ActivityCardDefinitionLimitTimeBasedPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityCardDefinitionLimitTimeBasedPeriodCurrentPeriod.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleEarningLimits.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleEarningLimitsGlobal.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectBenefit.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationCalendarExpirationDate.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationRounding.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationSlidingExpirationPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleError.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProduct.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProductsCollection.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalApplicableToSku.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalEvery.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalMetadata.md +10 -0
- data/docs/LoyaltyV2ActivityEarningRuleTierRulesAnyOfEntry.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleTriggerCustomEvent.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleTriggerLimitsCooldownFixedCooldownPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleTriggerSegment.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleValidityDailyHours.md +10 -0
- data/docs/LoyaltyV2ActivityRewardCostSpendingResponse.md +11 -0
- data/docs/LoyaltyV2ActivityRewardDigitalDiscountCoupons.md +8 -0
- data/docs/LoyaltyV2ActivityRewardDigitalGiftVouchersResponse.md +9 -0
- data/docs/LoyaltyV2ActivityRewardDigitalLoyaltyCardPointsResponse.md +9 -0
- data/docs/LoyaltyV2ActivityRewardMaterialProduct.md +8 -0
- data/docs/LoyaltyV2ActivityRewardMaterialSKU.md +9 -0
- data/docs/LoyaltyV2ActivityRewardPurchaseLimitsCooldownFixedCooldownPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityRewardPurchaseLimitsFrequencyLimitTriggers.md +8 -0
- data/docs/LoyaltyV2ActivityRewardRefunds.md +8 -0
- data/docs/LoyaltyV2ActivityRewardValidityDailyHoursResponse.md +10 -0
- data/docs/LoyaltyV2CardPointsBucketSimple.md +11 -0
- data/docs/LoyaltyV2CardPointsBucketSimplePoints.md +8 -0
- data/docs/LpmOrdPayCcrbTxDetailsMetadata.md +9 -0
- data/docs/LpmOrdPayCcrbTxDetailsRejection.md +9 -0
- data/docs/LpmOrdPayCcrbTxDetailsRejectionDetails.md +10 -0
- data/docs/LpmOrdPayCcrbTxDetailsSpendingCap.md +10 -0
- data/docs/LpmRewPurchCcrbTxDetailsPoints.md +8 -0
- data/docs/LpmRewPurchCcrbTxDetailsRejection.md +9 -0
- data/docs/LpmRewPurchCcrbTxDetailsResult.md +11 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultDigLcPoints.md +10 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultDigital.md +11 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultMaterial.md +10 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultReward.md +9 -0
- data/docs/ManagementApi.md +26 -26
- data/docs/ManagementProjectsMetadataSchemaDefinition.md +1 -1
- data/docs/Member.md +15 -0
- data/docs/MemberCard.md +11 -0
- data/docs/MemberCreate.md +10 -0
- data/docs/MemberTierProgress.md +13 -0
- data/docs/MemberTierProgressCurrent.md +11 -0
- data/docs/MemberTierProgressDeferred.md +10 -0
- data/docs/MemberTierProgressOpportunity.md +10 -0
- data/docs/MemberTierProgressPoints.md +10 -0
- data/docs/MemberTierProgressRisk.md +10 -0
- data/docs/MemberTierProgressTier.md +9 -0
- data/docs/MemberTierProgressTierStructure.md +9 -0
- data/docs/MembersReportDailyEntry.md +13 -0
- data/docs/MembersReportSummaryEntry.md +13 -0
- data/docs/MembershipCard.md +12 -0
- data/docs/MetadataSchemasApi.md +2 -2
- data/docs/OrderPaymentLimitDefinition.md +8 -0
- data/docs/OrderPaymentOrder.md +9 -0
- data/docs/OrderPaymentPaymentDetails.md +11 -0
- data/docs/OrderPaymentRejection.md +9 -0
- data/docs/OrderPaymentTransaction.md +20 -0
- data/docs/OrderPaymentTransactionDetails.md +12 -0
- data/docs/OrderPaymentTransactionDetailsSpendingCap.md +10 -0
- data/docs/OrdersApi.md +2 -2
- data/docs/PointsEarningsReportDailyEntry.md +15 -0
- data/docs/PointsEarningsReportListFilters.md +10 -0
- data/docs/PointsEarningsReportSummaryEntry.md +15 -0
- data/docs/ProductCollectionsApi.md +1 -1
- data/docs/ProductCollectionsProductsListResponseBody.md +1 -1
- data/docs/ProductsApi.md +4 -4
- data/docs/Program.md +17 -0
- data/docs/ProgramEarningRuleAssignment.md +10 -0
- data/docs/ProgramListCursor.md +9 -0
- data/docs/ProgramRewardAssignment.md +13 -0
- data/docs/ProgramRewardAssignmentStock.md +9 -0
- data/docs/ProgramRewardAssignmentStockLimited.md +8 -0
- data/docs/ProgramSimple.md +12 -0
- data/docs/ProgramTierStructureAssignment.md +10 -0
- data/docs/ProgramValidityDailyHours.md +10 -0
- data/docs/ProgramValidityHours.md +9 -0
- data/docs/PromotionTierCampaign.md +1 -1
- data/docs/PromotionsTiersCreateResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersDisableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersEnableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersGetResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersUpdateResponseBodyCampaign.md +1 -1
- data/docs/PublicationsApi.md +3 -3
- data/docs/PublicationsListResponseBody.md +1 -1
- data/docs/QualificationsApi.md +1 -1
- data/docs/RedemptionEntryPromotionTierCampaign.md +1 -1
- data/docs/RedemptionRewardResultParametersCoin.md +1 -1
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsRedeemRequestBody.md +1 -1
- data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -0
- data/docs/ReferralsApi.md +4 -4
- data/docs/ReferralsMembersHoldersListResponseBody.md +1 -1
- data/docs/ReportCardDefinitionIdFilterConditions.md +8 -0
- data/docs/ReportCardDefinitionIdFilterConditionsConditions.md +11 -0
- data/docs/RewardCostResponse.md +12 -0
- data/docs/RewardCostTierRulesAnyOfEntryResponse.md +9 -0
- data/docs/RewardCostTierRulesResponse.md +9 -0
- data/docs/RewardDigitalResponse.md +11 -0
- data/docs/RewardMaterialResponse.md +10 -0
- data/docs/RewardPurchaseDigitalCoupon.md +10 -0
- data/docs/RewardPurchaseDigitalGiftVoucher.md +12 -0
- data/docs/RewardPurchaseLimits.md +9 -0
- data/docs/RewardPurchaseLimitsCooldown.md +9 -0
- data/docs/RewardPurchaseLimitsCooldownFixedCooldown.md +8 -0
- data/docs/RewardPurchaseLimitsFrequency.md +9 -0
- data/docs/RewardPurchaseLimitsFrequencyLimit.md +10 -0
- data/docs/RewardPurchaseRefundPolicies.md +9 -0
- data/docs/RewardPurchaseTransaction.md +20 -0
- data/docs/RewardValidityHoursResponse.md +9 -0
- data/docs/RewardsCreateRequestBodyParametersCoin.md +1 -1
- data/docs/RewardsReportDailyEntry.md +13 -0
- data/docs/RewardsReportFilterRewardIdConditions.md +8 -0
- data/docs/RewardsReportFilterRewardIdConditionsConditions.md +11 -0
- data/docs/RewardsReportListFilters.md +9 -0
- data/docs/RewardsReportSummaryEntry.md +13 -0
- data/docs/RewardsSpendingsReportDailyEntry.md +15 -0
- data/docs/RewardsSpendingsReportFilterCostIdConditions.md +8 -0
- data/docs/RewardsSpendingsReportFilterCostIdConditionsConditions.md +11 -0
- data/docs/RewardsSpendingsReportFilterSpendingIdConditions.md +8 -0
- data/docs/RewardsSpendingsReportFilterSpendingIdConditionsConditions.md +11 -0
- data/docs/RewardsSpendingsReportListFilters.md +12 -0
- data/docs/RewardsSpendingsReportSummaryEntry.md +15 -0
- data/docs/RewardsUpdateRequestBodyParametersCoin.md +1 -1
- data/docs/SegmentsApi.md +1 -1
- data/docs/SpendingReportDailyEntry.md +17 -0
- data/docs/SpendingReportListFilters.md +9 -0
- data/docs/SpendingReportSummaryEntry.md +17 -0
- data/docs/TemplatesApi.md +7 -7
- data/docs/TierTransaction.md +20 -0
- data/docs/TierTransactionDetails.md +14 -0
- data/docs/TierTransactionOrigin.md +10 -0
- data/docs/TierTransactionRejection.md +9 -0
- data/docs/TiersReportDailyEntry.md +16 -0
- data/docs/TiersReportFilterTierIdConditions.md +8 -0
- data/docs/TiersReportFilterTierIdConditionsConditions.md +11 -0
- data/docs/TiersReportFilterTierStructureIdConditions.md +8 -0
- data/docs/TiersReportFilterTierStructureIdConditionsConditions.md +11 -0
- data/docs/TiersReportListFilters.md +10 -0
- data/docs/TiersReportSummaryEntry.md +16 -0
- data/docs/TransactionFilterDateConditions.md +8 -0
- data/docs/TransactionFilterDateConditionsConditions.md +14 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBody.md +19 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBodyPoints.md +9 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBodyPointsProportional.md +13 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBodyStock.md +9 -0
- data/docs/V2LoyaltiesEarningRulesGetResponseBody.md +22 -0
- data/docs/V2LoyaltiesEarningRulesGetResponseBodyTriggerLimits.md +9 -0
- data/docs/V2LoyaltiesProgramsEarningRulesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersActivateResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembersActivitiesListRequestQueryFilters.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersActivitiesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersBenefitsTransactionsListRequestQuery.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersBenefitsTransactionsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersBenefitsTransactionsListResponseBodyCursor.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFilters.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersCardsActivitiesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsExpiringPointsExpireResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsExpiringPointsListRequestQuery.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsExpiringPointsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsActivateResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsCancelResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsListRequestQuery.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPointsAdjustRequestBody.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPointsAdjustResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsTransactionsListRequestQuery.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersCardsTransactionsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCreateInBulkResponseBody.md +8 -0
- data/docs/V2LoyaltiesProgramsMembersCreateRequestBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCreateResponseBody.md +16 -0
- data/docs/V2LoyaltiesProgramsMembersDeactivateResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembersDeleteResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembersEarningRulesReportsDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersGetResponseBody.md +16 -0
- data/docs/V2LoyaltiesProgramsMembersListRequestQuery.md +12 -0
- data/docs/V2LoyaltiesProgramsMembersListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBody.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsListRequestQuery.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsListResponseBodyCursor.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesCreateRequestBody.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesListRequestQuery.md +12 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesListResponseBodyCursor.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersTiersTransactionsListRequestQuery.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersTiersTransactionsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersUpdateRequestBody.md +8 -0
- data/docs/V2LoyaltiesProgramsMembersUpdateResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembershipsGetResponseBody.md +11 -0
- data/docs/V2LoyaltiesProgramsReportsEarningRulesDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsEarningRulesSummaryListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsPointsEarningsDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsPointsEarningsSummaryListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsTiersDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsTiersSummaryListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsRewardsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsRewardsPurchasesRefundRequestBody.md +8 -0
- data/docs/V2LoyaltiesProgramsRewardsPurchasesRefundResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsTierStructuresListResponseBody.md +10 -0
- data/docs/V2LoyaltiesRewardsGetResponseBody.md +23 -0
- data/docs/VLMemberActivity.md +14 -0
- data/docs/VLMemberActivityData.md +11 -0
- data/docs/ValidationRulesApi.md +2 -2
- data/docs/ValidationsValidateRequestBody.md +1 -1
- data/docs/ValidationsValidateRequestBodyOptions.md +1 -0
- data/docs/ValidationsValidateResponseBody.md +1 -1
- data/docs/VouchersApi.md +8 -8
- data/lib/VoucherifySdk/api/campaigns_api.rb +14 -14
- data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
- data/lib/VoucherifySdk/api/customers_api.rb +13 -10
- data/lib/VoucherifySdk/api/exports_api.rb +8 -8
- data/lib/VoucherifySdk/api/loyalties_api.rb +104 -104
- data/lib/VoucherifySdk/api/lv2_benefits_api.rb +81 -0
- data/lib/VoucherifySdk/api/lv2_earning_rules_api.rb +81 -0
- data/lib/VoucherifySdk/api/lv2_examine_api.rb +150 -0
- data/lib/VoucherifySdk/api/lv2_programs_api.rb +3008 -0
- data/lib/VoucherifySdk/api/lv2_rewards_api.rb +81 -0
- data/lib/VoucherifySdk/api/management_api.rb +52 -52
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +4 -4
- data/lib/VoucherifySdk/api/orders_api.rb +4 -4
- data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
- data/lib/VoucherifySdk/api/products_api.rb +8 -8
- data/lib/VoucherifySdk/api/publications_api.rb +6 -6
- data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
- data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
- data/lib/VoucherifySdk/api/referrals_api.rb +8 -8
- data/lib/VoucherifySdk/api/segments_api.rb +2 -2
- data/lib/VoucherifySdk/api/templates_api.rb +14 -14
- data/lib/VoucherifySdk/api/validation_rules_api.rb +4 -4
- data/lib/VoucherifySdk/api/vouchers_api.rb +16 -16
- data/lib/VoucherifySdk/configuration.rb +8 -0
- data/lib/VoucherifySdk/models/activity_source.rb +252 -0
- data/lib/VoucherifySdk/models/activity_source_api_key.rb +232 -0
- data/lib/VoucherifySdk/models/activity_source_user.rb +210 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_applicable_to.rb +261 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_custom_event.rb +209 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_custom_event_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_customer.rb +209 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_customer_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order.rb +229 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_amount.rb +241 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items.rb +229 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items_amount.rb +259 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items_quantity.rb +259 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items_subtotal_amount.rb +259 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_total_amount.rb +241 -0
- data/lib/VoucherifySdk/models/benefit_transaction.rb +350 -0
- data/lib/VoucherifySdk/models/benefit_transaction_details.rb +238 -0
- data/lib/VoucherifySdk/models/benefit_transaction_details_metadata.rb +227 -0
- data/lib/VoucherifySdk/models/benefit_transaction_details_result.rb +210 -0
- data/lib/VoucherifySdk/models/benefit_transaction_rejection.rb +220 -0
- data/lib/VoucherifySdk/models/card.rb +387 -0
- data/lib/VoucherifySdk/models/card_activity.rb +308 -0
- data/lib/VoucherifySdk/models/card_activity_data.rb +258 -0
- data/lib/VoucherifySdk/models/card_balance.rb +225 -0
- data/lib/VoucherifySdk/models/card_code_generation_failure_result.rb +210 -0
- data/lib/VoucherifySdk/models/card_daily_report_entry.rb +412 -0
- data/lib/VoucherifySdk/models/card_definition_id_filter_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/card_definition_id_filter_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/card_lifetime_bucket.rb +231 -0
- data/lib/VoucherifySdk/models/card_lifetime_bucket_pending_points.rb +238 -0
- data/lib/VoucherifySdk/models/card_lifetime_bucket_points.rb +355 -0
- data/lib/VoucherifySdk/models/card_next_activation.rb +269 -0
- data/lib/VoucherifySdk/models/card_next_expiration.rb +223 -0
- data/lib/VoucherifySdk/models/card_pending_points_bucket.rb +405 -0
- data/lib/VoucherifySdk/models/card_pending_points_bucket_points.rb +210 -0
- data/lib/VoucherifySdk/models/card_points_bucket.rb +422 -0
- data/lib/VoucherifySdk/models/card_points_bucket_points.rb +210 -0
- data/lib/VoucherifySdk/models/card_simple.rb +332 -0
- data/lib/VoucherifySdk/models/card_transaction.rb +393 -0
- data/lib/VoucherifySdk/models/card_transaction_details.rb +354 -0
- data/lib/VoucherifySdk/models/card_transaction_details_card_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_order.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_order_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_points.rb +280 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase.rb +219 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase_card_transaction.rb +209 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase_reward_transaction.rb +209 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_rejection.rb +221 -0
- data/lib/VoucherifySdk/models/card_transaction_details_reward.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_reward_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_target_card.rb +210 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership.rb +251 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership_card.rb +277 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership_member.rb +275 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership_tier.rb +278 -0
- data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb +14 -1
- data/lib/VoucherifySdk/models/customers_create_response_body.rb +14 -1
- data/lib/VoucherifySdk/models/customers_get_response_body.rb +14 -1
- data/lib/VoucherifySdk/models/customers_redeemables_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/customers_update_response_body.rb +14 -1
- data/lib/VoucherifySdk/models/date_filter.rb +209 -0
- data/lib/VoucherifySdk/models/date_filter_conditions.rb +268 -0
- data/lib/VoucherifySdk/models/earning_rule_daily_report_entry.rb +258 -0
- data/lib/VoucherifySdk/models/earning_rule_earning.rb +281 -0
- data/lib/VoucherifySdk/models/earning_rule_effect.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points.rb +246 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration_calendar_expiration.rb +222 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration_rolling_expiration.rb +224 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration_sliding_expiration.rb +226 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_proportional.rb +296 -0
- data/lib/VoucherifySdk/models/earning_rule_id_filter_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/earning_rule_id_filter_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_applicable_to.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_custom_event.rb +215 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_customer.rb +215 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_order.rb +226 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_order_items.rb +226 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_order_items_calculation.rb +259 -0
- data/lib/VoucherifySdk/models/earning_rule_tier_rules.rb +252 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger.rb +252 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger_limits_cooldown.rb +243 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger_limits_cooldown_fixed_cooldown.rb +215 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger_limits_frequency.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_validity_hours.rb +252 -0
- data/lib/VoucherifySdk/models/earning_rules_report_daily_entry.rb +297 -0
- data/lib/VoucherifySdk/models/earning_rules_report_failures_breakdown.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rules_report_list_filters.rb +243 -0
- data/lib/VoucherifySdk/models/earning_rules_report_summary_entry.rb +308 -0
- data/lib/VoucherifySdk/models/error_error.rb +2 -2
- data/lib/VoucherifySdk/models/examine_card_reference.rb +284 -0
- data/lib/VoucherifySdk/models/examine_customer_identification.rb +279 -0
- data/lib/VoucherifySdk/models/examine_customer_reference.rb +271 -0
- data/lib/VoucherifySdk/models/examine_member_reference.rb +282 -0
- data/lib/VoucherifySdk/models/examine_program_reference.rb +271 -0
- data/lib/VoucherifySdk/models/export.rb +1 -1
- data/lib/VoucherifySdk/models/export_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/list_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body.rb +258 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_custom_event_all.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_custom_event_specific.rb +228 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_custom_event.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_custom_event_all.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_custom_event_specific.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_order_paid.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_segment_entered.rb +217 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_member.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order.rb +262 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order_item.rb +352 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order_item_product.rb +232 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order_item_sku.rb +232 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_trigger.rb +243 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_trigger_specific.rb +234 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body.rb +282 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_benefit_earning_rule_estimation.rb +245 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_benefit_estimation.rb +258 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_benefit_reference.rb +271 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_card_earning_rule_estimation.rb +256 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_card_estimation.rb +269 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_earning_rule_detail.rb +271 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_earning_rule_reference.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_membership.rb +280 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_request_body.rb +235 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_request_body_customer.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_request_body_member.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body.rb +278 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_card_estimation.rb +265 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_card_reward_estimation.rb +294 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_membership.rb +281 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_cost.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_detail.rb +293 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_reference.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_unavailability_reason.rb +261 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_type.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_type_conditions.rb +272 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_benefits_transactions_list_request_query_benefit_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_benefits_transactions_list_request_query_benefit_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_type.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_type_conditions.rb +272 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_reports_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_transactions_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_transactions_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_customer_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_customer_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_status.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_status_conditions.rb +272 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_combined_response_body.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_combined_response_body_transaction.rb +371 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_combined_response_body_transaction_details.rb +248 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_request_body_limit.rb +250 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_create_combined_response_body.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_create_combined_response_body_transaction.rb +369 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_create_combined_response_body_transaction_details.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_card_definition_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_card_definition_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_reward_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_reward_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_definition_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_definition_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_members_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_members_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_spendings_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_spendings_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_spending_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_spending_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_points_proportional_applicable_to_product.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_points_proportional_applicable_to_products_collection.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_points_proportional_applicable_to_sku.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_stock_limited.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_card_definition_limit_time_based_period.rb +246 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_card_definition_limit_time_based_period_current_period.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_earning_limits.rb +215 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_earning_limits_global.rb +257 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_benefit.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_calendar_expiration_date.rb +241 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_rolling_expiration_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_rolling_expiration_rounding.rb +255 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_sliding_expiration_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_error.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_applicable_to_product.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_applicable_to_products_collection.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_applicable_to_sku.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_every.rb +241 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_tier_rules_any_of_entry.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_trigger_custom_event.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_trigger_limits_cooldown_fixed_cooldown_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_trigger_segment.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_validity_daily_hours.rb +244 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_cost_spending_response.rb +260 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_digital_discount_coupons.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_digital_gift_vouchers_response.rb +227 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_digital_loyalty_card_points_response.rb +227 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_material_product.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_material_sku.rb +233 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_purchase_limits_cooldown_fixed_cooldown_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_purchase_limits_frequency_limit_triggers.rb +215 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_refunds.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_validity_daily_hours_response.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_card_points_bucket_simple.rb +272 -0
- data/lib/VoucherifySdk/models/loyalty_v2_card_points_bucket_simple_points.rb +210 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_metadata.rb +220 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_rejection.rb +219 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_rejection_details.rb +231 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_spending_cap.rb +257 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_points.rb +209 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_rejection.rb +222 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result.rb +239 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_dig_lc_points.rb +231 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_digital.rb +269 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_material.rb +259 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_reward.rb +244 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb +1 -0
- data/lib/VoucherifySdk/models/member.rb +333 -0
- data/lib/VoucherifySdk/models/member_card.rb +269 -0
- data/lib/VoucherifySdk/models/member_create.rb +257 -0
- data/lib/VoucherifySdk/models/member_tier_progress.rb +293 -0
- data/lib/VoucherifySdk/models/member_tier_progress_current.rb +239 -0
- data/lib/VoucherifySdk/models/member_tier_progress_deferred.rb +230 -0
- data/lib/VoucherifySdk/models/member_tier_progress_opportunity.rb +230 -0
- data/lib/VoucherifySdk/models/member_tier_progress_points.rb +232 -0
- data/lib/VoucherifySdk/models/member_tier_progress_risk.rb +254 -0
- data/lib/VoucherifySdk/models/member_tier_progress_tier.rb +227 -0
- data/lib/VoucherifySdk/models/member_tier_progress_tier_structure.rb +253 -0
- data/lib/VoucherifySdk/models/members_report_daily_entry.rb +291 -0
- data/lib/VoucherifySdk/models/members_report_summary_entry.rb +297 -0
- data/lib/VoucherifySdk/models/membership_card.rb +278 -0
- data/lib/VoucherifySdk/models/order_payment_limit_definition.rb +215 -0
- data/lib/VoucherifySdk/models/order_payment_order.rb +232 -0
- data/lib/VoucherifySdk/models/order_payment_payment_details.rb +243 -0
- data/lib/VoucherifySdk/models/order_payment_rejection.rb +221 -0
- data/lib/VoucherifySdk/models/order_payment_transaction.rb +372 -0
- data/lib/VoucherifySdk/models/order_payment_transaction_details.rb +249 -0
- data/lib/VoucherifySdk/models/order_payment_transaction_details_spending_cap.rb +258 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_parent_object_id.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_related_object_id.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_source_id.rb +1 -1
- data/lib/VoucherifySdk/models/points_earnings_report_daily_entry.rb +331 -0
- data/lib/VoucherifySdk/models/points_earnings_report_list_filters.rb +252 -0
- data/lib/VoucherifySdk/models/points_earnings_report_summary_entry.rb +337 -0
- data/lib/VoucherifySdk/models/product_collections_products_list_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/program.rb +341 -0
- data/lib/VoucherifySdk/models/program_earning_rule_assignment.rb +264 -0
- data/lib/VoucherifySdk/models/program_list_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/program_reward_assignment.rb +302 -0
- data/lib/VoucherifySdk/models/program_reward_assignment_stock.rb +243 -0
- data/lib/VoucherifySdk/models/program_reward_assignment_stock_limited.rb +220 -0
- data/lib/VoucherifySdk/models/program_simple.rb +288 -0
- data/lib/VoucherifySdk/models/program_tier_structure_assignment.rb +264 -0
- data/lib/VoucherifySdk/models/program_validity_daily_hours.rb +234 -0
- data/lib/VoucherifySdk/models/program_validity_hours.rb +247 -0
- data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/publications_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/report_card_definition_id_filter_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/report_card_definition_id_filter_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/reward_cost_response.rb +271 -0
- data/lib/VoucherifySdk/models/reward_cost_tier_rules_any_of_entry_response.rb +234 -0
- data/lib/VoucherifySdk/models/reward_cost_tier_rules_response.rb +252 -0
- data/lib/VoucherifySdk/models/reward_digital_response.rb +261 -0
- data/lib/VoucherifySdk/models/reward_material_response.rb +252 -0
- data/lib/VoucherifySdk/models/reward_purchase_digital_coupon.rb +256 -0
- data/lib/VoucherifySdk/models/reward_purchase_digital_gift_voucher.rb +278 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits.rb +231 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_cooldown.rb +243 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_cooldown_fixed_cooldown.rb +215 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_frequency.rb +247 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_frequency_limit.rb +268 -0
- data/lib/VoucherifySdk/models/reward_purchase_refund_policies.rb +247 -0
- data/lib/VoucherifySdk/models/reward_purchase_transaction.rb +371 -0
- data/lib/VoucherifySdk/models/reward_validity_hours_response.rb +247 -0
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_report_daily_entry.rb +297 -0
- data/lib/VoucherifySdk/models/rewards_report_filter_reward_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/rewards_report_filter_reward_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/rewards_report_list_filters.rb +243 -0
- data/lib/VoucherifySdk/models/rewards_report_summary_entry.rb +309 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_daily_entry.rb +337 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_cost_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_cost_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_spending_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_spending_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_list_filters.rb +270 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_summary_entry.rb +343 -0
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/spending_report_daily_entry.rb +335 -0
- data/lib/VoucherifySdk/models/spending_report_list_filters.rb +243 -0
- data/lib/VoucherifySdk/models/spending_report_summary_entry.rb +335 -0
- data/lib/VoucherifySdk/models/tier_transaction.rb +377 -0
- data/lib/VoucherifySdk/models/tier_transaction_details.rb +272 -0
- data/lib/VoucherifySdk/models/tier_transaction_origin.rb +260 -0
- data/lib/VoucherifySdk/models/tier_transaction_rejection.rb +221 -0
- data/lib/VoucherifySdk/models/tiers_report_daily_entry.rb +336 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_structure_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_structure_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/tiers_report_list_filters.rb +252 -0
- data/lib/VoucherifySdk/models/tiers_report_summary_entry.rb +342 -0
- data/lib/VoucherifySdk/models/transaction_filter_date_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/transaction_filter_date_conditions_conditions.rb +268 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body.rb +362 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body_points.rb +237 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body_points_proportional.rb +287 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body_stock.rb +243 -0
- data/lib/VoucherifySdk/models/v2_loyalties_earning_rules_get_response_body.rb +430 -0
- data/lib/VoucherifySdk/models/v2_loyalties_earning_rules_get_response_body_trigger_limits.rb +217 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_earning_rules_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_activate_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_activities_list_request_query_filters.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_activities_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_benefits_transactions_list_request_query.rb +252 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_benefits_transactions_list_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_benefits_transactions_list_response_body_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_activities_list_request_query_filters.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_activities_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_expiring_points_expire_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_expiring_points_list_request_query.rb +252 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_expiring_points_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_activate_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_cancel_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_list_request_query.rb +243 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_points_adjust_request_body.rb +236 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_points_adjust_response_body.rb +256 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_transactions_list_request_query.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_transactions_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_create_in_bulk_response_body.rb +216 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_create_request_body.rb +257 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_create_response_body.rb +346 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_deactivate_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_delete_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_earning_rules_reports_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_get_response_body.rb +346 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_list_request_query.rb +270 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_create_request_body.rb +270 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_list_request_query.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_list_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_list_response_body_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_create_request_body.rb +247 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_list_request_query.rb +270 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_list_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_list_response_body_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_tiers_transactions_list_request_query.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_tiers_transactions_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_update_request_body.rb +210 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_update_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_memberships_get_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_earning_rules_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_earning_rules_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_points_earnings_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_points_earnings_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_tiers_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_tiers_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_rewards_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_rewards_purchases_refund_request_body.rb +208 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_rewards_purchases_refund_response_body.rb +263 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_tier_structures_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_rewards_get_response_body.rb +424 -0
- data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/vl_member_activity.rb +308 -0
- data/lib/VoucherifySdk/models/vl_member_activity_data.rb +249 -0
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +366 -0
- metadata +767 -30
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# VoucherifySdk::MembersReportSummaryEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Identifies the summary row (format: `lpmrs_` followed by hexadecimal characters). | [optional] |
|
|
8
|
+
| **members_joined** | **Float** | Counts members who joined the program. | [optional] |
|
|
9
|
+
| **members_deactivated** | **Float** | Counts members deactivated. Decreases by 1 when a member is activated again. | [optional] |
|
|
10
|
+
| **members_deleted** | **Float** | Counts members deleted. | [optional] |
|
|
11
|
+
| **cards** | **Float** | Counts cards created. Decreases by 1 when a card is unassigned (e.g. when a member is deleted). | [optional] |
|
|
12
|
+
| **object** | **String** | Object type marker. Always `program_members_summary_report`. | [optional][default to 'program_members_summary_report'] |
|
|
13
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# VoucherifySdk::MembershipCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **member_role** | **String** | Role of the member on this card. Currently, loyalty program members can have only the `OWNER` role. | [optional] |
|
|
8
|
+
| **created_at** | **Time** | Timestamp when the card was assigned to the member (ISO 8601). | [optional] |
|
|
9
|
+
| **card** | [**CardSimple**](CardSimple.md) | | [optional] |
|
|
10
|
+
| **object** | **String** | Object type marker, always `member_card`. | [optional][default to 'member_card'] |
|
|
11
|
+
| **tier_progress** | [**MemberTierProgress**](MemberTierProgress.md) | | [optional] |
|
|
12
|
+
|
data/docs/MetadataSchemasApi.md
CHANGED
|
@@ -14,7 +14,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
14
14
|
|
|
15
15
|
Get Metadata Schema
|
|
16
16
|
|
|
17
|
-
Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](/prepare/metadata#add-metadata), provide its name in the resource field to retrieve its details.
|
|
17
|
+
Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](/prepare/metadata#add-metadata), provide its name in the resource field to retrieve its details. <Note> <Badge color blue>Management API</Badge> If you have Management API enabled, you can also use the [Get Metadata Schemas](/api-reference/management/get-metadata-schema) endpoint to retrieve a metadata schema using its ID. </Note>
|
|
18
18
|
|
|
19
19
|
### Examples
|
|
20
20
|
|
|
@@ -72,7 +72,7 @@ end
|
|
|
72
72
|
|
|
73
73
|
List Metadata Schema Definitions
|
|
74
74
|
|
|
75
|
-
Retrieve metadata schema definitions.
|
|
75
|
+
Retrieve metadata schema definitions. <Note> <Badge color blue>Management API</Badge> If you have Management API enabled, you can also use the [List Metadata Schemas](/api-reference/management/list-metadata-schemas) endpoint to list all metadata schemas. </Note>
|
|
76
76
|
|
|
77
77
|
### Examples
|
|
78
78
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::OrderPaymentOrder
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Voucherify order identifier. | [optional] |
|
|
8
|
+
| **source_id** | **String** | External (source) order identifier. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# VoucherifySdk::OrderPaymentPaymentDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Payment identifier. Omitted when not set. | [optional] |
|
|
8
|
+
| **amount** | **Float** | Amount of the order paid with points. | [optional] |
|
|
9
|
+
| **points_spent** | **Float** | Number of points spent on the payment. | [optional] |
|
|
10
|
+
| **exchange_ratio** | **Float** | Points-to-amount exchange ratio evaluated from the card definition's pay-with-points formula. | [optional] |
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::OrderPaymentRejection
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reason** | **String** | Machine-readable rejection reason. Order-side: `ORDER_NOT_FOUND`, `PAYMENT_EXCEEDS_ORDER_TOTAL_AMOUNT`. Card-side (when the linked card transaction fails first): `NOT_ENOUGH_BALANCE`, `GLOBAL_SPENDING_LIMIT_EXCEEDED`, `TRANSACTION_SPENDING_LIMIT_EXCEEDED`. | [optional] |
|
|
8
|
+
| **details** | **Object** | Structured rejection context. Omitted when the reason carries no extra data (`ORDER_NOT_FOUND`, `PAYMENT_EXCEEDS_ORDER_TOTAL_AMOUNT`, `NOT_ENOUGH_BALANCE`). For `GLOBAL_SPENDING_LIMIT_EXCEEDED`: `type`, `limit`, `spendings`. For `TRANSACTION_SPENDING_LIMIT_EXCEEDED`: `type`, `limit`. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# VoucherifySdk::OrderPaymentTransaction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **program_id** | **String** | Unique identifier of the loyalty program (format `lprg_...`). | [optional] |
|
|
8
|
+
| **member_id** | **String** | Unique identifier of the program member (format `lmbr_...`). | [optional] |
|
|
9
|
+
| **created_at** | **Time** | Timestamp when the transaction was created (ISO 8601). | [optional] |
|
|
10
|
+
| **updated_at** | **Time** | Timestamp when the transaction was last updated (ISO 8601), or `null`. | [optional] |
|
|
11
|
+
| **card_id** | **String** | Unique identifier of the loyalty card the points were spent from (format `lcrd_...`). | [optional] |
|
|
12
|
+
| **id** | **String** | Identifies the order transaction (`lotx_...`). Absent on dry-run (`SIMULATED`) create responses, which are never persisted. Always present in list responses. | [optional] |
|
|
13
|
+
| **card_definition_id** | **String** | Identifies the card definition (format `lcdef_...`). | [optional] |
|
|
14
|
+
| **card_transaction_id** | **String** | Identifies of the underlying card transaction (format `lctx_...`). `null` for DRY_RUN (SIMULATED) transactions. | [optional] |
|
|
15
|
+
| **order_id** | **String** | Identifies the paid order (format `ord_...`). | [optional] |
|
|
16
|
+
| **status** | **String** | Transaction status. `PENDING` - created, awaiting processing; `PROCESSING` - being processed; `APPROVED` - completed successfully; `REJECTED` - rejected (see `details.rejection`); `SIMULATED` - dry-run create result, not persisted (not returned by list). | [optional] |
|
|
17
|
+
| **type** | **String** | Defines the transaction type. Always `PAY_WITH_POINTS`. | [optional][default to 'PAY_WITH_POINTS'] |
|
|
18
|
+
| **details** | [**OrderPaymentTransactionDetails**](OrderPaymentTransactionDetails.md) | | [optional] |
|
|
19
|
+
| **object** | **String** | Object type marker. Always `order_transaction`. | [optional][default to 'order_transaction'] |
|
|
20
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# VoucherifySdk::OrderPaymentTransactionDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reason** | **String** | Human-readable reason: \"Points spent on order payment\". | [optional] |
|
|
8
|
+
| **rejection** | [**OrderPaymentRejection**](OrderPaymentRejection.md) | | [optional] |
|
|
9
|
+
| **metadata** | **Object** | Transaction metadata. For pay-with-points transactions this contains the flattened payment limits used for the calculation: `amount_limit` for the `AMOUNT_LIMIT` type and/or `points_limit` for the `POINTS_LIMIT` type. Empty object when the default `CARD_BALANCE` limit was used or when not set. | [optional] |
|
|
10
|
+
| **payment** | [**OrderPaymentPaymentDetails**](OrderPaymentPaymentDetails.md) | | [optional] |
|
|
11
|
+
| **spending_cap** | [**OrderPaymentTransactionDetailsSpendingCap**](OrderPaymentTransactionDetailsSpendingCap.md) | | [optional] |
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::OrderPaymentTransactionDetailsSpendingCap
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Identifies which cap limited the payment. | [optional] |
|
|
8
|
+
| **unit** | **String** | Whether `value` is points or an amount. | [optional] |
|
|
9
|
+
| **value** | **Float** | Cap value in `unit`. | [optional] |
|
|
10
|
+
|
data/docs/OrdersApi.md
CHANGED
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
18
18
|
|
|
19
19
|
Create Order
|
|
20
20
|
|
|
21
|
-
Creates an order object and triggers an order creation event.
|
|
21
|
+
Creates an order object and triggers an order creation event. <Note> <Badge color blue>Upsert Mode</Badge> If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. </Note>
|
|
22
22
|
|
|
23
23
|
### Examples
|
|
24
24
|
|
|
@@ -196,7 +196,7 @@ end
|
|
|
196
196
|
|
|
197
197
|
Import Orders
|
|
198
198
|
|
|
199
|
-
|
|
199
|
+
<Warning> <Badge color yellow>Historical orders</Badge> This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. </Warning> The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint.
|
|
200
200
|
|
|
201
201
|
### Examples
|
|
202
202
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# VoucherifySdk::PointsEarningsReportDailyEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **earning_rule_id** | **String** | Identifies the earning rule (format `lern_...`). | [optional] |
|
|
8
|
+
| **earning_item_id** | **String** | Identifies the earning item that produced the points (format: `lernei_` followed by hexadecimal characters). | [optional] |
|
|
9
|
+
| **card_definition_id** | **String** | Identifies the card definition (format `lcdef_...`). | [optional] |
|
|
10
|
+
| **date** | **Date** | Identifies the start of the truncated aggregation period (`YYYY-MM-DD`). For `week` this is Monday. For `month` this is the first day. For `quarter` this is the quarter start. | [optional] |
|
|
11
|
+
| **success_count** | **Float** | Counts earning operations that credited points or added pending points in the period. | [optional] |
|
|
12
|
+
| **points** | **Float** | Sums points credited immediately by earning rules in the period. Pending points activated in the period are not included. | [optional] |
|
|
13
|
+
| **pending_points** | **Float** | Sums pending points added in the period. Activated and canceled pending points are not deducted. | [optional] |
|
|
14
|
+
| **object** | **String** | Object type marker. Always `program_points_earnings_daily_report`. | [optional][default to 'program_points_earnings_daily_report'] |
|
|
15
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::PointsEarningsReportListFilters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **junction** | **String** | Joins the field filters. Allowed values are `AND` and `OR`. Defaults to `AND`. | [optional] |
|
|
8
|
+
| **earning_rule_id** | [**EarningRuleIdFilterConditions**](EarningRuleIdFilterConditions.md) | | [optional] |
|
|
9
|
+
| **card_definition_id** | [**ReportCardDefinitionIdFilterConditions**](ReportCardDefinitionIdFilterConditions.md) | | [optional] |
|
|
10
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# VoucherifySdk::PointsEarningsReportSummaryEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **earning_rule_id** | **String** | Identifies the earning rule (format `lern_...`). | [optional] |
|
|
8
|
+
| **earning_item_id** | **String** | Identifies the earning item that produced the points (format: `lernei_` followed by hexadecimal characters). | [optional] |
|
|
9
|
+
| **card_definition_id** | **String** | Identifies the card definition (format `lcdef_...`). | [optional] |
|
|
10
|
+
| **id** | **String** | Identifies the summary row (format: `lppes_` followed by hexadecimal characters). | [optional] |
|
|
11
|
+
| **success_count** | **Float** | Counts earning operations that credited points or added pending points. | [optional] |
|
|
12
|
+
| **points** | **Float** | Sums points credited immediately by earning rules. Pending points activated later are not included. | [optional] |
|
|
13
|
+
| **pending_points** | **Float** | Sums pending points added. Activated and canceled pending points are not deducted. | [optional] |
|
|
14
|
+
| **object** | **String** | Object type marker. Always `program_points_earnings_summary_report`. | [optional][default to 'program_points_earnings_summary_report'] |
|
|
15
|
+
|
|
@@ -6,6 +6,6 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **object** | **String** | The type of the object represented by JSON. This object stores information about products and SKUs. | [optional][default to 'list'] |
|
|
8
8
|
| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of products and SKUs. | [optional][default to 'data'] |
|
|
9
|
-
| **data** | [**Array<ProductCollectionsProductsListResponseBodyDataItem>**](ProductCollectionsProductsListResponseBodyDataItem.md) |
|
|
9
|
+
| **data** | [**Array<ProductCollectionsProductsListResponseBodyDataItem>**](ProductCollectionsProductsListResponseBodyDataItem.md) | A dictionary that contains an array of products and SKUs. | [optional] |
|
|
10
10
|
| **total** | **Integer** | Total number of products & SKUs in the product collection. | [optional] |
|
|
11
11
|
|
data/docs/ProductsApi.md
CHANGED
|
@@ -26,7 +26,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
26
26
|
|
|
27
27
|
Create Product
|
|
28
28
|
|
|
29
|
-
Creates a product object.
|
|
29
|
+
Creates a product object. <Note> <Badge color blue>Upsert Mode</Badge> If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. </Note>
|
|
30
30
|
|
|
31
31
|
### Examples
|
|
32
32
|
|
|
@@ -86,7 +86,7 @@ end
|
|
|
86
86
|
|
|
87
87
|
Create SKU
|
|
88
88
|
|
|
89
|
-
This method adds product variants to a [created product](/api-reference/products/create-product).
|
|
89
|
+
This method adds product variants to a [created product](/api-reference/products/create-product). <Note> <Badge color blue>Upsert Mode</Badge> If you pass an id or a source_id that already exists in the sku database, Voucherify will return a related sku object with updated fields. </Note>
|
|
90
90
|
|
|
91
91
|
### Examples
|
|
92
92
|
|
|
@@ -388,7 +388,7 @@ end
|
|
|
388
388
|
|
|
389
389
|
Import Products using CSV
|
|
390
390
|
|
|
391
|
-
Import products into the repository using a CSV file. The CSV file has to include headers in the first line.
|
|
391
|
+
Import products into the repository using a CSV file. The CSV file has to include headers in the first line. <Note> <Badge color blue>Standard product fields mapping</Badge> - Create a **comma separated value (CSV) file** or download our CSV import template. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b82ed68d51e779443f550/Import_products_template.csv). - Supported CSV file headers: name,source_id,price,attributes,image_url,Metadata_property_name - **Name** is a **required** field. The remaining fields in the CSV template are optional. - Override/Update products **names** in Voucherify using this method. Data will be updated for each product included in the CSV file whose **source_id** matches a source ID in Voucherify. No other data can be updated other than the product name. - Note that dates and date-time attributes need to be provided in compliance with the **ISO 8601 standard**. For example, 2022-03-11T09:00:00.000Z or 2022-03-11 - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Columns that cannot be mapped to standard fields, will be mapped to **Custom attributes** and added as **products metadata**. There is no limit on the number of custom attributes that you can import as metadata. - To provide the proper data type, you need to add all custom attributes to the metadata schema **before importing the file**. Read more [here](/prepare/metadata#add-metadata). - **Product attributes** (not custom attributes) need to be separated by a comma and enclosed in double quotes, i.e attribute1,attribute2. - Headers with metadata names **cant contain white-space characters**. - If you import metadata defined in the schema as **arrays (multiple)**, you need to separate each value using a comma, for example: - array of strings: subscribed,premium - array of numbers: 123,234. - array of dates: 2000-01-01,2000-01-02 </Note> This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
|
|
392
392
|
|
|
393
393
|
### Examples
|
|
394
394
|
|
|
@@ -448,7 +448,7 @@ end
|
|
|
448
448
|
|
|
449
449
|
Import SKUs using CSV
|
|
450
450
|
|
|
451
|
-
Import SKUs into the repository using a CSV file. The CSV file has to include headers in the first line. All properties which cannot be mapped to standard SKU fields will be added to the metadata object. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b98d08c9b585083488a4c/Import_SKUS_template.csv).
|
|
451
|
+
Import SKUs into the repository using a CSV file. The CSV file has to include headers in the first line. All properties which cannot be mapped to standard SKU fields will be added to the metadata object. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b98d08c9b585083488a4c/Import_SKUS_template.csv). <Warning> <Badge color yellow>Import sequence</Badge> First import products using the [dedicated endpoint](/api-reference/products/import-products-using-csv), then import SKUs using this endpoint to properly match SKUs to products. </Warning> <Note> <Badge color blue>Standard SKU fields mapping</Badge> - **Required** fields are source_id and product_id. - Supported CSV file headers: product_id,sku,source_id,price,image_url,attributes - SKU **source_id** must be unique in the entire product catalog, no duplicates are allowed. - SKU attributes need to be in the form of a stringy-fied json, i.e.{color:blue}. These attributes must be defined in the **product** beforehand so you can import them to the SKU. - You can use this method to update the following parameters in bulk: **sku** and the sku **price**. - Columns that cannot be mapped to standard fields will be mapped to Custom attributes and added as product metadata. There is no limit on the number of custom attributes that you can import as metadata. </Note> This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).
|
|
452
452
|
|
|
453
453
|
### Examples
|
|
454
454
|
|
data/docs/Program.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# VoucherifySdk::Program
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique program identifier. | [optional] |
|
|
8
|
+
| **name** | **String** | Program name. | [optional] |
|
|
9
|
+
| **status** | **String** | Program status. | [optional] |
|
|
10
|
+
| **start_date** | **Time** | Program validity start date (ISO 8601), or `null` when not set. | [optional] |
|
|
11
|
+
| **end_date** | **Time** | Program validity end date (ISO 8601), or `null` when not set. | [optional] |
|
|
12
|
+
| **validity_hours** | [**ProgramValidityHours**](ProgramValidityHours.md) | | [optional] |
|
|
13
|
+
| **metadata** | **Object** | Arbitrary key-value metadata. Defaults to `{}`. | [optional] |
|
|
14
|
+
| **created_at** | **Time** | Creation timestamp (ISO 8601). | [optional] |
|
|
15
|
+
| **updated_at** | **Time** | Last update timestamp (ISO 8601), or `null` when never updated. | [optional] |
|
|
16
|
+
| **object** | **String** | Object type marker. | [optional][default to 'program'] |
|
|
17
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramEarningRuleAssignment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **earning_rule_id** | **String** | Unique earning rule identifier. | [optional] |
|
|
8
|
+
| **created_at** | **Time** | Assignment creation timestamp (ISO 8601). | [optional] |
|
|
9
|
+
| **object** | **String** | Object type marker. Always `program_earning_rule`. | [optional][default to 'program_earning_rule'] |
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramListCursor
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_next** | **String** | Cursor id to pass as the `cursor` query parameter in the next request. | [optional] |
|
|
8
|
+
| **expires_at** | **Time** | Timestamp after which the cursor expires and can no longer be used. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramRewardAssignment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reward_id** | **String** | Unique reward identifier. | [optional] |
|
|
8
|
+
| **stock** | [**ProgramRewardAssignmentStock**](ProgramRewardAssignmentStock.md) | | |
|
|
9
|
+
| **redeemed** | **Float** | Number of times the reward has been redeemed within the program. Defaults to 0. | [optional] |
|
|
10
|
+
| **created_at** | **Time** | Assignment creation timestamp (ISO 8601). | [optional] |
|
|
11
|
+
| **updated_at** | **Time** | Last update timestamp (ISO 8601), or `null` when never updated. | [optional] |
|
|
12
|
+
| **object** | **String** | Object type marker. Always `program_reward`. | [optional][default to 'program_reward'] |
|
|
13
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramRewardAssignmentStock
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Stock type. | [optional] |
|
|
8
|
+
| **limited** | [**ProgramRewardAssignmentStockLimited**](ProgramRewardAssignmentStockLimited.md) | | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramRewardAssignmentStockLimited
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **quantity** | **Integer** | Available stock quantity. For responses, updates with each reward purchase. | [optional] |
|
|
8
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramSimple
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique program identifier. | [optional] |
|
|
8
|
+
| **name** | **String** | Program name. | [optional] |
|
|
9
|
+
| **status** | **String** | Program status. | [optional] |
|
|
10
|
+
| **metadata** | **Object** | User-defined key-value metadata. Defaults to `{}`. | [optional] |
|
|
11
|
+
| **object** | **String** | Object type marker. Always `program`. | [optional][default to 'program'] |
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramTierStructureAssignment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **tier_structure_id** | **String** | Unique tier structure identifier. | [optional] |
|
|
8
|
+
| **created_at** | **Time** | Assignment creation timestamp (ISO 8601). | [optional] |
|
|
9
|
+
| **object** | **String** | Object type marker. | [optional][default to 'program_tier_structure'] |
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramValidityDailyHours
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **days_of_week** | **Array<Integer>** | Days of week the window applies to. 0 = Sunday through 6 = Saturday. | [optional] |
|
|
8
|
+
| **start_time** | **String** | Window start time in `HH:mm` format. | [optional] |
|
|
9
|
+
| **end_time** | **String** | Window end time in `HH:mm` format. | [optional] |
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::ProgramValidityHours
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Validity hours mode. | [optional] |
|
|
8
|
+
| **daily** | [**Array<ProgramValidityDailyHours>**](ProgramValidityDailyHours.md) | Daily validity windows. Present only when `type` is `DAILY`. | [optional] |
|
|
9
|
+
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
11
11
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
12
12
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
13
|
-
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
13
|
+
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
14
14
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
15
15
|
| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
11
11
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
12
12
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
13
|
-
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
13
|
+
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
14
14
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
15
15
|
| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
11
11
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
12
12
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
13
|
-
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
13
|
+
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
14
14
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
15
15
|
| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
11
11
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
12
12
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
13
|
-
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
13
|
+
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
14
14
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
15
15
|
| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
11
11
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
12
12
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
13
|
-
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
13
|
+
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
14
14
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
15
15
|
| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
11
11
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
12
12
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
13
|
-
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
13
|
+
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
14
14
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
15
15
|
| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
16
16
|
|
data/docs/PublicationsApi.md
CHANGED
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
15
15
|
|
|
16
16
|
Create Publication
|
|
17
17
|
|
|
18
|
-
This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet.
|
|
18
|
+
This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. <Warning> <Badge color yellow>Clearly define the source of the voucher</Badge> You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. </Warning> <Warning> <Badge color yellow>Publish multiple vouchers</Badge> In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. </Warning> <Note> <Badge color blue>Auto-update campaign</Badge> In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. </Note>
|
|
19
19
|
|
|
20
20
|
### Examples
|
|
21
21
|
|
|
@@ -77,7 +77,7 @@ end
|
|
|
77
77
|
|
|
78
78
|
Create Publication with GET
|
|
79
79
|
|
|
80
|
-
This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet.
|
|
80
|
+
This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. <Danger> <Badge color red>Limited access</Badge> Access to this endpoint is limited. This endpoint is designed for specific integrations and the API keys need to be configured to access this endpoint. Navigate to the **Dashboard** → **Project Settings** → **General** → **Integration Keys** to set up a pair of API keys and use them to send the request. </Danger> <Warning> <Badge color yellow>Clearly define the source of the voucher</Badge> You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. </Warning> <Warning> <Badge color yellow>Publish multiple vouchers</Badge> This endpoint does not support the publishing of multiple vouchers from a single campaign. In case you want to publish multiple vouchers within a single publication, you need to use a [dedicated endpoint](/api-reference/publications/create-publication). </Warning> <Note> <Badge color blue>Auto-update campaign</Badge> In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. </Note> # Example Request <Danger> <Badge color red>Required</Badge> Query param voucher OR campaign MUST be filled out. If you provide both, campaign param will be skipped. </Danger>
|
|
81
81
|
|
|
82
82
|
### Examples
|
|
83
83
|
|
|
@@ -147,7 +147,7 @@ end
|
|
|
147
147
|
|
|
148
148
|
List Publications
|
|
149
149
|
|
|
150
|
-
Retrieve a list of publications. To return a **particular** publication, you can use the source_id query parameter and provide the source_id of the publication you are looking for specifically. # Pagination
|
|
150
|
+
Retrieve a list of publications. To return a **particular** publication, you can use the source_id query parameter and provide the source_id of the publication you are looking for specifically. # Pagination <Warning> <Badge color yellow>Important!</Badge> If you want to scroll through a huge set of records, it is recommended to use the [Exports API](/api-reference/exports/create-export). This API will return an error page_over_limit if you reach a page above 1000. </Warning> # Filter Query The filters query parameter allows for joining multiple parameters with logical operators. The syntax looks as follows: ## Examples
|
|
151
151
|
|
|
152
152
|
### Examples
|
|
153
153
|
|
|
@@ -6,6 +6,6 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **object** | **String** | The type of the object represented by JSON. This object stores information about publications in a dictionary. | [optional][default to 'list'] |
|
|
8
8
|
| **data_ref** | **String** | Identifies the name of the attribute that contains the array of publications. | [optional][default to 'publications'] |
|
|
9
|
-
| **publications** | [**Array<PublicationsListResponseBodyPublicationsItem>**](PublicationsListResponseBodyPublicationsItem.md) |
|
|
9
|
+
| **publications** | [**Array<PublicationsListResponseBodyPublicationsItem>**](PublicationsListResponseBodyPublicationsItem.md) | Contains array of publication objects, voucher object will be simplified. | [optional] |
|
|
10
10
|
| **total** | **Integer** | Total number of publications. | [optional] |
|
|
11
11
|
|
data/docs/QualificationsApi.md
CHANGED
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
13
13
|
|
|
14
14
|
Check Eligibility
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
<Warning> The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign - Total amount before discount </Warning> Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version <Tip> <Badge color green>Scenario Guide</Badge> Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. </Tip> # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. # Caching Qualification has a 5-minute cache for the returned results. If you change your campaign settings or validation rules, the changes will apply to qualification results after the cache refreshes.
|
|
17
17
|
|
|
18
18
|
### Examples
|
|
19
19
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
11
11
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
12
12
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
13
|
-
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
13
|
+
| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
14
14
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
15
15
|
| **object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
16
16
|
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **exchange_ratio** | **
|
|
7
|
+
| **exchange_ratio** | **Float** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] |
|
|
8
8
|
| **points_ratio** | **Integer** | The number of loyalty points that will map to the predefined cash amount defined by the `exchange_ratio` property. | [optional] |
|
|
9
9
|
|