voucherify 8.0.2 → 8.1.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 +123 -106
- data/Gemfile.lock +20 -16
- data/README.md +260 -75
- data/VoucherifySdk.gemspec +1 -1
- data/__tests__/README.md +18 -0
- data/__tests__/lib/campaigns.rb +53 -1
- data/__tests__/lib/config.rb +21 -0
- data/__tests__/lib/loyalties.rb +2 -2
- data/__tests__/lib/utils.rb +27 -1
- data/__tests__/spec/02_campaigns_spec.rb +33 -2
- data/__tests__/spec/04_publications_spec.rb +16 -3
- data/__tests__/spec/07_vouchers_spec.rb +22 -3
- data/__tests__/spec/12_validation_rules_spec.rb +1 -15
- data/__tests__/spec/13_management_spec.rb +110 -0
- data/__tests__/spec/14_additional_properties_spec.rb +28 -0
- data/__tests__/spec/support/get_snapshot_without_uniq_keys.rb +1 -1
- data/docs/AccessSettings.md +9 -0
- data/docs/AccessSettingsAssign.md +10 -0
- data/docs/AccessSettingsUnassign.md +10 -0
- data/docs/ApplicableTo.md +21 -4
- data/docs/ApplicableToOrderItemUnitsItem.md +10 -0
- data/docs/ApplicationDetailsItem.md +14 -0
- data/docs/AreaStoreCampaignAssignment.md +1 -0
- data/docs/AsyncActionsApi.md +2 -2
- data/docs/AsyncActionsListResponseBody.md +1 -0
- data/docs/BinApi.md +4 -4
- data/docs/Bundle.md +11 -0
- data/docs/BundleIdentifiedItem.md +11 -0
- data/docs/BundleMissingItem.md +10 -0
- data/docs/Campaign.md +5 -5
- data/docs/CampaignBase.md +5 -4
- data/docs/CampaignLoyaltyCardExpirationRules.md +6 -4
- data/docs/CampaignsApi.md +209 -12
- data/docs/CampaignsCreateRequestBody.md +3 -2
- data/docs/CampaignsCreateResponseBody.md +5 -5
- data/docs/CampaignsGetResponseBody.md +5 -5
- data/docs/CampaignsImportVoucherItem.md +1 -1
- data/docs/CampaignsSummaryGetResponseBody.md +48 -0
- data/docs/CampaignsTransactionsExportCreateRequestBody.md +8 -0
- data/docs/CampaignsTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/CampaignsTransactionsExportCreateResponseBody.md +16 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParameters.md +10 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFilters.md +11 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md +8 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md +8 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyResult.md +8 -0
- data/docs/CampaignsTransactionsListResponseBody.md +12 -0
- data/docs/CampaignsUpdateRequestBody.md +2 -1
- data/docs/CampaignsUpdateResponseBody.md +5 -5
- data/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +5 -2
- data/docs/CampaignsVouchersCreateResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/CategoriesApi.md +1 -1
- data/docs/ClientQualificationsCheckEligibilityRequestBody.md +2 -1
- data/docs/ClientQualificationsCheckEligibilityRequestBodySession.md +8 -0
- data/docs/ClientRedemptionsRedeemRequestBodyOptions.md +1 -1
- data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ClientSideApi.md +2 -2
- data/docs/ClientValidationsValidateRequestBodyOptions.md +1 -1
- data/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ClientValidationsValidateResponseBody.md +1 -0
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
- data/docs/CustomerLoyalty.md +1 -1
- data/docs/CustomerSummaryOrders.md +3 -3
- data/docs/CustomerSummaryRedemptionsGift.md +2 -2
- data/docs/CustomerWithSummaryLoyaltyReferralsAssets.md +2 -1
- data/docs/CustomersApi.md +10 -10
- data/docs/CustomersCreateResponseBodyAssets.md +2 -1
- data/docs/CustomersGetResponseBodyAssets.md +2 -1
- data/docs/CustomersUpdateResponseBodyAssets.md +2 -1
- data/docs/Discount.md +4 -4
- data/docs/DiscountUnitMultipleOneUnit.md +1 -1
- data/docs/EarningRule.md +2 -0
- data/docs/EarningRuleExpirationRules.md +13 -0
- data/docs/EarningRuleLoyalty.md +1 -0
- data/docs/EarningRuleLoyaltyCustomEventMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyCustomerMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyOrderAmount.md +1 -0
- data/docs/EarningRuleLoyaltyOrderItemsAmount.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyOrderTotalAmount.md +1 -0
- data/docs/EarningRulePendingPoints.md +9 -0
- data/docs/EventSource.md +10 -0
- data/docs/EventSourceApiKey.md +9 -0
- data/docs/EventSourceUser.md +8 -0
- data/docs/ExportCampaignTransactionsFilters.md +10 -0
- data/docs/ExportParameters.md +1 -0
- data/docs/ExportsApi.md +3 -3
- data/docs/ExportsCreateRequestBodyParameters.md +1 -0
- data/docs/ExportsCreateResponseBodyParameters.md +1 -0
- data/docs/ExportsGetResponseBodyParameters.md +1 -0
- data/docs/Gift.md +3 -2
- data/docs/InapplicableTo.md +21 -4
- data/docs/InapplicableToOrderItemUnitsItem.md +10 -0
- data/docs/LoyaltiesApi.md +590 -69
- data/docs/LoyaltiesCreateCampaignRequestBody.md +3 -2
- data/docs/LoyaltiesCreateCampaignResponseBody.md +1 -1
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBody.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesGetCampaignResponseBody.md +1 -1
- data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +5 -2
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +14 -0
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceRequestBody.md +8 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBody.md +12 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +1 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodySession.md +8 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherGift.md +3 -2
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +5 -2
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/LoyaltiesPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParameters.md +1 -1
- data/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +1 -1
- data/docs/LoyaltiesTransactionsExportCreateRequestBody.md +8 -0
- data/docs/LoyaltiesTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/LoyaltiesTransactionsListResponseBody.md +12 -0
- data/docs/LoyaltiesUpdateCampaignRequestBody.md +2 -1
- data/docs/LoyaltiesUpdateCampaignResponseBody.md +1 -1
- data/docs/LoyaltyCampaign.md +1 -1
- data/docs/LoyaltyCardTransaction.md +1 -1
- data/docs/LoyaltyCardTransactionDetails.md +2 -0
- data/docs/LoyaltyCardTransactionDetailsBalance.md +1 -0
- data/docs/LoyaltyCardTransactionDetailsEarningRule.md +1 -1
- data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/LoyaltyMemberLoyaltyCard.md +5 -2
- data/docs/LoyaltyPendingPoints.md +17 -0
- data/docs/LoyaltyPendingPointsDetails.md +12 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRule.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +8 -0
- data/docs/LoyaltyPendingPointsDetailsEvent.md +14 -0
- data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsOrder.md +9 -0
- data/docs/LoyaltyPointsBucket.md +1 -1
- data/docs/LoyaltyTierExpiration.md +1 -1
- data/docs/LoyaltyTiersExpirationAll.md +1 -1
- data/docs/ManagementApi.md +22 -22
- data/docs/ManagementProjectsStackingRules.md +14 -8
- data/docs/ManagementProjectsStackingRulesCreateRequestBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesCreateResponseBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesGetResponseBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesUpdateRequestBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesUpdateResponseBody.md +14 -8
- data/docs/ManagementProjectsUsersInviteCreateRequestBody.md +1 -1
- data/docs/ManagementProjectsUsersUpdateRoleRequestBody.md +1 -1
- data/docs/MetadataSchemasApi.md +5 -5
- data/docs/Order.md +3 -3
- data/docs/OrderCalculated.md +11 -11
- data/docs/OrderCalculatedItem.md +2 -1
- data/docs/OrderItem.md +1 -1
- data/docs/OrderRedemptionsEntry.md +1 -1
- data/docs/OrdersApi.md +3 -3
- data/docs/OrdersCreateRequestBody.md +3 -3
- data/docs/OrdersCreateResponseBody.md +11 -11
- data/docs/OrdersGetResponseBody.md +11 -11
- data/docs/OrdersImportCreateRequestBodyItem.md +4 -4
- data/docs/OrdersUpdateRequestBody.md +3 -3
- data/docs/OrdersUpdateResponseBody.md +11 -11
- data/docs/ParameterOrderListPendingPoints.md +7 -0
- data/docs/ParametersFiltersListCampaignTransactions.md +10 -0
- data/docs/ProductCollectionsCreateRequestBody.md +1 -1
- data/docs/ProductsApi.md +22 -22
- data/docs/ProductsSkusCreateRequestBody.md +1 -1
- data/docs/ProductsSkusUpdateRequestBody.md +1 -1
- 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 +7 -7
- data/docs/QualificationsApi.md +1 -1
- data/docs/QualificationsCheckEligibilityRequestBody.md +2 -1
- data/docs/QualificationsCheckEligibilityRequestBodySession.md +8 -0
- data/docs/QualificationsOption.md +1 -1
- data/docs/QualificationsRedeemable.md +1 -1
- data/docs/QualificationsRedeemableBase.md +1 -1
- data/docs/RedeemableGift.md +3 -2
- data/docs/RedeemableLoyaltyCard.md +2 -2
- data/docs/RedeemableResult.md +1 -0
- data/docs/RedeemableVoucherGift.md +3 -2
- data/docs/RedeemableVoucherLoyaltyCard.md +5 -2
- data/docs/Redemption.md +1 -0
- data/docs/RedemptionEntry.md +1 -0
- data/docs/RedemptionEntryOrder.md +11 -11
- data/docs/RedemptionEntryPromotionTierCampaign.md +1 -1
- data/docs/RedemptionEntryRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionEntrySession.md +8 -0
- data/docs/RedemptionEntryVoucherGift.md +3 -2
- data/docs/RedemptionEntryVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionRewardResultParametersCampaign.md +1 -1
- data/docs/RedemptionRollback.md +1 -1
- data/docs/RedemptionSession.md +8 -0
- data/docs/RedemptionVoucherGift.md +3 -2
- data/docs/RedemptionVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsGetResponseBody.md +1 -0
- data/docs/RedemptionsGetResponseBodyOrder.md +11 -11
- data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionsGetResponseBodySession.md +8 -0
- data/docs/RedemptionsGetResponseBodyVoucherGift.md +3 -2
- data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionsListResponseBodyRedemptionsItem.md +1 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +11 -11
- data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemSession.md +8 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherGift.md +3 -2
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -1
- data/docs/RedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/RedemptionsRollbackCreateResponseBody.md +1 -1
- data/docs/ReferralsApi.md +13 -13
- data/docs/Reward.md +1 -1
- data/docs/RewardsCreateRequestBody.md +1 -1
- data/docs/RewardsCreateRequestBodyParametersCampaign.md +1 -1
- data/docs/RewardsCreateResponseBody.md +1 -1
- data/docs/RewardsUpdateRequestBody.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCampaign.md +1 -1
- data/docs/RewardsUpdateResponseBody.md +1 -1
- data/docs/SegmentsApi.md +2 -2
- data/docs/SegmentsCreateRequestBody.md +1 -1
- data/docs/SegmentsCreateResponseBody.md +4 -3
- data/docs/SegmentsGetResponseBody.md +4 -3
- data/docs/SimpleLoyaltyCard.md +5 -2
- data/docs/SimpleVoucherRedemption.md +1 -0
- data/docs/StackingRules.md +15 -11
- data/docs/TemplatesApi.md +7 -7
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +3 -2
- data/docs/TrashBinItem.md +1 -1
- data/docs/ValidationRule.md +1 -0
- data/docs/ValidationRulesApi.md +3 -3
- data/docs/ValidationRulesCreateRequestBody.md +1 -0
- data/docs/ValidationRulesCreateResponseBody.md +1 -0
- data/docs/ValidationRulesGetResponseBody.md +1 -0
- data/docs/ValidationRulesUpdateRequestBody.md +1 -0
- data/docs/ValidationRulesUpdateResponseBody.md +1 -0
- data/docs/ValidationsApi.md +1 -1
- data/docs/ValidationsRedeemableInapplicableResult.md +1 -0
- data/docs/ValidationsValidateRequestBodyOptions.md +1 -1
- data/docs/ValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ValidationsValidateResponseBody.md +1 -0
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
- data/docs/ValidityHours.md +1 -1
- data/docs/VoucherBalance.md +1 -0
- data/docs/VoucherGift.md +3 -2
- data/docs/VoucherLoyaltyCard.md +5 -2
- data/docs/VoucherTransaction.md +1 -1
- data/docs/VoucherTransactionDetails.md +2 -0
- data/docs/VoucherTransactionDetailsBalance.md +1 -0
- data/docs/VoucherTransactionDetailsCustomEvent.md +2 -2
- data/docs/VoucherTransactionDetailsEarningRule.md +1 -1
- data/docs/VoucherTransactionDetailsEventSchema.md +2 -2
- data/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/VoucherTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/VoucherTransactionDetailsRollback.md +1 -1
- data/docs/VoucherTransactionDetailsSegment.md +2 -2
- data/docs/VoucherTransactionsExportParameters.md +1 -1
- data/docs/VoucherTransactionsFilters.md +1 -1
- data/docs/VoucherWithCategoriesGift.md +3 -2
- data/docs/VoucherWithCategoriesLoyaltyCard.md +5 -2
- data/docs/VouchersApi.md +16 -14
- data/docs/VouchersBalanceUpdateRequestBody.md +1 -1
- data/docs/VouchersBalanceUpdateResponseBody.md +2 -2
- data/docs/VouchersCreateRequestBody.md +2 -2
- data/docs/VouchersCreateResponseBodyGift.md +3 -2
- data/docs/VouchersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersCreateWithSpecificCodeRequestBody.md +2 -2
- data/docs/VouchersDisableResponseBodyGift.md +3 -2
- data/docs/VouchersDisableResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersEnableResponseBodyGift.md +3 -2
- data/docs/VouchersEnableResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersGetResponseBodyGift.md +3 -2
- data/docs/VouchersGetResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersImportCreateItemRequestBody.md +1 -1
- data/docs/VouchersTransactionsExportCreateResponseBodyResult.md +1 -1
- data/docs/VouchersUpdateRequestBody.md +2 -2
- data/docs/VouchersUpdateResponseBodyGift.md +3 -2
- data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +5 -2
- data/lib/VoucherifySdk/api/async_actions_api.rb +4 -4
- data/lib/VoucherifySdk/api/bin_api.rb +4 -4
- data/lib/VoucherifySdk/api/campaigns_api.rb +220 -18
- data/lib/VoucherifySdk/api/categories_api.rb +2 -2
- data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
- data/lib/VoucherifySdk/api/customers_api.rb +14 -14
- data/lib/VoucherifySdk/api/exports_api.rb +6 -6
- data/lib/VoucherifySdk/api/loyalties_api.rb +599 -68
- data/lib/VoucherifySdk/api/management_api.rb +44 -44
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +6 -6
- data/lib/VoucherifySdk/api/orders_api.rb +6 -6
- data/lib/VoucherifySdk/api/products_api.rb +30 -30
- data/lib/VoucherifySdk/api/publications_api.rb +8 -8
- 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 +14 -14
- data/lib/VoucherifySdk/api/segments_api.rb +4 -4
- data/lib/VoucherifySdk/api/templates_api.rb +14 -14
- data/lib/VoucherifySdk/api/validation_rules_api.rb +6 -6
- data/lib/VoucherifySdk/api/validations_api.rb +2 -2
- data/lib/VoucherifySdk/api/vouchers_api.rb +25 -22
- data/lib/VoucherifySdk/models/access_settings.rb +219 -0
- data/lib/VoucherifySdk/models/access_settings_assign.rb +238 -0
- data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
- data/lib/VoucherifySdk/models/access_settings_unassign.rb +238 -0
- data/lib/VoucherifySdk/models/applicable_to.rb +207 -18
- data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +235 -0
- data/lib/VoucherifySdk/models/application_details_item.rb +284 -0
- data/lib/VoucherifySdk/models/area_store_campaign_assignment.rb +12 -1
- data/lib/VoucherifySdk/models/async_actions_list_response_body.rb +16 -5
- data/lib/VoucherifySdk/models/bundle.rb +267 -0
- data/lib/VoucherifySdk/models/bundle_identified_item.rb +296 -0
- data/lib/VoucherifySdk/models/bundle_missing_item.rb +274 -0
- data/lib/VoucherifySdk/models/campaign.rb +17 -17
- data/lib/VoucherifySdk/models/campaign_base.rb +17 -8
- data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +53 -10
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +13 -4
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +17 -17
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +17 -17
- data/lib/VoucherifySdk/models/campaigns_import_voucher_item.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_summary_get_response_body.rb +673 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body.rb +334 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters.rb +257 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id.rb +209 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id_conditions.rb +221 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_result.rb +210 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +11 -2
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +17 -17
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb +12 -2
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body_session.rb +236 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result.rb +11 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +5 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
- data/lib/VoucherifySdk/models/create_publication_campaign.rb +3 -3
- data/lib/VoucherifySdk/models/customer_loyalty.rb +1 -1
- data/lib/VoucherifySdk/models/customer_summary_orders.rb +4 -3
- data/lib/VoucherifySdk/models/customer_summary_redemptions_gift.rb +2 -2
- data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_create_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_get_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_update_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/discount.rb +5 -1
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -0
- data/lib/VoucherifySdk/models/earning_rule.rb +20 -1
- data/lib/VoucherifySdk/models/earning_rule_expiration_rules.rb +313 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/earning_rule_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/event_source.rb +254 -0
- data/lib/VoucherifySdk/models/event_source_api_key.rb +221 -0
- data/lib/VoucherifySdk/models/event_source_user.rb +210 -0
- data/lib/VoucherifySdk/models/export_campaign_transactions_filters.rb +248 -0
- data/lib/VoucherifySdk/models/export_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +0 -1
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/filter_conditions_date_time.rb +2 -2
- data/lib/VoucherifySdk/models/gift.rb +14 -3
- data/lib/VoucherifySdk/models/inapplicable_to.rb +207 -18
- data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +235 -0
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +13 -4
- data/lib/VoucherifySdk/models/loyalties_create_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item.rb +22 -3
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb +22 -3
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_get_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +309 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_request_body.rb +210 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_session.rb +210 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_points_expiration_export_create_request_body_parameters.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/loyalties_transactions_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +11 -2
- data/lib/VoucherifySdk/models/loyalties_update_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +20 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +12 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +2 -1
- data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalty_member_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_pending_points.rb +314 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details.rb +249 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule_source.rb +210 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_event.rb +302 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_order.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb +1 -1
- data/lib/VoucherifySdk/models/management_projects_stacking_rules.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_request_body.rb +116 -13
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_request_body.rb +116 -13
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_users_invite_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/management_projects_users_update_role_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/order.rb +3 -3
- data/lib/VoucherifySdk/models/order_calculated.rb +28 -28
- data/lib/VoucherifySdk/models/order_calculated_item.rb +18 -6
- data/lib/VoucherifySdk/models/order_item.rb +1 -1
- data/lib/VoucherifySdk/models/order_redemptions_entry.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +17 -17
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status.rb +2 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status_conditions.rb +1 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_category_ids.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_is_referral_code.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_order_list_pending_points.rb +40 -0
- data/lib/VoucherifySdk/models/parameters_filters_list_campaign_transactions.rb +247 -0
- data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +2 -4
- data/lib/VoucherifySdk/models/products_skus_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_update_request_body.rb +1 -1
- 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/qualifications_check_eligibility_request_body.rb +12 -2
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body_session.rb +236 -0
- data/lib/VoucherifySdk/models/qualifications_option.rb +4 -4
- data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type_conditions.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +1 -1
- data/lib/VoucherifySdk/models/redeemable_gift.rb +18 -7
- data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +2 -2
- data/lib/VoucherifySdk/models/redeemable_result.rb +10 -1
- data/lib/VoucherifySdk/models/redeemable_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redeemable_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redemption.rb +11 -1
- data/lib/VoucherifySdk/models/redemption_entry.rb +11 -1
- data/lib/VoucherifySdk/models/redemption_entry_order.rb +28 -28
- data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemption_entry_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemption_entry_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_rollback.rb +15 -15
- data/lib/VoucherifySdk/models/redemption_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemption_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +28 -28
- data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemptions_get_response_body_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +11 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +27 -28
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions.rb +0 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_rollback_create_response_body.rb +15 -15
- data/lib/VoucherifySdk/models/reward.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/segments_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/segments_create_response_body.rb +31 -20
- data/lib/VoucherifySdk/models/segments_get_response_body.rb +32 -21
- data/lib/VoucherifySdk/models/simple_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/simple_voucher_redemption.rb +16 -5
- data/lib/VoucherifySdk/models/stacking_rules.rb +72 -20
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +13 -4
- data/lib/VoucherifySdk/models/trash_bin_item.rb +1 -1
- data/lib/VoucherifySdk/models/validation_rule.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable_result.rb +14 -5
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result.rb +11 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +5 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
- data/lib/VoucherifySdk/models/validity_hours.rb +1 -1
- data/lib/VoucherifySdk/models/validity_hours_daily_item.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_balance.rb +12 -1
- data/lib/VoucherifySdk/models/voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/voucher_transaction.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details.rb +20 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +12 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +2 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_parameters.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transactions_filters.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_with_categories_gift.rb +14 -3
- data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_balance_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_create_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_create_with_specific_code_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_get_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_import_create_item_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_transactions_export_create_response_body_result.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_update_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_update_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +85 -0
- metadata +210 -36
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Custom, unique name for set of validation rules. | [optional] |
|
|
8
8
|
| **rules** | **Object** | Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. | [optional] |
|
|
9
|
+
| **bundle_rules** | **Object** | Contains all the definitions for the bundle rules. It is a set of key value pairs representing the rules and logic between them. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. While updating with the PUT method, you can pass `\"bundle_rules\": null` to delete the configuration; in the response, an empty object is then returned. | [optional] |
|
|
9
10
|
| **error** | [**ValidationRulesCreateResponseBodyError**](ValidationRulesCreateResponseBodyError.md) | | [optional] |
|
|
10
11
|
| **applicable_to** | [**ValidationRulesCreateResponseBodyApplicableTo**](ValidationRulesCreateResponseBodyApplicableTo.md) | | [optional] |
|
|
11
12
|
| **type** | **String** | Type of validation rule. | [optional][default to 'expression'] |
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Custom, unique name for set of validation rules. | [optional] |
|
|
8
8
|
| **rules** | **Object** | Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. | [optional] |
|
|
9
|
+
| **bundle_rules** | **Object** | Contains all the definitions for the bundle rules. It is a set of key value pairs representing the rules and logic between them. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. While updating with the PUT method, you can pass `\"bundle_rules\": null` to delete the configuration; in the response, an empty object is then returned. | [optional] |
|
|
9
10
|
| **error** | [**ValidationRulesGetResponseBodyError**](ValidationRulesGetResponseBodyError.md) | | [optional] |
|
|
10
11
|
| **applicable_to** | [**ValidationRulesGetResponseBodyApplicableTo**](ValidationRulesGetResponseBodyApplicableTo.md) | | [optional] |
|
|
11
12
|
| **type** | **String** | Type of validation rule. | [optional][default to 'expression'] |
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Custom, unique name for set of validation rules. | [optional] |
|
|
8
8
|
| **rules** | **Object** | Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. | [optional] |
|
|
9
|
+
| **bundle_rules** | **Object** | Contains all the definitions for the bundle rules. It is a set of key value pairs representing the rules and logic between them. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. While updating with the PUT method, you can pass `\"bundle_rules\": null` to delete the configuration; in the response, an empty object is then returned. | [optional] |
|
|
9
10
|
| **error** | [**ValidationRulesUpdateRequestBodyError**](ValidationRulesUpdateRequestBodyError.md) | | [optional] |
|
|
10
11
|
| **applicable_to** | [**ValidationRulesUpdateRequestBodyApplicableTo**](ValidationRulesUpdateRequestBodyApplicableTo.md) | | [optional] |
|
|
11
12
|
| **type** | **String** | Type of validation rule. | [optional][default to 'expression'] |
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Custom, unique name for set of validation rules. | [optional] |
|
|
8
8
|
| **rules** | **Object** | Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. | [optional] |
|
|
9
|
+
| **bundle_rules** | **Object** | Contains all the definitions for the bundle rules. It is a set of key value pairs representing the rules and logic between them. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. While updating with the PUT method, you can pass `\"bundle_rules\": null` to delete the configuration; in the response, an empty object is then returned. | [optional] |
|
|
9
10
|
| **error** | [**ValidationRulesUpdateResponseBodyError**](ValidationRulesUpdateResponseBodyError.md) | | [optional] |
|
|
10
11
|
| **applicable_to** | [**ValidationRulesUpdateResponseBodyApplicableTo**](ValidationRulesUpdateResponseBodyApplicableTo.md) | | [optional] |
|
|
11
12
|
| **type** | **String** | Type of validation rule. | [optional][default to 'expression'] |
|
data/docs/ValidationsApi.md
CHANGED
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
13
13
|
|
|
14
14
|
Validate Stackable Discounts
|
|
15
15
|
|
|
16
|
-
Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys.
|
|
16
|
+
Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint.
|
|
17
17
|
|
|
18
18
|
### Examples
|
|
19
19
|
|
|
@@ -6,4 +6,5 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
8
|
| **details** | [**ValidationsRedeemableInapplicableResultDetails**](ValidationsRedeemableInapplicableResultDetails.md) | | [optional] |
|
|
9
|
+
| **bundle** | [**Bundle**](Bundle.md) | | [optional] |
|
|
9
10
|
|
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **expand** | **Array<String>** | The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br
|
|
7
|
+
| **expand** | **Array<String>** | The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br />- Order data with calculated discounts are listed in each child redeemable object.<br />- Metadata not included for each discount type. | | [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. | | [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br />- Includes `metadata` for each discount type. | | [\"category\"] | - Returns an expanded `categories` object, showing details about the category. | | [optional] |
|
|
8
8
|
|
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **credits** | **Integer** | The number of credits that the user wants to use from the gift card to fulfill the order. The value of credits cannot be higher than the current balance on the gift card.
|
|
7
|
+
| **credits** | **Integer** | The number of credits that the user wants to use from the gift card to fulfill the order. The value of credits cannot be higher than the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
8
|
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier of the validation, assigned by Voucherify. | [optional] |
|
|
7
8
|
| **valid** | **Boolean** | The result of the validation. It takes all of the redeemables into account and returns a `false` if at least one redeemable is inapplicable. Returns `true` if all redeemables are applicable. | [optional] |
|
|
8
9
|
| **redeemables** | [**Array<ValidationsValidateResponseBodyRedeemablesItem>**](ValidationsValidateResponseBodyRedeemablesItem.md) | | [optional] |
|
|
9
10
|
| **skipped_redeemables** | [**Array<ValidationsRedeemableSkipped>**](ValidationsRedeemableSkipped.md) | Lists validation results of each skipped redeemable. | [optional] |
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **discount** | [**ValidationsValidateResponseBodyRedeemablesItemResultDiscount**](ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md) | | [optional] |
|
|
8
|
+
| **bundle** | [**Bundle**](Bundle.md) | | [optional] |
|
|
8
9
|
| **gift** | [**ValidationsValidateResponseBodyRedeemablesItemResultGift**](ValidationsValidateResponseBodyRedeemablesItemResultGift.md) | | [optional] |
|
|
9
10
|
| **loyalty_card** | [**ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard**](ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md) | | [optional] |
|
|
10
11
|
| **error** | [**Error**](Error.md) | | [optional] |
|
|
@@ -6,19 +6,19 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **type** | **String** | | [optional] |
|
|
8
8
|
| **amount_off** | **Float** | Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. | [optional] |
|
|
9
|
-
| **amount_off_formula** | **String** |
|
|
9
|
+
| **amount_off_formula** | **String** | Formula used to dynamically calculate the discount. | [optional] |
|
|
10
10
|
| **aggregated_amount_limit** | **Integer** | Maximum discount amount per order. | [optional] |
|
|
11
11
|
| **effect** | **String** | | [optional] |
|
|
12
12
|
| **is_dynamic** | **Boolean** | Flag indicating whether the discount was calculated using a formula. | [optional] |
|
|
13
13
|
| **unit_off** | **Integer** | Number of units to be granted a full value discount. | [optional] |
|
|
14
|
-
| **unit_off_formula** | **String** |
|
|
14
|
+
| **unit_off_formula** | **String** | Formula used to dynamically calculate the number of units. | [optional] |
|
|
15
15
|
| **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
|
|
16
16
|
| **product** | [**ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct**](ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md) | | [optional] |
|
|
17
17
|
| **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) | | [optional] |
|
|
18
18
|
| **units** | [**Array<DiscountUnitMultipleOneUnit>**](DiscountUnitMultipleOneUnit.md) | | [optional] |
|
|
19
19
|
| **percent_off** | **Float** | The percent discount that the customer will receive. | [optional] |
|
|
20
|
-
| **percent_off_formula** | **String** |
|
|
20
|
+
| **percent_off_formula** | **String** | Formula used to dynamically calculate the discount. | [optional] |
|
|
21
21
|
| **amount_limit** | **Float** | Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] |
|
|
22
22
|
| **fixed_amount** | **Float** | Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the `fixed_amount_formula` parameter is present in the fixed amount definition, this value becomes the **fallback value**. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value. | [optional] |
|
|
23
|
-
| **fixed_amount_formula** | **String** |
|
|
23
|
+
| **fixed_amount_formula** | **String** | Formula used to dynamically calculate the discount. | [optional] |
|
|
24
24
|
|
|
@@ -4,5 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
7
|
+
| **balance** | **Integer** | Available funds at the moment of validation. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
|
+
| **credits** | **Integer** | Total number of gift card credits to be applied. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
9
|
|
data/docs/ValidityHours.md
CHANGED
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **daily** | [**Array<ValidityHoursDailyItem>**](ValidityHoursDailyItem.md) | Defines the
|
|
7
|
+
| **daily** | [**Array<ValidityHoursDailyItem>**](ValidityHoursDailyItem.md) | Defines the recurring period(s) when the resource is active. The periods should not overlap. | [optional] |
|
|
8
8
|
|
data/docs/VoucherBalance.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **type** | **String** | The type of voucher whose balance is being adjusted due to the transaction. | [optional] |
|
|
8
8
|
| **total** | **Integer** | The number of all points or credits accumulated on the card as affected by add or subtract operations. | [optional] |
|
|
9
9
|
| **object** | **String** | The type of the object represented by the JSON. | [optional][default to 'balance'] |
|
|
10
|
+
| **amount** | **Integer** | Credits added or subtracted on a gift card. | [optional] |
|
|
10
11
|
| **points** | **Integer** | Points added or subtracted in the transaction of a loyalty card. | [optional] |
|
|
11
12
|
| **balance** | **Integer** | The available points or credits on the card after the transaction as affected by redemption or rollback. | [optional] |
|
|
12
13
|
| **operation_type** | **String** | The type of the operation being performed. The operation type is `AUTOMATIC` if it is an automatic redemption. | [optional] |
|
data/docs/VoucherGift.md
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **amount** | **Integer** | Total gift card income over the lifetime of the card.
|
|
8
|
-
| **
|
|
7
|
+
| **amount** | **Integer** | Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
|
+
| **subtracted_amount** | **Integer** | Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
9
|
+
| **balance** | **Integer** | Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
9
10
|
| **effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] |
|
|
10
11
|
|
data/docs/VoucherLoyaltyCard.md
CHANGED
|
@@ -4,8 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **points** | **Integer** | Total points
|
|
8
|
-
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
|
7
|
+
| **points** | **Integer** | Total number of points added to the loyalty card over its lifespan. | [optional] |
|
|
8
|
+
| **balance** | **Integer** | Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`. | [optional] |
|
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
|
11
|
+
| **pending_points** | **Integer** | Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually. | [optional] |
|
|
12
|
+
| **expired_points** | **Integer** | Shows the total number of expired points over the lifetime of the loyalty card. | [optional] |
|
|
13
|
+
| **subtracted_points** | **Integer** | Shows the total number of subtracted points over the lifetime of the loyalty card. | [optional] |
|
|
11
14
|
|
data/docs/VoucherTransaction.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **source_id** | **String** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] |
|
|
9
9
|
| **voucher_id** | **String** | Unique voucher ID. | [optional] |
|
|
10
10
|
| **campaign_id** | **String** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] |
|
|
11
|
-
| **source** | **String** | The channel through which the transaction took place, whether through the API or the
|
|
11
|
+
| **source** | **String** | The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. | [optional] |
|
|
12
12
|
| **reason** | **String** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] |
|
|
13
13
|
| **related_transaction_id** | **String** | The related transaction ID on the receiving card. | [optional] |
|
|
14
14
|
| **created_at** | **Time** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
@@ -14,6 +14,8 @@
|
|
|
14
14
|
| **rollback** | [**VoucherTransactionDetailsRollback**](VoucherTransactionDetailsRollback.md) | | [optional] |
|
|
15
15
|
| **custom_event** | [**VoucherTransactionDetailsCustomEvent**](VoucherTransactionDetailsCustomEvent.md) | | [optional] |
|
|
16
16
|
| **event_schema** | [**VoucherTransactionDetailsEventSchema**](VoucherTransactionDetailsEventSchema.md) | | [optional] |
|
|
17
|
+
| **holder_loyalty_tier** | [**VoucherTransactionDetailsHolderLoyaltyTier**](VoucherTransactionDetailsHolderLoyaltyTier.md) | | [optional] |
|
|
18
|
+
| **pending_points** | [**LoyaltyPendingPoints**](LoyaltyPendingPoints.md) | | [optional] |
|
|
17
19
|
| **reward** | [**VoucherTransactionDetailsReward**](VoucherTransactionDetailsReward.md) | | [optional] |
|
|
18
20
|
| **source_voucher** | [**SimpleVoucher**](SimpleVoucher.md) | | [optional] |
|
|
19
21
|
| **destination_voucher** | [**SimpleVoucher**](SimpleVoucher.md) | | [optional] |
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **type** | **String** | The type of voucher whose balance is being adjusted due to the transaction. | [optional] |
|
|
8
8
|
| **total** | **Integer** | The number of all points or credits accumulated on the card as affected by add or subtract operations. | [optional] |
|
|
9
9
|
| **object** | **String** | The type of the object represented by the JSON. | [optional][default to 'balance'] |
|
|
10
|
+
| **amount** | **Integer** | Credits added or subtracted on a gift card. | [optional] |
|
|
10
11
|
| **points** | **Integer** | Points added or subtracted in the transaction of a loyalty card. | [optional] |
|
|
11
12
|
| **balance** | **Integer** | The available points or credits on the card after the transaction as affected by redemption or rollback. | [optional] |
|
|
12
13
|
| **operation_type** | **String** | The type of the operation being performed. The operation type is `AUTOMATIC` if it is an automatic redemption. | [optional] |
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | Unique event
|
|
8
|
-
| **type** | **String** | Type of custom event. | [optional] |
|
|
7
|
+
| **id** | **String** | Unique identifier of the event. | [optional] |
|
|
8
|
+
| **type** | **String** | Type of the custom event. | [optional] |
|
|
9
9
|
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | Unique earning rule
|
|
7
|
+
| **id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | [optional] |
|
|
8
8
|
| **source** | [**VoucherTransactionDetailsEarningRuleSource**](VoucherTransactionDetailsEarningRuleSource.md) | | [optional] |
|
|
9
9
|
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | Unique metadata schema
|
|
8
|
-
| **name** | **String** | Type of custom event. | [optional] |
|
|
7
|
+
| **id** | **String** | Unique identifier of the metadata schema. | [optional] |
|
|
8
|
+
| **name** | **String** | Type of the custom event. | [optional] |
|
|
9
9
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::VoucherTransactionDetailsHolderLoyaltyTier
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] |
|
|
8
|
+
| **name** | **String** | User-defined name of the loyalty tier. | [optional] |
|
|
9
|
+
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** |
|
|
8
|
-
| **name** | **String** |
|
|
7
|
+
| **id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] |
|
|
8
|
+
| **name** | **String** | User-defined name of the loyalty tier. | [optional] |
|
|
9
9
|
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** |
|
|
8
|
-
| **name** | **String** |
|
|
7
|
+
| **id** | **String** | Unique identifier of the segment. | [optional] |
|
|
8
|
+
| **name** | **String** | Name of the segment. | [optional] |
|
|
9
9
|
|
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **order** | **String** | How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] |
|
|
8
|
-
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Unique transaction ID. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - `CREDITS_REMOVAL` <br
|
|
8
|
+
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Unique transaction ID. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - `CREDITS_REMOVAL` <br /> - `CREDITS_ADDITION` <br /> - `CREDITS_REFUND` <br /> - `CREDITS_REDEMPTION` <br /> - `POINTS_ACCRUAL` <br /> - `POINTS_REDEMPTION`<br /> - `POINTS_REFUND`<br /> - `POINTS_ADDITION`<br /> - `POINTS_REMOVAL`<br /> - `POINTS_EXPIRATION`<br /> - `POINTS_TRANSFER_IN`<br /> - `POINTS_TRANSFER_OUT` | | source_id | Unique transaction source ID. | 8638 | | reason | Contains the reason for the transaction if one was included originally. | | | balance | The gift card or loyalty card balance after the transaction. | | | amount | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | | | created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z | | voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp | | campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV | | source| Channel through which the transaction was initiated. | API | | details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. | | related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 | | [optional] |
|
|
9
9
|
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **order** | **String** | How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] |
|
|
8
|
-
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Unique transaction ID. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - `CREDITS_REMOVAL` <br
|
|
8
|
+
| **fields** | **Array<String>** | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Unique transaction ID. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - `CREDITS_REMOVAL` <br /> - `CREDITS_ADDITION` <br /> - `CREDITS_REFUND` <br /> - `CREDITS_REDEMPTION` <br /> - `POINTS_ACCRUAL`<br /> - `POINTS_REDEMPTION`<br /> - `POINTS_REFUND`<br /> - `POINTS_ADDITION`<br /> - `POINTS_REMOVAL`<br /> - `POINTS_EXPIRATION`<br /> - `POINTS_TRANSFER_IN`<br /> - `POINTS_TRANSFER_OUT` | | source_id | Unique transaction source ID. | 8638 | | reason | Contains the reason for the transaction if one was included originally. | | | balance | The gift card or loyalty card balance after the transaction. | | | amount | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | | | created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z | | voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp | | campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV | | source| Channel through which the transaction was initiated. | API | | details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. | | related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 | | [optional] |
|
|
9
9
|
| **filters** | [**VoucherTransactionsExportFilterConditions**](VoucherTransactionsExportFilterConditions.md) | | |
|
|
10
10
|
|
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **amount** | **Integer** | Total gift card income over the lifetime of the card.
|
|
8
|
-
| **
|
|
7
|
+
| **amount** | **Integer** | Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
|
+
| **subtracted_amount** | **Integer** | Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
9
|
+
| **balance** | **Integer** | Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
9
10
|
| **effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] |
|
|
10
11
|
|
|
@@ -4,8 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **points** | **Integer** | Total points
|
|
8
|
-
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
|
7
|
+
| **points** | **Integer** | Total number of points added to the loyalty card over its lifespan. | [optional] |
|
|
8
|
+
| **balance** | **Integer** | Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`. | [optional] |
|
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
|
11
|
+
| **pending_points** | **Integer** | Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually. | [optional] |
|
|
12
|
+
| **expired_points** | **Integer** | Shows the total number of expired points over the lifetime of the loyalty card. | [optional] |
|
|
13
|
+
| **subtracted_points** | **Integer** | Shows the total number of subtracted points over the lifetime of the loyalty card. | [optional] |
|
|
11
14
|
|
data/docs/VouchersApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
17
17
|
| [**list_vouchers**](VouchersApi.md#list_vouchers) | **GET** /v1/vouchers | List Vouchers |
|
|
18
18
|
| [**release_validation_session**](VouchersApi.md#release_validation_session) | **DELETE** /v1/vouchers/{code}/sessions/{sessionKey} | Release Validation Session |
|
|
19
19
|
| [**update_voucher**](VouchersApi.md#update_voucher) | **PUT** /v1/vouchers/{code} | Update Voucher |
|
|
20
|
-
| [**update_voucher_balance**](VouchersApi.md#update_voucher_balance) | **POST** /v1/vouchers/{code}/balance |
|
|
20
|
+
| [**update_voucher_balance**](VouchersApi.md#update_voucher_balance) | **POST** /v1/vouchers/{code}/balance | Adjust Voucher Balance |
|
|
21
21
|
| [**update_vouchers_in_bulk**](VouchersApi.md#update_vouchers_in_bulk) | **POST** /v1/vouchers/bulk/async | Update Vouchers in Bulk |
|
|
22
22
|
| [**update_vouchers_metadata_in_bulk**](VouchersApi.md#update_vouchers_metadata_in_bulk) | **POST** /v1/vouchers/metadata/async | Update Vouchers' Metadata in Bulk |
|
|
23
23
|
|
|
@@ -28,7 +28,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
28
28
|
|
|
29
29
|
Create Voucher
|
|
30
30
|
|
|
31
|
-
Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it.
|
|
31
|
+
Create a generic (standalone) voucher or a voucher in a campaign. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. If no campaign name or campaign_id is provided, the new voucher will be a generic (standalone) one. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to this campaign. For a loyalty card, a campaign name or ID is required. 🚧 Standalone Vouchers and Campaigns Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers created through The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint.
|
|
32
32
|
|
|
33
33
|
### Examples
|
|
34
34
|
|
|
@@ -90,7 +90,7 @@ end
|
|
|
90
90
|
|
|
91
91
|
Delete Voucher
|
|
92
92
|
|
|
93
|
-
Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the voucher will be moved to the bin.
|
|
93
|
+
Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the voucher will be moved to [the bin](/api-reference/bin/list-bin-entries).
|
|
94
94
|
|
|
95
95
|
### Examples
|
|
96
96
|
|
|
@@ -329,7 +329,7 @@ end
|
|
|
329
329
|
|
|
330
330
|
Generate Random Code
|
|
331
331
|
|
|
332
|
-
Create a standalone
|
|
332
|
+
Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint.
|
|
333
333
|
|
|
334
334
|
### Examples
|
|
335
335
|
|
|
@@ -447,7 +447,7 @@ end
|
|
|
447
447
|
|
|
448
448
|
Import Vouchers
|
|
449
449
|
|
|
450
|
-
Import standalone vouchers and gift cards into the repository. 📘 Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601
|
|
450
|
+
Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. 📘 Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. 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). 🚧 Standalone Vouchers and Campaigns Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. To create a generic (standalone) voucher with a type: STANDALONE, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint.
|
|
451
451
|
|
|
452
452
|
### Examples
|
|
453
453
|
|
|
@@ -505,7 +505,7 @@ end
|
|
|
505
505
|
|
|
506
506
|
Import Vouchers using CSV
|
|
507
507
|
|
|
508
|
-
Import standalone vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](
|
|
508
|
+
Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](/build/discount-code-import). ___ 📘 Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - 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 - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. 📘 Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. 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). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns Generic (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
|
|
509
509
|
|
|
510
510
|
### Examples
|
|
511
511
|
|
|
@@ -527,7 +527,8 @@ end
|
|
|
527
527
|
|
|
528
528
|
api_instance = VoucherifySdk::VouchersApi.new
|
|
529
529
|
opts = {
|
|
530
|
-
file: File.new('/path/to/some/file') # File | File path.
|
|
530
|
+
file: File.new('/path/to/some/file'), # File | File path.
|
|
531
|
+
webhooks_enable: true # Boolean | Triggers a webhook sendout for new and updated vouchers if the voucher created and voucher updated webhooks are configured in Project settings.
|
|
531
532
|
}
|
|
532
533
|
|
|
533
534
|
begin
|
|
@@ -544,6 +545,7 @@ end
|
|
|
544
545
|
| Name | Type | Description | Notes |
|
|
545
546
|
| ---- | ---- | ----------- | ----- |
|
|
546
547
|
| **file** | **File** | File path. | [optional] |
|
|
548
|
+
| **webhooks_enable** | **Boolean** | Triggers a webhook sendout for new and updated vouchers if the voucher created and voucher updated webhooks are configured in Project settings. | [optional] |
|
|
547
549
|
|
|
548
550
|
### Return type
|
|
549
551
|
|
|
@@ -711,7 +713,7 @@ end
|
|
|
711
713
|
|
|
712
714
|
Release Validation Session
|
|
713
715
|
|
|
714
|
-
Manually release a validation session that has been set up for the voucher. This method
|
|
716
|
+
Manually release a validation session that has been set up for the voucher. This method undoes the actions that are explained in the [Locking validation session](/guides/locking-validation-session) guide. 📘 Release session in the Dashboard You can also use the [Validations Manager](/optimize/validations-and-redemptions#sessions) in the Dashboard to unlock sessions.
|
|
715
717
|
|
|
716
718
|
### Examples
|
|
717
719
|
|
|
@@ -770,7 +772,7 @@ nil (empty response body)
|
|
|
770
772
|
|
|
771
773
|
Update Voucher
|
|
772
774
|
|
|
773
|
-
Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped.
|
|
775
|
+
Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped. If you want to change the amount on a gift card or the number of points on a loyalty card, use the [Adjust voucher balance](/api-reference/vouchers/adjust-voucher-balance) endpoint.
|
|
774
776
|
|
|
775
777
|
### Examples
|
|
776
778
|
|
|
@@ -828,9 +830,9 @@ end
|
|
|
828
830
|
|
|
829
831
|
> <VouchersBalanceUpdateResponseBody> update_voucher_balance(code, vouchers_balance_update_request_body)
|
|
830
832
|
|
|
831
|
-
|
|
833
|
+
Adjust Voucher Balance
|
|
832
834
|
|
|
833
|
-
Add balance to an existing gift card or loyalty card.
|
|
835
|
+
Add balance to an existing gift card or loyalty card. For loyalty cards, it must be assigned to a holder.
|
|
834
836
|
|
|
835
837
|
### Examples
|
|
836
838
|
|
|
@@ -855,7 +857,7 @@ code = 'code_example' # String | A **code** that identifies the voucher or a uni
|
|
|
855
857
|
vouchers_balance_update_request_body = VoucherifySdk::VouchersBalanceUpdateRequestBody.new # VouchersBalanceUpdateRequestBody | Provide the amount to be added to/subtracted from the voucher.
|
|
856
858
|
|
|
857
859
|
begin
|
|
858
|
-
#
|
|
860
|
+
# Adjust Voucher Balance
|
|
859
861
|
result = api_instance.update_voucher_balance(code, vouchers_balance_update_request_body)
|
|
860
862
|
p result
|
|
861
863
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -890,7 +892,7 @@ end
|
|
|
890
892
|
|
|
891
893
|
Update Vouchers in Bulk
|
|
892
894
|
|
|
893
|
-
Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported. 🚧
|
|
895
|
+
Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported. 🚧 Currently, only **metadata** updates are supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
894
896
|
|
|
895
897
|
### Examples
|
|
896
898
|
|
|
@@ -948,7 +950,7 @@ end
|
|
|
948
950
|
|
|
949
951
|
Update Vouchers' Metadata in Bulk
|
|
950
952
|
|
|
951
|
-
Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. Upserts are not supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
953
|
+
Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. Upserts are not supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
952
954
|
|
|
953
955
|
### Examples
|
|
954
956
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **amount** | **Integer** | The incremental amount to be added to or removed from the current balance on the gift card or loyalty card.
|
|
7
|
+
| **amount** | **Integer** | The incremental amount to be added to or removed from the current balance on the gift card or loyalty card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. To remove balance, simply add a minus sign before the value, i.e. to remove $20, use -2000. | [optional] |
|
|
8
8
|
| **source_id** | **String** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. | [optional] |
|
|
9
9
|
| **reason** | **String** | Reason why the transaction occurred. | [optional] |
|
|
10
10
|
|
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **amount** | **Integer** | The incremental amount added (positive integer) or subtracted (negative integer) to the current balance on the gift card or loyalty card.
|
|
7
|
+
| **amount** | **Integer** | The incremental amount added (positive integer) or subtracted (negative integer) to the current balance on the gift card or loyalty card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
8
|
| **total** | **Integer** | Total income incurred over the lifespan of the gift card or loyalty card. | [optional] |
|
|
9
|
-
| **balance** | **Integer** | The balance after adding or subtracting a specified amount.
|
|
9
|
+
| **balance** | **Integer** | The balance after adding or subtracting a specified amount. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
10
10
|
| **type** | **String** | The type of voucher being modified. | [optional] |
|
|
11
11
|
| **operation_type** | **String** | The type of the operation being performed. | [optional][default to 'MANUAL'] |
|
|
12
12
|
| **object** | **String** | The type of the object represented by JSON. Default is `balance`. | [optional][default to 'balance'] |
|
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
| **code** | **String** | Code that identifies a voucher. The pattern can use all the letters of the English alphabet, Arabic numerals, and special characters. Pass this attribute in the request body to create a distinct code. Otherwise, either use the `code_config` object to set the rules that the Voucherify API will use to create a random code, or don't pass any code and Voucherify will generate a random code. | [optional] |
|
|
8
8
|
| **campaign** | **String** | Identifies the voucher's parent campaign using a unique campaign name. | [optional] |
|
|
9
9
|
| **campaign_id** | **String** | Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API. | [optional] |
|
|
10
|
-
| **category** | **String** | The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](
|
|
11
|
-
| **category_id** | **String** | Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](
|
|
10
|
+
| **category** | **String** | The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. | [optional] |
|
|
11
|
+
| **category_id** | **String** | Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. | [optional] |
|
|
12
12
|
| **start_date** | **Time** | Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is *inactive before* this date. | [optional] |
|
|
13
13
|
| **expiration_date** | **Time** | Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is *inactive after* this date. | [optional] |
|
|
14
14
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **amount** | **Integer** | Total gift card income over the lifetime of the card.
|
|
8
|
-
| **
|
|
7
|
+
| **amount** | **Integer** | Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
|
+
| **subtracted_amount** | **Integer** | Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
9
|
+
| **balance** | **Integer** | Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
9
10
|
| **effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] |
|
|
10
11
|
|
|
@@ -4,8 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **points** | **Integer** | Total points
|
|
8
|
-
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
|
7
|
+
| **points** | **Integer** | Total number of points added to the loyalty card over its lifespan. | [optional] |
|
|
8
|
+
| **balance** | **Integer** | Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`. | [optional] |
|
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
|
11
|
+
| **pending_points** | **Integer** | Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually. | [optional] |
|
|
12
|
+
| **expired_points** | **Integer** | Shows the total number of expired points over the lifetime of the loyalty card. | [optional] |
|
|
13
|
+
| **subtracted_points** | **Integer** | Shows the total number of subtracted points over the lifetime of the loyalty card. | [optional] |
|
|
11
14
|
|