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
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsSummaryGetResponseBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **object** | **String** | The type of the object, which is `campaign_summary`. | [optional][default to 'campaign_summary'] |
|
|
8
|
+
| **campaign** | [**CampaignBase**](CampaignBase.md) | | [optional] |
|
|
9
|
+
| **redemptions** | **Integer** | Total number of redemptions, which includes successful and failed redemptions. | [optional] |
|
|
10
|
+
| **redemptions_succeeded** | **Integer** | Total number of successful redemptions. | [optional] |
|
|
11
|
+
| **redemptions_failed** | **Integer** | Total number of failed redemptions. | [optional] |
|
|
12
|
+
| **rollbacks** | **Integer** | Total number of rollbacks, which includes successful and failed rollbacks. | [optional] |
|
|
13
|
+
| **rollbacks_succeeded** | **Integer** | Total number of successful rollbacks. | [optional] |
|
|
14
|
+
| **rollbacks_failed** | **Integer** | Total number of failed rollbacks. | [optional] |
|
|
15
|
+
| **validations** | **Integer** | Total number of validations, which includes successful and failed validations. | [optional] |
|
|
16
|
+
| **validations_succeeded** | **Integer** | Total number of successful validations. | [optional] |
|
|
17
|
+
| **validations_failed** | **Integer** | Total number of failed validations. | [optional] |
|
|
18
|
+
| **orders_amount** | **Integer** | Total amount of orders related to the campaign. This amount is not reduced by `orders_rolledback_amount`. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
19
|
+
| **orders_rolledback_amount** | **Integer** | Total amount of orders that were rolled back and are related to the campaign. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
20
|
+
| **vouchers_created** | **Integer** | Total number of vouchers created within the campaign. Includes vouchers generated when the campaign was created, vouchers added manually, or vouchers generated automatically when a new customer joined the campaign. | [optional] |
|
|
21
|
+
| **vouchers_deleted** | **Integer** | Total number of vouchers deleted within the campaign. Includes vouchers moved to the bin and vouchers deleted permanently. Vouchers moved to the bin and then deleted permanently are counted once. | [optional] |
|
|
22
|
+
| **publications** | **Integer** | Total number of publications, which includes successful and failed publications. | [optional] |
|
|
23
|
+
| **publications_succeeded** | **Integer** | Total number of successful publications. | [optional] |
|
|
24
|
+
| **publications_failed** | **Integer** | Total number of failed publications. | [optional] |
|
|
25
|
+
| **discounted_amount** | **Integer** | Total amount of discounts related to the campaign. This amount is not reduced by the `rolledback_discounted_amount`. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
26
|
+
| **rolledback_discounted_amount** | **Integer** | Total amount of discounts orders that were rolled back and are related to the campaign. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
27
|
+
| **created_vouchers_amount** | **Integer** | The total credit amount for all created gift cards. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
28
|
+
| **amount_added** | **Integer** | The total credit amount that was added. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
29
|
+
| **amount_deleted** | **Integer** | The total credit amount that was deleted by deleting gift cards. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
30
|
+
| **amount_redeemed** | **Integer** | The total credit amount that was redeemed. This amount is not reduced by the `amount_rolledback`. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
31
|
+
| **amount_rolledback** | **Integer** | The total credit amount that was rolled back. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
32
|
+
| **amount_subtracted** | **Integer** | The total credit amount that was subtracted. The value is multiplied by `100` to precisely represent 2 decimal places. For example, `$10` is represented as `1000`. | [optional] |
|
|
33
|
+
| **created_vouchers_points** | **Integer** | Total number of points added to newly created loyalty cards. This also counts points added for the loyalty cards which are created by importing a CSV file to a campaign. | [optional] |
|
|
34
|
+
| **points_deleted** | **Integer** | Total number of points that were deleted. | [optional] |
|
|
35
|
+
| **points_subtracted** | **Integer** | Total number of points that were subtracted. | [optional] |
|
|
36
|
+
| **points_added** | **Integer** | Total number of points that were added. This includes points added manually or automatically by redeeming a reward that adds loyalty points to cards in this campaign. | [optional] |
|
|
37
|
+
| **points_rewarded** | **Integer** | Total number of points that were rewarded to loyalty cards through earning rules. This includes pending points that were activated. | [optional] |
|
|
38
|
+
| **points_redeemed** | **Integer** | Total number of points that were redeemed for rewards. | [optional] |
|
|
39
|
+
| **points_rolledback** | **Integer** | Total number of points that were rolled back for reward redemptions. | [optional] |
|
|
40
|
+
| **points_expired** | **Integer** | Total number of points that have expired. | [optional] |
|
|
41
|
+
| **points_transferred_out** | **Integer** | Total number of points transferred out of loyalty cards covered by the campaign. | [optional] |
|
|
42
|
+
| **points_transferred_in** | **Integer** | Total number of points transferred into loyalty cards covered by the campaign. | [optional] |
|
|
43
|
+
| **pending_points_added** | **Integer** | Total number of pending points that were added either as part of earning rules or added manually to an existing pending point bucket. Pending points that were activated manually or automatically or that were canceled do not affect this number. | [optional] |
|
|
44
|
+
| **pending_points_subtracted** | **Integer** | Total number of pending points that were subtracted from existing pending point buckets. | [optional] |
|
|
45
|
+
| **pending_points_activated** | **Integer** | Total number of pending points that were activated manually or automatically. | [optional] |
|
|
46
|
+
| **pending_points_canceled** | **Integer** | Total number of pending points that were canceled. | [optional] |
|
|
47
|
+
| **referred_customers** | **Integer** | Total number of all referred customers. | [optional] |
|
|
48
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsExportCreateRequestBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **parameters** | [**CampaignsTransactionsExportCreateRequestBodyParameters**](CampaignsTransactionsExportCreateRequestBodyParameters.md) | | [optional] |
|
|
8
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsExportCreateRequestBodyParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **order** | **String** | How the export is ordered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] |
|
|
8
|
+
| **fields** | **Array<String>** | Data fields that will be exported for the transactions that are associated with balance movements on cards in a campaign. | [optional] |
|
|
9
|
+
| **filters** | [**ExportCampaignTransactionsFilters**](ExportCampaignTransactionsFilters.md) | | [optional] |
|
|
10
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsExportCreateResponseBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique export ID. | [optional] |
|
|
8
|
+
| **object** | **String** | The type of object being represented. This object stores information about the `export`. | [optional][default to 'export'] |
|
|
9
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the export was scheduled in ISO 8601 format. | [optional] |
|
|
10
|
+
| **status** | **String** | Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated. | [optional][default to 'SCHEDULED'] |
|
|
11
|
+
| **channel** | **String** | The channel through which the export was triggered. | [optional][default to 'API'] |
|
|
12
|
+
| **exported_object** | **String** | The type of exported object. | [optional][default to 'voucher_transactions'] |
|
|
13
|
+
| **parameters** | [**CampaignsTransactionsExportCreateResponseBodyParameters**](CampaignsTransactionsExportCreateResponseBodyParameters.md) | | [optional] |
|
|
14
|
+
| **result** | [**CampaignsTransactionsExportCreateResponseBodyResult**](CampaignsTransactionsExportCreateResponseBodyResult.md) | | [optional] |
|
|
15
|
+
| **user_id** | **String** | Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the `channel` value is `WEBSITE`. | [optional] |
|
|
16
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsExportCreateResponseBodyParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **order** | **String** | How the export is ordered, where the dash `-` preceding a sorting option means sorting in a descending order. | [optional] |
|
|
8
|
+
| **fields** | **Array<String>** | Data fields that will be exported for the transactions that are associated with balance movements on cards in a campaign. | [optional] |
|
|
9
|
+
| **filters** | [**CampaignsTransactionsExportCreateResponseBodyParametersFilters**](CampaignsTransactionsExportCreateResponseBodyParametersFilters.md) | | [optional] |
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsExportCreateResponseBodyParametersFilters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **junction** | [**Junction**](Junction.md) | | [optional] |
|
|
8
|
+
| **created_at** | [**FilterConditionsDateTime**](FilterConditionsDateTime.md) | | [optional] |
|
|
9
|
+
| **voucher_id** | [**FilterConditionsString**](FilterConditionsString.md) | | [optional] |
|
|
10
|
+
| **campaign_id** | [**CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId**](CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md) | | [optional] |
|
|
11
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conditions** | [**CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions**](CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md) | | [optional] |
|
|
8
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsExportCreateResponseBodyResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | URL of the CSV file location. It contains the `token` used for authorization in the [Download export](/api-reference/exports/download-export) method. | [optional] |
|
|
8
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignsTransactionsListResponseBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'list'] |
|
|
8
|
+
| **data_ref** | **String** | Identifies the name of the attribute that contains the array of transaction objects. | [optional][default to 'data'] |
|
|
9
|
+
| **data** | [**Array<VoucherTransaction>**](VoucherTransaction.md) | A dictionary that contains an array of transactions. Each entry in the array is a separate transaction object. | [optional] |
|
|
10
|
+
| **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different paging or a different start date filter) to get more records returned in the results. | [optional] |
|
|
11
|
+
| **more_starting_after** | **String** | Returns an ID that can be used to return another page of results. Use the transaction ID in the `starting_after_id` query parameter to display another page of the results starting after the transaction with that ID. | [optional] |
|
|
12
|
+
|
|
@@ -14,8 +14,9 @@
|
|
|
14
14
|
| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
|
|
15
15
|
| **unset_metadata_fields** | **Array<String>** | Determine which metadata should be removed from campaign. | [optional] |
|
|
16
16
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
|
|
17
|
+
| **access_settings** | [**AccessSettings**](AccessSettings.md) | | [optional] |
|
|
17
18
|
| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
|
|
18
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone
|
|
19
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. | [optional] |
|
|
19
20
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
20
21
|
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`. | [optional] |
|
|
21
22
|
| **discount** | [**Discount**](Discount.md) | | [optional] |
|
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
| **name** | **String** | Campaign name. | [optional] |
|
|
9
9
|
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
10
10
|
| **campaign_type** | **String** | Type of campaign. | [optional] |
|
|
11
|
-
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
|
|
11
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [optional] |
|
|
12
12
|
| **voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|
|
13
13
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
14
|
-
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone
|
|
14
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them. | [optional] |
|
|
15
15
|
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
16
16
|
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
17
17
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
@@ -27,14 +27,14 @@
|
|
|
27
27
|
| **category** | **String** | Unique category name. | [optional] |
|
|
28
28
|
| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
|
|
29
29
|
| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
|
|
30
|
-
| **readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. | [optional] |
|
|
30
|
+
| **readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the [GET Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint. | [optional] |
|
|
31
31
|
| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
|
|
32
32
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
33
|
-
| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
|
|
33
|
+
| **categories** | [**Array<Category>**](Category.md) | Contains details about the campaign category. For the GET [List campaigns](/api-reference/campaigns/list-campaigns) endpoint, this is returned only if the `expand=category` query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET [Campaign summary](/api-reference/campaigns/get-campaign-summary) endpoint, it is always returned as an empty array. | [optional] |
|
|
34
34
|
| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
35
35
|
| **referral_program** | [**ReferralProgram**](ReferralProgram.md) | | [optional] |
|
|
36
36
|
| **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] |
|
|
37
|
+
| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] |
|
|
37
38
|
| **promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] |
|
|
38
39
|
| **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] |
|
|
39
|
-
| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] |
|
|
40
40
|
|
|
@@ -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
|
|
|
@@ -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/CategoriesApi.md
CHANGED
|
@@ -9,5 +9,6 @@
|
|
|
9
9
|
| **tracking_id** | **String** | Is correspondent to Customer's source_id | [optional] |
|
|
10
10
|
| **scenario** | **String** | Defines the scenario Voucherify should consider during the qualification process. - `ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer's cart based on the vouchers assigned to the customer's profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s). | [optional] |
|
|
11
11
|
| **options** | [**QualificationsOption**](QualificationsOption.md) | | [optional] |
|
|
12
|
-
| **
|
|
12
|
+
| **session** | [**ClientQualificationsCheckEligibilityRequestBodySession**](ClientQualificationsCheckEligibilityRequestBodySession.md) | | [optional] |
|
|
13
|
+
| **metadata** | **Object** | A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the [Create Validation Rules](/api-reference/validation-rules/create-validation-rules) endpoint or with the [Validation Rule Builder](/personalize/create-validation-rules) in the the Dashboard. | [optional] |
|
|
13
14
|
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VoucherifySdk::ClientQualificationsCheckEligibilityRequestBodySession
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Parameter required to return the details about the `locked_credits`. | [optional][default to 'LOCK'] |
|
|
8
|
+
|
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **expand** | **Array<String>** | Expand array lets you configure params 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>** | Expand array lets you configure params 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. | | [\"redeemable\", \"redemption\", \"category\"] | - Returns each discount type's `metadata` in each child redemption object.<br />- Returns redemption object `metadata`.<br />- 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
|
|
data/docs/ClientSideApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
17
17
|
|
|
18
18
|
Check Eligibility (client-side)
|
|
19
19
|
|
|
20
|
-
Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of Campaign Qualifications, Voucher Qualifications
|
|
20
|
+
Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version 👍 Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. # Caching Qualification has a 5-minute cache for the returned results. If you change your campaign settings or validation rules, the changes will apply to qualification results after the cache refreshes.
|
|
21
21
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
@@ -145,7 +145,7 @@ end
|
|
|
145
145
|
|
|
146
146
|
Redeem Stackable Discounts (client-side)
|
|
147
147
|
|
|
148
|
-
This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications. # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: 📘 Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your rollback request.
|
|
148
|
+
This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications. # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: 📘 Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).
|
|
149
149
|
|
|
150
150
|
### Examples
|
|
151
151
|
|
|
@@ -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<ClientValidationsValidateResponseBodyRedeemablesItem>**](ClientValidationsValidateResponseBodyRedeemablesItem.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** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount**](ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md) | | [optional] |
|
|
8
|
+
| **bundle** | [**Bundle**](Bundle.md) | | [optional] |
|
|
8
9
|
| **gift** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultGift**](ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md) | | [optional] |
|
|
9
10
|
| **loyalty_card** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard**](ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.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** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct**](ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.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/CustomerLoyalty.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **points** | **Integer** | Customer's loyalty points. | [optional] |
|
|
7
|
+
| **points** | **Integer** | Customer's loyalty points minus expired for all loyalty cards which the customer has. | [optional] |
|
|
8
8
|
| **referred_customers** | **Integer** | Total number of customers referred by the customer. | [optional] |
|
|
9
9
|
| **campaigns** | [**Hash<String, CustomerLoyaltyCampaignsEntry>**](CustomerLoyaltyCampaignsEntry.md) | Contains campaigns with details about point balances and how many customers were referred by the customer. | [optional] |
|
|
10
10
|
|
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **total_amount** | **Integer** | The total amount spent by the customer.
|
|
7
|
+
| **total_amount** | **Integer** | The total amount spent by the customer. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
8
8
|
| **total_count** | **Integer** | Total number of orders made by the customer. | [optional] |
|
|
9
|
-
| **average_amount** | **Integer** | Average amount spent on orders. `total_amount` &divide; `total_count`.
|
|
10
|
-
| **last_order_amount** | **Integer** | Amount spent on last order.
|
|
9
|
+
| **average_amount** | **Integer** | Average amount spent on orders. `total_amount` &divide; `total_count`. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
10
|
+
| **last_order_amount** | **Integer** | Amount spent on last order. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
|
|
11
11
|
| **last_order_date** | **Time** | Timestamp representing the date and time of the customer's last order in ISO 8601 format. | [optional] |
|
|
12
12
|
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **redeemed_amount** | **Integer** | Total amount of gift card credits redeemed by customer.
|
|
8
|
-
| **amount_to_go** | **Integer** | Remaining gift card balance across all gift cards.
|
|
7
|
+
| **redeemed_amount** | **Integer** | Total amount of gift card credits redeemed by customer. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional][default to 0] |
|
|
8
|
+
| **amount_to_go** | **Integer** | Remaining gift card balance across all gift cards. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional][default to 0] |
|
|
9
9
|
|
|
@@ -4,5 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **cockpit_url** | **String** |
|
|
7
|
+
| **cockpit_url** | **String** | URL address to customer preference center. Previously, a customer's cockpit URL address. | [optional] |
|
|
8
|
+
| **cockpit_preference_center_url** | **String** | URL address to customer preference center. | [optional] |
|
|
8
9
|
|
data/docs/CustomersApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
9
9
|
| [**delete_customer**](CustomersApi.md#delete_customer) | **DELETE** /v1/customers/{customerId} | Delete Customer |
|
|
10
10
|
| [**get_customer**](CustomersApi.md#get_customer) | **GET** /v1/customers/{customerId} | Get Customer |
|
|
11
11
|
| [**import_customers_using_csv**](CustomersApi.md#import_customers_using_csv) | **POST** /v1/customers/importCSV | Import and Update Customers using CSV |
|
|
12
|
-
| [**list_customer_activities**](CustomersApi.md#list_customer_activities) | **GET** /v1/customers/{customerId}/activities | List Customer Activities
|
|
12
|
+
| [**list_customer_activities**](CustomersApi.md#list_customer_activities) | **GET** /v1/customers/{customerId}/activities | List Customer Activities |
|
|
13
13
|
| [**list_customer_activity**](CustomersApi.md#list_customer_activity) | **GET** /v1/customers/{customerId}/activity | List Customer Activity |
|
|
14
14
|
| [**list_customer_redeemables**](CustomersApi.md#list_customer_redeemables) | **GET** /v1/customers/{customerId}/redeemables | List Customer's Redeemables |
|
|
15
15
|
| [**list_customer_segments**](CustomersApi.md#list_customer_segments) | **GET** /v1/customers/{customerId}/segments | List Customer's Segments |
|
|
@@ -200,7 +200,7 @@ nil (empty response body)
|
|
|
200
200
|
|
|
201
201
|
Get Customer
|
|
202
202
|
|
|
203
|
-
|
|
203
|
+
Retrieves details of a given customer by customers id or source_id.
|
|
204
204
|
|
|
205
205
|
### Examples
|
|
206
206
|
|
|
@@ -258,7 +258,7 @@ end
|
|
|
258
258
|
|
|
259
259
|
Import and Update Customers using CSV
|
|
260
260
|
|
|
261
|
-
This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object. 📘 Standard customer fields mapping **No spaces allowed in field names** Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. 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.
|
|
261
|
+
This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object. 📘 Standard customer fields mapping **No spaces allowed in field names** Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. 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).
|
|
262
262
|
|
|
263
263
|
### Examples
|
|
264
264
|
|
|
@@ -316,7 +316,7 @@ end
|
|
|
316
316
|
|
|
317
317
|
> <CustomersActivitiesListResponseBody> list_customer_activities(customer_id, opts)
|
|
318
318
|
|
|
319
|
-
List Customer Activities
|
|
319
|
+
List Customer Activities
|
|
320
320
|
|
|
321
321
|
> ❗️ Deprecated This endpoint represents the deprecated version of the API responsible for listing customer activities and we do not recommend using it. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint. Retrieve customer activities.
|
|
322
322
|
|
|
@@ -353,7 +353,7 @@ opts = {
|
|
|
353
353
|
}
|
|
354
354
|
|
|
355
355
|
begin
|
|
356
|
-
# List Customer Activities
|
|
356
|
+
# List Customer Activities
|
|
357
357
|
result = api_instance.list_customer_activities(customer_id, opts)
|
|
358
358
|
p result
|
|
359
359
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -396,7 +396,7 @@ end
|
|
|
396
396
|
|
|
397
397
|
List Customer Activity
|
|
398
398
|
|
|
399
|
-
|
|
399
|
+
Retrieves activity details of a given customer by customers id or source_id.
|
|
400
400
|
|
|
401
401
|
### Examples
|
|
402
402
|
|
|
@@ -627,7 +627,7 @@ opts = {
|
|
|
627
627
|
email: 'email_example', # String | Limit the customers to the ones that have this specific email address.
|
|
628
628
|
city: 'city_example', # String | Limit the customers to the ones that are located in the specified city.
|
|
629
629
|
name: 'name_example', # String | Filter customers by the name property.
|
|
630
|
-
segment_id: 'segment_id_example', # String | Filter customers by the segment
|
|
630
|
+
segment_id: 'segment_id_example', # String | Filter customers by the segment ID. Warning: Passing additional query parameter filters that are in conflict with the segment filters may return unexpected results.
|
|
631
631
|
created_at_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter customers by date customer was created.
|
|
632
632
|
created_at_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter customers by date customer was created.
|
|
633
633
|
updated_at_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter customers by date customer was updated last time.
|
|
@@ -654,7 +654,7 @@ end
|
|
|
654
654
|
| **email** | **String** | Limit the customers to the ones that have this specific email address. | [optional] |
|
|
655
655
|
| **city** | **String** | Limit the customers to the ones that are located in the specified city. | [optional] |
|
|
656
656
|
| **name** | **String** | Filter customers by the name property. | [optional] |
|
|
657
|
-
| **segment_id** | **String** | Filter customers by the segment
|
|
657
|
+
| **segment_id** | **String** | Filter customers by the segment ID. Warning: Passing additional query parameter filters that are in conflict with the segment filters may return unexpected results. | [optional] |
|
|
658
658
|
| **created_at_before** | **Time** | Filter customers by date customer was created. | [optional] |
|
|
659
659
|
| **created_at_after** | **Time** | Filter customers by date customer was created. | [optional] |
|
|
660
660
|
| **updated_at_before** | **Time** | Filter customers by date customer was updated last time. | [optional] |
|
|
@@ -744,7 +744,7 @@ end
|
|
|
744
744
|
|
|
745
745
|
Update Customers in Bulk
|
|
746
746
|
|
|
747
|
-
Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. 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 If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. 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.
|
|
747
|
+
Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. 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 If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. 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.
|
|
748
748
|
|
|
749
749
|
### Examples
|
|
750
750
|
|
|
@@ -804,7 +804,7 @@ end
|
|
|
804
804
|
|
|
805
805
|
Update Customers' Metadata in Bulk
|
|
806
806
|
|
|
807
|
-
Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. 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 If a
|
|
807
|
+
Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. 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 If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. 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.
|
|
808
808
|
|
|
809
809
|
### Examples
|
|
810
810
|
|
|
@@ -4,5 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **cockpit_url** | **String** |
|
|
7
|
+
| **cockpit_url** | **String** | URL address to customer preference center. Previously, a customer's cockpit URL address. | [optional] |
|
|
8
|
+
| **cockpit_preference_center_url** | **String** | URL address to customer preference center. | [optional] |
|
|
8
9
|
|