voucherify 8.0.3 → 8.1.1
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 -111
- data/Gemfile.lock +19 -17
- data/README.md +223 -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/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/ApplicableTo.md +18 -2
- data/docs/ApplicableToOrderItemUnitsItem.md +2 -1
- data/docs/AsyncActionsApi.md +2 -2
- data/docs/AsyncActionsListResponseBody.md +1 -0
- data/docs/Bundle.md +11 -0
- data/docs/BundleIdentifiedItem.md +11 -0
- data/docs/BundleMissingItem.md +10 -0
- data/docs/Campaign.md +4 -4
- data/docs/CampaignBase.md +4 -4
- data/docs/CampaignLoyaltyCardExpirationRules.md +6 -4
- data/docs/CampaignsApi.md +211 -14
- data/docs/CampaignsCreateRequestBody.md +2 -2
- data/docs/CampaignsCreateResponseBody.md +4 -4
- data/docs/CampaignsGetResponseBody.md +4 -4
- 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 +1 -1
- data/docs/CampaignsUpdateResponseBody.md +4 -4
- data/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +5 -3
- data/docs/CampaignsVouchersCreateResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +5 -3
- 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/CustomerSummaryOrders.md +3 -3
- data/docs/CustomerSummaryRedemptionsGift.md +2 -2
- data/docs/CustomerWithSummaryLoyaltyReferralsAssets.md +2 -1
- data/docs/CustomersApi.md +14 -14
- 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 +1 -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/ErrorError.md +1 -1
- data/docs/ExportCampaignTransactionsFilters.md +10 -0
- data/docs/ExportParameters.md +3 -2
- data/docs/ExportsApi.md +7 -7
- data/docs/ExportsCreateRequestBodyParameters.md +3 -2
- data/docs/ExportsCreateResponseBodyParameters.md +3 -2
- data/docs/ExportsGetResponseBodyParameters.md +3 -2
- data/docs/Gift.md +3 -2
- data/docs/InapplicableTo.md +18 -2
- data/docs/InapplicableToOrderItemUnitsItem.md +2 -1
- data/docs/LoyaltiesApi.md +293 -96
- data/docs/LoyaltiesCreateCampaignRequestBody.md +2 -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 +1 -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/LoyaltiesEarningRulesDisableResponseBody.md +1 -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/LoyaltiesEarningRulesEnableResponseBody.md +1 -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/LoyaltiesEarningRulesGetResponseBody.md +1 -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/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 +1 -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/LoyaltiesGetCampaignResponseBody.md +1 -1
- data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +5 -3
- data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +5 -3
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +1 -1
- data/docs/LoyaltiesMembersPendingPointsBalanceRequestBody.md +8 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBody.md +12 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBodyRelatedObject.md +9 -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 -3
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +5 -3
- 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 +1 -1
- data/docs/LoyaltiesUpdateCampaignResponseBody.md +1 -1
- data/docs/LoyaltyCampaign.md +1 -1
- data/docs/LoyaltyCardTransaction.md +1 -1
- data/docs/LoyaltyCardTransactionDetailsBalance.md +1 -0
- data/docs/LoyaltyMemberLoyaltyCard.md +5 -3
- data/docs/LoyaltyPointsBucket.md +1 -1
- data/docs/LoyaltyTiersExpirationAll.md +1 -1
- data/docs/ManagementApi.md +26 -26
- 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 +1 -1
- data/docs/OrderCalculatedItem.md +1 -1
- data/docs/OrderItem.md +1 -1
- data/docs/OrdersApi.md +4 -4
- data/docs/OrdersCreateRequestBody.md +1 -1
- data/docs/OrdersImportCreateRequestBodyItem.md +2 -2
- data/docs/OrdersUpdateRequestBody.md +1 -1
- data/docs/ParametersFiltersListCampaignTransactions.md +10 -0
- data/docs/ProductCollectionsApi.md +1 -1
- data/docs/ProductCollectionsCreateRequestBody.md +1 -1
- data/docs/ProductsApi.md +23 -23
- 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 +8 -8
- 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 -3
- data/docs/Redemption.md +1 -0
- data/docs/RedemptionEntry.md +1 -0
- 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 -3
- data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionRewardResultParametersCampaign.md +1 -1
- data/docs/RedemptionRewardResultParametersCoin.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 -3
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsGetResponseBody.md +1 -0
- 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 -3
- data/docs/RedemptionsListResponseBodyRedemptionsItem.md +1 -0
- 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 -3
- data/docs/RedemptionsRedeemRequestBodyOptions.md +2 -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/RewardsCreateRequestBodyParametersCoin.md +1 -1
- data/docs/RewardsCreateResponseBody.md +1 -1
- data/docs/RewardsUpdateRequestBody.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCampaign.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCoin.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 -3
- data/docs/SimpleVoucherRedemption.md +1 -0
- data/docs/StackingRules.md +15 -11
- data/docs/TemplatesApi.md +7 -7
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +2 -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 +2 -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 -3
- data/docs/VoucherTransaction.md +1 -1
- data/docs/VoucherTransactionDetailsBalance.md +1 -0
- data/docs/VoucherTransactionsExportParameters.md +1 -1
- data/docs/VoucherTransactionsFilters.md +1 -1
- data/docs/VoucherWithCategoriesGift.md +3 -2
- data/docs/VoucherWithCategoriesLoyaltyCard.md +5 -3
- data/docs/VouchersApi.md +18 -16
- 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 -3
- data/docs/VouchersCreateWithSpecificCodeRequestBody.md +2 -2
- data/docs/VouchersDisableResponseBodyGift.md +3 -2
- data/docs/VouchersDisableResponseBodyLoyaltyCard.md +5 -3
- data/docs/VouchersEnableResponseBodyGift.md +3 -2
- data/docs/VouchersEnableResponseBodyLoyaltyCard.md +5 -3
- data/docs/VouchersGetResponseBodyGift.md +3 -2
- data/docs/VouchersGetResponseBodyLoyaltyCard.md +5 -3
- 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 -3
- data/lib/VoucherifySdk/api/async_actions_api.rb +4 -4
- data/lib/VoucherifySdk/api/campaigns_api.rb +224 -22
- 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 +22 -22
- data/lib/VoucherifySdk/api/exports_api.rb +10 -10
- data/lib/VoucherifySdk/api/loyalties_api.rb +335 -130
- data/lib/VoucherifySdk/api/management_api.rb +52 -52
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +6 -6
- data/lib/VoucherifySdk/api/orders_api.rb +8 -8
- data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
- data/lib/VoucherifySdk/api/products_api.rb +32 -32
- data/lib/VoucherifySdk/api/publications_api.rb +10 -10
- 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 +29 -26
- data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
- data/lib/VoucherifySdk/models/applicable_to.rb +192 -16
- data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +20 -5
- 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 +4 -4
- data/lib/VoucherifySdk/models/campaign_base.rb +4 -4
- data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +53 -10
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +4 -4
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +4 -4
- 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 +1 -1
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +4 -4
- 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 +30 -8
- 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 +30 -8
- 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 -2
- 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_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 -2
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -1
- data/lib/VoucherifySdk/models/earning_rule.rb +10 -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/error_error.rb +2 -2
- data/lib/VoucherifySdk/models/export.rb +1 -1
- data/lib/VoucherifySdk/models/export_campaign_transactions_filters.rb +248 -0
- data/lib/VoucherifySdk/models/export_parameters.rb +19 -8
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +19 -8
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +19 -8
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -2
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +19 -8
- 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 +192 -16
- data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +20 -5
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +3 -3
- 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 +10 -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_disable_response_body.rb +10 -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_enable_response_body.rb +10 -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_get_response_body.rb +10 -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_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 +10 -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_get_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +30 -8
- 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 +30 -8
- 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 +1 -1
- 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_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 +30 -8
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +30 -8
- 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 +1 -1
- 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_balance.rb +12 -1
- data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/loyalty_member_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_points_bucket.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 +1 -1
- data/lib/VoucherifySdk/models/order_calculated_item.rb +1 -1
- data/lib/VoucherifySdk/models/order_item.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +15 -15
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +1 -1
- 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/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 +1 -1
- 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 +30 -8
- 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_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 +30 -8
- 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_reward_result_parameters_coin.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 +30 -8
- data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +11 -1
- 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 +30 -8
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +11 -1
- 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 +30 -8
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +29 -7
- 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_request_body_parameters_coin.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_request_body_parameters_coin.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 +30 -8
- 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 +3 -3
- 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_redeemable_skipped_result_details.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +29 -7
- 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 -2
- 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 +30 -8
- data/lib/VoucherifySdk/models/voucher_transaction.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +12 -1
- 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 +30 -8
- 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 +30 -8
- 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 +30 -8
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/vouchers_get_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +30 -8
- 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 +30 -8
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +55 -0
- metadata +142 -28
|
@@ -20,7 +20,7 @@ module VoucherifySdk
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Activate Member Pending Points
|
|
23
|
-
#
|
|
23
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
24
24
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
25
25
|
# @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -31,7 +31,7 @@ module VoucherifySdk
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Activate Member Pending Points
|
|
34
|
-
# >
|
|
34
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
35
35
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
36
36
|
# @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -81,10 +81,10 @@ module VoucherifySdk
|
|
|
81
81
|
end
|
|
82
82
|
|
|
83
83
|
# Add Member
|
|
84
|
-
# This method assigns a loyalty card to a customer. It selects a loyalty card suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet.
|
|
84
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet. <Note> <Badge color blue>Auto-update campaign</Badge> In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign. </Note>
|
|
85
85
|
# @param campaign_id [String] Unique campaign ID of the loyalty program.
|
|
86
86
|
# @param [Hash] opts the optional parameters
|
|
87
|
-
# @option opts [LoyaltiesMembersCreateRequestBody] :loyalties_members_create_request_body Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint.
|
|
87
|
+
# @option opts [LoyaltiesMembersCreateRequestBody] :loyalties_members_create_request_body Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint.
|
|
88
88
|
# @return [LoyaltiesMembersCreateResponseBody]
|
|
89
89
|
def add_member(campaign_id, opts = {})
|
|
90
90
|
data, _status_code, _headers = add_member_with_http_info(campaign_id, opts)
|
|
@@ -92,10 +92,10 @@ module VoucherifySdk
|
|
|
92
92
|
end
|
|
93
93
|
|
|
94
94
|
# Add Member
|
|
95
|
-
# This method assigns a loyalty card to a customer. It selects a loyalty card suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet.
|
|
95
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet. <Note> <Badge color blue>Auto-update campaign</Badge> In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign. </Note>
|
|
96
96
|
# @param campaign_id [String] Unique campaign ID of the loyalty program.
|
|
97
97
|
# @param [Hash] opts the optional parameters
|
|
98
|
-
# @option opts [LoyaltiesMembersCreateRequestBody] :loyalties_members_create_request_body Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint.
|
|
98
|
+
# @option opts [LoyaltiesMembersCreateRequestBody] :loyalties_members_create_request_body Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint.
|
|
99
99
|
# @return [Array<(LoyaltiesMembersCreateResponseBody, Integer, Hash)>] LoyaltiesMembersCreateResponseBody data, response status code and response headers
|
|
100
100
|
private def add_member_with_http_info(campaign_id, opts = {})
|
|
101
101
|
if @api_client.config.debugging
|
|
@@ -146,8 +146,76 @@ module VoucherifySdk
|
|
|
146
146
|
return data, status_code, headers
|
|
147
147
|
end
|
|
148
148
|
|
|
149
|
+
# Adjust Member Pending Points
|
|
150
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Adjusts the pending points with a given ID. You can add or subtract the number of points. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
151
|
+
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
152
|
+
# @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
|
|
153
|
+
# @param [Hash] opts the optional parameters
|
|
154
|
+
# @option opts [LoyaltiesMembersPendingPointsBalanceRequestBody] :loyalties_members_pending_points_balance_request_body Define the number of pending points to be added or subtracted.
|
|
155
|
+
# @return [LoyaltiesMembersPendingPointsBalanceResponseBody]
|
|
156
|
+
def adjust_member_pending_points(member_id, pending_points_id, opts = {})
|
|
157
|
+
data, _status_code, _headers = adjust_member_pending_points_with_http_info(member_id, pending_points_id, opts)
|
|
158
|
+
data
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# Adjust Member Pending Points
|
|
162
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Adjusts the pending points with a given ID. You can add or subtract the number of points. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
163
|
+
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
164
|
+
# @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
|
|
165
|
+
# @param [Hash] opts the optional parameters
|
|
166
|
+
# @option opts [LoyaltiesMembersPendingPointsBalanceRequestBody] :loyalties_members_pending_points_balance_request_body Define the number of pending points to be added or subtracted.
|
|
167
|
+
# @return [Array<(LoyaltiesMembersPendingPointsBalanceResponseBody, Integer, Hash)>] LoyaltiesMembersPendingPointsBalanceResponseBody data, response status code and response headers
|
|
168
|
+
private def adjust_member_pending_points_with_http_info(member_id, pending_points_id, opts = {})
|
|
169
|
+
if @api_client.config.debugging
|
|
170
|
+
@api_client.config.logger.debug 'Calling API: LoyaltiesApi.adjust_member_pending_points ...'
|
|
171
|
+
end
|
|
172
|
+
# resource path
|
|
173
|
+
local_var_path = '/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance'.sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s)).sub('{' + 'pendingPointsId' + '}', CGI.escape(pending_points_id.to_s))
|
|
174
|
+
|
|
175
|
+
# query parameters
|
|
176
|
+
query_params = opts[:query_params] || {}
|
|
177
|
+
|
|
178
|
+
# header parameters
|
|
179
|
+
header_params = opts[:header_params] || {}
|
|
180
|
+
# HTTP header 'Accept' (if needed)
|
|
181
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
182
|
+
# HTTP header 'Content-Type'
|
|
183
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
184
|
+
if !content_type.nil?
|
|
185
|
+
header_params['Content-Type'] = content_type
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# form parameters
|
|
189
|
+
form_params = opts[:form_params] || {}
|
|
190
|
+
|
|
191
|
+
# http body (model)
|
|
192
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'loyalties_members_pending_points_balance_request_body'])
|
|
193
|
+
|
|
194
|
+
# return_type
|
|
195
|
+
return_type = opts[:debug_return_type] || 'LoyaltiesMembersPendingPointsBalanceResponseBody'
|
|
196
|
+
|
|
197
|
+
# auth_names
|
|
198
|
+
auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
|
|
199
|
+
|
|
200
|
+
new_options = opts.merge(
|
|
201
|
+
:operation => :"LoyaltiesApi.adjust_member_pending_points",
|
|
202
|
+
:header_params => header_params,
|
|
203
|
+
:query_params => query_params,
|
|
204
|
+
:form_params => form_params,
|
|
205
|
+
:body => post_body,
|
|
206
|
+
:auth_names => auth_names,
|
|
207
|
+
:return_type => return_type
|
|
208
|
+
)
|
|
209
|
+
|
|
210
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
211
|
+
if @api_client.config.debugging
|
|
212
|
+
@api_client.config.logger.debug "API called: LoyaltiesApi#adjust_member_pending_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
213
|
+
end
|
|
214
|
+
return data, status_code, headers
|
|
215
|
+
end
|
|
216
|
+
|
|
149
217
|
# Cancel Member Pending Points
|
|
150
|
-
#
|
|
218
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
151
219
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
152
220
|
# @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
|
|
153
221
|
# @param [Hash] opts the optional parameters
|
|
@@ -158,7 +226,7 @@ module VoucherifySdk
|
|
|
158
226
|
end
|
|
159
227
|
|
|
160
228
|
# Cancel Member Pending Points
|
|
161
|
-
# >
|
|
229
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
162
230
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
163
231
|
# @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
|
|
164
232
|
# @param [Hash] opts the optional parameters
|
|
@@ -206,7 +274,7 @@ module VoucherifySdk
|
|
|
206
274
|
end
|
|
207
275
|
|
|
208
276
|
# Create Earning Rule
|
|
209
|
-
# Create earning rules for a loyalty campaign.
|
|
277
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Create earning rules for a loyalty campaign. <Warning> <Badge color yellow>Maximum number of earning rules</Badge> You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup. </Warning>
|
|
210
278
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
211
279
|
# @param [Hash] opts the optional parameters
|
|
212
280
|
# @option opts [Array<LoyaltiesEarningRulesCreateRequestBodyItem>] :loyalties_earning_rules_create_request_body_item Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object
|
|
@@ -217,7 +285,7 @@ module VoucherifySdk
|
|
|
217
285
|
end
|
|
218
286
|
|
|
219
287
|
# Create Earning Rule
|
|
220
|
-
# Create earning rules for a loyalty campaign.
|
|
288
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Create earning rules for a loyalty campaign. <Warning> <Badge color yellow>Maximum number of earning rules</Badge> You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup. </Warning>
|
|
221
289
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
222
290
|
# @param [Hash] opts the optional parameters
|
|
223
291
|
# @option opts [Array<LoyaltiesEarningRulesCreateRequestBodyItem>] :loyalties_earning_rules_create_request_body_item Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object
|
|
@@ -272,7 +340,7 @@ module VoucherifySdk
|
|
|
272
340
|
end
|
|
273
341
|
|
|
274
342
|
# Create loyalty tiers
|
|
275
|
-
# Creates loyalty tiers for desired campaign.
|
|
343
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates loyalty tiers for desired campaign.
|
|
276
344
|
# @param campaign_id [String] Unique loyalty campaign ID or name.
|
|
277
345
|
# @param [Hash] opts the optional parameters
|
|
278
346
|
# @option opts [Array<LoyaltiesTiersCreateInBulkRequestBodyItem>] :loyalties_tiers_create_in_bulk_request_body_item Provide tier definitions you want to add to existing loyalty campaign.
|
|
@@ -283,7 +351,7 @@ module VoucherifySdk
|
|
|
283
351
|
end
|
|
284
352
|
|
|
285
353
|
# Create loyalty tiers
|
|
286
|
-
# Creates loyalty tiers for desired campaign.
|
|
354
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates loyalty tiers for desired campaign.
|
|
287
355
|
# @param campaign_id [String] Unique loyalty campaign ID or name.
|
|
288
356
|
# @param [Hash] opts the optional parameters
|
|
289
357
|
# @option opts [Array<LoyaltiesTiersCreateInBulkRequestBodyItem>] :loyalties_tiers_create_in_bulk_request_body_item Provide tier definitions you want to add to existing loyalty campaign.
|
|
@@ -338,7 +406,7 @@ module VoucherifySdk
|
|
|
338
406
|
end
|
|
339
407
|
|
|
340
408
|
# Create Loyalty Campaign
|
|
341
|
-
# Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern.
|
|
409
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. <Note> <Badge color blue>Global uniqueness</Badge> All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. </Note> <Warning> <Badge color yellow>Asynchronous action!</Badge> This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. </Warning>
|
|
342
410
|
# @param [Hash] opts the optional parameters
|
|
343
411
|
# @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
|
|
344
412
|
# @return [LoyaltiesCreateCampaignResponseBody]
|
|
@@ -348,7 +416,7 @@ module VoucherifySdk
|
|
|
348
416
|
end
|
|
349
417
|
|
|
350
418
|
# Create Loyalty Campaign
|
|
351
|
-
# Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern.
|
|
419
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. <Note> <Badge color blue>Global uniqueness</Badge> All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. </Note> <Warning> <Badge color yellow>Asynchronous action!</Badge> This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. </Warning>
|
|
352
420
|
# @param [Hash] opts the optional parameters
|
|
353
421
|
# @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
|
|
354
422
|
# @return [Array<(LoyaltiesCreateCampaignResponseBody, Integer, Hash)>] LoyaltiesCreateCampaignResponseBody data, response status code and response headers
|
|
@@ -402,7 +470,7 @@ module VoucherifySdk
|
|
|
402
470
|
end
|
|
403
471
|
|
|
404
472
|
# Export Loyalty Campaign Point Expiration
|
|
405
|
-
# Schedule the generation of a
|
|
473
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
|
|
406
474
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
407
475
|
# @param [Hash] opts the optional parameters
|
|
408
476
|
# @option opts [LoyaltiesPointsExpirationExportCreateRequestBody] :loyalties_points_expiration_export_create_request_body Specify the data filters, types of data to return and order in which the results should be returned.
|
|
@@ -413,7 +481,7 @@ module VoucherifySdk
|
|
|
413
481
|
end
|
|
414
482
|
|
|
415
483
|
# Export Loyalty Campaign Point Expiration
|
|
416
|
-
# Schedule the generation of a
|
|
484
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
|
|
417
485
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
418
486
|
# @param [Hash] opts the optional parameters
|
|
419
487
|
# @option opts [LoyaltiesPointsExpirationExportCreateRequestBody] :loyalties_points_expiration_export_create_request_body Specify the data filters, types of data to return and order in which the results should be returned.
|
|
@@ -467,8 +535,8 @@ module VoucherifySdk
|
|
|
467
535
|
return data, status_code, headers
|
|
468
536
|
end
|
|
469
537
|
|
|
470
|
-
# Create Reward Assignment
|
|
471
|
-
# Add rewards to a loyalty campaign.
|
|
538
|
+
# Create Loyalty Campaign Reward Assignment
|
|
539
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Add rewards to a loyalty campaign.
|
|
472
540
|
# @param campaign_id [String] Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
473
541
|
# @param [Hash] opts the optional parameters
|
|
474
542
|
# @option opts [Array<LoyaltiesRewardsCreateAssignmentItemRequestBody>] :loyalties_rewards_create_assignment_item_request_body Define the cost of the rewards in loyalty points.
|
|
@@ -478,8 +546,8 @@ module VoucherifySdk
|
|
|
478
546
|
data
|
|
479
547
|
end
|
|
480
548
|
|
|
481
|
-
# Create Reward Assignment
|
|
482
|
-
# Add rewards to a loyalty campaign.
|
|
549
|
+
# Create Loyalty Campaign Reward Assignment
|
|
550
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Add rewards to a loyalty campaign.
|
|
483
551
|
# @param campaign_id [String] Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
484
552
|
# @param [Hash] opts the optional parameters
|
|
485
553
|
# @option opts [Array<LoyaltiesRewardsCreateAssignmentItemRequestBody>] :loyalties_rewards_create_assignment_item_request_body Define the cost of the rewards in loyalty points.
|
|
@@ -534,7 +602,7 @@ module VoucherifySdk
|
|
|
534
602
|
end
|
|
535
603
|
|
|
536
604
|
# Delete Earning Rule
|
|
537
|
-
# This method deletes an earning rule for a specific loyalty campaign.
|
|
605
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes an earning rule for a specific loyalty campaign.
|
|
538
606
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
539
607
|
# @param earning_rule_id [String] A unique earning rule ID.
|
|
540
608
|
# @param [Hash] opts the optional parameters
|
|
@@ -545,7 +613,7 @@ module VoucherifySdk
|
|
|
545
613
|
end
|
|
546
614
|
|
|
547
615
|
# Delete Earning Rule
|
|
548
|
-
# This method deletes an earning rule for a specific loyalty campaign.
|
|
616
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes an earning rule for a specific loyalty campaign.
|
|
549
617
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
550
618
|
# @param earning_rule_id [String] A unique earning rule ID.
|
|
551
619
|
# @param [Hash] opts the optional parameters
|
|
@@ -593,7 +661,7 @@ module VoucherifySdk
|
|
|
593
661
|
end
|
|
594
662
|
|
|
595
663
|
# Delete Loyalty Campaign
|
|
596
|
-
# Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin.
|
|
664
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to [the bin](/api-reference/bin/list-bin-entries).
|
|
597
665
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
598
666
|
# @param [Hash] opts the optional parameters
|
|
599
667
|
# @option opts [Boolean] :force If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name.
|
|
@@ -604,7 +672,7 @@ module VoucherifySdk
|
|
|
604
672
|
end
|
|
605
673
|
|
|
606
674
|
# Delete Loyalty Campaign
|
|
607
|
-
# Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin.
|
|
675
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to [the bin](/api-reference/bin/list-bin-entries).
|
|
608
676
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
609
677
|
# @param [Hash] opts the optional parameters
|
|
610
678
|
# @option opts [Boolean] :force If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name.
|
|
@@ -654,8 +722,8 @@ module VoucherifySdk
|
|
|
654
722
|
return data, status_code, headers
|
|
655
723
|
end
|
|
656
724
|
|
|
657
|
-
# Delete Reward Assignment
|
|
658
|
-
# This method deletes a reward assignment for a particular loyalty campaign.
|
|
725
|
+
# Delete Campaign Reward Assignment
|
|
726
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes a reward assignment for a particular loyalty campaign.
|
|
659
727
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
660
728
|
# @param assignment_id [String] A unique reward assignment ID.
|
|
661
729
|
# @param [Hash] opts the optional parameters
|
|
@@ -665,8 +733,8 @@ module VoucherifySdk
|
|
|
665
733
|
nil
|
|
666
734
|
end
|
|
667
735
|
|
|
668
|
-
# Delete Reward Assignment
|
|
669
|
-
# This method deletes a reward assignment for a particular loyalty campaign.
|
|
736
|
+
# Delete Campaign Reward Assignment
|
|
737
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes a reward assignment for a particular loyalty campaign.
|
|
670
738
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
671
739
|
# @param assignment_id [String] A unique reward assignment ID.
|
|
672
740
|
# @param [Hash] opts the optional parameters
|
|
@@ -714,7 +782,7 @@ module VoucherifySdk
|
|
|
714
782
|
end
|
|
715
783
|
|
|
716
784
|
# Disable Earning Rule
|
|
717
|
-
# Disable an earning rule.
|
|
785
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Disable an earning rule.
|
|
718
786
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
719
787
|
# @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
|
|
720
788
|
# @param [Hash] opts the optional parameters
|
|
@@ -725,7 +793,7 @@ module VoucherifySdk
|
|
|
725
793
|
end
|
|
726
794
|
|
|
727
795
|
# Disable Earning Rule
|
|
728
|
-
# Disable an earning rule.
|
|
796
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Disable an earning rule.
|
|
729
797
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
730
798
|
# @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
|
|
731
799
|
# @param [Hash] opts the optional parameters
|
|
@@ -775,7 +843,7 @@ module VoucherifySdk
|
|
|
775
843
|
end
|
|
776
844
|
|
|
777
845
|
# Enable Earning Rule
|
|
778
|
-
# Enable an earning rule.
|
|
846
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Enable an earning rule.
|
|
779
847
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
780
848
|
# @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
|
|
781
849
|
# @param [Hash] opts the optional parameters
|
|
@@ -786,7 +854,7 @@ module VoucherifySdk
|
|
|
786
854
|
end
|
|
787
855
|
|
|
788
856
|
# Enable Earning Rule
|
|
789
|
-
# Enable an earning rule.
|
|
857
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Enable an earning rule.
|
|
790
858
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
791
859
|
# @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
|
|
792
860
|
# @param [Hash] opts the optional parameters
|
|
@@ -835,8 +903,74 @@ module VoucherifySdk
|
|
|
835
903
|
return data, status_code, headers
|
|
836
904
|
end
|
|
837
905
|
|
|
906
|
+
# Export Loyalty Campaign Transactions
|
|
907
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: <Tip> <Badge color green>Export Campaign Transactions</Badge> This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions. </Tip>
|
|
908
|
+
# @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
|
|
909
|
+
# @param [Hash] opts the optional parameters
|
|
910
|
+
# @option opts [LoyaltiesTransactionsExportCreateRequestBody] :loyalties_transactions_export_create_request_body Specify the parameters for the transaction export.
|
|
911
|
+
# @return [CampaignsTransactionsExportCreateResponseBody]
|
|
912
|
+
def export_loyalty_campaign_transactions(campaign_id, opts = {})
|
|
913
|
+
data, _status_code, _headers = export_loyalty_campaign_transactions_with_http_info(campaign_id, opts)
|
|
914
|
+
data
|
|
915
|
+
end
|
|
916
|
+
|
|
917
|
+
# Export Loyalty Campaign Transactions
|
|
918
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: <Tip> <Badge color green>Export Campaign Transactions</Badge> This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions. </Tip>
|
|
919
|
+
# @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
|
|
920
|
+
# @param [Hash] opts the optional parameters
|
|
921
|
+
# @option opts [LoyaltiesTransactionsExportCreateRequestBody] :loyalties_transactions_export_create_request_body Specify the parameters for the transaction export.
|
|
922
|
+
# @return [Array<(CampaignsTransactionsExportCreateResponseBody, Integer, Hash)>] CampaignsTransactionsExportCreateResponseBody data, response status code and response headers
|
|
923
|
+
private def export_loyalty_campaign_transactions_with_http_info(campaign_id, opts = {})
|
|
924
|
+
if @api_client.config.debugging
|
|
925
|
+
@api_client.config.logger.debug 'Calling API: LoyaltiesApi.export_loyalty_campaign_transactions ...'
|
|
926
|
+
end
|
|
927
|
+
# resource path
|
|
928
|
+
local_var_path = '/v1/loyalties/{campaignId}/transactions/export'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
929
|
+
|
|
930
|
+
# query parameters
|
|
931
|
+
query_params = opts[:query_params] || {}
|
|
932
|
+
|
|
933
|
+
# header parameters
|
|
934
|
+
header_params = opts[:header_params] || {}
|
|
935
|
+
# HTTP header 'Accept' (if needed)
|
|
936
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
937
|
+
# HTTP header 'Content-Type'
|
|
938
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
939
|
+
if !content_type.nil?
|
|
940
|
+
header_params['Content-Type'] = content_type
|
|
941
|
+
end
|
|
942
|
+
|
|
943
|
+
# form parameters
|
|
944
|
+
form_params = opts[:form_params] || {}
|
|
945
|
+
|
|
946
|
+
# http body (model)
|
|
947
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'loyalties_transactions_export_create_request_body'])
|
|
948
|
+
|
|
949
|
+
# return_type
|
|
950
|
+
return_type = opts[:debug_return_type] || 'CampaignsTransactionsExportCreateResponseBody'
|
|
951
|
+
|
|
952
|
+
# auth_names
|
|
953
|
+
auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
|
|
954
|
+
|
|
955
|
+
new_options = opts.merge(
|
|
956
|
+
:operation => :"LoyaltiesApi.export_loyalty_campaign_transactions",
|
|
957
|
+
:header_params => header_params,
|
|
958
|
+
:query_params => query_params,
|
|
959
|
+
:form_params => form_params,
|
|
960
|
+
:body => post_body,
|
|
961
|
+
:auth_names => auth_names,
|
|
962
|
+
:return_type => return_type
|
|
963
|
+
)
|
|
964
|
+
|
|
965
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
966
|
+
if @api_client.config.debugging
|
|
967
|
+
@api_client.config.logger.debug "API called: LoyaltiesApi#export_loyalty_campaign_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
968
|
+
end
|
|
969
|
+
return data, status_code, headers
|
|
970
|
+
end
|
|
971
|
+
|
|
838
972
|
# Export Loyalty Card Transactions
|
|
839
|
-
# Export transactions that are associated with point movements on a loyalty card.
|
|
973
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card.
|
|
840
974
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
|
|
841
975
|
# @param [Hash] opts the optional parameters
|
|
842
976
|
# @option opts [LoyaltiesMembersTransactionsExportCreateRequestBody] :loyalties_members_transactions_export_create_request_body Specify the parameters and filters for the transaction export.
|
|
@@ -847,7 +981,7 @@ module VoucherifySdk
|
|
|
847
981
|
end
|
|
848
982
|
|
|
849
983
|
# Export Loyalty Card Transactions
|
|
850
|
-
# Export transactions that are associated with point movements on a loyalty card.
|
|
984
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card.
|
|
851
985
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
|
|
852
986
|
# @param [Hash] opts the optional parameters
|
|
853
987
|
# @option opts [LoyaltiesMembersTransactionsExportCreateRequestBody] :loyalties_members_transactions_export_create_request_body Specify the parameters and filters for the transaction export.
|
|
@@ -901,8 +1035,8 @@ module VoucherifySdk
|
|
|
901
1035
|
return data, status_code, headers
|
|
902
1036
|
end
|
|
903
1037
|
|
|
904
|
-
# Export Loyalty Card Transactions
|
|
905
|
-
# Export transactions that are associated with point movements on a loyalty card.
|
|
1038
|
+
# Export Loyalty Card Transactions with campaign ID
|
|
1039
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card.
|
|
906
1040
|
# @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
|
|
907
1041
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
|
|
908
1042
|
# @param [Hash] opts the optional parameters
|
|
@@ -913,8 +1047,8 @@ module VoucherifySdk
|
|
|
913
1047
|
data
|
|
914
1048
|
end
|
|
915
1049
|
|
|
916
|
-
# Export Loyalty Card Transactions
|
|
917
|
-
# Export transactions that are associated with point movements on a loyalty card.
|
|
1050
|
+
# Export Loyalty Card Transactions with campaign ID
|
|
1051
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card.
|
|
918
1052
|
# @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
|
|
919
1053
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
|
|
920
1054
|
# @param [Hash] opts the optional parameters
|
|
@@ -970,7 +1104,7 @@ module VoucherifySdk
|
|
|
970
1104
|
end
|
|
971
1105
|
|
|
972
1106
|
# Get Earning Rule
|
|
973
|
-
# Retrieves an earning rule assigned to a campaign.
|
|
1107
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves an earning rule assigned to a campaign.
|
|
974
1108
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
975
1109
|
# @param earning_rule_id [String] A unique earning rule ID.
|
|
976
1110
|
# @param [Hash] opts the optional parameters
|
|
@@ -981,7 +1115,7 @@ module VoucherifySdk
|
|
|
981
1115
|
end
|
|
982
1116
|
|
|
983
1117
|
# Get Earning Rule
|
|
984
|
-
# Retrieves an earning rule assigned to a campaign.
|
|
1118
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves an earning rule assigned to a campaign.
|
|
985
1119
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
986
1120
|
# @param earning_rule_id [String] A unique earning rule ID.
|
|
987
1121
|
# @param [Hash] opts the optional parameters
|
|
@@ -1031,7 +1165,7 @@ module VoucherifySdk
|
|
|
1031
1165
|
end
|
|
1032
1166
|
|
|
1033
1167
|
# Get Loyalty Campaign
|
|
1034
|
-
# Retrieve a specific loyalty campaign.
|
|
1168
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a specific loyalty campaign.
|
|
1035
1169
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1036
1170
|
# @param [Hash] opts the optional parameters
|
|
1037
1171
|
# @return [LoyaltiesGetCampaignResponseBody]
|
|
@@ -1041,7 +1175,7 @@ module VoucherifySdk
|
|
|
1041
1175
|
end
|
|
1042
1176
|
|
|
1043
1177
|
# Get Loyalty Campaign
|
|
1044
|
-
# Retrieve a specific loyalty campaign.
|
|
1178
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a specific loyalty campaign.
|
|
1045
1179
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1046
1180
|
# @param [Hash] opts the optional parameters
|
|
1047
1181
|
# @return [Array<(LoyaltiesGetCampaignResponseBody, Integer, Hash)>] LoyaltiesGetCampaignResponseBody data, response status code and response headers
|
|
@@ -1090,7 +1224,7 @@ module VoucherifySdk
|
|
|
1090
1224
|
end
|
|
1091
1225
|
|
|
1092
1226
|
# Get Loyalty Tier
|
|
1093
|
-
# Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
|
|
1227
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
|
|
1094
1228
|
# @param campaign_id [String] Unique loyalty campaign ID or name.
|
|
1095
1229
|
# @param loyalty_tier_id [String] Unique loyalty tier ID.
|
|
1096
1230
|
# @param [Hash] opts the optional parameters
|
|
@@ -1101,7 +1235,7 @@ module VoucherifySdk
|
|
|
1101
1235
|
end
|
|
1102
1236
|
|
|
1103
1237
|
# Get Loyalty Tier
|
|
1104
|
-
# Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
|
|
1238
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
|
|
1105
1239
|
# @param campaign_id [String] Unique loyalty campaign ID or name.
|
|
1106
1240
|
# @param loyalty_tier_id [String] Unique loyalty tier ID.
|
|
1107
1241
|
# @param [Hash] opts the optional parameters
|
|
@@ -1151,7 +1285,7 @@ module VoucherifySdk
|
|
|
1151
1285
|
end
|
|
1152
1286
|
|
|
1153
1287
|
# Get Member
|
|
1154
|
-
# Retrieve loyalty card with the given member ID (i.e. voucher code).
|
|
1288
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve loyalty card with the given member ID (i.e. voucher code). <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter. </Note>
|
|
1155
1289
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
1156
1290
|
# @param [Hash] opts the optional parameters
|
|
1157
1291
|
# @return [LoyaltiesMembersGetResponseBody]
|
|
@@ -1161,7 +1295,7 @@ module VoucherifySdk
|
|
|
1161
1295
|
end
|
|
1162
1296
|
|
|
1163
1297
|
# Get Member
|
|
1164
|
-
# Retrieve loyalty card with the given member ID (i.e. voucher code).
|
|
1298
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve loyalty card with the given member ID (i.e. voucher code). <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter. </Note>
|
|
1165
1299
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
1166
1300
|
# @param [Hash] opts the optional parameters
|
|
1167
1301
|
# @return [Array<(LoyaltiesMembersGetResponseBody, Integer, Hash)>] LoyaltiesMembersGetResponseBody data, response status code and response headers
|
|
@@ -1209,8 +1343,8 @@ module VoucherifySdk
|
|
|
1209
1343
|
return data, status_code, headers
|
|
1210
1344
|
end
|
|
1211
1345
|
|
|
1212
|
-
# Get Member
|
|
1213
|
-
# Retrieves the loyalty card with the given member ID (i.e. voucher code).
|
|
1346
|
+
# Get Member with campaign ID
|
|
1347
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the loyalty card with the given member ID (i.e. voucher code).
|
|
1214
1348
|
# @param campaign_id [String] Unique campaign ID.
|
|
1215
1349
|
# @param member_id [String] Unique code that identifies the loyalty card.
|
|
1216
1350
|
# @param [Hash] opts the optional parameters
|
|
@@ -1220,8 +1354,8 @@ module VoucherifySdk
|
|
|
1220
1354
|
data
|
|
1221
1355
|
end
|
|
1222
1356
|
|
|
1223
|
-
# Get Member
|
|
1224
|
-
# Retrieves the loyalty card with the given member ID (i.e. voucher code).
|
|
1357
|
+
# Get Member with campaign ID
|
|
1358
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the loyalty card with the given member ID (i.e. voucher code).
|
|
1225
1359
|
# @param campaign_id [String] Unique campaign ID.
|
|
1226
1360
|
# @param member_id [String] Unique code that identifies the loyalty card.
|
|
1227
1361
|
# @param [Hash] opts the optional parameters
|
|
@@ -1270,8 +1404,8 @@ module VoucherifySdk
|
|
|
1270
1404
|
return data, status_code, headers
|
|
1271
1405
|
end
|
|
1272
1406
|
|
|
1273
|
-
# Get Reward
|
|
1274
|
-
# Retrieve specific reward assignment.
|
|
1407
|
+
# Get Campaign Reward Assignments
|
|
1408
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment.
|
|
1275
1409
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1276
1410
|
# @param assignment_id [String] Unique reward assignment ID.
|
|
1277
1411
|
# @param [Hash] opts the optional parameters
|
|
@@ -1281,8 +1415,8 @@ module VoucherifySdk
|
|
|
1281
1415
|
data
|
|
1282
1416
|
end
|
|
1283
1417
|
|
|
1284
|
-
# Get Reward
|
|
1285
|
-
# Retrieve specific reward assignment.
|
|
1418
|
+
# Get Campaign Reward Assignments
|
|
1419
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment.
|
|
1286
1420
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1287
1421
|
# @param assignment_id [String] Unique reward assignment ID.
|
|
1288
1422
|
# @param [Hash] opts the optional parameters
|
|
@@ -1331,8 +1465,8 @@ module VoucherifySdk
|
|
|
1331
1465
|
return data, status_code, headers
|
|
1332
1466
|
end
|
|
1333
1467
|
|
|
1334
|
-
# Get Reward Assignment
|
|
1335
|
-
# Retrieve specific reward assignment.
|
|
1468
|
+
# Get Campaign Reward Assignment
|
|
1469
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments). </Note>
|
|
1336
1470
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1337
1471
|
# @param assignment_id [String] A unique reward assignment ID.
|
|
1338
1472
|
# @param [Hash] opts the optional parameters
|
|
@@ -1342,8 +1476,8 @@ module VoucherifySdk
|
|
|
1342
1476
|
data
|
|
1343
1477
|
end
|
|
1344
1478
|
|
|
1345
|
-
# Get Reward Assignment
|
|
1346
|
-
# Retrieve specific reward assignment.
|
|
1479
|
+
# Get Campaign Reward Assignment
|
|
1480
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments). </Note>
|
|
1347
1481
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1348
1482
|
# @param assignment_id [String] A unique reward assignment ID.
|
|
1349
1483
|
# @param [Hash] opts the optional parameters
|
|
@@ -1393,7 +1527,7 @@ module VoucherifySdk
|
|
|
1393
1527
|
end
|
|
1394
1528
|
|
|
1395
1529
|
# Get Reward Details
|
|
1396
|
-
# Get reward details in the context of a loyalty campaign and reward assignment ID.
|
|
1530
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get reward details in the context of a loyalty campaign and reward assignment ID.
|
|
1397
1531
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1398
1532
|
# @param assignment_id [String] Unique reward assignment ID.
|
|
1399
1533
|
# @param [Hash] opts the optional parameters
|
|
@@ -1404,7 +1538,7 @@ module VoucherifySdk
|
|
|
1404
1538
|
end
|
|
1405
1539
|
|
|
1406
1540
|
# Get Reward Details
|
|
1407
|
-
# Get reward details in the context of a loyalty campaign and reward assignment ID.
|
|
1541
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get reward details in the context of a loyalty campaign and reward assignment ID.
|
|
1408
1542
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1409
1543
|
# @param assignment_id [String] Unique reward assignment ID.
|
|
1410
1544
|
# @param [Hash] opts the optional parameters
|
|
@@ -1454,7 +1588,7 @@ module VoucherifySdk
|
|
|
1454
1588
|
end
|
|
1455
1589
|
|
|
1456
1590
|
# List Campaign Pending Points
|
|
1457
|
-
#
|
|
1591
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
1458
1592
|
# @param campaign_id [String] Unique campaign ID.
|
|
1459
1593
|
# @param [Hash] opts the optional parameters
|
|
1460
1594
|
# @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
|
|
@@ -1467,7 +1601,7 @@ module VoucherifySdk
|
|
|
1467
1601
|
end
|
|
1468
1602
|
|
|
1469
1603
|
# List Campaign Pending Points
|
|
1470
|
-
# >
|
|
1604
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
1471
1605
|
# @param campaign_id [String] Unique campaign ID.
|
|
1472
1606
|
# @param [Hash] opts the optional parameters
|
|
1473
1607
|
# @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
|
|
@@ -1522,7 +1656,7 @@ module VoucherifySdk
|
|
|
1522
1656
|
end
|
|
1523
1657
|
|
|
1524
1658
|
# List Earning Rules
|
|
1525
|
-
# Returns a list of all earning rules within a given campaign.
|
|
1659
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of all earning rules within a given campaign.
|
|
1526
1660
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1527
1661
|
# @param [Hash] opts the optional parameters
|
|
1528
1662
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1535,7 +1669,7 @@ module VoucherifySdk
|
|
|
1535
1669
|
end
|
|
1536
1670
|
|
|
1537
1671
|
# List Earning Rules
|
|
1538
|
-
# Returns a list of all earning rules within a given campaign.
|
|
1672
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of all earning rules within a given campaign.
|
|
1539
1673
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1540
1674
|
# @param [Hash] opts the optional parameters
|
|
1541
1675
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1589,8 +1723,79 @@ module VoucherifySdk
|
|
|
1589
1723
|
return data, status_code, headers
|
|
1590
1724
|
end
|
|
1591
1725
|
|
|
1726
|
+
# List Loyalty Campaign Transactions
|
|
1727
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves all transactions for the campaign with the given campaign ID or campaign name.
|
|
1728
|
+
# @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
|
|
1729
|
+
# @param [Hash] opts the optional parameters
|
|
1730
|
+
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
1731
|
+
# @option opts [ParameterOrderListTransactions] :order Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
1732
|
+
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
|
|
1733
|
+
# @option opts [ParametersFiltersListCampaignTransactions] :filters Filters for listing responses. The id filter denotes the unique transaction identifier.
|
|
1734
|
+
# @return [LoyaltiesTransactionsListResponseBody]
|
|
1735
|
+
def list_loyalty_campaign_transactions(campaign_id, opts = {})
|
|
1736
|
+
data, _status_code, _headers = list_loyalty_campaign_transactions_with_http_info(campaign_id, opts)
|
|
1737
|
+
data
|
|
1738
|
+
end
|
|
1739
|
+
|
|
1740
|
+
# List Loyalty Campaign Transactions
|
|
1741
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves all transactions for the campaign with the given campaign ID or campaign name.
|
|
1742
|
+
# @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
|
|
1743
|
+
# @param [Hash] opts the optional parameters
|
|
1744
|
+
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
1745
|
+
# @option opts [ParameterOrderListTransactions] :order Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
1746
|
+
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
|
|
1747
|
+
# @option opts [ParametersFiltersListCampaignTransactions] :filters Filters for listing responses. The id filter denotes the unique transaction identifier.
|
|
1748
|
+
# @return [Array<(LoyaltiesTransactionsListResponseBody, Integer, Hash)>] LoyaltiesTransactionsListResponseBody data, response status code and response headers
|
|
1749
|
+
private def list_loyalty_campaign_transactions_with_http_info(campaign_id, opts = {})
|
|
1750
|
+
if @api_client.config.debugging
|
|
1751
|
+
@api_client.config.logger.debug 'Calling API: LoyaltiesApi.list_loyalty_campaign_transactions ...'
|
|
1752
|
+
end
|
|
1753
|
+
# resource path
|
|
1754
|
+
local_var_path = '/v1/loyalties/{campaignId}/transactions'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
|
1755
|
+
|
|
1756
|
+
# query parameters
|
|
1757
|
+
query_params = opts[:query_params] || {}
|
|
1758
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
1759
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
1760
|
+
query_params[:'starting_after_id'] = opts[:'starting_after_id'] if !opts[:'starting_after_id'].nil?
|
|
1761
|
+
query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?
|
|
1762
|
+
|
|
1763
|
+
# header parameters
|
|
1764
|
+
header_params = opts[:header_params] || {}
|
|
1765
|
+
# HTTP header 'Accept' (if needed)
|
|
1766
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1767
|
+
|
|
1768
|
+
# form parameters
|
|
1769
|
+
form_params = opts[:form_params] || {}
|
|
1770
|
+
|
|
1771
|
+
# http body (model)
|
|
1772
|
+
post_body = opts[:debug_body]
|
|
1773
|
+
|
|
1774
|
+
# return_type
|
|
1775
|
+
return_type = opts[:debug_return_type] || 'LoyaltiesTransactionsListResponseBody'
|
|
1776
|
+
|
|
1777
|
+
# auth_names
|
|
1778
|
+
auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
|
|
1779
|
+
|
|
1780
|
+
new_options = opts.merge(
|
|
1781
|
+
:operation => :"LoyaltiesApi.list_loyalty_campaign_transactions",
|
|
1782
|
+
:header_params => header_params,
|
|
1783
|
+
:query_params => query_params,
|
|
1784
|
+
:form_params => form_params,
|
|
1785
|
+
:body => post_body,
|
|
1786
|
+
:auth_names => auth_names,
|
|
1787
|
+
:return_type => return_type
|
|
1788
|
+
)
|
|
1789
|
+
|
|
1790
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1791
|
+
if @api_client.config.debugging
|
|
1792
|
+
@api_client.config.logger.debug "API called: LoyaltiesApi#list_loyalty_campaign_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1793
|
+
end
|
|
1794
|
+
return data, status_code, headers
|
|
1795
|
+
end
|
|
1796
|
+
|
|
1592
1797
|
# List Loyalty Card Transactions
|
|
1593
|
-
# Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1798
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1594
1799
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
|
|
1595
1800
|
# @param [Hash] opts the optional parameters
|
|
1596
1801
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1603,7 +1808,7 @@ module VoucherifySdk
|
|
|
1603
1808
|
end
|
|
1604
1809
|
|
|
1605
1810
|
# List Loyalty Card Transactions
|
|
1606
|
-
# Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1811
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1607
1812
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
|
|
1608
1813
|
# @param [Hash] opts the optional parameters
|
|
1609
1814
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1657,8 +1862,8 @@ module VoucherifySdk
|
|
|
1657
1862
|
return data, status_code, headers
|
|
1658
1863
|
end
|
|
1659
1864
|
|
|
1660
|
-
# List Loyalty Card Transactions
|
|
1661
|
-
# Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1865
|
+
# List Loyalty Card Transactions with campaign ID
|
|
1866
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1662
1867
|
# @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
|
|
1663
1868
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
|
|
1664
1869
|
# @param [Hash] opts the optional parameters
|
|
@@ -1671,8 +1876,8 @@ module VoucherifySdk
|
|
|
1671
1876
|
data
|
|
1672
1877
|
end
|
|
1673
1878
|
|
|
1674
|
-
# List Loyalty Card Transactions
|
|
1675
|
-
# Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1879
|
+
# List Loyalty Card Transactions with campaign ID
|
|
1880
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1676
1881
|
# @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
|
|
1677
1882
|
# @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
|
|
1678
1883
|
# @param [Hash] opts the optional parameters
|
|
@@ -1728,7 +1933,7 @@ module VoucherifySdk
|
|
|
1728
1933
|
end
|
|
1729
1934
|
|
|
1730
1935
|
# List Loyalty Campaigns
|
|
1731
|
-
# Returns a list of your loyalty campaigns.
|
|
1936
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty campaigns.
|
|
1732
1937
|
# @param [Hash] opts the optional parameters
|
|
1733
1938
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
1734
1939
|
# @option opts [Integer] :page Which page of results to return. The lowest value is 1.
|
|
@@ -1740,7 +1945,7 @@ module VoucherifySdk
|
|
|
1740
1945
|
end
|
|
1741
1946
|
|
|
1742
1947
|
# List Loyalty Campaigns
|
|
1743
|
-
# Returns a list of your loyalty campaigns.
|
|
1948
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty campaigns.
|
|
1744
1949
|
# @param [Hash] opts the optional parameters
|
|
1745
1950
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
1746
1951
|
# @option opts [Integer] :page Which page of results to return. The lowest value is 1.
|
|
@@ -1794,7 +1999,7 @@ module VoucherifySdk
|
|
|
1794
1999
|
end
|
|
1795
2000
|
|
|
1796
2001
|
# List Loyalty Tier Earning Rules
|
|
1797
|
-
# Retrieve available earning rules for a given tier and the calculation method for earning points.
|
|
2002
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve available earning rules for a given tier and the calculation method for earning points.
|
|
1798
2003
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
1799
2004
|
# @param loyalty_tier_id [String] Unique loyalty tier ID.
|
|
1800
2005
|
# @param [Hash] opts the optional parameters
|
|
@@ -1807,7 +2012,7 @@ module VoucherifySdk
|
|
|
1807
2012
|
end
|
|
1808
2013
|
|
|
1809
2014
|
# List Loyalty Tier Earning Rules
|
|
1810
|
-
# Retrieve available earning rules for a given tier and the calculation method for earning points.
|
|
2015
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve available earning rules for a given tier and the calculation method for earning points.
|
|
1811
2016
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
1812
2017
|
# @param loyalty_tier_id [String] Unique loyalty tier ID.
|
|
1813
2018
|
# @param [Hash] opts the optional parameters
|
|
@@ -1861,7 +2066,7 @@ module VoucherifySdk
|
|
|
1861
2066
|
end
|
|
1862
2067
|
|
|
1863
2068
|
# List Loyalty Tier Rewards
|
|
1864
|
-
# Get available rewards for a given tier.
|
|
2069
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get available rewards for a given tier.
|
|
1865
2070
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
1866
2071
|
# @param loyalty_tier_id [String] Unique loyalty tier ID.
|
|
1867
2072
|
# @param [Hash] opts the optional parameters
|
|
@@ -1872,7 +2077,7 @@ module VoucherifySdk
|
|
|
1872
2077
|
end
|
|
1873
2078
|
|
|
1874
2079
|
# List Loyalty Tier Rewards
|
|
1875
|
-
# Get available rewards for a given tier.
|
|
2080
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get available rewards for a given tier.
|
|
1876
2081
|
# @param campaign_id [String] Unique campaign ID or name.
|
|
1877
2082
|
# @param loyalty_tier_id [String] Unique loyalty tier ID.
|
|
1878
2083
|
# @param [Hash] opts the optional parameters
|
|
@@ -1922,7 +2127,7 @@ module VoucherifySdk
|
|
|
1922
2127
|
end
|
|
1923
2128
|
|
|
1924
2129
|
# List Loyalty Tiers
|
|
1925
|
-
# Retrieve a list of loyalty tiers which were added to the loyalty program.
|
|
2130
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a list of loyalty tiers which were added to the loyalty program.
|
|
1926
2131
|
# @param campaign_id [String] Unique loyalty campaign ID or name.
|
|
1927
2132
|
# @param [Hash] opts the optional parameters
|
|
1928
2133
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1934,7 +2139,7 @@ module VoucherifySdk
|
|
|
1934
2139
|
end
|
|
1935
2140
|
|
|
1936
2141
|
# List Loyalty Tiers
|
|
1937
|
-
# Retrieve a list of loyalty tiers which were added to the loyalty program.
|
|
2142
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a list of loyalty tiers which were added to the loyalty program.
|
|
1938
2143
|
# @param campaign_id [String] Unique loyalty campaign ID or name.
|
|
1939
2144
|
# @param [Hash] opts the optional parameters
|
|
1940
2145
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1987,7 +2192,7 @@ module VoucherifySdk
|
|
|
1987
2192
|
end
|
|
1988
2193
|
|
|
1989
2194
|
# List Member Activity
|
|
1990
|
-
#
|
|
2195
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. </Note> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
1991
2196
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
1992
2197
|
# @param [Hash] opts the optional parameters
|
|
1993
2198
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2000,7 +2205,7 @@ module VoucherifySdk
|
|
|
2000
2205
|
end
|
|
2001
2206
|
|
|
2002
2207
|
# List Member Activity
|
|
2003
|
-
#
|
|
2208
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. </Note> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
2004
2209
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2005
2210
|
# @param [Hash] opts the optional parameters
|
|
2006
2211
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2054,8 +2259,8 @@ module VoucherifySdk
|
|
|
2054
2259
|
return data, status_code, headers
|
|
2055
2260
|
end
|
|
2056
2261
|
|
|
2057
|
-
# List Member Activity
|
|
2058
|
-
# Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
2262
|
+
# List Member Activity with campaign ID
|
|
2263
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
2059
2264
|
# @param campaign_id [String] Unique campaign ID.
|
|
2060
2265
|
# @param member_id [String] A code that identifies the loyalty card.
|
|
2061
2266
|
# @param [Hash] opts the optional parameters
|
|
@@ -2068,8 +2273,8 @@ module VoucherifySdk
|
|
|
2068
2273
|
data
|
|
2069
2274
|
end
|
|
2070
2275
|
|
|
2071
|
-
# List Member Activity
|
|
2072
|
-
# Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
2276
|
+
# List Member Activity with campaign ID
|
|
2277
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
2073
2278
|
# @param campaign_id [String] Unique campaign ID.
|
|
2074
2279
|
# @param member_id [String] A code that identifies the loyalty card.
|
|
2075
2280
|
# @param [Hash] opts the optional parameters
|
|
@@ -2125,7 +2330,7 @@ module VoucherifySdk
|
|
|
2125
2330
|
end
|
|
2126
2331
|
|
|
2127
2332
|
# List Member's Loyalty Tiers
|
|
2128
|
-
# Retrieve member tiers using the loyalty card ID.
|
|
2333
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve member tiers using the loyalty card ID.
|
|
2129
2334
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2130
2335
|
# @param [Hash] opts the optional parameters
|
|
2131
2336
|
# @return [LoyaltiesMembersTiersListResponseBody]
|
|
@@ -2135,7 +2340,7 @@ module VoucherifySdk
|
|
|
2135
2340
|
end
|
|
2136
2341
|
|
|
2137
2342
|
# List Member's Loyalty Tiers
|
|
2138
|
-
# Retrieve member tiers using the loyalty card ID.
|
|
2343
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve member tiers using the loyalty card ID.
|
|
2139
2344
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2140
2345
|
# @param [Hash] opts the optional parameters
|
|
2141
2346
|
# @return [Array<(LoyaltiesMembersTiersListResponseBody, Integer, Hash)>] LoyaltiesMembersTiersListResponseBody data, response status code and response headers
|
|
@@ -2184,7 +2389,7 @@ module VoucherifySdk
|
|
|
2184
2389
|
end
|
|
2185
2390
|
|
|
2186
2391
|
# List Member Pending Points
|
|
2187
|
-
#
|
|
2392
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. </Note> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
2188
2393
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
2189
2394
|
# @param [Hash] opts the optional parameters
|
|
2190
2395
|
# @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
|
|
@@ -2197,7 +2402,7 @@ module VoucherifySdk
|
|
|
2197
2402
|
end
|
|
2198
2403
|
|
|
2199
2404
|
# List Member Pending Points
|
|
2200
|
-
# >
|
|
2405
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. </Note> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
2201
2406
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
2202
2407
|
# @param [Hash] opts the optional parameters
|
|
2203
2408
|
# @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
|
|
@@ -2251,8 +2456,8 @@ module VoucherifySdk
|
|
|
2251
2456
|
return data, status_code, headers
|
|
2252
2457
|
end
|
|
2253
2458
|
|
|
2254
|
-
# List Member Pending Points
|
|
2255
|
-
#
|
|
2459
|
+
# List Member Pending Points with campaign ID
|
|
2460
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
2256
2461
|
# @param campaign_id [String] Unique campaign ID.
|
|
2257
2462
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
2258
2463
|
# @param [Hash] opts the optional parameters
|
|
@@ -2265,8 +2470,8 @@ module VoucherifySdk
|
|
|
2265
2470
|
data
|
|
2266
2471
|
end
|
|
2267
2472
|
|
|
2268
|
-
# List Member Pending Points
|
|
2269
|
-
# >
|
|
2473
|
+
# List Member Pending Points with campaign ID
|
|
2474
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
|
|
2270
2475
|
# @param campaign_id [String] Unique campaign ID.
|
|
2271
2476
|
# @param member_id [String] Unique loyalty card code assigned to a particular customer.
|
|
2272
2477
|
# @param [Hash] opts the optional parameters
|
|
@@ -2322,7 +2527,7 @@ module VoucherifySdk
|
|
|
2322
2527
|
end
|
|
2323
2528
|
|
|
2324
2529
|
# List Member Rewards
|
|
2325
|
-
# Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
|
|
2530
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
|
|
2326
2531
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2327
2532
|
# @param [Hash] opts the optional parameters
|
|
2328
2533
|
# @option opts [Boolean] :affordable_only Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford.
|
|
@@ -2333,7 +2538,7 @@ module VoucherifySdk
|
|
|
2333
2538
|
end
|
|
2334
2539
|
|
|
2335
2540
|
# List Member Rewards
|
|
2336
|
-
# Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
|
|
2541
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
|
|
2337
2542
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2338
2543
|
# @param [Hash] opts the optional parameters
|
|
2339
2544
|
# @option opts [Boolean] :affordable_only Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford.
|
|
@@ -2384,7 +2589,7 @@ module VoucherifySdk
|
|
|
2384
2589
|
end
|
|
2385
2590
|
|
|
2386
2591
|
# List Members
|
|
2387
|
-
# Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
|
|
2592
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
|
|
2388
2593
|
# @param campaign_id [String] Unique campaign ID of the loyalty program.
|
|
2389
2594
|
# @param [Hash] opts the optional parameters
|
|
2390
2595
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2402,7 +2607,7 @@ module VoucherifySdk
|
|
|
2402
2607
|
end
|
|
2403
2608
|
|
|
2404
2609
|
# List Members
|
|
2405
|
-
# Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
|
|
2610
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
|
|
2406
2611
|
# @param campaign_id [String] Unique campaign ID of the loyalty program.
|
|
2407
2612
|
# @param [Hash] opts the optional parameters
|
|
2408
2613
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2467,7 +2672,7 @@ module VoucherifySdk
|
|
|
2467
2672
|
end
|
|
2468
2673
|
|
|
2469
2674
|
# List Loyalty Card Point Expiration
|
|
2470
|
-
# Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
|
|
2675
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the [Exports API](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
|
|
2471
2676
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2472
2677
|
# @param member_id [String] Loyalty card code.
|
|
2473
2678
|
# @param [Hash] opts the optional parameters
|
|
@@ -2480,7 +2685,7 @@ module VoucherifySdk
|
|
|
2480
2685
|
end
|
|
2481
2686
|
|
|
2482
2687
|
# List Loyalty Card Point Expiration
|
|
2483
|
-
# Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
|
|
2688
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the [Exports API](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
|
|
2484
2689
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2485
2690
|
# @param member_id [String] Loyalty card code.
|
|
2486
2691
|
# @param [Hash] opts the optional parameters
|
|
@@ -2533,8 +2738,8 @@ module VoucherifySdk
|
|
|
2533
2738
|
return data, status_code, headers
|
|
2534
2739
|
end
|
|
2535
2740
|
|
|
2536
|
-
# List Reward Assignments
|
|
2537
|
-
# Returns reward assignments from a given loyalty campaign.
|
|
2741
|
+
# List Reward Assignments with campaign ID
|
|
2742
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns reward assignments from a given loyalty campaign. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response. </Note>
|
|
2538
2743
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2539
2744
|
# @param [Hash] opts the optional parameters
|
|
2540
2745
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2546,8 +2751,8 @@ module VoucherifySdk
|
|
|
2546
2751
|
data
|
|
2547
2752
|
end
|
|
2548
2753
|
|
|
2549
|
-
# List Reward Assignments
|
|
2550
|
-
# Returns reward assignments from a given loyalty campaign.
|
|
2754
|
+
# List Reward Assignments with campaign ID
|
|
2755
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns reward assignments from a given loyalty campaign. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response. </Note>
|
|
2551
2756
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2552
2757
|
# @param [Hash] opts the optional parameters
|
|
2553
2758
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2601,8 +2806,8 @@ module VoucherifySdk
|
|
|
2601
2806
|
return data, status_code, headers
|
|
2602
2807
|
end
|
|
2603
2808
|
|
|
2604
|
-
# List
|
|
2605
|
-
# Returns active rewards from a given loyalty campaign.
|
|
2809
|
+
# List Campaign Rewards
|
|
2810
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns active rewards from a given loyalty campaign.
|
|
2606
2811
|
# @param campaign_id [String] Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2607
2812
|
# @param [Hash] opts the optional parameters
|
|
2608
2813
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2614,8 +2819,8 @@ module VoucherifySdk
|
|
|
2614
2819
|
data
|
|
2615
2820
|
end
|
|
2616
2821
|
|
|
2617
|
-
# List
|
|
2618
|
-
# Returns active rewards from a given loyalty campaign.
|
|
2822
|
+
# List Campaign Rewards
|
|
2823
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns active rewards from a given loyalty campaign.
|
|
2619
2824
|
# @param campaign_id [String] Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2620
2825
|
# @param [Hash] opts the optional parameters
|
|
2621
2826
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -2670,7 +2875,7 @@ module VoucherifySdk
|
|
|
2670
2875
|
end
|
|
2671
2876
|
|
|
2672
2877
|
# Redeem Reward
|
|
2673
|
-
#
|
|
2878
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter. </Note>
|
|
2674
2879
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2675
2880
|
# @param [Hash] opts the optional parameters
|
|
2676
2881
|
# @option opts [LoyaltiesMembersRedemptionRedeemRequestBody] :loyalties_members_redemption_redeem_request_body Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.
|
|
@@ -2681,7 +2886,7 @@ module VoucherifySdk
|
|
|
2681
2886
|
end
|
|
2682
2887
|
|
|
2683
2888
|
# Redeem Reward
|
|
2684
|
-
#
|
|
2889
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter. </Note>
|
|
2685
2890
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2686
2891
|
# @param [Hash] opts the optional parameters
|
|
2687
2892
|
# @option opts [LoyaltiesMembersRedemptionRedeemRequestBody] :loyalties_members_redemption_redeem_request_body Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.
|
|
@@ -2735,8 +2940,8 @@ module VoucherifySdk
|
|
|
2735
2940
|
return data, status_code, headers
|
|
2736
2941
|
end
|
|
2737
2942
|
|
|
2738
|
-
# Redeem Reward
|
|
2739
|
-
# Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
|
|
2943
|
+
# Redeem Reward with campaign ID
|
|
2944
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
|
|
2740
2945
|
# @param campaign_id [String] Unique campaign ID.
|
|
2741
2946
|
# @param member_id [String] A code that identifies the loyalty card.
|
|
2742
2947
|
# @param [Hash] opts the optional parameters
|
|
@@ -2747,8 +2952,8 @@ module VoucherifySdk
|
|
|
2747
2952
|
data
|
|
2748
2953
|
end
|
|
2749
2954
|
|
|
2750
|
-
# Redeem Reward
|
|
2751
|
-
# Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
|
|
2955
|
+
# Redeem Reward with campaign ID
|
|
2956
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
|
|
2752
2957
|
# @param campaign_id [String] Unique campaign ID.
|
|
2753
2958
|
# @param member_id [String] A code that identifies the loyalty card.
|
|
2754
2959
|
# @param [Hash] opts the optional parameters
|
|
@@ -2804,7 +3009,7 @@ module VoucherifySdk
|
|
|
2804
3009
|
end
|
|
2805
3010
|
|
|
2806
3011
|
# Transfer Loyalty Points
|
|
2807
|
-
# Transfer points between different loyalty cards
|
|
3012
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules.
|
|
2808
3013
|
# @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
|
|
2809
3014
|
# @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
|
|
2810
3015
|
# @param [Hash] opts the optional parameters
|
|
@@ -2816,7 +3021,7 @@ module VoucherifySdk
|
|
|
2816
3021
|
end
|
|
2817
3022
|
|
|
2818
3023
|
# Transfer Loyalty Points
|
|
2819
|
-
# Transfer points between different loyalty cards
|
|
3024
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules.
|
|
2820
3025
|
# @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
|
|
2821
3026
|
# @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
|
|
2822
3027
|
# @param [Hash] opts the optional parameters
|
|
@@ -2872,7 +3077,7 @@ module VoucherifySdk
|
|
|
2872
3077
|
end
|
|
2873
3078
|
|
|
2874
3079
|
# Update Earning Rule
|
|
2875
|
-
# Update an earning rule definition.
|
|
3080
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Update an earning rule definition.
|
|
2876
3081
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2877
3082
|
# @param earning_rule_id [String] A unique earning rule ID.
|
|
2878
3083
|
# @param [Hash] opts the optional parameters
|
|
@@ -2884,7 +3089,7 @@ module VoucherifySdk
|
|
|
2884
3089
|
end
|
|
2885
3090
|
|
|
2886
3091
|
# Update Earning Rule
|
|
2887
|
-
# Update an earning rule definition.
|
|
3092
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Update an earning rule definition.
|
|
2888
3093
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
2889
3094
|
# @param earning_rule_id [String] A unique earning rule ID.
|
|
2890
3095
|
# @param [Hash] opts the optional parameters
|
|
@@ -2939,8 +3144,8 @@ module VoucherifySdk
|
|
|
2939
3144
|
return data, status_code, headers
|
|
2940
3145
|
end
|
|
2941
3146
|
|
|
2942
|
-
#
|
|
2943
|
-
# This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest.
|
|
3147
|
+
# Adjust Loyalty Card Balance
|
|
3148
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter. </Note>
|
|
2944
3149
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2945
3150
|
# @param [Hash] opts the optional parameters
|
|
2946
3151
|
# @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
|
|
@@ -2950,8 +3155,8 @@ module VoucherifySdk
|
|
|
2950
3155
|
data
|
|
2951
3156
|
end
|
|
2952
3157
|
|
|
2953
|
-
#
|
|
2954
|
-
# This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >
|
|
3158
|
+
# Adjust Loyalty Card Balance
|
|
3159
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter. </Note>
|
|
2955
3160
|
# @param member_id [String] Unique loyalty card assigned to a particular customer.
|
|
2956
3161
|
# @param [Hash] opts the optional parameters
|
|
2957
3162
|
# @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
|
|
@@ -3005,8 +3210,8 @@ module VoucherifySdk
|
|
|
3005
3210
|
return data, status_code, headers
|
|
3006
3211
|
end
|
|
3007
3212
|
|
|
3008
|
-
#
|
|
3009
|
-
# This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest.
|
|
3213
|
+
# Adjust Loyalty Card Balance with campaign ID
|
|
3214
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. </Warning>
|
|
3010
3215
|
# @param campaign_id [String] Unique campaign ID.
|
|
3011
3216
|
# @param member_id [String] A code that identifies the loyalty card.
|
|
3012
3217
|
# @param [Hash] opts the optional parameters
|
|
@@ -3017,8 +3222,8 @@ module VoucherifySdk
|
|
|
3017
3222
|
data
|
|
3018
3223
|
end
|
|
3019
3224
|
|
|
3020
|
-
#
|
|
3021
|
-
# This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >
|
|
3225
|
+
# Adjust Loyalty Card Balance with campaign ID
|
|
3226
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. </Warning>
|
|
3022
3227
|
# @param campaign_id [String] Unique campaign ID.
|
|
3023
3228
|
# @param member_id [String] A code that identifies the loyalty card.
|
|
3024
3229
|
# @param [Hash] opts the optional parameters
|
|
@@ -3074,7 +3279,7 @@ module VoucherifySdk
|
|
|
3074
3279
|
end
|
|
3075
3280
|
|
|
3076
3281
|
# Update Loyalty Campaign
|
|
3077
|
-
# Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the loyalty cards which have not been published or redeemed yet.
|
|
3282
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the [loyalty cards](/api-reference/loyalties/get-member) which have not been published or redeemed yet.
|
|
3078
3283
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
3079
3284
|
# @param [Hash] opts the optional parameters
|
|
3080
3285
|
# @option opts [LoyaltiesUpdateCampaignRequestBody] :loyalties_update_campaign_request_body Specify the new values for the parameters that you would like to update for the given loyalty campaign.
|
|
@@ -3085,7 +3290,7 @@ module VoucherifySdk
|
|
|
3085
3290
|
end
|
|
3086
3291
|
|
|
3087
3292
|
# Update Loyalty Campaign
|
|
3088
|
-
# Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the loyalty cards which have not been published or redeemed yet.
|
|
3293
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the [loyalty cards](/api-reference/loyalties/get-member) which have not been published or redeemed yet.
|
|
3089
3294
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
3090
3295
|
# @param [Hash] opts the optional parameters
|
|
3091
3296
|
# @option opts [LoyaltiesUpdateCampaignRequestBody] :loyalties_update_campaign_request_body Specify the new values for the parameters that you would like to update for the given loyalty campaign.
|
|
@@ -3139,8 +3344,8 @@ module VoucherifySdk
|
|
|
3139
3344
|
return data, status_code, headers
|
|
3140
3345
|
end
|
|
3141
3346
|
|
|
3142
|
-
# Update Reward Assignment
|
|
3143
|
-
# Updates rewards parameters, i.e. the points cost for the specific reward.
|
|
3347
|
+
# Update Campaign Reward Assignment
|
|
3348
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Updates rewards parameters, i.e. the points cost for the specific reward.
|
|
3144
3349
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
3145
3350
|
# @param assignment_id [String] A unique reward assignment ID.
|
|
3146
3351
|
# @param [Hash] opts the optional parameters
|
|
@@ -3151,8 +3356,8 @@ module VoucherifySdk
|
|
|
3151
3356
|
data
|
|
3152
3357
|
end
|
|
3153
3358
|
|
|
3154
|
-
# Update Reward Assignment
|
|
3155
|
-
# Updates rewards parameters, i.e. the points cost for the specific reward.
|
|
3359
|
+
# Update Campaign Reward Assignment
|
|
3360
|
+
# <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Updates rewards parameters, i.e. the points cost for the specific reward.
|
|
3156
3361
|
# @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
3157
3362
|
# @param assignment_id [String] A unique reward assignment ID.
|
|
3158
3363
|
# @param [Hash] opts the optional parameters
|