voucherify 8.0.2 → 8.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +123 -106
- data/Gemfile.lock +20 -16
- data/README.md +260 -75
- data/VoucherifySdk.gemspec +1 -1
- data/__tests__/README.md +18 -0
- data/__tests__/lib/campaigns.rb +53 -1
- data/__tests__/lib/config.rb +21 -0
- data/__tests__/lib/loyalties.rb +2 -2
- data/__tests__/lib/utils.rb +27 -1
- data/__tests__/spec/02_campaigns_spec.rb +33 -2
- data/__tests__/spec/04_publications_spec.rb +16 -3
- data/__tests__/spec/07_vouchers_spec.rb +22 -3
- data/__tests__/spec/12_validation_rules_spec.rb +1 -15
- data/__tests__/spec/13_management_spec.rb +110 -0
- data/__tests__/spec/14_additional_properties_spec.rb +28 -0
- data/__tests__/spec/support/get_snapshot_without_uniq_keys.rb +1 -1
- data/docs/AccessSettings.md +9 -0
- data/docs/AccessSettingsAssign.md +10 -0
- data/docs/AccessSettingsUnassign.md +10 -0
- data/docs/ApplicableTo.md +21 -4
- data/docs/ApplicableToOrderItemUnitsItem.md +10 -0
- data/docs/ApplicationDetailsItem.md +14 -0
- data/docs/AreaStoreCampaignAssignment.md +1 -0
- data/docs/AsyncActionsApi.md +2 -2
- data/docs/AsyncActionsListResponseBody.md +1 -0
- data/docs/BinApi.md +4 -4
- data/docs/Bundle.md +11 -0
- data/docs/BundleIdentifiedItem.md +11 -0
- data/docs/BundleMissingItem.md +10 -0
- data/docs/Campaign.md +5 -5
- data/docs/CampaignBase.md +5 -4
- data/docs/CampaignLoyaltyCardExpirationRules.md +6 -4
- data/docs/CampaignsApi.md +209 -12
- data/docs/CampaignsCreateRequestBody.md +3 -2
- data/docs/CampaignsCreateResponseBody.md +5 -5
- data/docs/CampaignsGetResponseBody.md +5 -5
- data/docs/CampaignsImportVoucherItem.md +1 -1
- data/docs/CampaignsSummaryGetResponseBody.md +48 -0
- data/docs/CampaignsTransactionsExportCreateRequestBody.md +8 -0
- data/docs/CampaignsTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/CampaignsTransactionsExportCreateResponseBody.md +16 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParameters.md +10 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFilters.md +11 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md +8 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md +8 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyResult.md +8 -0
- data/docs/CampaignsTransactionsListResponseBody.md +12 -0
- data/docs/CampaignsUpdateRequestBody.md +2 -1
- data/docs/CampaignsUpdateResponseBody.md +5 -5
- data/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +5 -2
- data/docs/CampaignsVouchersCreateResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/CategoriesApi.md +1 -1
- data/docs/ClientQualificationsCheckEligibilityRequestBody.md +2 -1
- data/docs/ClientQualificationsCheckEligibilityRequestBodySession.md +8 -0
- data/docs/ClientRedemptionsRedeemRequestBodyOptions.md +1 -1
- data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ClientSideApi.md +2 -2
- data/docs/ClientValidationsValidateRequestBodyOptions.md +1 -1
- data/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ClientValidationsValidateResponseBody.md +1 -0
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
- data/docs/CustomerLoyalty.md +1 -1
- data/docs/CustomerSummaryOrders.md +3 -3
- data/docs/CustomerSummaryRedemptionsGift.md +2 -2
- data/docs/CustomerWithSummaryLoyaltyReferralsAssets.md +2 -1
- data/docs/CustomersApi.md +10 -10
- data/docs/CustomersCreateResponseBodyAssets.md +2 -1
- data/docs/CustomersGetResponseBodyAssets.md +2 -1
- data/docs/CustomersUpdateResponseBodyAssets.md +2 -1
- data/docs/Discount.md +4 -4
- data/docs/DiscountUnitMultipleOneUnit.md +1 -1
- data/docs/EarningRule.md +2 -0
- data/docs/EarningRuleExpirationRules.md +13 -0
- data/docs/EarningRuleLoyalty.md +1 -0
- data/docs/EarningRuleLoyaltyCustomEventMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyCustomerMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyOrderAmount.md +1 -0
- data/docs/EarningRuleLoyaltyOrderItemsAmount.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyOrderTotalAmount.md +1 -0
- data/docs/EarningRulePendingPoints.md +9 -0
- data/docs/EventSource.md +10 -0
- data/docs/EventSourceApiKey.md +9 -0
- data/docs/EventSourceUser.md +8 -0
- data/docs/ExportCampaignTransactionsFilters.md +10 -0
- data/docs/ExportParameters.md +1 -0
- data/docs/ExportsApi.md +3 -3
- data/docs/ExportsCreateRequestBodyParameters.md +1 -0
- data/docs/ExportsCreateResponseBodyParameters.md +1 -0
- data/docs/ExportsGetResponseBodyParameters.md +1 -0
- data/docs/Gift.md +3 -2
- data/docs/InapplicableTo.md +21 -4
- data/docs/InapplicableToOrderItemUnitsItem.md +10 -0
- data/docs/LoyaltiesApi.md +590 -69
- data/docs/LoyaltiesCreateCampaignRequestBody.md +3 -2
- data/docs/LoyaltiesCreateCampaignResponseBody.md +1 -1
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBody.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +2 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesGetCampaignResponseBody.md +1 -1
- data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +5 -2
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +14 -0
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceRequestBody.md +8 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBody.md +12 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +1 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodySession.md +8 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherGift.md +3 -2
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +5 -2
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/LoyaltiesPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParameters.md +1 -1
- data/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +1 -1
- data/docs/LoyaltiesTransactionsExportCreateRequestBody.md +8 -0
- data/docs/LoyaltiesTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/LoyaltiesTransactionsListResponseBody.md +12 -0
- data/docs/LoyaltiesUpdateCampaignRequestBody.md +2 -1
- data/docs/LoyaltiesUpdateCampaignResponseBody.md +1 -1
- data/docs/LoyaltyCampaign.md +1 -1
- data/docs/LoyaltyCardTransaction.md +1 -1
- data/docs/LoyaltyCardTransactionDetails.md +2 -0
- data/docs/LoyaltyCardTransactionDetailsBalance.md +1 -0
- data/docs/LoyaltyCardTransactionDetailsEarningRule.md +1 -1
- data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/LoyaltyMemberLoyaltyCard.md +5 -2
- data/docs/LoyaltyPendingPoints.md +17 -0
- data/docs/LoyaltyPendingPointsDetails.md +12 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRule.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +8 -0
- data/docs/LoyaltyPendingPointsDetailsEvent.md +14 -0
- data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsOrder.md +9 -0
- data/docs/LoyaltyPointsBucket.md +1 -1
- data/docs/LoyaltyTierExpiration.md +1 -1
- data/docs/LoyaltyTiersExpirationAll.md +1 -1
- data/docs/ManagementApi.md +22 -22
- data/docs/ManagementProjectsStackingRules.md +14 -8
- data/docs/ManagementProjectsStackingRulesCreateRequestBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesCreateResponseBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesGetResponseBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesUpdateRequestBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesUpdateResponseBody.md +14 -8
- data/docs/ManagementProjectsUsersInviteCreateRequestBody.md +1 -1
- data/docs/ManagementProjectsUsersUpdateRoleRequestBody.md +1 -1
- data/docs/MetadataSchemasApi.md +5 -5
- data/docs/Order.md +3 -3
- data/docs/OrderCalculated.md +11 -11
- data/docs/OrderCalculatedItem.md +2 -1
- data/docs/OrderItem.md +1 -1
- data/docs/OrderRedemptionsEntry.md +1 -1
- data/docs/OrdersApi.md +3 -3
- data/docs/OrdersCreateRequestBody.md +3 -3
- data/docs/OrdersCreateResponseBody.md +11 -11
- data/docs/OrdersGetResponseBody.md +11 -11
- data/docs/OrdersImportCreateRequestBodyItem.md +4 -4
- data/docs/OrdersUpdateRequestBody.md +3 -3
- data/docs/OrdersUpdateResponseBody.md +11 -11
- data/docs/ParameterOrderListPendingPoints.md +7 -0
- data/docs/ParametersFiltersListCampaignTransactions.md +10 -0
- data/docs/ProductCollectionsCreateRequestBody.md +1 -1
- data/docs/ProductsApi.md +22 -22
- data/docs/ProductsSkusCreateRequestBody.md +1 -1
- data/docs/ProductsSkusUpdateRequestBody.md +1 -1
- data/docs/PromotionTierCampaign.md +1 -1
- data/docs/PromotionsTiersCreateResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersDisableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersEnableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersGetResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersUpdateResponseBodyCampaign.md +1 -1
- data/docs/PublicationsApi.md +7 -7
- data/docs/QualificationsApi.md +1 -1
- data/docs/QualificationsCheckEligibilityRequestBody.md +2 -1
- data/docs/QualificationsCheckEligibilityRequestBodySession.md +8 -0
- data/docs/QualificationsOption.md +1 -1
- data/docs/QualificationsRedeemable.md +1 -1
- data/docs/QualificationsRedeemableBase.md +1 -1
- data/docs/RedeemableGift.md +3 -2
- data/docs/RedeemableLoyaltyCard.md +2 -2
- data/docs/RedeemableResult.md +1 -0
- data/docs/RedeemableVoucherGift.md +3 -2
- data/docs/RedeemableVoucherLoyaltyCard.md +5 -2
- data/docs/Redemption.md +1 -0
- data/docs/RedemptionEntry.md +1 -0
- data/docs/RedemptionEntryOrder.md +11 -11
- data/docs/RedemptionEntryPromotionTierCampaign.md +1 -1
- data/docs/RedemptionEntryRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionEntrySession.md +8 -0
- data/docs/RedemptionEntryVoucherGift.md +3 -2
- data/docs/RedemptionEntryVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionRewardResultParametersCampaign.md +1 -1
- data/docs/RedemptionRollback.md +1 -1
- data/docs/RedemptionSession.md +8 -0
- data/docs/RedemptionVoucherGift.md +3 -2
- data/docs/RedemptionVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsGetResponseBody.md +1 -0
- data/docs/RedemptionsGetResponseBodyOrder.md +11 -11
- data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionsGetResponseBodySession.md +8 -0
- data/docs/RedemptionsGetResponseBodyVoucherGift.md +3 -2
- data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionsListResponseBodyRedemptionsItem.md +1 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +11 -11
- data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemSession.md +8 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherGift.md +3 -2
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +5 -2
- data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -1
- data/docs/RedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/RedemptionsRollbackCreateResponseBody.md +1 -1
- data/docs/ReferralsApi.md +13 -13
- data/docs/Reward.md +1 -1
- data/docs/RewardsCreateRequestBody.md +1 -1
- data/docs/RewardsCreateRequestBodyParametersCampaign.md +1 -1
- data/docs/RewardsCreateResponseBody.md +1 -1
- data/docs/RewardsUpdateRequestBody.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCampaign.md +1 -1
- data/docs/RewardsUpdateResponseBody.md +1 -1
- data/docs/SegmentsApi.md +2 -2
- data/docs/SegmentsCreateRequestBody.md +1 -1
- data/docs/SegmentsCreateResponseBody.md +4 -3
- data/docs/SegmentsGetResponseBody.md +4 -3
- data/docs/SimpleLoyaltyCard.md +5 -2
- data/docs/SimpleVoucherRedemption.md +1 -0
- data/docs/StackingRules.md +15 -11
- data/docs/TemplatesApi.md +7 -7
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +3 -2
- data/docs/TrashBinItem.md +1 -1
- data/docs/ValidationRule.md +1 -0
- data/docs/ValidationRulesApi.md +3 -3
- data/docs/ValidationRulesCreateRequestBody.md +1 -0
- data/docs/ValidationRulesCreateResponseBody.md +1 -0
- data/docs/ValidationRulesGetResponseBody.md +1 -0
- data/docs/ValidationRulesUpdateRequestBody.md +1 -0
- data/docs/ValidationRulesUpdateResponseBody.md +1 -0
- data/docs/ValidationsApi.md +1 -1
- data/docs/ValidationsRedeemableInapplicableResult.md +1 -0
- data/docs/ValidationsValidateRequestBodyOptions.md +1 -1
- data/docs/ValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ValidationsValidateResponseBody.md +1 -0
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
- data/docs/ValidityHours.md +1 -1
- data/docs/VoucherBalance.md +1 -0
- data/docs/VoucherGift.md +3 -2
- data/docs/VoucherLoyaltyCard.md +5 -2
- data/docs/VoucherTransaction.md +1 -1
- data/docs/VoucherTransactionDetails.md +2 -0
- data/docs/VoucherTransactionDetailsBalance.md +1 -0
- data/docs/VoucherTransactionDetailsCustomEvent.md +2 -2
- data/docs/VoucherTransactionDetailsEarningRule.md +1 -1
- data/docs/VoucherTransactionDetailsEventSchema.md +2 -2
- data/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/VoucherTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/VoucherTransactionDetailsRollback.md +1 -1
- data/docs/VoucherTransactionDetailsSegment.md +2 -2
- data/docs/VoucherTransactionsExportParameters.md +1 -1
- data/docs/VoucherTransactionsFilters.md +1 -1
- data/docs/VoucherWithCategoriesGift.md +3 -2
- data/docs/VoucherWithCategoriesLoyaltyCard.md +5 -2
- data/docs/VouchersApi.md +16 -14
- data/docs/VouchersBalanceUpdateRequestBody.md +1 -1
- data/docs/VouchersBalanceUpdateResponseBody.md +2 -2
- data/docs/VouchersCreateRequestBody.md +2 -2
- data/docs/VouchersCreateResponseBodyGift.md +3 -2
- data/docs/VouchersCreateResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersCreateWithSpecificCodeRequestBody.md +2 -2
- data/docs/VouchersDisableResponseBodyGift.md +3 -2
- data/docs/VouchersDisableResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersEnableResponseBodyGift.md +3 -2
- data/docs/VouchersEnableResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersGetResponseBodyGift.md +3 -2
- data/docs/VouchersGetResponseBodyLoyaltyCard.md +5 -2
- data/docs/VouchersImportCreateItemRequestBody.md +1 -1
- data/docs/VouchersTransactionsExportCreateResponseBodyResult.md +1 -1
- data/docs/VouchersUpdateRequestBody.md +2 -2
- data/docs/VouchersUpdateResponseBodyGift.md +3 -2
- data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +5 -2
- data/lib/VoucherifySdk/api/async_actions_api.rb +4 -4
- data/lib/VoucherifySdk/api/bin_api.rb +4 -4
- data/lib/VoucherifySdk/api/campaigns_api.rb +220 -18
- data/lib/VoucherifySdk/api/categories_api.rb +2 -2
- data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
- data/lib/VoucherifySdk/api/customers_api.rb +14 -14
- data/lib/VoucherifySdk/api/exports_api.rb +6 -6
- data/lib/VoucherifySdk/api/loyalties_api.rb +599 -68
- data/lib/VoucherifySdk/api/management_api.rb +44 -44
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +6 -6
- data/lib/VoucherifySdk/api/orders_api.rb +6 -6
- data/lib/VoucherifySdk/api/products_api.rb +30 -30
- data/lib/VoucherifySdk/api/publications_api.rb +8 -8
- data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
- data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
- data/lib/VoucherifySdk/api/referrals_api.rb +14 -14
- data/lib/VoucherifySdk/api/segments_api.rb +4 -4
- data/lib/VoucherifySdk/api/templates_api.rb +14 -14
- data/lib/VoucherifySdk/api/validation_rules_api.rb +6 -6
- data/lib/VoucherifySdk/api/validations_api.rb +2 -2
- data/lib/VoucherifySdk/api/vouchers_api.rb +25 -22
- data/lib/VoucherifySdk/models/access_settings.rb +219 -0
- data/lib/VoucherifySdk/models/access_settings_assign.rb +238 -0
- data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
- data/lib/VoucherifySdk/models/access_settings_unassign.rb +238 -0
- data/lib/VoucherifySdk/models/applicable_to.rb +207 -18
- data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +235 -0
- data/lib/VoucherifySdk/models/application_details_item.rb +284 -0
- data/lib/VoucherifySdk/models/area_store_campaign_assignment.rb +12 -1
- data/lib/VoucherifySdk/models/async_actions_list_response_body.rb +16 -5
- data/lib/VoucherifySdk/models/bundle.rb +267 -0
- data/lib/VoucherifySdk/models/bundle_identified_item.rb +296 -0
- data/lib/VoucherifySdk/models/bundle_missing_item.rb +274 -0
- data/lib/VoucherifySdk/models/campaign.rb +17 -17
- data/lib/VoucherifySdk/models/campaign_base.rb +17 -8
- data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +53 -10
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +13 -4
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +17 -17
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +17 -17
- data/lib/VoucherifySdk/models/campaigns_import_voucher_item.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_summary_get_response_body.rb +673 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body.rb +334 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters.rb +257 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id.rb +209 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id_conditions.rb +221 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_result.rb +210 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +11 -2
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +17 -17
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb +12 -2
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body_session.rb +236 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result.rb +11 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +5 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
- data/lib/VoucherifySdk/models/create_publication_campaign.rb +3 -3
- data/lib/VoucherifySdk/models/customer_loyalty.rb +1 -1
- data/lib/VoucherifySdk/models/customer_summary_orders.rb +4 -3
- data/lib/VoucherifySdk/models/customer_summary_redemptions_gift.rb +2 -2
- data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_create_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_get_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_update_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/discount.rb +5 -1
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -0
- data/lib/VoucherifySdk/models/earning_rule.rb +20 -1
- data/lib/VoucherifySdk/models/earning_rule_expiration_rules.rb +313 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/earning_rule_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/event_source.rb +254 -0
- data/lib/VoucherifySdk/models/event_source_api_key.rb +221 -0
- data/lib/VoucherifySdk/models/event_source_user.rb +210 -0
- data/lib/VoucherifySdk/models/export_campaign_transactions_filters.rb +248 -0
- data/lib/VoucherifySdk/models/export_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +0 -1
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +16 -5
- data/lib/VoucherifySdk/models/filter_conditions_date_time.rb +2 -2
- data/lib/VoucherifySdk/models/gift.rb +14 -3
- data/lib/VoucherifySdk/models/inapplicable_to.rb +207 -18
- data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +235 -0
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +13 -4
- data/lib/VoucherifySdk/models/loyalties_create_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item.rb +22 -3
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb +22 -3
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +20 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_get_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +309 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_request_body.rb +210 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_session.rb +210 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_points_expiration_export_create_request_body_parameters.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/loyalties_transactions_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +11 -2
- data/lib/VoucherifySdk/models/loyalties_update_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +20 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +12 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +2 -1
- data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/loyalty_member_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_pending_points.rb +314 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details.rb +249 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule_source.rb +210 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_event.rb +302 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_order.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb +1 -1
- data/lib/VoucherifySdk/models/management_projects_stacking_rules.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_request_body.rb +116 -13
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_request_body.rb +116 -13
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_users_invite_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/management_projects_users_update_role_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/order.rb +3 -3
- data/lib/VoucherifySdk/models/order_calculated.rb +28 -28
- data/lib/VoucherifySdk/models/order_calculated_item.rb +18 -6
- data/lib/VoucherifySdk/models/order_item.rb +1 -1
- data/lib/VoucherifySdk/models/order_redemptions_entry.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +17 -17
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status.rb +2 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status_conditions.rb +1 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_category_ids.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_is_referral_code.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_order_list_pending_points.rb +40 -0
- data/lib/VoucherifySdk/models/parameters_filters_list_campaign_transactions.rb +247 -0
- data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +2 -4
- data/lib/VoucherifySdk/models/products_skus_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body.rb +12 -2
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body_session.rb +236 -0
- data/lib/VoucherifySdk/models/qualifications_option.rb +4 -4
- data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type_conditions.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +1 -1
- data/lib/VoucherifySdk/models/redeemable_gift.rb +18 -7
- data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +2 -2
- data/lib/VoucherifySdk/models/redeemable_result.rb +10 -1
- data/lib/VoucherifySdk/models/redeemable_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redeemable_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redemption.rb +11 -1
- data/lib/VoucherifySdk/models/redemption_entry.rb +11 -1
- data/lib/VoucherifySdk/models/redemption_entry_order.rb +28 -28
- data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemption_entry_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemption_entry_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_rollback.rb +15 -15
- data/lib/VoucherifySdk/models/redemption_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemption_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +28 -28
- data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemptions_get_response_body_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +11 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +27 -28
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions.rb +0 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_rollback_create_response_body.rb +15 -15
- data/lib/VoucherifySdk/models/reward.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/segments_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/segments_create_response_body.rb +31 -20
- data/lib/VoucherifySdk/models/segments_get_response_body.rb +32 -21
- data/lib/VoucherifySdk/models/simple_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/simple_voucher_redemption.rb +16 -5
- data/lib/VoucherifySdk/models/stacking_rules.rb +72 -20
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +13 -4
- data/lib/VoucherifySdk/models/trash_bin_item.rb +1 -1
- data/lib/VoucherifySdk/models/validation_rule.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable_result.rb +14 -5
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result.rb +11 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +5 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
- data/lib/VoucherifySdk/models/validity_hours.rb +1 -1
- data/lib/VoucherifySdk/models/validity_hours_daily_item.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_balance.rb +12 -1
- data/lib/VoucherifySdk/models/voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/voucher_transaction.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details.rb +20 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +12 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +2 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_parameters.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transactions_filters.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_with_categories_gift.rb +14 -3
- data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_balance_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_create_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_create_with_specific_code_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_get_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/models/vouchers_import_create_item_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_transactions_export_create_response_body_result.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_update_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_update_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +40 -7
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +85 -0
- metadata +210 -36
data/docs/LoyaltiesApi.md
CHANGED
|
@@ -4,50 +4,118 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**activate_member_pending_points**](LoyaltiesApi.md#activate_member_pending_points) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points |
|
|
7
8
|
| [**add_member**](LoyaltiesApi.md#add_member) | **POST** /v1/loyalties/{campaignId}/members | Add Member |
|
|
9
|
+
| [**adjust_member_pending_points**](LoyaltiesApi.md#adjust_member_pending_points) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | Adjust Member Pending Points |
|
|
10
|
+
| [**cancel_member_pending_points**](LoyaltiesApi.md#cancel_member_pending_points) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points |
|
|
8
11
|
| [**create_earning_rule**](LoyaltiesApi.md#create_earning_rule) | **POST** /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule |
|
|
9
12
|
| [**create_in_bulk_loyalty_tiers**](LoyaltiesApi.md#create_in_bulk_loyalty_tiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers |
|
|
10
13
|
| [**create_loyalty_program**](LoyaltiesApi.md#create_loyalty_program) | **POST** /v1/loyalties | Create Loyalty Campaign |
|
|
11
|
-
| [**create_points_expiration_export**](LoyaltiesApi.md#create_points_expiration_export) | **POST** /v1/loyalties/{campaignId}/points-expiration/export |
|
|
12
|
-
| [**create_reward_assignment1**](LoyaltiesApi.md#create_reward_assignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Reward Assignment |
|
|
14
|
+
| [**create_points_expiration_export**](LoyaltiesApi.md#create_points_expiration_export) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration |
|
|
15
|
+
| [**create_reward_assignment1**](LoyaltiesApi.md#create_reward_assignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Loyalty Campaign Reward Assignment |
|
|
13
16
|
| [**delete_earning_rule**](LoyaltiesApi.md#delete_earning_rule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule |
|
|
14
17
|
| [**delete_loyalty_program**](LoyaltiesApi.md#delete_loyalty_program) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign |
|
|
15
|
-
| [**delete_reward_assignment1**](LoyaltiesApi.md#delete_reward_assignment1) | **DELETE** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Reward Assignment |
|
|
18
|
+
| [**delete_reward_assignment1**](LoyaltiesApi.md#delete_reward_assignment1) | **DELETE** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Campaign Reward Assignment |
|
|
16
19
|
| [**disable_earning_rule**](LoyaltiesApi.md#disable_earning_rule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule |
|
|
17
20
|
| [**enable_earning_rule**](LoyaltiesApi.md#enable_earning_rule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule |
|
|
21
|
+
| [**export_loyalty_campaign_transactions**](LoyaltiesApi.md#export_loyalty_campaign_transactions) | **POST** /v1/loyalties/{campaignId}/transactions/export | Export Loyalty Campaign Transactions |
|
|
18
22
|
| [**export_loyalty_card_transactions**](LoyaltiesApi.md#export_loyalty_card_transactions) | **POST** /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions |
|
|
19
|
-
| [**export_loyalty_card_transactions1**](LoyaltiesApi.md#export_loyalty_card_transactions1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions |
|
|
23
|
+
| [**export_loyalty_card_transactions1**](LoyaltiesApi.md#export_loyalty_card_transactions1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions with campaign ID |
|
|
20
24
|
| [**get_earning_rule**](LoyaltiesApi.md#get_earning_rule) | **GET** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule |
|
|
21
25
|
| [**get_loyalty_program**](LoyaltiesApi.md#get_loyalty_program) | **GET** /v1/loyalties/{campaignId} | Get Loyalty Campaign |
|
|
22
26
|
| [**get_loyalty_tier**](LoyaltiesApi.md#get_loyalty_tier) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier |
|
|
23
27
|
| [**get_member**](LoyaltiesApi.md#get_member) | **GET** /v1/loyalties/members/{memberId} | Get Member |
|
|
24
|
-
| [**get_member1**](LoyaltiesApi.md#get_member1) | **GET** /v1/loyalties/{campaignId}/members/{memberId} | Get Member |
|
|
25
|
-
| [**get_reward_assignment1**](LoyaltiesApi.md#get_reward_assignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Reward
|
|
26
|
-
| [**get_reward_assignment2**](LoyaltiesApi.md#get_reward_assignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Reward Assignment |
|
|
28
|
+
| [**get_member1**](LoyaltiesApi.md#get_member1) | **GET** /v1/loyalties/{campaignId}/members/{memberId} | Get Member with campaign ID |
|
|
29
|
+
| [**get_reward_assignment1**](LoyaltiesApi.md#get_reward_assignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Campaign Reward Assignments |
|
|
30
|
+
| [**get_reward_assignment2**](LoyaltiesApi.md#get_reward_assignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Campaign Reward Assignment |
|
|
27
31
|
| [**get_reward_details**](LoyaltiesApi.md#get_reward_details) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details |
|
|
32
|
+
| [**list_campaign_pending_points**](LoyaltiesApi.md#list_campaign_pending_points) | **GET** /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points |
|
|
28
33
|
| [**list_earning_rules**](LoyaltiesApi.md#list_earning_rules) | **GET** /v1/loyalties/{campaignId}/earning-rules | List Earning Rules |
|
|
34
|
+
| [**list_loyalty_campaign_transactions**](LoyaltiesApi.md#list_loyalty_campaign_transactions) | **GET** /v1/loyalties/{campaignId}/transactions | List Loyalty Campaign Transactions |
|
|
29
35
|
| [**list_loyalty_card_transactions**](LoyaltiesApi.md#list_loyalty_card_transactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions |
|
|
30
|
-
| [**list_loyalty_card_transactions1**](LoyaltiesApi.md#list_loyalty_card_transactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions |
|
|
36
|
+
| [**list_loyalty_card_transactions1**](LoyaltiesApi.md#list_loyalty_card_transactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions with campaign ID |
|
|
31
37
|
| [**list_loyalty_programs**](LoyaltiesApi.md#list_loyalty_programs) | **GET** /v1/loyalties | List Loyalty Campaigns |
|
|
32
38
|
| [**list_loyalty_tier_earning_rules**](LoyaltiesApi.md#list_loyalty_tier_earning_rules) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules |
|
|
33
39
|
| [**list_loyalty_tier_rewards**](LoyaltiesApi.md#list_loyalty_tier_rewards) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards |
|
|
34
40
|
| [**list_loyalty_tiers**](LoyaltiesApi.md#list_loyalty_tiers) | **GET** /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers |
|
|
35
41
|
| [**list_member_activity**](LoyaltiesApi.md#list_member_activity) | **GET** /v1/loyalties/members/{memberId}/activity | List Member Activity |
|
|
36
|
-
| [**list_member_activity1**](LoyaltiesApi.md#list_member_activity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity |
|
|
42
|
+
| [**list_member_activity1**](LoyaltiesApi.md#list_member_activity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity with campaign ID |
|
|
37
43
|
| [**list_member_loyalty_tier**](LoyaltiesApi.md#list_member_loyalty_tier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers |
|
|
44
|
+
| [**list_member_pending_points**](LoyaltiesApi.md#list_member_pending_points) | **GET** /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points |
|
|
45
|
+
| [**list_member_pending_points1**](LoyaltiesApi.md#list_member_pending_points1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points with campaign ID |
|
|
38
46
|
| [**list_member_rewards**](LoyaltiesApi.md#list_member_rewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards |
|
|
39
47
|
| [**list_members**](LoyaltiesApi.md#list_members) | **GET** /v1/loyalties/{campaignId}/members | List Members |
|
|
40
|
-
| [**list_points_expiration**](LoyaltiesApi.md#list_points_expiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration |
|
|
41
|
-
| [**list_reward_assignments1**](LoyaltiesApi.md#list_reward_assignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments |
|
|
42
|
-
| [**list_reward_assignments2**](LoyaltiesApi.md#list_reward_assignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List
|
|
48
|
+
| [**list_points_expiration**](LoyaltiesApi.md#list_points_expiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration |
|
|
49
|
+
| [**list_reward_assignments1**](LoyaltiesApi.md#list_reward_assignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments with campaign ID |
|
|
50
|
+
| [**list_reward_assignments2**](LoyaltiesApi.md#list_reward_assignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List Campaign Rewards |
|
|
43
51
|
| [**redeem_reward**](LoyaltiesApi.md#redeem_reward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward |
|
|
44
|
-
| [**redeem_reward1**](LoyaltiesApi.md#redeem_reward1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward |
|
|
52
|
+
| [**redeem_reward1**](LoyaltiesApi.md#redeem_reward1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward with campaign ID |
|
|
45
53
|
| [**transfer_points**](LoyaltiesApi.md#transfer_points) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points |
|
|
46
54
|
| [**update_earning_rule**](LoyaltiesApi.md#update_earning_rule) | **PUT** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Update Earning Rule |
|
|
47
|
-
| [**update_loyalty_card_balance**](LoyaltiesApi.md#update_loyalty_card_balance) | **POST** /v1/loyalties/members/{memberId}/balance |
|
|
48
|
-
| [**update_loyalty_card_balance1**](LoyaltiesApi.md#update_loyalty_card_balance1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/balance |
|
|
55
|
+
| [**update_loyalty_card_balance**](LoyaltiesApi.md#update_loyalty_card_balance) | **POST** /v1/loyalties/members/{memberId}/balance | Adjust Loyalty Card Balance |
|
|
56
|
+
| [**update_loyalty_card_balance1**](LoyaltiesApi.md#update_loyalty_card_balance1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/balance | Adjust Loyalty Card Balance with campaign ID |
|
|
49
57
|
| [**update_loyalty_program**](LoyaltiesApi.md#update_loyalty_program) | **PUT** /v1/loyalties/{campaignId} | Update Loyalty Campaign |
|
|
50
|
-
| [**update_reward_assignment1**](LoyaltiesApi.md#update_reward_assignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Reward Assignment |
|
|
58
|
+
| [**update_reward_assignment1**](LoyaltiesApi.md#update_reward_assignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Campaign Reward Assignment |
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
## activate_member_pending_points
|
|
62
|
+
|
|
63
|
+
> <LoyaltiesMembersPendingPointsActivateResponseBody> activate_member_pending_points(member_id, pending_points_id)
|
|
64
|
+
|
|
65
|
+
Activate Member Pending Points
|
|
66
|
+
|
|
67
|
+
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. 👍 Configuring pending points 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).
|
|
68
|
+
|
|
69
|
+
### Examples
|
|
70
|
+
|
|
71
|
+
```ruby
|
|
72
|
+
require 'time'
|
|
73
|
+
require 'VoucherifySdk'
|
|
74
|
+
# setup authorization
|
|
75
|
+
VoucherifySdk.configure do |config|
|
|
76
|
+
# Configure API key authorization: X-App-Id
|
|
77
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
78
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
79
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
80
|
+
|
|
81
|
+
# Configure API key authorization: X-App-Token
|
|
82
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
83
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
84
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
88
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
|
89
|
+
pending_points_id = 'pending_points_id_example' # String | Unique pending point identifier, assigned by Voucherify.
|
|
90
|
+
|
|
91
|
+
begin
|
|
92
|
+
# Activate Member Pending Points
|
|
93
|
+
result = api_instance.activate_member_pending_points(member_id, pending_points_id)
|
|
94
|
+
p result
|
|
95
|
+
rescue VoucherifySdk::ApiError => e
|
|
96
|
+
puts "Error when calling LoyaltiesApi->activate_member_pending_points: #{e}"
|
|
97
|
+
end
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
| Name | Type | Description | Notes |
|
|
103
|
+
| ---- | ---- | ----------- | ----- |
|
|
104
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
|
105
|
+
| **pending_points_id** | **String** | Unique pending point identifier, assigned by Voucherify. | |
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
[**LoyaltiesMembersPendingPointsActivateResponseBody**](LoyaltiesMembersPendingPointsActivateResponseBody.md)
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: Not defined
|
|
118
|
+
- **Accept**: application/json
|
|
51
119
|
|
|
52
120
|
|
|
53
121
|
## add_member
|
|
@@ -56,7 +124,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
56
124
|
|
|
57
125
|
Add Member
|
|
58
126
|
|
|
59
|
-
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. 📘 Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign.
|
|
127
|
+
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. 📘 Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign.
|
|
60
128
|
|
|
61
129
|
### Examples
|
|
62
130
|
|
|
@@ -79,7 +147,7 @@ end
|
|
|
79
147
|
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
80
148
|
campaign_id = 'campaign_id_example' # String | Unique campaign ID of the loyalty program.
|
|
81
149
|
opts = {
|
|
82
|
-
loyalties_members_create_request_body: VoucherifySdk::LoyaltiesMembersCreateRequestBody.new # LoyaltiesMembersCreateRequestBody | 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.
|
|
150
|
+
loyalties_members_create_request_body: VoucherifySdk::LoyaltiesMembersCreateRequestBody.new # LoyaltiesMembersCreateRequestBody | 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.
|
|
83
151
|
}
|
|
84
152
|
|
|
85
153
|
begin
|
|
@@ -96,7 +164,7 @@ end
|
|
|
96
164
|
| Name | Type | Description | Notes |
|
|
97
165
|
| ---- | ---- | ----------- | ----- |
|
|
98
166
|
| **campaign_id** | **String** | Unique campaign ID of the loyalty program. | |
|
|
99
|
-
| **loyalties_members_create_request_body** | [**LoyaltiesMembersCreateRequestBody**](LoyaltiesMembersCreateRequestBody.md) | 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. | [optional] |
|
|
167
|
+
| **loyalties_members_create_request_body** | [**LoyaltiesMembersCreateRequestBody**](LoyaltiesMembersCreateRequestBody.md) | 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. | [optional] |
|
|
100
168
|
|
|
101
169
|
### Return type
|
|
102
170
|
|
|
@@ -112,13 +180,136 @@ end
|
|
|
112
180
|
- **Accept**: application/json
|
|
113
181
|
|
|
114
182
|
|
|
183
|
+
## adjust_member_pending_points
|
|
184
|
+
|
|
185
|
+
> <LoyaltiesMembersPendingPointsBalanceResponseBody> adjust_member_pending_points(member_id, pending_points_id, opts)
|
|
186
|
+
|
|
187
|
+
Adjust Member Pending Points
|
|
188
|
+
|
|
189
|
+
Adjusts the pending points with a given ID. You can add or subtract the number of points. 👍 Configuring pending points 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).
|
|
190
|
+
|
|
191
|
+
### Examples
|
|
192
|
+
|
|
193
|
+
```ruby
|
|
194
|
+
require 'time'
|
|
195
|
+
require 'VoucherifySdk'
|
|
196
|
+
# setup authorization
|
|
197
|
+
VoucherifySdk.configure do |config|
|
|
198
|
+
# Configure API key authorization: X-App-Id
|
|
199
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
200
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
201
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
202
|
+
|
|
203
|
+
# Configure API key authorization: X-App-Token
|
|
204
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
205
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
206
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
210
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
|
211
|
+
pending_points_id = 'pending_points_id_example' # String | Unique pending point identifier, assigned by Voucherify.
|
|
212
|
+
opts = {
|
|
213
|
+
loyalties_members_pending_points_balance_request_body: VoucherifySdk::LoyaltiesMembersPendingPointsBalanceRequestBody.new # LoyaltiesMembersPendingPointsBalanceRequestBody | Define the number of pending points to be added or subtracted.
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
begin
|
|
217
|
+
# Adjust Member Pending Points
|
|
218
|
+
result = api_instance.adjust_member_pending_points(member_id, pending_points_id, opts)
|
|
219
|
+
p result
|
|
220
|
+
rescue VoucherifySdk::ApiError => e
|
|
221
|
+
puts "Error when calling LoyaltiesApi->adjust_member_pending_points: #{e}"
|
|
222
|
+
end
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Name | Type | Description | Notes |
|
|
228
|
+
| ---- | ---- | ----------- | ----- |
|
|
229
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
|
230
|
+
| **pending_points_id** | **String** | Unique pending point identifier, assigned by Voucherify. | |
|
|
231
|
+
| **loyalties_members_pending_points_balance_request_body** | [**LoyaltiesMembersPendingPointsBalanceRequestBody**](LoyaltiesMembersPendingPointsBalanceRequestBody.md) | Define the number of pending points to be added or subtracted. | [optional] |
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
[**LoyaltiesMembersPendingPointsBalanceResponseBody**](LoyaltiesMembersPendingPointsBalanceResponseBody.md)
|
|
236
|
+
|
|
237
|
+
### Authorization
|
|
238
|
+
|
|
239
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: application/json
|
|
244
|
+
- **Accept**: application/json
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## cancel_member_pending_points
|
|
248
|
+
|
|
249
|
+
> cancel_member_pending_points(member_id, pending_points_id)
|
|
250
|
+
|
|
251
|
+
Cancel Member Pending Points
|
|
252
|
+
|
|
253
|
+
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. 👍 Configuring pending points 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).
|
|
254
|
+
|
|
255
|
+
### Examples
|
|
256
|
+
|
|
257
|
+
```ruby
|
|
258
|
+
require 'time'
|
|
259
|
+
require 'VoucherifySdk'
|
|
260
|
+
# setup authorization
|
|
261
|
+
VoucherifySdk.configure do |config|
|
|
262
|
+
# Configure API key authorization: X-App-Id
|
|
263
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
264
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
265
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
266
|
+
|
|
267
|
+
# Configure API key authorization: X-App-Token
|
|
268
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
269
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
270
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
274
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
|
275
|
+
pending_points_id = 'pending_points_id_example' # String | Unique pending point identifier, assigned by Voucherify.
|
|
276
|
+
|
|
277
|
+
begin
|
|
278
|
+
# Cancel Member Pending Points
|
|
279
|
+
api_instance.cancel_member_pending_points(member_id, pending_points_id)
|
|
280
|
+
rescue VoucherifySdk::ApiError => e
|
|
281
|
+
puts "Error when calling LoyaltiesApi->cancel_member_pending_points: #{e}"
|
|
282
|
+
end
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Parameters
|
|
286
|
+
|
|
287
|
+
| Name | Type | Description | Notes |
|
|
288
|
+
| ---- | ---- | ----------- | ----- |
|
|
289
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
|
290
|
+
| **pending_points_id** | **String** | Unique pending point identifier, assigned by Voucherify. | |
|
|
291
|
+
|
|
292
|
+
### Return type
|
|
293
|
+
|
|
294
|
+
nil (empty response body)
|
|
295
|
+
|
|
296
|
+
### Authorization
|
|
297
|
+
|
|
298
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
299
|
+
|
|
300
|
+
### HTTP request headers
|
|
301
|
+
|
|
302
|
+
- **Content-Type**: Not defined
|
|
303
|
+
- **Accept**: Not defined
|
|
304
|
+
|
|
305
|
+
|
|
115
306
|
## create_earning_rule
|
|
116
307
|
|
|
117
308
|
> <Array<LoyaltiesEarningRulesCreateResponseBody>> create_earning_rule(campaign_id, opts)
|
|
118
309
|
|
|
119
310
|
Create Earning Rule
|
|
120
311
|
|
|
121
|
-
Create earning rules for a loyalty campaign.
|
|
312
|
+
Create earning rules for a loyalty campaign. 🚧 Maximum number of earning rules You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup.
|
|
122
313
|
|
|
123
314
|
### Examples
|
|
124
315
|
|
|
@@ -242,7 +433,7 @@ end
|
|
|
242
433
|
|
|
243
434
|
Create Loyalty Campaign
|
|
244
435
|
|
|
245
|
-
Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧
|
|
436
|
+
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. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! 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.
|
|
246
437
|
|
|
247
438
|
### Examples
|
|
248
439
|
|
|
@@ -300,9 +491,9 @@ end
|
|
|
300
491
|
|
|
301
492
|
> <LoyaltiesPointsExpirationExportCreateResponseBody> create_points_expiration_export(campaign_id, opts)
|
|
302
493
|
|
|
303
|
-
|
|
494
|
+
Export Loyalty Campaign Point Expiration
|
|
304
495
|
|
|
305
|
-
Schedule the generation of a
|
|
496
|
+
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.
|
|
306
497
|
|
|
307
498
|
### Examples
|
|
308
499
|
|
|
@@ -329,7 +520,7 @@ opts = {
|
|
|
329
520
|
}
|
|
330
521
|
|
|
331
522
|
begin
|
|
332
|
-
#
|
|
523
|
+
# Export Loyalty Campaign Point Expiration
|
|
333
524
|
result = api_instance.create_points_expiration_export(campaign_id, opts)
|
|
334
525
|
p result
|
|
335
526
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -362,7 +553,7 @@ end
|
|
|
362
553
|
|
|
363
554
|
> <LoyaltiesRewardsCreateAssignmentResponseBody> create_reward_assignment1(campaign_id, opts)
|
|
364
555
|
|
|
365
|
-
Create Reward Assignment
|
|
556
|
+
Create Loyalty Campaign Reward Assignment
|
|
366
557
|
|
|
367
558
|
Add rewards to a loyalty campaign.
|
|
368
559
|
|
|
@@ -391,7 +582,7 @@ opts = {
|
|
|
391
582
|
}
|
|
392
583
|
|
|
393
584
|
begin
|
|
394
|
-
# Create Reward Assignment
|
|
585
|
+
# Create Loyalty Campaign Reward Assignment
|
|
395
586
|
result = api_instance.create_reward_assignment1(campaign_id, opts)
|
|
396
587
|
p result
|
|
397
588
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -485,7 +676,7 @@ nil (empty response body)
|
|
|
485
676
|
|
|
486
677
|
Delete Loyalty Campaign
|
|
487
678
|
|
|
488
|
-
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.
|
|
679
|
+
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).
|
|
489
680
|
|
|
490
681
|
### Examples
|
|
491
682
|
|
|
@@ -545,7 +736,7 @@ end
|
|
|
545
736
|
|
|
546
737
|
> delete_reward_assignment1(campaign_id, assignment_id)
|
|
547
738
|
|
|
548
|
-
Delete Reward Assignment
|
|
739
|
+
Delete Campaign Reward Assignment
|
|
549
740
|
|
|
550
741
|
This method deletes a reward assignment for a particular loyalty campaign.
|
|
551
742
|
|
|
@@ -572,7 +763,7 @@ campaign_id = 'campaign_id_example' # String | The campaign ID or name of the lo
|
|
|
572
763
|
assignment_id = 'assignment_id_example' # String | A unique reward assignment ID.
|
|
573
764
|
|
|
574
765
|
begin
|
|
575
|
-
# Delete Reward Assignment
|
|
766
|
+
# Delete Campaign Reward Assignment
|
|
576
767
|
api_instance.delete_reward_assignment1(campaign_id, assignment_id)
|
|
577
768
|
rescue VoucherifySdk::ApiError => e
|
|
578
769
|
puts "Error when calling LoyaltiesApi->delete_reward_assignment1: #{e}"
|
|
@@ -628,7 +819,7 @@ end
|
|
|
628
819
|
|
|
629
820
|
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
630
821
|
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
|
631
|
-
earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule
|
|
822
|
+
earning_rule_id = 'earning_rule_id_example' # String | Unique identifier of an earning rule, assigned by Voucherify.
|
|
632
823
|
|
|
633
824
|
begin
|
|
634
825
|
# Disable Earning Rule
|
|
@@ -644,7 +835,7 @@ end
|
|
|
644
835
|
| Name | Type | Description | Notes |
|
|
645
836
|
| ---- | ---- | ----------- | ----- |
|
|
646
837
|
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
|
647
|
-
| **earning_rule_id** | **String** | Unique earning rule
|
|
838
|
+
| **earning_rule_id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | |
|
|
648
839
|
|
|
649
840
|
### Return type
|
|
650
841
|
|
|
@@ -688,7 +879,7 @@ end
|
|
|
688
879
|
|
|
689
880
|
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
690
881
|
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
|
691
|
-
earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule
|
|
882
|
+
earning_rule_id = 'earning_rule_id_example' # String | Unique identifier of an earning rule, assigned by Voucherify.
|
|
692
883
|
|
|
693
884
|
begin
|
|
694
885
|
# Enable Earning Rule
|
|
@@ -704,7 +895,7 @@ end
|
|
|
704
895
|
| Name | Type | Description | Notes |
|
|
705
896
|
| ---- | ---- | ----------- | ----- |
|
|
706
897
|
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
|
707
|
-
| **earning_rule_id** | **String** | Unique earning rule
|
|
898
|
+
| **earning_rule_id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | |
|
|
708
899
|
|
|
709
900
|
### Return type
|
|
710
901
|
|
|
@@ -720,6 +911,68 @@ end
|
|
|
720
911
|
- **Accept**: application/json
|
|
721
912
|
|
|
722
913
|
|
|
914
|
+
## export_loyalty_campaign_transactions
|
|
915
|
+
|
|
916
|
+
> <CampaignsTransactionsExportCreateResponseBody> export_loyalty_campaign_transactions(campaign_id, opts)
|
|
917
|
+
|
|
918
|
+
Export Loyalty Campaign Transactions
|
|
919
|
+
|
|
920
|
+
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: 👍 Export Campaign Transactions 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.
|
|
921
|
+
|
|
922
|
+
### Examples
|
|
923
|
+
|
|
924
|
+
```ruby
|
|
925
|
+
require 'time'
|
|
926
|
+
require 'VoucherifySdk'
|
|
927
|
+
# setup authorization
|
|
928
|
+
VoucherifySdk.configure do |config|
|
|
929
|
+
# Configure API key authorization: X-App-Id
|
|
930
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
931
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
932
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
933
|
+
|
|
934
|
+
# Configure API key authorization: X-App-Token
|
|
935
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
936
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
937
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
938
|
+
end
|
|
939
|
+
|
|
940
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
941
|
+
campaign_id = 'campaign_id_example' # String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
|
|
942
|
+
opts = {
|
|
943
|
+
loyalties_transactions_export_create_request_body: VoucherifySdk::LoyaltiesTransactionsExportCreateRequestBody.new # LoyaltiesTransactionsExportCreateRequestBody | Specify the parameters for the transaction export.
|
|
944
|
+
}
|
|
945
|
+
|
|
946
|
+
begin
|
|
947
|
+
# Export Loyalty Campaign Transactions
|
|
948
|
+
result = api_instance.export_loyalty_campaign_transactions(campaign_id, opts)
|
|
949
|
+
p result
|
|
950
|
+
rescue VoucherifySdk::ApiError => e
|
|
951
|
+
puts "Error when calling LoyaltiesApi->export_loyalty_campaign_transactions: #{e}"
|
|
952
|
+
end
|
|
953
|
+
```
|
|
954
|
+
|
|
955
|
+
### Parameters
|
|
956
|
+
|
|
957
|
+
| Name | Type | Description | Notes |
|
|
958
|
+
| ---- | ---- | ----------- | ----- |
|
|
959
|
+
| **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. | |
|
|
960
|
+
| **loyalties_transactions_export_create_request_body** | [**LoyaltiesTransactionsExportCreateRequestBody**](LoyaltiesTransactionsExportCreateRequestBody.md) | Specify the parameters for the transaction export. | [optional] |
|
|
961
|
+
|
|
962
|
+
### Return type
|
|
963
|
+
|
|
964
|
+
[**CampaignsTransactionsExportCreateResponseBody**](CampaignsTransactionsExportCreateResponseBody.md)
|
|
965
|
+
|
|
966
|
+
### Authorization
|
|
967
|
+
|
|
968
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
969
|
+
|
|
970
|
+
### HTTP request headers
|
|
971
|
+
|
|
972
|
+
- **Content-Type**: application/json
|
|
973
|
+
- **Accept**: application/json
|
|
974
|
+
|
|
975
|
+
|
|
723
976
|
## export_loyalty_card_transactions
|
|
724
977
|
|
|
725
978
|
> <LoyaltiesMembersTransactionsExportCreateResponseBody> export_loyalty_card_transactions(member_id, opts)
|
|
@@ -786,7 +1039,7 @@ end
|
|
|
786
1039
|
|
|
787
1040
|
> <LoyaltiesMembersTransactionsExportCreateResponseBody> export_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
788
1041
|
|
|
789
|
-
Export Loyalty Card Transactions
|
|
1042
|
+
Export Loyalty Card Transactions with campaign ID
|
|
790
1043
|
|
|
791
1044
|
Export transactions that are associated with point movements on a loyalty card.
|
|
792
1045
|
|
|
@@ -816,7 +1069,7 @@ opts = {
|
|
|
816
1069
|
}
|
|
817
1070
|
|
|
818
1071
|
begin
|
|
819
|
-
# Export Loyalty Card Transactions
|
|
1072
|
+
# Export Loyalty Card Transactions with campaign ID
|
|
820
1073
|
result = api_instance.export_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
821
1074
|
p result
|
|
822
1075
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -1030,7 +1283,7 @@ end
|
|
|
1030
1283
|
|
|
1031
1284
|
Get Member
|
|
1032
1285
|
|
|
1033
|
-
Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
|
|
1286
|
+
Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint 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.
|
|
1034
1287
|
|
|
1035
1288
|
### Examples
|
|
1036
1289
|
|
|
@@ -1086,7 +1339,7 @@ end
|
|
|
1086
1339
|
|
|
1087
1340
|
> <LoyaltiesMembersGetResponseBody> get_member1(campaign_id, member_id)
|
|
1088
1341
|
|
|
1089
|
-
Get Member
|
|
1342
|
+
Get Member with campaign ID
|
|
1090
1343
|
|
|
1091
1344
|
Retrieves the loyalty card with the given member ID (i.e. voucher code).
|
|
1092
1345
|
|
|
@@ -1113,7 +1366,7 @@ campaign_id = 'campaign_id_example' # String | Unique campaign ID.
|
|
|
1113
1366
|
member_id = 'member_id_example' # String | Unique code that identifies the loyalty card.
|
|
1114
1367
|
|
|
1115
1368
|
begin
|
|
1116
|
-
# Get Member
|
|
1369
|
+
# Get Member with campaign ID
|
|
1117
1370
|
result = api_instance.get_member1(campaign_id, member_id)
|
|
1118
1371
|
p result
|
|
1119
1372
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -1146,7 +1399,7 @@ end
|
|
|
1146
1399
|
|
|
1147
1400
|
> <LoyaltiesRewardAssignmentsGetResponseBody> get_reward_assignment1(campaign_id, assignment_id)
|
|
1148
1401
|
|
|
1149
|
-
Get Reward
|
|
1402
|
+
Get Campaign Reward Assignments
|
|
1150
1403
|
|
|
1151
1404
|
Retrieve specific reward assignment.
|
|
1152
1405
|
|
|
@@ -1173,7 +1426,7 @@ campaign_id = 'campaign_id_example' # String | The campaign ID or name of the lo
|
|
|
1173
1426
|
assignment_id = 'assignment_id_example' # String | Unique reward assignment ID.
|
|
1174
1427
|
|
|
1175
1428
|
begin
|
|
1176
|
-
# Get Reward
|
|
1429
|
+
# Get Campaign Reward Assignments
|
|
1177
1430
|
result = api_instance.get_reward_assignment1(campaign_id, assignment_id)
|
|
1178
1431
|
p result
|
|
1179
1432
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -1206,9 +1459,9 @@ end
|
|
|
1206
1459
|
|
|
1207
1460
|
> <LoyaltiesRewardsGetResponseBody> get_reward_assignment2(campaign_id, assignment_id)
|
|
1208
1461
|
|
|
1209
|
-
Get Reward Assignment
|
|
1462
|
+
Get Campaign Reward Assignment
|
|
1210
1463
|
|
|
1211
|
-
Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this endpoint.
|
|
1464
|
+
Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments).
|
|
1212
1465
|
|
|
1213
1466
|
### Examples
|
|
1214
1467
|
|
|
@@ -1233,7 +1486,7 @@ campaign_id = 'campaign_id_example' # String | The campaign ID or name of the lo
|
|
|
1233
1486
|
assignment_id = 'assignment_id_example' # String | A unique reward assignment ID.
|
|
1234
1487
|
|
|
1235
1488
|
begin
|
|
1236
|
-
# Get Reward Assignment
|
|
1489
|
+
# Get Campaign Reward Assignment
|
|
1237
1490
|
result = api_instance.get_reward_assignment2(campaign_id, assignment_id)
|
|
1238
1491
|
p result
|
|
1239
1492
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -1322,6 +1575,72 @@ end
|
|
|
1322
1575
|
- **Accept**: application/json
|
|
1323
1576
|
|
|
1324
1577
|
|
|
1578
|
+
## list_campaign_pending_points
|
|
1579
|
+
|
|
1580
|
+
> <LoyaltiesPendingPointsListResponseBody> list_campaign_pending_points(campaign_id, opts)
|
|
1581
|
+
|
|
1582
|
+
List Campaign Pending Points
|
|
1583
|
+
|
|
1584
|
+
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. 👍 Configuring pending points 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).
|
|
1585
|
+
|
|
1586
|
+
### Examples
|
|
1587
|
+
|
|
1588
|
+
```ruby
|
|
1589
|
+
require 'time'
|
|
1590
|
+
require 'VoucherifySdk'
|
|
1591
|
+
# setup authorization
|
|
1592
|
+
VoucherifySdk.configure do |config|
|
|
1593
|
+
# Configure API key authorization: X-App-Id
|
|
1594
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1595
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1596
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1597
|
+
|
|
1598
|
+
# Configure API key authorization: X-App-Token
|
|
1599
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1600
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1601
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1602
|
+
end
|
|
1603
|
+
|
|
1604
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1605
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID.
|
|
1606
|
+
opts = {
|
|
1607
|
+
limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
|
|
1608
|
+
order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
|
1609
|
+
starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
|
1610
|
+
}
|
|
1611
|
+
|
|
1612
|
+
begin
|
|
1613
|
+
# List Campaign Pending Points
|
|
1614
|
+
result = api_instance.list_campaign_pending_points(campaign_id, opts)
|
|
1615
|
+
p result
|
|
1616
|
+
rescue VoucherifySdk::ApiError => e
|
|
1617
|
+
puts "Error when calling LoyaltiesApi->list_campaign_pending_points: #{e}"
|
|
1618
|
+
end
|
|
1619
|
+
```
|
|
1620
|
+
|
|
1621
|
+
### Parameters
|
|
1622
|
+
|
|
1623
|
+
| Name | Type | Description | Notes |
|
|
1624
|
+
| ---- | ---- | ----------- | ----- |
|
|
1625
|
+
| **campaign_id** | **String** | Unique campaign ID. | |
|
|
1626
|
+
| **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
|
|
1627
|
+
| **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
1628
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
|
|
1629
|
+
|
|
1630
|
+
### Return type
|
|
1631
|
+
|
|
1632
|
+
[**LoyaltiesPendingPointsListResponseBody**](LoyaltiesPendingPointsListResponseBody.md)
|
|
1633
|
+
|
|
1634
|
+
### Authorization
|
|
1635
|
+
|
|
1636
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1637
|
+
|
|
1638
|
+
### HTTP request headers
|
|
1639
|
+
|
|
1640
|
+
- **Content-Type**: Not defined
|
|
1641
|
+
- **Accept**: application/json
|
|
1642
|
+
|
|
1643
|
+
|
|
1325
1644
|
## list_earning_rules
|
|
1326
1645
|
|
|
1327
1646
|
> <LoyaltiesEarningRulesListResponseBody> list_earning_rules(campaign_id, opts)
|
|
@@ -1388,6 +1707,74 @@ end
|
|
|
1388
1707
|
- **Accept**: application/json
|
|
1389
1708
|
|
|
1390
1709
|
|
|
1710
|
+
## list_loyalty_campaign_transactions
|
|
1711
|
+
|
|
1712
|
+
> <LoyaltiesTransactionsListResponseBody> list_loyalty_campaign_transactions(campaign_id, opts)
|
|
1713
|
+
|
|
1714
|
+
List Loyalty Campaign Transactions
|
|
1715
|
+
|
|
1716
|
+
Retrieves all transactions for the campaign with the given campaign ID or campaign name.
|
|
1717
|
+
|
|
1718
|
+
### Examples
|
|
1719
|
+
|
|
1720
|
+
```ruby
|
|
1721
|
+
require 'time'
|
|
1722
|
+
require 'VoucherifySdk'
|
|
1723
|
+
# setup authorization
|
|
1724
|
+
VoucherifySdk.configure do |config|
|
|
1725
|
+
# Configure API key authorization: X-App-Id
|
|
1726
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1727
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1728
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1729
|
+
|
|
1730
|
+
# Configure API key authorization: X-App-Token
|
|
1731
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1732
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1733
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1734
|
+
end
|
|
1735
|
+
|
|
1736
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1737
|
+
campaign_id = 'campaign_id_example' # String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
|
|
1738
|
+
opts = {
|
|
1739
|
+
limit: 56, # Integer | 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.
|
|
1740
|
+
order: VoucherifySdk::ParameterOrderListTransactions::ID, # ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
1741
|
+
starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
|
|
1742
|
+
filters: VoucherifySdk::ParametersFiltersListCampaignTransactions.new # ParametersFiltersListCampaignTransactions | Filters for listing responses. The id filter denotes the unique transaction identifier.
|
|
1743
|
+
}
|
|
1744
|
+
|
|
1745
|
+
begin
|
|
1746
|
+
# List Loyalty Campaign Transactions
|
|
1747
|
+
result = api_instance.list_loyalty_campaign_transactions(campaign_id, opts)
|
|
1748
|
+
p result
|
|
1749
|
+
rescue VoucherifySdk::ApiError => e
|
|
1750
|
+
puts "Error when calling LoyaltiesApi->list_loyalty_campaign_transactions: #{e}"
|
|
1751
|
+
end
|
|
1752
|
+
```
|
|
1753
|
+
|
|
1754
|
+
### Parameters
|
|
1755
|
+
|
|
1756
|
+
| Name | Type | Description | Notes |
|
|
1757
|
+
| ---- | ---- | ----------- | ----- |
|
|
1758
|
+
| **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. | |
|
|
1759
|
+
| **limit** | **Integer** | 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. | [optional] |
|
|
1760
|
+
| **order** | [**ParameterOrderListTransactions**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
1761
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. | [optional] |
|
|
1762
|
+
| **filters** | [**ParametersFiltersListCampaignTransactions**](.md) | Filters for listing responses. The id filter denotes the unique transaction identifier. | [optional] |
|
|
1763
|
+
|
|
1764
|
+
### Return type
|
|
1765
|
+
|
|
1766
|
+
[**LoyaltiesTransactionsListResponseBody**](LoyaltiesTransactionsListResponseBody.md)
|
|
1767
|
+
|
|
1768
|
+
### Authorization
|
|
1769
|
+
|
|
1770
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1771
|
+
|
|
1772
|
+
### HTTP request headers
|
|
1773
|
+
|
|
1774
|
+
- **Content-Type**: Not defined
|
|
1775
|
+
- **Accept**: application/json
|
|
1776
|
+
|
|
1777
|
+
|
|
1391
1778
|
## list_loyalty_card_transactions
|
|
1392
1779
|
|
|
1393
1780
|
> <LoyaltiesMembersTransactionsListResponseBody> list_loyalty_card_transactions(member_id, opts)
|
|
@@ -1458,7 +1845,7 @@ end
|
|
|
1458
1845
|
|
|
1459
1846
|
> <LoyaltiesMembersTransactionsListResponseBody> list_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
1460
1847
|
|
|
1461
|
-
List Loyalty Card Transactions
|
|
1848
|
+
List Loyalty Card Transactions with campaign ID
|
|
1462
1849
|
|
|
1463
1850
|
Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1464
1851
|
|
|
@@ -1490,7 +1877,7 @@ opts = {
|
|
|
1490
1877
|
}
|
|
1491
1878
|
|
|
1492
1879
|
begin
|
|
1493
|
-
# List Loyalty Card Transactions
|
|
1880
|
+
# List Loyalty Card Transactions with campaign ID
|
|
1494
1881
|
result = api_instance.list_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
1495
1882
|
p result
|
|
1496
1883
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -1782,7 +2169,7 @@ end
|
|
|
1782
2169
|
|
|
1783
2170
|
List Member Activity
|
|
1784
2171
|
|
|
1785
|
-
📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
2172
|
+
📘 Alternative endpoint 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. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
1786
2173
|
|
|
1787
2174
|
### Examples
|
|
1788
2175
|
|
|
@@ -1846,7 +2233,7 @@ end
|
|
|
1846
2233
|
|
|
1847
2234
|
> <LoyaltiesMemberActivityListResponseBody> list_member_activity1(campaign_id, member_id, opts)
|
|
1848
2235
|
|
|
1849
|
-
List Member Activity
|
|
2236
|
+
List Member Activity with campaign ID
|
|
1850
2237
|
|
|
1851
2238
|
Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
1852
2239
|
|
|
@@ -1878,7 +2265,7 @@ opts = {
|
|
|
1878
2265
|
}
|
|
1879
2266
|
|
|
1880
2267
|
begin
|
|
1881
|
-
# List Member Activity
|
|
2268
|
+
# List Member Activity with campaign ID
|
|
1882
2269
|
result = api_instance.list_member_activity1(campaign_id, member_id, opts)
|
|
1883
2270
|
p result
|
|
1884
2271
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -1968,6 +2355,140 @@ end
|
|
|
1968
2355
|
- **Accept**: application/json
|
|
1969
2356
|
|
|
1970
2357
|
|
|
2358
|
+
## list_member_pending_points
|
|
2359
|
+
|
|
2360
|
+
> <LoyaltiesMembersPendingPointsListResponseBody> list_member_pending_points(member_id, opts)
|
|
2361
|
+
|
|
2362
|
+
List Member Pending Points
|
|
2363
|
+
|
|
2364
|
+
📘 Alternative endpoint 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. 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. 👍 Configuring pending points 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).
|
|
2365
|
+
|
|
2366
|
+
### Examples
|
|
2367
|
+
|
|
2368
|
+
```ruby
|
|
2369
|
+
require 'time'
|
|
2370
|
+
require 'VoucherifySdk'
|
|
2371
|
+
# setup authorization
|
|
2372
|
+
VoucherifySdk.configure do |config|
|
|
2373
|
+
# Configure API key authorization: X-App-Id
|
|
2374
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2375
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2376
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2377
|
+
|
|
2378
|
+
# Configure API key authorization: X-App-Token
|
|
2379
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2380
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2381
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2382
|
+
end
|
|
2383
|
+
|
|
2384
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
2385
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
|
2386
|
+
opts = {
|
|
2387
|
+
limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
|
|
2388
|
+
order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
|
2389
|
+
starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
|
2390
|
+
}
|
|
2391
|
+
|
|
2392
|
+
begin
|
|
2393
|
+
# List Member Pending Points
|
|
2394
|
+
result = api_instance.list_member_pending_points(member_id, opts)
|
|
2395
|
+
p result
|
|
2396
|
+
rescue VoucherifySdk::ApiError => e
|
|
2397
|
+
puts "Error when calling LoyaltiesApi->list_member_pending_points: #{e}"
|
|
2398
|
+
end
|
|
2399
|
+
```
|
|
2400
|
+
|
|
2401
|
+
### Parameters
|
|
2402
|
+
|
|
2403
|
+
| Name | Type | Description | Notes |
|
|
2404
|
+
| ---- | ---- | ----------- | ----- |
|
|
2405
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
|
2406
|
+
| **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
|
|
2407
|
+
| **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
2408
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
|
|
2409
|
+
|
|
2410
|
+
### Return type
|
|
2411
|
+
|
|
2412
|
+
[**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
|
|
2413
|
+
|
|
2414
|
+
### Authorization
|
|
2415
|
+
|
|
2416
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2417
|
+
|
|
2418
|
+
### HTTP request headers
|
|
2419
|
+
|
|
2420
|
+
- **Content-Type**: Not defined
|
|
2421
|
+
- **Accept**: application/json
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
## list_member_pending_points1
|
|
2425
|
+
|
|
2426
|
+
> <LoyaltiesMembersPendingPointsListResponseBody> list_member_pending_points1(campaign_id, member_id, opts)
|
|
2427
|
+
|
|
2428
|
+
List Member Pending Points with campaign ID
|
|
2429
|
+
|
|
2430
|
+
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. 👍 Configuring pending points 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).
|
|
2431
|
+
|
|
2432
|
+
### Examples
|
|
2433
|
+
|
|
2434
|
+
```ruby
|
|
2435
|
+
require 'time'
|
|
2436
|
+
require 'VoucherifySdk'
|
|
2437
|
+
# setup authorization
|
|
2438
|
+
VoucherifySdk.configure do |config|
|
|
2439
|
+
# Configure API key authorization: X-App-Id
|
|
2440
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2441
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2442
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2443
|
+
|
|
2444
|
+
# Configure API key authorization: X-App-Token
|
|
2445
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2446
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2447
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2448
|
+
end
|
|
2449
|
+
|
|
2450
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
2451
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID.
|
|
2452
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
|
2453
|
+
opts = {
|
|
2454
|
+
limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
|
|
2455
|
+
order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
|
2456
|
+
starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
|
2457
|
+
}
|
|
2458
|
+
|
|
2459
|
+
begin
|
|
2460
|
+
# List Member Pending Points with campaign ID
|
|
2461
|
+
result = api_instance.list_member_pending_points1(campaign_id, member_id, opts)
|
|
2462
|
+
p result
|
|
2463
|
+
rescue VoucherifySdk::ApiError => e
|
|
2464
|
+
puts "Error when calling LoyaltiesApi->list_member_pending_points1: #{e}"
|
|
2465
|
+
end
|
|
2466
|
+
```
|
|
2467
|
+
|
|
2468
|
+
### Parameters
|
|
2469
|
+
|
|
2470
|
+
| Name | Type | Description | Notes |
|
|
2471
|
+
| ---- | ---- | ----------- | ----- |
|
|
2472
|
+
| **campaign_id** | **String** | Unique campaign ID. | |
|
|
2473
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
|
2474
|
+
| **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
|
|
2475
|
+
| **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
2476
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
|
|
2477
|
+
|
|
2478
|
+
### Return type
|
|
2479
|
+
|
|
2480
|
+
[**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
|
|
2481
|
+
|
|
2482
|
+
### Authorization
|
|
2483
|
+
|
|
2484
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2485
|
+
|
|
2486
|
+
### HTTP request headers
|
|
2487
|
+
|
|
2488
|
+
- **Content-Type**: Not defined
|
|
2489
|
+
- **Accept**: application/json
|
|
2490
|
+
|
|
2491
|
+
|
|
1971
2492
|
## list_member_rewards
|
|
1972
2493
|
|
|
1973
2494
|
> <LoyaltiesMembersRewardsListResponseBody> list_member_rewards(member_id, opts)
|
|
@@ -2110,9 +2631,9 @@ end
|
|
|
2110
2631
|
|
|
2111
2632
|
> <LoyaltiesMembersPointsExpirationListResponseBody> list_points_expiration(campaign_id, member_id, opts)
|
|
2112
2633
|
|
|
2113
|
-
|
|
2634
|
+
List Loyalty Card Point Expiration
|
|
2114
2635
|
|
|
2115
|
-
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.
|
|
2636
|
+
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.
|
|
2116
2637
|
|
|
2117
2638
|
### Examples
|
|
2118
2639
|
|
|
@@ -2141,7 +2662,7 @@ opts = {
|
|
|
2141
2662
|
}
|
|
2142
2663
|
|
|
2143
2664
|
begin
|
|
2144
|
-
#
|
|
2665
|
+
# List Loyalty Card Point Expiration
|
|
2145
2666
|
result = api_instance.list_points_expiration(campaign_id, member_id, opts)
|
|
2146
2667
|
p result
|
|
2147
2668
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -2176,9 +2697,9 @@ end
|
|
|
2176
2697
|
|
|
2177
2698
|
> <LoyaltiesRewardAssignmentsListResponseBody> list_reward_assignments1(campaign_id, opts)
|
|
2178
2699
|
|
|
2179
|
-
List Reward Assignments
|
|
2700
|
+
List Reward Assignments with campaign ID
|
|
2180
2701
|
|
|
2181
|
-
Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to be more contextual to the type of data returned in the response.
|
|
2702
|
+
Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint 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.
|
|
2182
2703
|
|
|
2183
2704
|
### Examples
|
|
2184
2705
|
|
|
@@ -2207,7 +2728,7 @@ opts = {
|
|
|
2207
2728
|
}
|
|
2208
2729
|
|
|
2209
2730
|
begin
|
|
2210
|
-
# List Reward Assignments
|
|
2731
|
+
# List Reward Assignments with campaign ID
|
|
2211
2732
|
result = api_instance.list_reward_assignments1(campaign_id, opts)
|
|
2212
2733
|
p result
|
|
2213
2734
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -2242,7 +2763,7 @@ end
|
|
|
2242
2763
|
|
|
2243
2764
|
> <LoyaltiesRewardsListAssignmentsResponseBody> list_reward_assignments2(campaign_id, opts)
|
|
2244
2765
|
|
|
2245
|
-
List
|
|
2766
|
+
List Campaign Rewards
|
|
2246
2767
|
|
|
2247
2768
|
Returns active rewards from a given loyalty campaign.
|
|
2248
2769
|
|
|
@@ -2273,7 +2794,7 @@ opts = {
|
|
|
2273
2794
|
}
|
|
2274
2795
|
|
|
2275
2796
|
begin
|
|
2276
|
-
# List
|
|
2797
|
+
# List Campaign Rewards
|
|
2277
2798
|
result = api_instance.list_reward_assignments2(campaign_id, opts)
|
|
2278
2799
|
p result
|
|
2279
2800
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -2310,7 +2831,7 @@ end
|
|
|
2310
2831
|
|
|
2311
2832
|
Redeem Reward
|
|
2312
2833
|
|
|
2313
|
-
📘 Alternative endpoint
|
|
2834
|
+
📘 Alternative endpoint 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.
|
|
2314
2835
|
|
|
2315
2836
|
### Examples
|
|
2316
2837
|
|
|
@@ -2370,7 +2891,7 @@ end
|
|
|
2370
2891
|
|
|
2371
2892
|
> <LoyaltiesMembersRedemptionRedeemResponseBody> redeem_reward1(campaign_id, member_id, opts)
|
|
2372
2893
|
|
|
2373
|
-
Redeem Reward
|
|
2894
|
+
Redeem Reward with campaign ID
|
|
2374
2895
|
|
|
2375
2896
|
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.
|
|
2376
2897
|
|
|
@@ -2400,7 +2921,7 @@ opts = {
|
|
|
2400
2921
|
}
|
|
2401
2922
|
|
|
2402
2923
|
begin
|
|
2403
|
-
# Redeem Reward
|
|
2924
|
+
# Redeem Reward with campaign ID
|
|
2404
2925
|
result = api_instance.redeem_reward1(campaign_id, member_id, opts)
|
|
2405
2926
|
p result
|
|
2406
2927
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -2436,7 +2957,7 @@ end
|
|
|
2436
2957
|
|
|
2437
2958
|
Transfer Loyalty Points
|
|
2438
2959
|
|
|
2439
|
-
Transfer points between different loyalty cards
|
|
2960
|
+
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.
|
|
2440
2961
|
|
|
2441
2962
|
### Examples
|
|
2442
2963
|
|
|
@@ -2562,9 +3083,9 @@ end
|
|
|
2562
3083
|
|
|
2563
3084
|
> <LoyaltiesMembersBalanceUpdateResponseBody> update_loyalty_card_balance(member_id, opts)
|
|
2564
3085
|
|
|
2565
|
-
|
|
3086
|
+
Adjust Loyalty Card Balance
|
|
2566
3087
|
|
|
2567
|
-
This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action 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. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. 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.
|
|
3088
|
+
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. >🚧 Async Action 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. 📘 Alternative endpoint 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.
|
|
2568
3089
|
|
|
2569
3090
|
### Examples
|
|
2570
3091
|
|
|
@@ -2591,7 +3112,7 @@ opts = {
|
|
|
2591
3112
|
}
|
|
2592
3113
|
|
|
2593
3114
|
begin
|
|
2594
|
-
#
|
|
3115
|
+
# Adjust Loyalty Card Balance
|
|
2595
3116
|
result = api_instance.update_loyalty_card_balance(member_id, opts)
|
|
2596
3117
|
p result
|
|
2597
3118
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -2624,9 +3145,9 @@ end
|
|
|
2624
3145
|
|
|
2625
3146
|
> <LoyaltiesMembersBalanceUpdateResponseBody> update_loyalty_card_balance1(campaign_id, member_id, opts)
|
|
2626
3147
|
|
|
2627
|
-
|
|
3148
|
+
Adjust Loyalty Card Balance with campaign ID
|
|
2628
3149
|
|
|
2629
|
-
This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action 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.
|
|
3150
|
+
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. >🚧 Async Action 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.
|
|
2630
3151
|
|
|
2631
3152
|
### Examples
|
|
2632
3153
|
|
|
@@ -2654,7 +3175,7 @@ opts = {
|
|
|
2654
3175
|
}
|
|
2655
3176
|
|
|
2656
3177
|
begin
|
|
2657
|
-
#
|
|
3178
|
+
# Adjust Loyalty Card Balance with campaign ID
|
|
2658
3179
|
result = api_instance.update_loyalty_card_balance1(campaign_id, member_id, opts)
|
|
2659
3180
|
p result
|
|
2660
3181
|
rescue VoucherifySdk::ApiError => e
|
|
@@ -2690,7 +3211,7 @@ end
|
|
|
2690
3211
|
|
|
2691
3212
|
Update Loyalty Campaign
|
|
2692
3213
|
|
|
2693
|
-
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.
|
|
3214
|
+
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.
|
|
2694
3215
|
|
|
2695
3216
|
### Examples
|
|
2696
3217
|
|
|
@@ -2750,7 +3271,7 @@ end
|
|
|
2750
3271
|
|
|
2751
3272
|
> <LoyaltiesRewardsUpdateAssignmentResponseBody> update_reward_assignment1(campaign_id, assignment_id, opts)
|
|
2752
3273
|
|
|
2753
|
-
Update Reward Assignment
|
|
3274
|
+
Update Campaign Reward Assignment
|
|
2754
3275
|
|
|
2755
3276
|
Updates rewards parameters, i.e. the points cost for the specific reward.
|
|
2756
3277
|
|
|
@@ -2780,7 +3301,7 @@ opts = {
|
|
|
2780
3301
|
}
|
|
2781
3302
|
|
|
2782
3303
|
begin
|
|
2783
|
-
# Update Reward Assignment
|
|
3304
|
+
# Update Campaign Reward Assignment
|
|
2784
3305
|
result = api_instance.update_reward_assignment1(campaign_id, assignment_id, opts)
|
|
2785
3306
|
p result
|
|
2786
3307
|
rescue VoucherifySdk::ApiError => e
|