voucherify 8.1.0 → 8.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +192 -56
- data/Gemfile.lock +7 -7
- data/README.md +422 -0
- data/__tests__/LOYALTY_V2_COVERAGE.md +161 -0
- data/__tests__/lib/config.rb +20 -0
- data/__tests__/lib/loyalty_v2_fixture.rb +199 -0
- data/__tests__/lib/loyalty_v2_http.rb +209 -0
- data/__tests__/spec/13_management_spec.rb +6 -1
- data/__tests__/spec/15_loyalty_v2_spec.rb +403 -0
- data/docs/ActivitySource.md +10 -0
- data/docs/ActivitySourceApiKey.md +10 -0
- data/docs/ActivitySourceUser.md +8 -0
- data/docs/BenefitPointsProportionalApplicableTo.md +11 -0
- data/docs/BenefitPointsProportionalCustomEvent.md +8 -0
- data/docs/BenefitPointsProportionalCustomEventMetadata.md +10 -0
- data/docs/BenefitPointsProportionalCustomer.md +8 -0
- data/docs/BenefitPointsProportionalCustomerMetadata.md +10 -0
- data/docs/BenefitPointsProportionalOrder.md +10 -0
- data/docs/BenefitPointsProportionalOrderAmount.md +9 -0
- data/docs/BenefitPointsProportionalOrderItems.md +10 -0
- data/docs/BenefitPointsProportionalOrderItemsAmount.md +10 -0
- data/docs/BenefitPointsProportionalOrderItemsQuantity.md +10 -0
- data/docs/BenefitPointsProportionalOrderItemsSubtotalAmount.md +10 -0
- data/docs/BenefitPointsProportionalOrderMetadata.md +10 -0
- data/docs/BenefitPointsProportionalOrderTotalAmount.md +9 -0
- data/docs/BenefitTransaction.md +18 -0
- data/docs/BenefitTransactionDetails.md +11 -0
- data/docs/BenefitTransactionDetailsMetadata.md +9 -0
- data/docs/BenefitTransactionDetailsResult.md +8 -0
- data/docs/BenefitTransactionRejection.md +9 -0
- data/docs/CampaignsApi.md +7 -7
- data/docs/Card.md +19 -0
- data/docs/CardActivity.md +14 -0
- data/docs/CardActivityData.md +12 -0
- data/docs/CardBalance.md +9 -0
- data/docs/CardCodeGenerationFailureResult.md +8 -0
- data/docs/CardDailyReportEntry.md +24 -0
- data/docs/CardDefinitionIdFilterConditions.md +8 -0
- data/docs/CardDefinitionIdFilterConditionsConditions.md +11 -0
- data/docs/CardLifetimeBucket.md +9 -0
- data/docs/CardLifetimeBucketPendingPoints.md +10 -0
- data/docs/CardLifetimeBucketPoints.md +19 -0
- data/docs/CardNextActivation.md +11 -0
- data/docs/CardNextExpiration.md +9 -0
- data/docs/CardPendingPointsBucket.md +20 -0
- data/docs/CardPendingPointsBucketPoints.md +8 -0
- data/docs/CardPointsBucket.md +21 -0
- data/docs/CardPointsBucketPoints.md +8 -0
- data/docs/CardSimple.md +16 -0
- data/docs/CardTransaction.md +19 -0
- data/docs/CardTransactionDetails.md +22 -0
- data/docs/CardTransactionDetailsCardTransaction.md +8 -0
- data/docs/CardTransactionDetailsOrder.md +8 -0
- data/docs/CardTransactionDetailsOrderTransaction.md +8 -0
- data/docs/CardTransactionDetailsPoints.md +12 -0
- data/docs/CardTransactionDetailsPurchase.md +9 -0
- data/docs/CardTransactionDetailsPurchaseCardTransaction.md +8 -0
- data/docs/CardTransactionDetailsPurchaseRewardTransaction.md +8 -0
- data/docs/CardTransactionDetailsPurchaseTransaction.md +8 -0
- data/docs/CardTransactionDetailsRejection.md +9 -0
- data/docs/CardTransactionDetailsReward.md +8 -0
- data/docs/CardTransactionDetailsRewardTransaction.md +8 -0
- data/docs/CardTransactionDetailsTargetCard.md +8 -0
- data/docs/ClientRedemptionsRedeemRequestBody.md +1 -1
- data/docs/ClientSideApi.md +2 -2
- data/docs/ClientValidationsValidateRequestBody.md +1 -1
- data/docs/ClientValidationsValidateResponseBody.md +1 -1
- data/docs/CustomerLoyaltyMembership.md +11 -0
- data/docs/CustomerLoyaltyMembershipCard.md +13 -0
- data/docs/CustomerLoyaltyMembershipMember.md +11 -0
- data/docs/CustomerLoyaltyMembershipTier.md +12 -0
- data/docs/CustomerWithSummaryLoyaltyReferrals.md +1 -0
- data/docs/CustomersApi.md +8 -6
- data/docs/CustomersCreateResponseBody.md +1 -0
- data/docs/CustomersGetResponseBody.md +1 -0
- data/docs/CustomersRedeemablesListResponseBody.md +1 -1
- data/docs/CustomersUpdateResponseBody.md +1 -0
- data/docs/DateFilter.md +8 -0
- data/docs/DateFilterConditions.md +14 -0
- data/docs/EarningRuleDailyReportEntry.md +10 -0
- data/docs/EarningRuleEarning.md +12 -0
- data/docs/EarningRuleEffect.md +11 -0
- data/docs/EarningRuleEffectPoints.md +10 -0
- data/docs/EarningRuleEffectPointsExpiration.md +11 -0
- data/docs/EarningRuleEffectPointsExpirationCalendarExpiration.md +8 -0
- data/docs/EarningRuleEffectPointsExpirationRollingExpiration.md +9 -0
- data/docs/EarningRuleEffectPointsExpirationSlidingExpiration.md +9 -0
- data/docs/EarningRuleEffectPointsProportional.md +14 -0
- data/docs/EarningRuleIdFilterConditions.md +8 -0
- data/docs/EarningRuleIdFilterConditionsConditions.md +11 -0
- data/docs/EarningRulePointsProportionalApplicableTo.md +11 -0
- data/docs/EarningRulePointsProportionalCustomEvent.md +8 -0
- data/docs/EarningRulePointsProportionalCustomer.md +8 -0
- data/docs/EarningRulePointsProportionalOrder.md +10 -0
- data/docs/EarningRulePointsProportionalOrderItems.md +10 -0
- data/docs/EarningRulePointsProportionalOrderItemsCalculation.md +10 -0
- data/docs/EarningRuleTierRules.md +9 -0
- data/docs/EarningRuleTrigger.md +10 -0
- data/docs/EarningRuleTriggerLimitsCooldown.md +9 -0
- data/docs/EarningRuleTriggerLimitsCooldownFixedCooldown.md +8 -0
- data/docs/EarningRuleTriggerLimitsFrequency.md +9 -0
- data/docs/EarningRuleValidityHours.md +9 -0
- data/docs/EarningRulesReportDailyEntry.md +13 -0
- data/docs/EarningRulesReportFailuresBreakdown.md +9 -0
- data/docs/EarningRulesReportListFilters.md +9 -0
- data/docs/EarningRulesReportSummaryEntry.md +13 -0
- data/docs/ErrorError.md +1 -1
- data/docs/ExamineCardReference.md +12 -0
- data/docs/ExamineCustomerIdentification.md +11 -0
- data/docs/ExamineCustomerReference.md +11 -0
- data/docs/ExamineMemberReference.md +12 -0
- data/docs/ExamineProgramReference.md +11 -0
- data/docs/ExportParameters.md +2 -2
- data/docs/ExportsApi.md +6 -6
- data/docs/ExportsCreateRequestBodyParameters.md +2 -2
- data/docs/ExportsCreateResponseBodyParameters.md +2 -2
- data/docs/ExportsGetResponseBodyParameters.md +2 -2
- data/docs/LV2BenefitsApi.md +66 -0
- data/docs/LV2EarningRulesApi.md +66 -0
- data/docs/LV2ExamineApi.md +129 -0
- data/docs/LV2ProgramsApi.md +2935 -0
- data/docs/LV2RewardsApi.md +66 -0
- data/docs/ListCursor.md +9 -0
- data/docs/LoyaltiesApi.md +52 -52
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBody.md +12 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomEventAll.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomEventSpecific.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomer.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerCustomEvent.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerCustomEventAll.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerCustomEventSpecific.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerOrderPaid.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyCustomerSegmentEntered.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyMember.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrder.md +12 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrderItem.md +19 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrderItemProduct.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyOrderItemSku.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyTrigger.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineRequestBodyTriggerSpecific.md +8 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBody.md +12 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyBenefitEarningRuleEstimation.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyBenefitEstimation.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyBenefitReference.md +11 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyCardEarningRuleEstimation.md +10 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyCardEstimation.md +11 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyEarningRuleDetail.md +11 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyEarningRuleReference.md +9 -0
- data/docs/LoyaltiesExamineEarningRulesExamineResponseBodyMembership.md +12 -0
- data/docs/LoyaltiesExamineRewardsExamineRequestBody.md +10 -0
- data/docs/LoyaltiesExamineRewardsExamineRequestBodyCustomer.md +8 -0
- data/docs/LoyaltiesExamineRewardsExamineRequestBodyMember.md +8 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBody.md +11 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyCardEstimation.md +10 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyCardRewardEstimation.md +12 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyMembership.md +11 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardCost.md +9 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardDetail.md +13 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardReference.md +9 -0
- data/docs/LoyaltiesExamineRewardsExamineResponseBodyRewardUnavailabilityReason.md +10 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersId.md +8 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersType.md +8 -0
- data/docs/LoyaltiesProgramsMembersActivitiesListRequestQueryFiltersTypeConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersBenefitsTransactionsListRequestQueryBenefitId.md +8 -0
- data/docs/LoyaltiesProgramsMembersBenefitsTransactionsListRequestQueryBenefitIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersId.md +8 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersType.md +8 -0
- data/docs/LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFiltersTypeConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersCardsReportsDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsMembersCardsTransactionsListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersCardsTransactionsListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryCustomerId.md +8 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryCustomerIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryStatus.md +8 -0
- data/docs/LoyaltiesProgramsMembersListRequestQueryStatusConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBody.md +10 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBodyTransaction.md +20 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBodyTransactionDetails.md +12 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBodyLimit.md +10 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersOrdersPaymentsListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBody.md +10 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBodyTransaction.md +20 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBodyTransactionDetails.md +12 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryCardDefinitionId.md +8 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryCardDefinitionIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryId.md +8 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryRewardId.md +8 -0
- data/docs/LoyaltiesProgramsMembersRewardsPurchasesListRequestQueryRewardIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardDefinitionId.md +8 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardDefinitionIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardId.md +8 -0
- data/docs/LoyaltiesProgramsMembersTiersTransactionsListRequestQueryCardIdConditions.md +11 -0
- data/docs/LoyaltiesProgramsReportsMembersDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsMembersSummaryListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsSpendingsDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsSpendingsSummaryListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsRewardsSummaryListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsSpendingDailyListResponseBody.md +9 -0
- data/docs/LoyaltiesProgramsReportsSpendingSummaryListResponseBody.md +9 -0
- data/docs/LoyaltyV2ActivityBenefitPointsProportionalApplicableToProduct.md +8 -0
- data/docs/LoyaltyV2ActivityBenefitPointsProportionalApplicableToProductsCollection.md +8 -0
- data/docs/LoyaltyV2ActivityBenefitPointsProportionalApplicableToSku.md +8 -0
- data/docs/LoyaltyV2ActivityBenefitStockLimited.md +8 -0
- data/docs/LoyaltyV2ActivityCardDefinitionLimitTimeBasedPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityCardDefinitionLimitTimeBasedPeriodCurrentPeriod.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleEarningLimits.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleEarningLimitsGlobal.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectBenefit.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationCalendarExpirationDate.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationRollingExpirationRounding.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleEffectPointsExpirationSlidingExpirationPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleError.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProduct.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalApplicableToProductsCollection.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalApplicableToSku.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalEvery.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRulePointsProportionalMetadata.md +10 -0
- data/docs/LoyaltyV2ActivityEarningRuleTierRulesAnyOfEntry.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleTriggerCustomEvent.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleTriggerLimitsCooldownFixedCooldownPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityEarningRuleTriggerSegment.md +8 -0
- data/docs/LoyaltyV2ActivityEarningRuleValidityDailyHours.md +10 -0
- data/docs/LoyaltyV2ActivityRewardCostSpendingResponse.md +11 -0
- data/docs/LoyaltyV2ActivityRewardDigitalDiscountCoupons.md +8 -0
- data/docs/LoyaltyV2ActivityRewardDigitalGiftVouchersResponse.md +9 -0
- data/docs/LoyaltyV2ActivityRewardDigitalLoyaltyCardPointsResponse.md +9 -0
- data/docs/LoyaltyV2ActivityRewardMaterialProduct.md +8 -0
- data/docs/LoyaltyV2ActivityRewardMaterialSKU.md +9 -0
- data/docs/LoyaltyV2ActivityRewardPurchaseLimitsCooldownFixedCooldownPeriod.md +9 -0
- data/docs/LoyaltyV2ActivityRewardPurchaseLimitsFrequencyLimitTriggers.md +8 -0
- data/docs/LoyaltyV2ActivityRewardRefunds.md +8 -0
- data/docs/LoyaltyV2ActivityRewardValidityDailyHoursResponse.md +10 -0
- data/docs/LoyaltyV2CardPointsBucketSimple.md +11 -0
- data/docs/LoyaltyV2CardPointsBucketSimplePoints.md +8 -0
- data/docs/LpmOrdPayCcrbTxDetailsMetadata.md +9 -0
- data/docs/LpmOrdPayCcrbTxDetailsRejection.md +9 -0
- data/docs/LpmOrdPayCcrbTxDetailsRejectionDetails.md +10 -0
- data/docs/LpmOrdPayCcrbTxDetailsSpendingCap.md +10 -0
- data/docs/LpmRewPurchCcrbTxDetailsPoints.md +8 -0
- data/docs/LpmRewPurchCcrbTxDetailsRejection.md +9 -0
- data/docs/LpmRewPurchCcrbTxDetailsResult.md +11 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultDigLcPoints.md +10 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultDigital.md +11 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultMaterial.md +10 -0
- data/docs/LpmRewPurchCcrbTxDetailsResultReward.md +9 -0
- data/docs/ManagementApi.md +26 -26
- data/docs/ManagementProjectsMetadataSchemaDefinition.md +1 -1
- data/docs/Member.md +15 -0
- data/docs/MemberCard.md +11 -0
- data/docs/MemberCreate.md +10 -0
- data/docs/MemberTierProgress.md +13 -0
- data/docs/MemberTierProgressCurrent.md +11 -0
- data/docs/MemberTierProgressDeferred.md +10 -0
- data/docs/MemberTierProgressOpportunity.md +10 -0
- data/docs/MemberTierProgressPoints.md +10 -0
- data/docs/MemberTierProgressRisk.md +10 -0
- data/docs/MemberTierProgressTier.md +9 -0
- data/docs/MemberTierProgressTierStructure.md +9 -0
- data/docs/MembersReportDailyEntry.md +13 -0
- data/docs/MembersReportSummaryEntry.md +13 -0
- data/docs/MembershipCard.md +12 -0
- data/docs/MetadataSchemasApi.md +2 -2
- data/docs/OrderPaymentLimitDefinition.md +8 -0
- data/docs/OrderPaymentOrder.md +9 -0
- data/docs/OrderPaymentPaymentDetails.md +11 -0
- data/docs/OrderPaymentRejection.md +9 -0
- data/docs/OrderPaymentTransaction.md +20 -0
- data/docs/OrderPaymentTransactionDetails.md +12 -0
- data/docs/OrderPaymentTransactionDetailsSpendingCap.md +10 -0
- data/docs/OrdersApi.md +2 -2
- data/docs/PointsEarningsReportDailyEntry.md +15 -0
- data/docs/PointsEarningsReportListFilters.md +10 -0
- data/docs/PointsEarningsReportSummaryEntry.md +15 -0
- data/docs/ProductCollectionsApi.md +1 -1
- data/docs/ProductCollectionsProductsListResponseBody.md +1 -1
- data/docs/ProductsApi.md +4 -4
- data/docs/Program.md +17 -0
- data/docs/ProgramEarningRuleAssignment.md +10 -0
- data/docs/ProgramListCursor.md +9 -0
- data/docs/ProgramRewardAssignment.md +13 -0
- data/docs/ProgramRewardAssignmentStock.md +9 -0
- data/docs/ProgramRewardAssignmentStockLimited.md +8 -0
- data/docs/ProgramSimple.md +12 -0
- data/docs/ProgramTierStructureAssignment.md +10 -0
- data/docs/ProgramValidityDailyHours.md +10 -0
- data/docs/ProgramValidityHours.md +9 -0
- data/docs/PromotionTierCampaign.md +1 -1
- data/docs/PromotionsTiersCreateResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersDisableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersEnableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersGetResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersUpdateResponseBodyCampaign.md +1 -1
- data/docs/PublicationsApi.md +3 -3
- data/docs/PublicationsListResponseBody.md +1 -1
- data/docs/QualificationsApi.md +1 -1
- data/docs/RedemptionEntryPromotionTierCampaign.md +1 -1
- data/docs/RedemptionRewardResultParametersCoin.md +1 -1
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsRedeemRequestBody.md +1 -1
- data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -0
- data/docs/ReferralsApi.md +4 -4
- data/docs/ReferralsMembersHoldersListResponseBody.md +1 -1
- data/docs/ReportCardDefinitionIdFilterConditions.md +8 -0
- data/docs/ReportCardDefinitionIdFilterConditionsConditions.md +11 -0
- data/docs/RewardCostResponse.md +12 -0
- data/docs/RewardCostTierRulesAnyOfEntryResponse.md +9 -0
- data/docs/RewardCostTierRulesResponse.md +9 -0
- data/docs/RewardDigitalResponse.md +11 -0
- data/docs/RewardMaterialResponse.md +10 -0
- data/docs/RewardPurchaseDigitalCoupon.md +10 -0
- data/docs/RewardPurchaseDigitalGiftVoucher.md +12 -0
- data/docs/RewardPurchaseLimits.md +9 -0
- data/docs/RewardPurchaseLimitsCooldown.md +9 -0
- data/docs/RewardPurchaseLimitsCooldownFixedCooldown.md +8 -0
- data/docs/RewardPurchaseLimitsFrequency.md +9 -0
- data/docs/RewardPurchaseLimitsFrequencyLimit.md +10 -0
- data/docs/RewardPurchaseRefundPolicies.md +9 -0
- data/docs/RewardPurchaseTransaction.md +20 -0
- data/docs/RewardValidityHoursResponse.md +9 -0
- data/docs/RewardsCreateRequestBodyParametersCoin.md +1 -1
- data/docs/RewardsReportDailyEntry.md +13 -0
- data/docs/RewardsReportFilterRewardIdConditions.md +8 -0
- data/docs/RewardsReportFilterRewardIdConditionsConditions.md +11 -0
- data/docs/RewardsReportListFilters.md +9 -0
- data/docs/RewardsReportSummaryEntry.md +13 -0
- data/docs/RewardsSpendingsReportDailyEntry.md +15 -0
- data/docs/RewardsSpendingsReportFilterCostIdConditions.md +8 -0
- data/docs/RewardsSpendingsReportFilterCostIdConditionsConditions.md +11 -0
- data/docs/RewardsSpendingsReportFilterSpendingIdConditions.md +8 -0
- data/docs/RewardsSpendingsReportFilterSpendingIdConditionsConditions.md +11 -0
- data/docs/RewardsSpendingsReportListFilters.md +12 -0
- data/docs/RewardsSpendingsReportSummaryEntry.md +15 -0
- data/docs/RewardsUpdateRequestBodyParametersCoin.md +1 -1
- data/docs/SegmentsApi.md +1 -1
- data/docs/SpendingReportDailyEntry.md +17 -0
- data/docs/SpendingReportListFilters.md +9 -0
- data/docs/SpendingReportSummaryEntry.md +17 -0
- data/docs/TemplatesApi.md +7 -7
- data/docs/TierTransaction.md +20 -0
- data/docs/TierTransactionDetails.md +14 -0
- data/docs/TierTransactionOrigin.md +10 -0
- data/docs/TierTransactionRejection.md +9 -0
- data/docs/TiersReportDailyEntry.md +16 -0
- data/docs/TiersReportFilterTierIdConditions.md +8 -0
- data/docs/TiersReportFilterTierIdConditionsConditions.md +11 -0
- data/docs/TiersReportFilterTierStructureIdConditions.md +8 -0
- data/docs/TiersReportFilterTierStructureIdConditionsConditions.md +11 -0
- data/docs/TiersReportListFilters.md +10 -0
- data/docs/TiersReportSummaryEntry.md +16 -0
- data/docs/TransactionFilterDateConditions.md +8 -0
- data/docs/TransactionFilterDateConditionsConditions.md +14 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBody.md +19 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBodyPoints.md +9 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBodyPointsProportional.md +13 -0
- data/docs/V2LoyaltiesBenefitsGetResponseBodyStock.md +9 -0
- data/docs/V2LoyaltiesEarningRulesGetResponseBody.md +22 -0
- data/docs/V2LoyaltiesEarningRulesGetResponseBodyTriggerLimits.md +9 -0
- data/docs/V2LoyaltiesProgramsEarningRulesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersActivateResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembersActivitiesListRequestQueryFilters.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersActivitiesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersBenefitsTransactionsListRequestQuery.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersBenefitsTransactionsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersBenefitsTransactionsListResponseBodyCursor.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFilters.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersCardsActivitiesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsExpiringPointsExpireResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsExpiringPointsListRequestQuery.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsExpiringPointsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsActivateResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsCancelResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsListRequestQuery.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPendingPointsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPointsAdjustRequestBody.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersCardsPointsAdjustResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCardsTransactionsListRequestQuery.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersCardsTransactionsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCreateInBulkResponseBody.md +8 -0
- data/docs/V2LoyaltiesProgramsMembersCreateRequestBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersCreateResponseBody.md +16 -0
- data/docs/V2LoyaltiesProgramsMembersDeactivateResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembersDeleteResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembersEarningRulesReportsDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersGetResponseBody.md +16 -0
- data/docs/V2LoyaltiesProgramsMembersListRequestQuery.md +12 -0
- data/docs/V2LoyaltiesProgramsMembersListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBody.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsListRequestQuery.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersOrdersPaymentsListResponseBodyCursor.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesCreateRequestBody.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesListRequestQuery.md +12 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersRewardsPurchasesListResponseBodyCursor.md +9 -0
- data/docs/V2LoyaltiesProgramsMembersTiersTransactionsListRequestQuery.md +11 -0
- data/docs/V2LoyaltiesProgramsMembersTiersTransactionsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsMembersUpdateRequestBody.md +8 -0
- data/docs/V2LoyaltiesProgramsMembersUpdateResponseBody.md +15 -0
- data/docs/V2LoyaltiesProgramsMembershipsGetResponseBody.md +11 -0
- data/docs/V2LoyaltiesProgramsReportsEarningRulesDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsEarningRulesSummaryListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsPointsEarningsDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsPointsEarningsSummaryListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsTiersDailyListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsReportsTiersSummaryListResponseBody.md +9 -0
- data/docs/V2LoyaltiesProgramsRewardsListResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsRewardsPurchasesRefundRequestBody.md +8 -0
- data/docs/V2LoyaltiesProgramsRewardsPurchasesRefundResponseBody.md +10 -0
- data/docs/V2LoyaltiesProgramsTierStructuresListResponseBody.md +10 -0
- data/docs/V2LoyaltiesRewardsGetResponseBody.md +23 -0
- data/docs/VLMemberActivity.md +14 -0
- data/docs/VLMemberActivityData.md +11 -0
- data/docs/ValidationRulesApi.md +2 -2
- data/docs/ValidationsValidateRequestBody.md +1 -1
- data/docs/ValidationsValidateRequestBodyOptions.md +1 -0
- data/docs/ValidationsValidateResponseBody.md +1 -1
- data/docs/VouchersApi.md +8 -8
- data/lib/VoucherifySdk/api/campaigns_api.rb +14 -14
- data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
- data/lib/VoucherifySdk/api/customers_api.rb +13 -10
- data/lib/VoucherifySdk/api/exports_api.rb +8 -8
- data/lib/VoucherifySdk/api/loyalties_api.rb +104 -104
- data/lib/VoucherifySdk/api/lv2_benefits_api.rb +81 -0
- data/lib/VoucherifySdk/api/lv2_earning_rules_api.rb +81 -0
- data/lib/VoucherifySdk/api/lv2_examine_api.rb +150 -0
- data/lib/VoucherifySdk/api/lv2_programs_api.rb +3008 -0
- data/lib/VoucherifySdk/api/lv2_rewards_api.rb +81 -0
- data/lib/VoucherifySdk/api/management_api.rb +52 -52
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +4 -4
- data/lib/VoucherifySdk/api/orders_api.rb +4 -4
- data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
- data/lib/VoucherifySdk/api/products_api.rb +8 -8
- data/lib/VoucherifySdk/api/publications_api.rb +6 -6
- data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
- data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
- data/lib/VoucherifySdk/api/referrals_api.rb +8 -8
- data/lib/VoucherifySdk/api/segments_api.rb +2 -2
- data/lib/VoucherifySdk/api/templates_api.rb +14 -14
- data/lib/VoucherifySdk/api/validation_rules_api.rb +4 -4
- data/lib/VoucherifySdk/api/vouchers_api.rb +16 -16
- data/lib/VoucherifySdk/configuration.rb +8 -0
- data/lib/VoucherifySdk/models/activity_source.rb +252 -0
- data/lib/VoucherifySdk/models/activity_source_api_key.rb +232 -0
- data/lib/VoucherifySdk/models/activity_source_user.rb +210 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_applicable_to.rb +261 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_custom_event.rb +209 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_custom_event_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_customer.rb +209 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_customer_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order.rb +229 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_amount.rb +241 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items.rb +229 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items_amount.rb +259 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items_quantity.rb +259 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_items_subtotal_amount.rb +259 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/benefit_points_proportional_order_total_amount.rb +241 -0
- data/lib/VoucherifySdk/models/benefit_transaction.rb +350 -0
- data/lib/VoucherifySdk/models/benefit_transaction_details.rb +238 -0
- data/lib/VoucherifySdk/models/benefit_transaction_details_metadata.rb +227 -0
- data/lib/VoucherifySdk/models/benefit_transaction_details_result.rb +210 -0
- data/lib/VoucherifySdk/models/benefit_transaction_rejection.rb +220 -0
- data/lib/VoucherifySdk/models/card.rb +387 -0
- data/lib/VoucherifySdk/models/card_activity.rb +308 -0
- data/lib/VoucherifySdk/models/card_activity_data.rb +258 -0
- data/lib/VoucherifySdk/models/card_balance.rb +225 -0
- data/lib/VoucherifySdk/models/card_code_generation_failure_result.rb +210 -0
- data/lib/VoucherifySdk/models/card_daily_report_entry.rb +412 -0
- data/lib/VoucherifySdk/models/card_definition_id_filter_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/card_definition_id_filter_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/card_lifetime_bucket.rb +231 -0
- data/lib/VoucherifySdk/models/card_lifetime_bucket_pending_points.rb +238 -0
- data/lib/VoucherifySdk/models/card_lifetime_bucket_points.rb +355 -0
- data/lib/VoucherifySdk/models/card_next_activation.rb +269 -0
- data/lib/VoucherifySdk/models/card_next_expiration.rb +223 -0
- data/lib/VoucherifySdk/models/card_pending_points_bucket.rb +405 -0
- data/lib/VoucherifySdk/models/card_pending_points_bucket_points.rb +210 -0
- data/lib/VoucherifySdk/models/card_points_bucket.rb +422 -0
- data/lib/VoucherifySdk/models/card_points_bucket_points.rb +210 -0
- data/lib/VoucherifySdk/models/card_simple.rb +332 -0
- data/lib/VoucherifySdk/models/card_transaction.rb +393 -0
- data/lib/VoucherifySdk/models/card_transaction_details.rb +354 -0
- data/lib/VoucherifySdk/models/card_transaction_details_card_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_order.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_order_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_points.rb +280 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase.rb +219 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase_card_transaction.rb +209 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase_reward_transaction.rb +209 -0
- data/lib/VoucherifySdk/models/card_transaction_details_purchase_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_rejection.rb +221 -0
- data/lib/VoucherifySdk/models/card_transaction_details_reward.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_reward_transaction.rb +210 -0
- data/lib/VoucherifySdk/models/card_transaction_details_target_card.rb +210 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership.rb +251 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership_card.rb +277 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership_member.rb +275 -0
- data/lib/VoucherifySdk/models/customer_loyalty_membership_tier.rb +278 -0
- data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb +14 -1
- data/lib/VoucherifySdk/models/customers_create_response_body.rb +14 -1
- data/lib/VoucherifySdk/models/customers_get_response_body.rb +14 -1
- data/lib/VoucherifySdk/models/customers_redeemables_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/customers_update_response_body.rb +14 -1
- data/lib/VoucherifySdk/models/date_filter.rb +209 -0
- data/lib/VoucherifySdk/models/date_filter_conditions.rb +268 -0
- data/lib/VoucherifySdk/models/earning_rule_daily_report_entry.rb +258 -0
- data/lib/VoucherifySdk/models/earning_rule_earning.rb +281 -0
- data/lib/VoucherifySdk/models/earning_rule_effect.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points.rb +246 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration_calendar_expiration.rb +222 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration_rolling_expiration.rb +224 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_expiration_sliding_expiration.rb +226 -0
- data/lib/VoucherifySdk/models/earning_rule_effect_points_proportional.rb +296 -0
- data/lib/VoucherifySdk/models/earning_rule_id_filter_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/earning_rule_id_filter_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_applicable_to.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_custom_event.rb +215 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_customer.rb +215 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_order.rb +226 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_order_items.rb +226 -0
- data/lib/VoucherifySdk/models/earning_rule_points_proportional_order_items_calculation.rb +259 -0
- data/lib/VoucherifySdk/models/earning_rule_tier_rules.rb +252 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger.rb +252 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger_limits_cooldown.rb +243 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger_limits_cooldown_fixed_cooldown.rb +215 -0
- data/lib/VoucherifySdk/models/earning_rule_trigger_limits_frequency.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_validity_hours.rb +252 -0
- data/lib/VoucherifySdk/models/earning_rules_report_daily_entry.rb +297 -0
- data/lib/VoucherifySdk/models/earning_rules_report_failures_breakdown.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rules_report_list_filters.rb +243 -0
- data/lib/VoucherifySdk/models/earning_rules_report_summary_entry.rb +308 -0
- data/lib/VoucherifySdk/models/error_error.rb +2 -2
- data/lib/VoucherifySdk/models/examine_card_reference.rb +284 -0
- data/lib/VoucherifySdk/models/examine_customer_identification.rb +279 -0
- data/lib/VoucherifySdk/models/examine_customer_reference.rb +271 -0
- data/lib/VoucherifySdk/models/examine_member_reference.rb +282 -0
- data/lib/VoucherifySdk/models/examine_program_reference.rb +271 -0
- data/lib/VoucherifySdk/models/export.rb +1 -1
- data/lib/VoucherifySdk/models/export_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/list_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body.rb +258 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_custom_event_all.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_custom_event_specific.rb +228 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_custom_event.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_custom_event_all.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_custom_event_specific.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_order_paid.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_customer_segment_entered.rb +217 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_member.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order.rb +262 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order_item.rb +352 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order_item_product.rb +232 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_order_item_sku.rb +232 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_trigger.rb +243 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_request_body_trigger_specific.rb +234 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body.rb +282 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_benefit_earning_rule_estimation.rb +245 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_benefit_estimation.rb +258 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_benefit_reference.rb +271 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_card_earning_rule_estimation.rb +256 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_card_estimation.rb +269 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_earning_rule_detail.rb +271 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_earning_rule_reference.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_examine_earning_rules_examine_response_body_membership.rb +280 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_request_body.rb +235 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_request_body_customer.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_request_body_member.rb +211 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body.rb +278 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_card_estimation.rb +265 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_card_reward_estimation.rb +294 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_membership.rb +281 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_cost.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_detail.rb +293 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_reference.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_examine_rewards_examine_response_body_reward_unavailability_reason.rb +261 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_type.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_activities_list_request_query_filters_type_conditions.rb +272 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_benefits_transactions_list_request_query_benefit_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_benefits_transactions_list_request_query_benefit_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_type.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_activities_list_request_query_filters_type_conditions.rb +272 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_reports_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_transactions_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_cards_transactions_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_customer_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_customer_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_status.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_list_request_query_status_conditions.rb +272 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_combined_response_body.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_combined_response_body_transaction.rb +371 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_combined_response_body_transaction_details.rb +248 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_create_request_body_limit.rb +250 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_orders_payments_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_create_combined_response_body.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_create_combined_response_body_transaction.rb +369 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_create_combined_response_body_transaction_details.rb +252 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_card_definition_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_card_definition_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_reward_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_rewards_purchases_list_request_query_reward_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_definition_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_definition_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_id.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_programs_members_tiers_transactions_list_request_query_card_id_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_members_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_members_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_spendings_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_spendings_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_rewards_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_spending_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalties_programs_reports_spending_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_points_proportional_applicable_to_product.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_points_proportional_applicable_to_products_collection.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_points_proportional_applicable_to_sku.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_benefit_stock_limited.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_card_definition_limit_time_based_period.rb +246 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_card_definition_limit_time_based_period_current_period.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_earning_limits.rb +215 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_earning_limits_global.rb +257 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_benefit.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_calendar_expiration_date.rb +241 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_rolling_expiration_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_rolling_expiration_rounding.rb +255 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_effect_points_expiration_sliding_expiration_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_error.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_applicable_to_product.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_applicable_to_products_collection.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_applicable_to_sku.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_every.rb +241 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_points_proportional_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_tier_rules_any_of_entry.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_trigger_custom_event.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_trigger_limits_cooldown_fixed_cooldown_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_trigger_segment.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_earning_rule_validity_daily_hours.rb +244 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_cost_spending_response.rb +260 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_digital_discount_coupons.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_digital_gift_vouchers_response.rb +227 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_digital_loyalty_card_points_response.rb +227 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_material_product.rb +216 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_material_sku.rb +233 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_purchase_limits_cooldown_fixed_cooldown_period.rb +250 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_purchase_limits_frequency_limit_triggers.rb +215 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_refunds.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_activity_reward_validity_daily_hours_response.rb +234 -0
- data/lib/VoucherifySdk/models/loyalty_v2_card_points_bucket_simple.rb +272 -0
- data/lib/VoucherifySdk/models/loyalty_v2_card_points_bucket_simple_points.rb +210 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_metadata.rb +220 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_rejection.rb +219 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_rejection_details.rb +231 -0
- data/lib/VoucherifySdk/models/lpm_ord_pay_ccrb_tx_details_spending_cap.rb +257 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_points.rb +209 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_rejection.rb +222 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result.rb +239 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_dig_lc_points.rb +231 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_digital.rb +269 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_material.rb +259 -0
- data/lib/VoucherifySdk/models/lpm_rew_purch_ccrb_tx_details_result_reward.rb +244 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb +1 -0
- data/lib/VoucherifySdk/models/member.rb +333 -0
- data/lib/VoucherifySdk/models/member_card.rb +269 -0
- data/lib/VoucherifySdk/models/member_create.rb +257 -0
- data/lib/VoucherifySdk/models/member_tier_progress.rb +293 -0
- data/lib/VoucherifySdk/models/member_tier_progress_current.rb +239 -0
- data/lib/VoucherifySdk/models/member_tier_progress_deferred.rb +230 -0
- data/lib/VoucherifySdk/models/member_tier_progress_opportunity.rb +230 -0
- data/lib/VoucherifySdk/models/member_tier_progress_points.rb +232 -0
- data/lib/VoucherifySdk/models/member_tier_progress_risk.rb +254 -0
- data/lib/VoucherifySdk/models/member_tier_progress_tier.rb +227 -0
- data/lib/VoucherifySdk/models/member_tier_progress_tier_structure.rb +253 -0
- data/lib/VoucherifySdk/models/members_report_daily_entry.rb +291 -0
- data/lib/VoucherifySdk/models/members_report_summary_entry.rb +297 -0
- data/lib/VoucherifySdk/models/membership_card.rb +278 -0
- data/lib/VoucherifySdk/models/order_payment_limit_definition.rb +215 -0
- data/lib/VoucherifySdk/models/order_payment_order.rb +232 -0
- data/lib/VoucherifySdk/models/order_payment_payment_details.rb +243 -0
- data/lib/VoucherifySdk/models/order_payment_rejection.rb +221 -0
- data/lib/VoucherifySdk/models/order_payment_transaction.rb +372 -0
- data/lib/VoucherifySdk/models/order_payment_transaction_details.rb +249 -0
- data/lib/VoucherifySdk/models/order_payment_transaction_details_spending_cap.rb +258 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_parent_object_id.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_related_object_id.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_source_id.rb +1 -1
- data/lib/VoucherifySdk/models/points_earnings_report_daily_entry.rb +331 -0
- data/lib/VoucherifySdk/models/points_earnings_report_list_filters.rb +252 -0
- data/lib/VoucherifySdk/models/points_earnings_report_summary_entry.rb +337 -0
- data/lib/VoucherifySdk/models/product_collections_products_list_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/program.rb +341 -0
- data/lib/VoucherifySdk/models/program_earning_rule_assignment.rb +264 -0
- data/lib/VoucherifySdk/models/program_list_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/program_reward_assignment.rb +302 -0
- data/lib/VoucherifySdk/models/program_reward_assignment_stock.rb +243 -0
- data/lib/VoucherifySdk/models/program_reward_assignment_stock_limited.rb +220 -0
- data/lib/VoucherifySdk/models/program_simple.rb +288 -0
- data/lib/VoucherifySdk/models/program_tier_structure_assignment.rb +264 -0
- data/lib/VoucherifySdk/models/program_validity_daily_hours.rb +234 -0
- data/lib/VoucherifySdk/models/program_validity_hours.rb +247 -0
- data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/publications_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/report_card_definition_id_filter_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/report_card_definition_id_filter_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/reward_cost_response.rb +271 -0
- data/lib/VoucherifySdk/models/reward_cost_tier_rules_any_of_entry_response.rb +234 -0
- data/lib/VoucherifySdk/models/reward_cost_tier_rules_response.rb +252 -0
- data/lib/VoucherifySdk/models/reward_digital_response.rb +261 -0
- data/lib/VoucherifySdk/models/reward_material_response.rb +252 -0
- data/lib/VoucherifySdk/models/reward_purchase_digital_coupon.rb +256 -0
- data/lib/VoucherifySdk/models/reward_purchase_digital_gift_voucher.rb +278 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits.rb +231 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_cooldown.rb +243 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_cooldown_fixed_cooldown.rb +215 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_frequency.rb +247 -0
- data/lib/VoucherifySdk/models/reward_purchase_limits_frequency_limit.rb +268 -0
- data/lib/VoucherifySdk/models/reward_purchase_refund_policies.rb +247 -0
- data/lib/VoucherifySdk/models/reward_purchase_transaction.rb +371 -0
- data/lib/VoucherifySdk/models/reward_validity_hours_response.rb +247 -0
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_report_daily_entry.rb +297 -0
- data/lib/VoucherifySdk/models/rewards_report_filter_reward_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/rewards_report_filter_reward_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/rewards_report_list_filters.rb +243 -0
- data/lib/VoucherifySdk/models/rewards_report_summary_entry.rb +309 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_daily_entry.rb +337 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_cost_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_cost_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_spending_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_filter_spending_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_list_filters.rb +270 -0
- data/lib/VoucherifySdk/models/rewards_spendings_report_summary_entry.rb +343 -0
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/spending_report_daily_entry.rb +335 -0
- data/lib/VoucherifySdk/models/spending_report_list_filters.rb +243 -0
- data/lib/VoucherifySdk/models/spending_report_summary_entry.rb +335 -0
- data/lib/VoucherifySdk/models/tier_transaction.rb +377 -0
- data/lib/VoucherifySdk/models/tier_transaction_details.rb +272 -0
- data/lib/VoucherifySdk/models/tier_transaction_origin.rb +260 -0
- data/lib/VoucherifySdk/models/tier_transaction_rejection.rb +221 -0
- data/lib/VoucherifySdk/models/tiers_report_daily_entry.rb +336 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_structure_id_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/tiers_report_filter_tier_structure_id_conditions_conditions.rb +238 -0
- data/lib/VoucherifySdk/models/tiers_report_list_filters.rb +252 -0
- data/lib/VoucherifySdk/models/tiers_report_summary_entry.rb +342 -0
- data/lib/VoucherifySdk/models/transaction_filter_date_conditions.rb +209 -0
- data/lib/VoucherifySdk/models/transaction_filter_date_conditions_conditions.rb +268 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body.rb +362 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body_points.rb +237 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body_points_proportional.rb +287 -0
- data/lib/VoucherifySdk/models/v2_loyalties_benefits_get_response_body_stock.rb +243 -0
- data/lib/VoucherifySdk/models/v2_loyalties_earning_rules_get_response_body.rb +430 -0
- data/lib/VoucherifySdk/models/v2_loyalties_earning_rules_get_response_body_trigger_limits.rb +217 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_earning_rules_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_activate_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_activities_list_request_query_filters.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_activities_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_benefits_transactions_list_request_query.rb +252 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_benefits_transactions_list_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_benefits_transactions_list_response_body_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_activities_list_request_query_filters.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_activities_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_expiring_points_expire_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_expiring_points_list_request_query.rb +252 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_expiring_points_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_activate_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_cancel_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_list_request_query.rb +243 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_pending_points_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_points_adjust_request_body.rb +236 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_points_adjust_response_body.rb +256 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_transactions_list_request_query.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_cards_transactions_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_create_in_bulk_response_body.rb +216 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_create_request_body.rb +257 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_create_response_body.rb +346 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_deactivate_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_delete_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_earning_rules_reports_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_get_response_body.rb +346 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_list_request_query.rb +270 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_create_request_body.rb +270 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_list_request_query.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_list_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_orders_payments_list_response_body_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_create_request_body.rb +247 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_list_request_query.rb +270 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_list_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_rewards_purchases_list_response_body_cursor.rb +221 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_tiers_transactions_list_request_query.rb +261 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_tiers_transactions_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_update_request_body.rb +210 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_members_update_response_body.rb +333 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_memberships_get_response_body.rb +267 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_earning_rules_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_earning_rules_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_points_earnings_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_points_earnings_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_tiers_daily_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_reports_tiers_summary_list_response_body.rb +249 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_rewards_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_rewards_purchases_refund_request_body.rb +208 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_rewards_purchases_refund_response_body.rb +263 -0
- data/lib/VoucherifySdk/models/v2_loyalties_programs_tier_structures_list_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/v2_loyalties_rewards_get_response_body.rb +424 -0
- data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +11 -0
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/vl_member_activity.rb +308 -0
- data/lib/VoucherifySdk/models/vl_member_activity_data.rb +249 -0
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +366 -0
- metadata +767 -30
|
@@ -0,0 +1,2935 @@
|
|
|
1
|
+
# VoucherifySdk::LV2ProgramsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.voucherify.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**activate_card_pending_points_bucket**](LV2ProgramsApi.md#activate_card_pending_points_bucket) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-points/{bucketId}/activate | Activate pending point bucket |
|
|
8
|
+
| [**activate_program_member**](LV2ProgramsApi.md#activate_program_member) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/activate | Activate program member |
|
|
9
|
+
| [**adjust_card_points**](LV2ProgramsApi.md#adjust_card_points) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/points | Adjust card points |
|
|
10
|
+
| [**batch_create_program_members**](LV2ProgramsApi.md#batch_create_program_members) | **POST** /v2/loyalties/programs/{programId}/members/batch | Batch create program members |
|
|
11
|
+
| [**cancel_card_pending_points_bucket**](LV2ProgramsApi.md#cancel_card_pending_points_bucket) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-points/{bucketId}/cancel | Cancel pending point bucket |
|
|
12
|
+
| [**create_member_order_payment**](LV2ProgramsApi.md#create_member_order_payment) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/orders/payments | Pay for order with points |
|
|
13
|
+
| [**create_program_member**](LV2ProgramsApi.md#create_program_member) | **POST** /v2/loyalties/programs/{programId}/members | Create program member |
|
|
14
|
+
| [**deactivate_program_member**](LV2ProgramsApi.md#deactivate_program_member) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/deactivate | Deactivate program member |
|
|
15
|
+
| [**delete_program_member**](LV2ProgramsApi.md#delete_program_member) | **DELETE** /v2/loyalties/programs/{programId}/members/{memberId} | Delete program member |
|
|
16
|
+
| [**expire_card_points_bucket**](LV2ProgramsApi.md#expire_card_points_bucket) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points/{bucketId}/expire | Expire point bucket |
|
|
17
|
+
| [**get_member_earning_rule_daily_report**](LV2ProgramsApi.md#get_member_earning_rule_daily_report) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/earning-rules/{earningRuleId}/reports/daily | List member earning-rule daily reports |
|
|
18
|
+
| [**get_program_member**](LV2ProgramsApi.md#get_program_member) | **GET** /v2/loyalties/programs/{programId}/members/{memberId} | Get program member |
|
|
19
|
+
| [**get_program_membership**](LV2ProgramsApi.md#get_program_membership) | **GET** /v2/loyalties/programs/{programId}/memberships/{customerId} | Get program membership |
|
|
20
|
+
| [**get_program_points_earnings_daily_report**](LV2ProgramsApi.md#get_program_points_earnings_daily_report) | **GET** /v2/loyalties/programs/{programId}/reports/points-earnings/daily | List program points-earnings daily reports |
|
|
21
|
+
| [**get_program_points_earnings_summary_report**](LV2ProgramsApi.md#get_program_points_earnings_summary_report) | **GET** /v2/loyalties/programs/{programId}/reports/points-earnings/summary | List program points-earnings summary reports |
|
|
22
|
+
| [**list_card_activities**](LV2ProgramsApi.md#list_card_activities) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/activities | List card activities |
|
|
23
|
+
| [**list_card_expiring_points**](LV2ProgramsApi.md#list_card_expiring_points) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points | List card expiring points buckets |
|
|
24
|
+
| [**list_card_pending_points**](LV2ProgramsApi.md#list_card_pending_points) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-points | List card pending point buckets |
|
|
25
|
+
| [**list_card_transactions**](LV2ProgramsApi.md#list_card_transactions) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/transactions | List card transactions |
|
|
26
|
+
| [**list_member_benefit_transactions**](LV2ProgramsApi.md#list_member_benefit_transactions) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/benefits/transactions | List member benefit transactions |
|
|
27
|
+
| [**list_member_card_daily_reports**](LV2ProgramsApi.md#list_member_card_daily_reports) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/reports/daily | List card daily points reports |
|
|
28
|
+
| [**list_member_order_payments**](LV2ProgramsApi.md#list_member_order_payments) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/orders/payments | List member order payments |
|
|
29
|
+
| [**list_member_reward_purchases**](LV2ProgramsApi.md#list_member_reward_purchases) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/rewards/purchases | List member reward purchases |
|
|
30
|
+
| [**list_member_tier_transactions**](LV2ProgramsApi.md#list_member_tier_transactions) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/tiers/transactions | List member tier transactions |
|
|
31
|
+
| [**list_program_earning_rule_assignments**](LV2ProgramsApi.md#list_program_earning_rule_assignments) | **GET** /v2/loyalties/programs/{programId}/earning-rules | List program earning rule assignments |
|
|
32
|
+
| [**list_program_earning_rules_daily_reports**](LV2ProgramsApi.md#list_program_earning_rules_daily_reports) | **GET** /v2/loyalties/programs/{programId}/reports/earning-rules/daily | List program earning-rules daily reports |
|
|
33
|
+
| [**list_program_earning_rules_summary_reports**](LV2ProgramsApi.md#list_program_earning_rules_summary_reports) | **GET** /v2/loyalties/programs/{programId}/reports/earning-rules/summary | List program earning-rules summary reports |
|
|
34
|
+
| [**list_program_member_activities**](LV2ProgramsApi.md#list_program_member_activities) | **GET** /v2/loyalties/programs/{programId}/members/{memberId}/activities | List program member activities |
|
|
35
|
+
| [**list_program_members**](LV2ProgramsApi.md#list_program_members) | **GET** /v2/loyalties/programs/{programId}/members | List program members |
|
|
36
|
+
| [**list_program_members_daily_reports**](LV2ProgramsApi.md#list_program_members_daily_reports) | **GET** /v2/loyalties/programs/{programId}/reports/members/daily | List program members daily reports |
|
|
37
|
+
| [**list_program_members_summary_reports**](LV2ProgramsApi.md#list_program_members_summary_reports) | **GET** /v2/loyalties/programs/{programId}/reports/members/summary | List program members summary reports |
|
|
38
|
+
| [**list_program_reward_assignments**](LV2ProgramsApi.md#list_program_reward_assignments) | **GET** /v2/loyalties/programs/{programId}/rewards | List program reward assignments |
|
|
39
|
+
| [**list_program_rewards_daily_reports**](LV2ProgramsApi.md#list_program_rewards_daily_reports) | **GET** /v2/loyalties/programs/{programId}/reports/rewards/daily | List program rewards daily reports |
|
|
40
|
+
| [**list_program_rewards_spendings_daily_reports**](LV2ProgramsApi.md#list_program_rewards_spendings_daily_reports) | **GET** /v2/loyalties/programs/{programId}/reports/rewards/spendings/daily | List program rewards spendings daily reports |
|
|
41
|
+
| [**list_program_rewards_spendings_summary_reports**](LV2ProgramsApi.md#list_program_rewards_spendings_summary_reports) | **GET** /v2/loyalties/programs/{programId}/reports/rewards/spendings/summary | List program rewards spendings summary reports |
|
|
42
|
+
| [**list_program_rewards_summary_reports**](LV2ProgramsApi.md#list_program_rewards_summary_reports) | **GET** /v2/loyalties/programs/{programId}/reports/rewards/summary | List program rewards summary reports |
|
|
43
|
+
| [**list_program_spending_daily_reports**](LV2ProgramsApi.md#list_program_spending_daily_reports) | **GET** /v2/loyalties/programs/{programId}/reports/spending/daily | List program spending daily reports |
|
|
44
|
+
| [**list_program_spending_summary_reports**](LV2ProgramsApi.md#list_program_spending_summary_reports) | **GET** /v2/loyalties/programs/{programId}/reports/spending/summary | List program spending summary reports |
|
|
45
|
+
| [**list_program_tier_structure_assignments**](LV2ProgramsApi.md#list_program_tier_structure_assignments) | **GET** /v2/loyalties/programs/{programId}/tier-structures | List program tier structure assignments |
|
|
46
|
+
| [**list_program_tiers_daily_reports**](LV2ProgramsApi.md#list_program_tiers_daily_reports) | **GET** /v2/loyalties/programs/{programId}/reports/tiers/daily | List program tiers daily reports |
|
|
47
|
+
| [**list_program_tiers_summary_reports**](LV2ProgramsApi.md#list_program_tiers_summary_reports) | **GET** /v2/loyalties/programs/{programId}/reports/tiers/summary | List program tiers summary reports |
|
|
48
|
+
| [**purchase_member_reward**](LV2ProgramsApi.md#purchase_member_reward) | **POST** /v2/loyalties/programs/{programId}/members/{memberId}/rewards/purchases | Purchase reward with points |
|
|
49
|
+
| [**refund_reward_purchase**](LV2ProgramsApi.md#refund_reward_purchase) | **POST** /v2/loyalties/programs/{programId}/rewards/purchases/{rewardTransactionId}/refund | Refund reward purchase |
|
|
50
|
+
| [**update_program_member**](LV2ProgramsApi.md#update_program_member) | **PUT** /v2/loyalties/programs/{programId}/members/{memberId} | Update program member |
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## activate_card_pending_points_bucket
|
|
54
|
+
|
|
55
|
+
> <V2LoyaltiesProgramsMembersCardsPendingPointsActivateResponseBody> activate_card_pending_points_bucket(program_id, member_id, card_id, bucket_id)
|
|
56
|
+
|
|
57
|
+
Activate pending point bucket
|
|
58
|
+
|
|
59
|
+
Activates a pending points bucket and creates a PENDING_POINTS_ACTIVATED card transaction. The transaction is created with status PENDING and processed asynchronously. No request body. The bucket must be PENDING, and its date must be after the current project day. The program and the member must be ACTIVE, and the program must be inside its validity window. Otherwise the response is 423. Returns 404 when the program or the member doesnt exist, when the card isnt assigned to that member, or when the bucket isnt on that card.
|
|
60
|
+
|
|
61
|
+
### Examples
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
require 'time'
|
|
65
|
+
require 'VoucherifySdk'
|
|
66
|
+
# setup authorization
|
|
67
|
+
VoucherifySdk.configure do |config|
|
|
68
|
+
# Configure API key authorization: X-App-Id
|
|
69
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
70
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
71
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
72
|
+
|
|
73
|
+
# Configure API key authorization: X-App-Token
|
|
74
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
75
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
76
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
80
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
81
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
82
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
83
|
+
bucket_id = 'bucket_id_example' # String | Identifies the pending points bucket. Format lcppb_[a-f0-9]+.
|
|
84
|
+
|
|
85
|
+
begin
|
|
86
|
+
# Activate pending point bucket
|
|
87
|
+
result = api_instance.activate_card_pending_points_bucket(program_id, member_id, card_id, bucket_id)
|
|
88
|
+
p result
|
|
89
|
+
rescue VoucherifySdk::ApiError => e
|
|
90
|
+
puts "Error when calling LV2ProgramsApi->activate_card_pending_points_bucket: #{e}"
|
|
91
|
+
end
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
| Name | Type | Description | Notes |
|
|
97
|
+
| ---- | ---- | ----------- | ----- |
|
|
98
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
99
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
100
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
101
|
+
| **bucket_id** | **String** | Identifies the pending points bucket. Format lcppb_[a-f0-9]+. | |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
[**V2LoyaltiesProgramsMembersCardsPendingPointsActivateResponseBody**](V2LoyaltiesProgramsMembersCardsPendingPointsActivateResponseBody.md)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
## activate_program_member
|
|
118
|
+
|
|
119
|
+
> <V2LoyaltiesProgramsMembersActivateResponseBody> activate_program_member(program_id, member_id)
|
|
120
|
+
|
|
121
|
+
Activate program member
|
|
122
|
+
|
|
123
|
+
Moves an INACTIVE member to ACTIVE and sets updated_at. Records a vl.member.activated activity. No request body. Returns the member without a cards array. Returns 404 when the program doesnt exist, or when the member doesnt exist in that program. The program is checked first. A DELETED member returns 404. Returns 400 with key invalid_state_transition when the member is already ACTIVE.
|
|
124
|
+
|
|
125
|
+
### Examples
|
|
126
|
+
|
|
127
|
+
```ruby
|
|
128
|
+
require 'time'
|
|
129
|
+
require 'VoucherifySdk'
|
|
130
|
+
# setup authorization
|
|
131
|
+
VoucherifySdk.configure do |config|
|
|
132
|
+
# Configure API key authorization: X-App-Id
|
|
133
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
134
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
135
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
136
|
+
|
|
137
|
+
# Configure API key authorization: X-App-Token
|
|
138
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
139
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
140
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
144
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
145
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
146
|
+
|
|
147
|
+
begin
|
|
148
|
+
# Activate program member
|
|
149
|
+
result = api_instance.activate_program_member(program_id, member_id)
|
|
150
|
+
p result
|
|
151
|
+
rescue VoucherifySdk::ApiError => e
|
|
152
|
+
puts "Error when calling LV2ProgramsApi->activate_program_member: #{e}"
|
|
153
|
+
end
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
| Name | Type | Description | Notes |
|
|
159
|
+
| ---- | ---- | ----------- | ----- |
|
|
160
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
161
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
[**V2LoyaltiesProgramsMembersActivateResponseBody**](V2LoyaltiesProgramsMembersActivateResponseBody.md)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: Not defined
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
## adjust_card_points
|
|
178
|
+
|
|
179
|
+
> <V2LoyaltiesProgramsMembersCardsPointsAdjustResponseBody> adjust_card_points(program_id, member_id, card_id, opts)
|
|
180
|
+
|
|
181
|
+
Adjust card points
|
|
182
|
+
|
|
183
|
+
Manually adjusts the points balance of the members card. A positive points value creates an ADMIN_CREDIT card transaction. The expiration date comes from the member tier when that tier defines its own points expiration. Otherwise the date comes from the card definition. expiration_date is null when points dont expire. A negative points value creates an ADMIN_DEBIT card transaction. When points is 0, no transaction is created and status is NO_CHANGE. The transaction is created with status PENDING and processed asynchronously. The program and the member must be ACTIVE. The program must also be inside its validity window. Otherwise the response is 423. The response is 404 when the program or the member doesnt exist, or when the card isnt assigned to that member.
|
|
184
|
+
|
|
185
|
+
### Examples
|
|
186
|
+
|
|
187
|
+
```ruby
|
|
188
|
+
require 'time'
|
|
189
|
+
require 'VoucherifySdk'
|
|
190
|
+
# setup authorization
|
|
191
|
+
VoucherifySdk.configure do |config|
|
|
192
|
+
# Configure API key authorization: X-App-Id
|
|
193
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
194
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
195
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
196
|
+
|
|
197
|
+
# Configure API key authorization: X-App-Token
|
|
198
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
199
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
200
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
204
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
205
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
206
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
207
|
+
opts = {
|
|
208
|
+
v2_loyalties_programs_members_cards_points_adjust_request_body: VoucherifySdk::V2LoyaltiesProgramsMembersCardsPointsAdjustRequestBody.new # V2LoyaltiesProgramsMembersCardsPointsAdjustRequestBody |
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
begin
|
|
212
|
+
# Adjust card points
|
|
213
|
+
result = api_instance.adjust_card_points(program_id, member_id, card_id, opts)
|
|
214
|
+
p result
|
|
215
|
+
rescue VoucherifySdk::ApiError => e
|
|
216
|
+
puts "Error when calling LV2ProgramsApi->adjust_card_points: #{e}"
|
|
217
|
+
end
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Parameters
|
|
221
|
+
|
|
222
|
+
| Name | Type | Description | Notes |
|
|
223
|
+
| ---- | ---- | ----------- | ----- |
|
|
224
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
225
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
226
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
227
|
+
| **v2_loyalties_programs_members_cards_points_adjust_request_body** | [**V2LoyaltiesProgramsMembersCardsPointsAdjustRequestBody**](V2LoyaltiesProgramsMembersCardsPointsAdjustRequestBody.md) | | [optional] |
|
|
228
|
+
|
|
229
|
+
### Return type
|
|
230
|
+
|
|
231
|
+
[**V2LoyaltiesProgramsMembersCardsPointsAdjustResponseBody**](V2LoyaltiesProgramsMembersCardsPointsAdjustResponseBody.md)
|
|
232
|
+
|
|
233
|
+
### Authorization
|
|
234
|
+
|
|
235
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
236
|
+
|
|
237
|
+
### HTTP request headers
|
|
238
|
+
|
|
239
|
+
- **Content-Type**: application/json
|
|
240
|
+
- **Accept**: application/json
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
## batch_create_program_members
|
|
244
|
+
|
|
245
|
+
> <V2LoyaltiesProgramsMembersCreateInBulkResponseBody> batch_create_program_members(program_id, opts)
|
|
246
|
+
|
|
247
|
+
Batch create program members
|
|
248
|
+
|
|
249
|
+
Schedules creation of program members from a JSON array and returns 202 with async_action_id. The program must exist, be ACTIVE, and be inside its validity window. The body isnt checked before that response. Entries are processed in batches of 100. The raw body must be at most 10 MB. Each entry uses the same fields as [Create program member](/api-reference/programs/create-program-member). A failed entry is skipped. Its report row sets created to false and explains the failure in error. Skipped cases include an invalid customer_identification, an unknown customer, an invalid status, a duplicate customer in the batch (Duplicate customer ID), a customer who is already a member (Member already exists), metadata that doesnt match the vl_member schema, and entries past the loyalty members plan limit. Successful entries enroll the customer and create a loyalty card for each card definition on the program. Report columns are identification_type, customer_id, customer_source_id, program_id, member_id, created, and error. An empty array or a null entry fails the async action with invalid_request_payload. A body that isnt a JSON array fails it with top_level_object_should_be_an_array. Use [Get async action](/api-reference/async-actions/get-async-action) to read the status and the report. You can also open the result from Audit log, [Background tasks](/analyze/audit-logs#background-tasks).
|
|
250
|
+
|
|
251
|
+
### Examples
|
|
252
|
+
|
|
253
|
+
```ruby
|
|
254
|
+
require 'time'
|
|
255
|
+
require 'VoucherifySdk'
|
|
256
|
+
# setup authorization
|
|
257
|
+
VoucherifySdk.configure do |config|
|
|
258
|
+
# Configure API key authorization: X-App-Id
|
|
259
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
260
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
261
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
262
|
+
|
|
263
|
+
# Configure API key authorization: X-App-Token
|
|
264
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
265
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
266
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
270
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
271
|
+
opts = {
|
|
272
|
+
member_create: [VoucherifySdk::MemberCreate.new({customer_identification: 3.56})] # Array<MemberCreate> |
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
begin
|
|
276
|
+
# Batch create program members
|
|
277
|
+
result = api_instance.batch_create_program_members(program_id, opts)
|
|
278
|
+
p result
|
|
279
|
+
rescue VoucherifySdk::ApiError => e
|
|
280
|
+
puts "Error when calling LV2ProgramsApi->batch_create_program_members: #{e}"
|
|
281
|
+
end
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
| Name | Type | Description | Notes |
|
|
287
|
+
| ---- | ---- | ----------- | ----- |
|
|
288
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
289
|
+
| **member_create** | [**Array<MemberCreate>**](MemberCreate.md) | | [optional] |
|
|
290
|
+
|
|
291
|
+
### Return type
|
|
292
|
+
|
|
293
|
+
[**V2LoyaltiesProgramsMembersCreateInBulkResponseBody**](V2LoyaltiesProgramsMembersCreateInBulkResponseBody.md)
|
|
294
|
+
|
|
295
|
+
### Authorization
|
|
296
|
+
|
|
297
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
298
|
+
|
|
299
|
+
### HTTP request headers
|
|
300
|
+
|
|
301
|
+
- **Content-Type**: application/json
|
|
302
|
+
- **Accept**: application/json
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
## cancel_card_pending_points_bucket
|
|
306
|
+
|
|
307
|
+
> <V2LoyaltiesProgramsMembersCardsPendingPointsCancelResponseBody> cancel_card_pending_points_bucket(program_id, member_id, card_id, bucket_id)
|
|
308
|
+
|
|
309
|
+
Cancel pending point bucket
|
|
310
|
+
|
|
311
|
+
Cancels a pending points bucket so its points arent activated. Creates a PENDING_POINTS_CANCELED card transaction. The transaction is created with status PENDING and processed asynchronously. No request body. The bucket must be PENDING, and its date must be after the current project day. The program and the member must be ACTIVE, and the program must be inside its validity window. Otherwise the response is 423. Returns 404 when the program or the member doesnt exist, when the card isnt assigned to that member, or when the bucket isnt on that card.
|
|
312
|
+
|
|
313
|
+
### Examples
|
|
314
|
+
|
|
315
|
+
```ruby
|
|
316
|
+
require 'time'
|
|
317
|
+
require 'VoucherifySdk'
|
|
318
|
+
# setup authorization
|
|
319
|
+
VoucherifySdk.configure do |config|
|
|
320
|
+
# Configure API key authorization: X-App-Id
|
|
321
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
322
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
323
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
324
|
+
|
|
325
|
+
# Configure API key authorization: X-App-Token
|
|
326
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
327
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
328
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
332
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
333
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
334
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
335
|
+
bucket_id = 'bucket_id_example' # String | Identifies the pending points bucket. Format lcppb_[a-f0-9]+.
|
|
336
|
+
|
|
337
|
+
begin
|
|
338
|
+
# Cancel pending point bucket
|
|
339
|
+
result = api_instance.cancel_card_pending_points_bucket(program_id, member_id, card_id, bucket_id)
|
|
340
|
+
p result
|
|
341
|
+
rescue VoucherifySdk::ApiError => e
|
|
342
|
+
puts "Error when calling LV2ProgramsApi->cancel_card_pending_points_bucket: #{e}"
|
|
343
|
+
end
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### Parameters
|
|
347
|
+
|
|
348
|
+
| Name | Type | Description | Notes |
|
|
349
|
+
| ---- | ---- | ----------- | ----- |
|
|
350
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
351
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
352
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
353
|
+
| **bucket_id** | **String** | Identifies the pending points bucket. Format lcppb_[a-f0-9]+. | |
|
|
354
|
+
|
|
355
|
+
### Return type
|
|
356
|
+
|
|
357
|
+
[**V2LoyaltiesProgramsMembersCardsPendingPointsCancelResponseBody**](V2LoyaltiesProgramsMembersCardsPendingPointsCancelResponseBody.md)
|
|
358
|
+
|
|
359
|
+
### Authorization
|
|
360
|
+
|
|
361
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
362
|
+
|
|
363
|
+
### HTTP request headers
|
|
364
|
+
|
|
365
|
+
- **Content-Type**: Not defined
|
|
366
|
+
- **Accept**: application/json
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
## create_member_order_payment
|
|
370
|
+
|
|
371
|
+
> <LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBody> create_member_order_payment(program_id, member_id, opts)
|
|
372
|
+
|
|
373
|
+
Pay for order with points
|
|
374
|
+
|
|
375
|
+
Pays for an order with points from the members card. The amount and points come from the card definitions pay-with-points exchange ratio, limited by the order total, the card balance, card spending caps, and the optional payment_limit. The binding cap is returned as details.spending_cap. The program and member must be ACTIVE, and the program must be inside its validity window. The card must belong to the member. The card definition must have pay-with-points enabled and an exchange-ratio formula. The order must already exist, identified by id or source_id. Modes: - TRANSACTION (default): creates a PENDING order transaction and a PENDING card transaction. Returns 202. The same order can be paid again; each call creates a new transaction. - DRY_RUN: simulates the payment and doesnt create a transaction. Returns 200 with status SIMULATED.
|
|
376
|
+
|
|
377
|
+
### Examples
|
|
378
|
+
|
|
379
|
+
```ruby
|
|
380
|
+
require 'time'
|
|
381
|
+
require 'VoucherifySdk'
|
|
382
|
+
# setup authorization
|
|
383
|
+
VoucherifySdk.configure do |config|
|
|
384
|
+
# Configure API key authorization: X-App-Id
|
|
385
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
386
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
387
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
388
|
+
|
|
389
|
+
# Configure API key authorization: X-App-Token
|
|
390
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
391
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
392
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
396
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
397
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
398
|
+
opts = {
|
|
399
|
+
v2_loyalties_programs_members_orders_payments_create_request_body: VoucherifySdk::V2LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBody.new({order: VoucherifySdk::OrderPaymentOrder.new}) # V2LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBody |
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
begin
|
|
403
|
+
# Pay for order with points
|
|
404
|
+
result = api_instance.create_member_order_payment(program_id, member_id, opts)
|
|
405
|
+
p result
|
|
406
|
+
rescue VoucherifySdk::ApiError => e
|
|
407
|
+
puts "Error when calling LV2ProgramsApi->create_member_order_payment: #{e}"
|
|
408
|
+
end
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
### Parameters
|
|
412
|
+
|
|
413
|
+
| Name | Type | Description | Notes |
|
|
414
|
+
| ---- | ---- | ----------- | ----- |
|
|
415
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
416
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
417
|
+
| **v2_loyalties_programs_members_orders_payments_create_request_body** | [**V2LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBody**](V2LoyaltiesProgramsMembersOrdersPaymentsCreateRequestBody.md) | | [optional] |
|
|
418
|
+
|
|
419
|
+
### Return type
|
|
420
|
+
|
|
421
|
+
[**LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBody**](LoyaltiesProgramsMembersOrdersPaymentsCreateCombinedResponseBody.md)
|
|
422
|
+
|
|
423
|
+
### Authorization
|
|
424
|
+
|
|
425
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
426
|
+
|
|
427
|
+
### HTTP request headers
|
|
428
|
+
|
|
429
|
+
- **Content-Type**: application/json
|
|
430
|
+
- **Accept**: application/json
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
## create_program_member
|
|
434
|
+
|
|
435
|
+
> <V2LoyaltiesProgramsMembersCreateResponseBody> create_program_member(program_id, opts)
|
|
436
|
+
|
|
437
|
+
Create program member
|
|
438
|
+
|
|
439
|
+
Enrolls an existing customer as a member of the loyalty program and creates a loyalty card for each card definition assigned to the program. Card code generation is asynchronous, so code can be null right after creation. The program must be ACTIVE and inside its validity window, and the customer must already exist. A customer can be a member of a program only once. Identify the customer with customer_identification. status defaults to ACTIVE.
|
|
440
|
+
|
|
441
|
+
### Examples
|
|
442
|
+
|
|
443
|
+
```ruby
|
|
444
|
+
require 'time'
|
|
445
|
+
require 'VoucherifySdk'
|
|
446
|
+
# setup authorization
|
|
447
|
+
VoucherifySdk.configure do |config|
|
|
448
|
+
# Configure API key authorization: X-App-Id
|
|
449
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
450
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
451
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
452
|
+
|
|
453
|
+
# Configure API key authorization: X-App-Token
|
|
454
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
455
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
456
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
457
|
+
end
|
|
458
|
+
|
|
459
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
460
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
461
|
+
opts = {
|
|
462
|
+
v2_loyalties_programs_members_create_request_body: VoucherifySdk::V2LoyaltiesProgramsMembersCreateRequestBody.new({customer_identification: 3.56}) # V2LoyaltiesProgramsMembersCreateRequestBody |
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
begin
|
|
466
|
+
# Create program member
|
|
467
|
+
result = api_instance.create_program_member(program_id, opts)
|
|
468
|
+
p result
|
|
469
|
+
rescue VoucherifySdk::ApiError => e
|
|
470
|
+
puts "Error when calling LV2ProgramsApi->create_program_member: #{e}"
|
|
471
|
+
end
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
### Parameters
|
|
475
|
+
|
|
476
|
+
| Name | Type | Description | Notes |
|
|
477
|
+
| ---- | ---- | ----------- | ----- |
|
|
478
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
479
|
+
| **v2_loyalties_programs_members_create_request_body** | [**V2LoyaltiesProgramsMembersCreateRequestBody**](V2LoyaltiesProgramsMembersCreateRequestBody.md) | | [optional] |
|
|
480
|
+
|
|
481
|
+
### Return type
|
|
482
|
+
|
|
483
|
+
[**V2LoyaltiesProgramsMembersCreateResponseBody**](V2LoyaltiesProgramsMembersCreateResponseBody.md)
|
|
484
|
+
|
|
485
|
+
### Authorization
|
|
486
|
+
|
|
487
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
488
|
+
|
|
489
|
+
### HTTP request headers
|
|
490
|
+
|
|
491
|
+
- **Content-Type**: application/json
|
|
492
|
+
- **Accept**: application/json
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
## deactivate_program_member
|
|
496
|
+
|
|
497
|
+
> <V2LoyaltiesProgramsMembersDeactivateResponseBody> deactivate_program_member(program_id, member_id)
|
|
498
|
+
|
|
499
|
+
Deactivate program member
|
|
500
|
+
|
|
501
|
+
Moves an ACTIVE member to INACTIVE and sets updated_at. Records a vl.member.deactivated activity. An INACTIVE member cant earn or spend points. No request body. Returns the member without a cards array. Returns 404 when the program doesnt exist, or when the member doesnt exist in that program. The program is checked first. A DELETED member returns 404. Returns 400 with key invalid_state_transition when the member is already INACTIVE.
|
|
502
|
+
|
|
503
|
+
### Examples
|
|
504
|
+
|
|
505
|
+
```ruby
|
|
506
|
+
require 'time'
|
|
507
|
+
require 'VoucherifySdk'
|
|
508
|
+
# setup authorization
|
|
509
|
+
VoucherifySdk.configure do |config|
|
|
510
|
+
# Configure API key authorization: X-App-Id
|
|
511
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
512
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
513
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
514
|
+
|
|
515
|
+
# Configure API key authorization: X-App-Token
|
|
516
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
517
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
518
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
519
|
+
end
|
|
520
|
+
|
|
521
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
522
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
523
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
524
|
+
|
|
525
|
+
begin
|
|
526
|
+
# Deactivate program member
|
|
527
|
+
result = api_instance.deactivate_program_member(program_id, member_id)
|
|
528
|
+
p result
|
|
529
|
+
rescue VoucherifySdk::ApiError => e
|
|
530
|
+
puts "Error when calling LV2ProgramsApi->deactivate_program_member: #{e}"
|
|
531
|
+
end
|
|
532
|
+
```
|
|
533
|
+
|
|
534
|
+
### Parameters
|
|
535
|
+
|
|
536
|
+
| Name | Type | Description | Notes |
|
|
537
|
+
| ---- | ---- | ----------- | ----- |
|
|
538
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
539
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
540
|
+
|
|
541
|
+
### Return type
|
|
542
|
+
|
|
543
|
+
[**V2LoyaltiesProgramsMembersDeactivateResponseBody**](V2LoyaltiesProgramsMembersDeactivateResponseBody.md)
|
|
544
|
+
|
|
545
|
+
### Authorization
|
|
546
|
+
|
|
547
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
548
|
+
|
|
549
|
+
### HTTP request headers
|
|
550
|
+
|
|
551
|
+
- **Content-Type**: Not defined
|
|
552
|
+
- **Accept**: application/json
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
## delete_program_member
|
|
556
|
+
|
|
557
|
+
> <V2LoyaltiesProgramsMembersDeleteResponseBody> delete_program_member(program_id, member_id)
|
|
558
|
+
|
|
559
|
+
Delete program member
|
|
560
|
+
|
|
561
|
+
Deletes the member and sets status to DELETED. Removes the members card assignments in this program. Returns the member without a cards array. Delete doesnt change updated_at. Records a vl.member.deleted activity. Each unassigned card also records vl.member.card.unassigned and vl.card.unassigned. When an assignment has a tier, the delete records a LEFT tier transaction with origin member_card_deleted. The same customer can join the program again. The new member gets a new ID. Returns 404 when the program doesnt exist, or when the member doesnt exist in that program. The program is checked first. Deleting a member that is already DELETED returns 404.
|
|
562
|
+
|
|
563
|
+
### Examples
|
|
564
|
+
|
|
565
|
+
```ruby
|
|
566
|
+
require 'time'
|
|
567
|
+
require 'VoucherifySdk'
|
|
568
|
+
# setup authorization
|
|
569
|
+
VoucherifySdk.configure do |config|
|
|
570
|
+
# Configure API key authorization: X-App-Id
|
|
571
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
572
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
573
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
574
|
+
|
|
575
|
+
# Configure API key authorization: X-App-Token
|
|
576
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
577
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
578
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
579
|
+
end
|
|
580
|
+
|
|
581
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
582
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
583
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
584
|
+
|
|
585
|
+
begin
|
|
586
|
+
# Delete program member
|
|
587
|
+
result = api_instance.delete_program_member(program_id, member_id)
|
|
588
|
+
p result
|
|
589
|
+
rescue VoucherifySdk::ApiError => e
|
|
590
|
+
puts "Error when calling LV2ProgramsApi->delete_program_member: #{e}"
|
|
591
|
+
end
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
### Parameters
|
|
595
|
+
|
|
596
|
+
| Name | Type | Description | Notes |
|
|
597
|
+
| ---- | ---- | ----------- | ----- |
|
|
598
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
599
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
600
|
+
|
|
601
|
+
### Return type
|
|
602
|
+
|
|
603
|
+
[**V2LoyaltiesProgramsMembersDeleteResponseBody**](V2LoyaltiesProgramsMembersDeleteResponseBody.md)
|
|
604
|
+
|
|
605
|
+
### Authorization
|
|
606
|
+
|
|
607
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
608
|
+
|
|
609
|
+
### HTTP request headers
|
|
610
|
+
|
|
611
|
+
- **Content-Type**: Not defined
|
|
612
|
+
- **Accept**: application/json
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
## expire_card_points_bucket
|
|
616
|
+
|
|
617
|
+
> <V2LoyaltiesProgramsMembersCardsExpiringPointsExpireResponseBody> expire_card_points_bucket(program_id, member_id, card_id, bucket_id)
|
|
618
|
+
|
|
619
|
+
Expire point bucket
|
|
620
|
+
|
|
621
|
+
Expires an ACTIVE points bucket. Creates an ADMIN_POINTS_EXPIRATION card transaction. The transaction is created with status PENDING and processed asynchronously. No request body. The bucket must be ACTIVE, and its expiration_date must be on or after the current project day. The program and the member must be ACTIVE, and the program must be inside its validity window. Otherwise the response is 423. Returns 404 when the program, the member, or the card definition doesnt exist, when the card isnt assigned to that member, or when the bucket isnt on that card.
|
|
622
|
+
|
|
623
|
+
### Examples
|
|
624
|
+
|
|
625
|
+
```ruby
|
|
626
|
+
require 'time'
|
|
627
|
+
require 'VoucherifySdk'
|
|
628
|
+
# setup authorization
|
|
629
|
+
VoucherifySdk.configure do |config|
|
|
630
|
+
# Configure API key authorization: X-App-Id
|
|
631
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
632
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
633
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
634
|
+
|
|
635
|
+
# Configure API key authorization: X-App-Token
|
|
636
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
637
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
638
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
639
|
+
end
|
|
640
|
+
|
|
641
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
642
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
643
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
644
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
645
|
+
bucket_id = 'bucket_id_example' # String | Identifies the points expiration bucket. Format lcpeb_[a-f0-9]+.
|
|
646
|
+
|
|
647
|
+
begin
|
|
648
|
+
# Expire point bucket
|
|
649
|
+
result = api_instance.expire_card_points_bucket(program_id, member_id, card_id, bucket_id)
|
|
650
|
+
p result
|
|
651
|
+
rescue VoucherifySdk::ApiError => e
|
|
652
|
+
puts "Error when calling LV2ProgramsApi->expire_card_points_bucket: #{e}"
|
|
653
|
+
end
|
|
654
|
+
```
|
|
655
|
+
|
|
656
|
+
### Parameters
|
|
657
|
+
|
|
658
|
+
| Name | Type | Description | Notes |
|
|
659
|
+
| ---- | ---- | ----------- | ----- |
|
|
660
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
661
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
662
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
663
|
+
| **bucket_id** | **String** | Identifies the points expiration bucket. Format lcpeb_[a-f0-9]+. | |
|
|
664
|
+
|
|
665
|
+
### Return type
|
|
666
|
+
|
|
667
|
+
[**V2LoyaltiesProgramsMembersCardsExpiringPointsExpireResponseBody**](V2LoyaltiesProgramsMembersCardsExpiringPointsExpireResponseBody.md)
|
|
668
|
+
|
|
669
|
+
### Authorization
|
|
670
|
+
|
|
671
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
672
|
+
|
|
673
|
+
### HTTP request headers
|
|
674
|
+
|
|
675
|
+
- **Content-Type**: Not defined
|
|
676
|
+
- **Accept**: application/json
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
## get_member_earning_rule_daily_report
|
|
680
|
+
|
|
681
|
+
> <V2LoyaltiesProgramsMembersEarningRulesReportsDailyListResponseBody> get_member_earning_rule_daily_report(program_id, member_id, earning_rule_id, start_date, end_date, resolution)
|
|
682
|
+
|
|
683
|
+
List member earning-rule daily reports
|
|
684
|
+
|
|
685
|
+
Returns aggregated daily usage statistics for a specific earning rule and member over the given date range and resolution. Each entry sums successful earning-rule triggers recorded in one period. Periods without recorded activity are omitted. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program or member does not exist, or when the earning rule does not exist or is not assigned to the program.
|
|
686
|
+
|
|
687
|
+
### Examples
|
|
688
|
+
|
|
689
|
+
```ruby
|
|
690
|
+
require 'time'
|
|
691
|
+
require 'VoucherifySdk'
|
|
692
|
+
# setup authorization
|
|
693
|
+
VoucherifySdk.configure do |config|
|
|
694
|
+
# Configure API key authorization: X-App-Id
|
|
695
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
696
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
697
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
698
|
+
|
|
699
|
+
# Configure API key authorization: X-App-Token
|
|
700
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
701
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
702
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
703
|
+
end
|
|
704
|
+
|
|
705
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
706
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
707
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
708
|
+
earning_rule_id = 'earning_rule_id_example' # String | Identifies the earning rule. Format lern_[a-f0-9]+.
|
|
709
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
710
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
711
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
712
|
+
|
|
713
|
+
begin
|
|
714
|
+
# List member earning-rule daily reports
|
|
715
|
+
result = api_instance.get_member_earning_rule_daily_report(program_id, member_id, earning_rule_id, start_date, end_date, resolution)
|
|
716
|
+
p result
|
|
717
|
+
rescue VoucherifySdk::ApiError => e
|
|
718
|
+
puts "Error when calling LV2ProgramsApi->get_member_earning_rule_daily_report: #{e}"
|
|
719
|
+
end
|
|
720
|
+
```
|
|
721
|
+
|
|
722
|
+
### Parameters
|
|
723
|
+
|
|
724
|
+
| Name | Type | Description | Notes |
|
|
725
|
+
| ---- | ---- | ----------- | ----- |
|
|
726
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
727
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
728
|
+
| **earning_rule_id** | **String** | Identifies the earning rule. Format lern_[a-f0-9]+. | |
|
|
729
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
730
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
731
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
732
|
+
|
|
733
|
+
### Return type
|
|
734
|
+
|
|
735
|
+
[**V2LoyaltiesProgramsMembersEarningRulesReportsDailyListResponseBody**](V2LoyaltiesProgramsMembersEarningRulesReportsDailyListResponseBody.md)
|
|
736
|
+
|
|
737
|
+
### Authorization
|
|
738
|
+
|
|
739
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
740
|
+
|
|
741
|
+
### HTTP request headers
|
|
742
|
+
|
|
743
|
+
- **Content-Type**: Not defined
|
|
744
|
+
- **Accept**: application/json
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
## get_program_member
|
|
748
|
+
|
|
749
|
+
> <V2LoyaltiesProgramsMembersGetResponseBody> get_program_member(program_id, member_id)
|
|
750
|
+
|
|
751
|
+
Get program member
|
|
752
|
+
|
|
753
|
+
Returns one member of the program together with that members loyalty cards. Each card includes balance, lifetime_bucket, next_expiration, and next_activation. tier_progress is not included. Use [Get program membership](/api-reference/programs/get-program-membership) when you need tier progress. card.code can be null shortly after member creation, while code generation is still running. Returns 404 when the program doesnt exist, or when the member doesnt exist in that program. The program is checked first.
|
|
754
|
+
|
|
755
|
+
### Examples
|
|
756
|
+
|
|
757
|
+
```ruby
|
|
758
|
+
require 'time'
|
|
759
|
+
require 'VoucherifySdk'
|
|
760
|
+
# setup authorization
|
|
761
|
+
VoucherifySdk.configure do |config|
|
|
762
|
+
# Configure API key authorization: X-App-Id
|
|
763
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
764
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
765
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
766
|
+
|
|
767
|
+
# Configure API key authorization: X-App-Token
|
|
768
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
769
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
770
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
771
|
+
end
|
|
772
|
+
|
|
773
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
774
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
775
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
776
|
+
|
|
777
|
+
begin
|
|
778
|
+
# Get program member
|
|
779
|
+
result = api_instance.get_program_member(program_id, member_id)
|
|
780
|
+
p result
|
|
781
|
+
rescue VoucherifySdk::ApiError => e
|
|
782
|
+
puts "Error when calling LV2ProgramsApi->get_program_member: #{e}"
|
|
783
|
+
end
|
|
784
|
+
```
|
|
785
|
+
|
|
786
|
+
### Parameters
|
|
787
|
+
|
|
788
|
+
| Name | Type | Description | Notes |
|
|
789
|
+
| ---- | ---- | ----------- | ----- |
|
|
790
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
791
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
792
|
+
|
|
793
|
+
### Return type
|
|
794
|
+
|
|
795
|
+
[**V2LoyaltiesProgramsMembersGetResponseBody**](V2LoyaltiesProgramsMembersGetResponseBody.md)
|
|
796
|
+
|
|
797
|
+
### Authorization
|
|
798
|
+
|
|
799
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
800
|
+
|
|
801
|
+
### HTTP request headers
|
|
802
|
+
|
|
803
|
+
- **Content-Type**: Not defined
|
|
804
|
+
- **Accept**: application/json
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
## get_program_membership
|
|
808
|
+
|
|
809
|
+
> <V2LoyaltiesProgramsMembershipsGetResponseBody> get_program_membership(program_id, customer_id, opts)
|
|
810
|
+
|
|
811
|
+
Get program membership
|
|
812
|
+
|
|
813
|
+
Returns the membership for one customer in the program: the member, the program, and the members loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted. identification_type chooses how customerId is read. It defaults to customer_id.
|
|
814
|
+
|
|
815
|
+
### Examples
|
|
816
|
+
|
|
817
|
+
```ruby
|
|
818
|
+
require 'time'
|
|
819
|
+
require 'VoucherifySdk'
|
|
820
|
+
# setup authorization
|
|
821
|
+
VoucherifySdk.configure do |config|
|
|
822
|
+
# Configure API key authorization: X-App-Id
|
|
823
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
824
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
825
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
826
|
+
|
|
827
|
+
# Configure API key authorization: X-App-Token
|
|
828
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
829
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
830
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
831
|
+
end
|
|
832
|
+
|
|
833
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
834
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
835
|
+
customer_id = 'customer_id_example' # String | Identifies the customer or member. identification_type selects the value: a Voucherify customer ID (cust_...), a customer source_id, or a loyalty member ID (lmbr_...).
|
|
836
|
+
opts = {
|
|
837
|
+
identification_type: 'customer_id' # String | Selects how customerId is read. customer_id is the Voucherify customer ID and the default. customer_source_id is the customers source_id. member_id is the loyalty member ID.
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
begin
|
|
841
|
+
# Get program membership
|
|
842
|
+
result = api_instance.get_program_membership(program_id, customer_id, opts)
|
|
843
|
+
p result
|
|
844
|
+
rescue VoucherifySdk::ApiError => e
|
|
845
|
+
puts "Error when calling LV2ProgramsApi->get_program_membership: #{e}"
|
|
846
|
+
end
|
|
847
|
+
```
|
|
848
|
+
|
|
849
|
+
### Parameters
|
|
850
|
+
|
|
851
|
+
| Name | Type | Description | Notes |
|
|
852
|
+
| ---- | ---- | ----------- | ----- |
|
|
853
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
854
|
+
| **customer_id** | **String** | Identifies the customer or member. identification_type selects the value: a Voucherify customer ID (cust_...), a customer source_id, or a loyalty member ID (lmbr_...). | |
|
|
855
|
+
| **identification_type** | **String** | Selects how customerId is read. customer_id is the Voucherify customer ID and the default. customer_source_id is the customers source_id. member_id is the loyalty member ID. | [optional][default to 'customer_id'] |
|
|
856
|
+
|
|
857
|
+
### Return type
|
|
858
|
+
|
|
859
|
+
[**V2LoyaltiesProgramsMembershipsGetResponseBody**](V2LoyaltiesProgramsMembershipsGetResponseBody.md)
|
|
860
|
+
|
|
861
|
+
### Authorization
|
|
862
|
+
|
|
863
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
864
|
+
|
|
865
|
+
### HTTP request headers
|
|
866
|
+
|
|
867
|
+
- **Content-Type**: Not defined
|
|
868
|
+
- **Accept**: application/json
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
## get_program_points_earnings_daily_report
|
|
872
|
+
|
|
873
|
+
> <V2LoyaltiesProgramsReportsPointsEarningsDailyListResponseBody> get_program_points_earnings_daily_report(program_id, start_date, end_date, resolution, opts)
|
|
874
|
+
|
|
875
|
+
List program points-earnings daily reports
|
|
876
|
+
|
|
877
|
+
Returns aggregated daily points-earnings statistics for the program over the given date range and resolution, optionally filtered by earning rule and card definition. Each entry sums earning operations recorded for one period, earning rule, earning item, and card definition. Periods without recorded activity are omitted. A filter that matches no rows returns an empty data array. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
878
|
+
|
|
879
|
+
### Examples
|
|
880
|
+
|
|
881
|
+
```ruby
|
|
882
|
+
require 'time'
|
|
883
|
+
require 'VoucherifySdk'
|
|
884
|
+
# setup authorization
|
|
885
|
+
VoucherifySdk.configure do |config|
|
|
886
|
+
# Configure API key authorization: X-App-Id
|
|
887
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
888
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
889
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
890
|
+
|
|
891
|
+
# Configure API key authorization: X-App-Token
|
|
892
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
893
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
894
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
895
|
+
end
|
|
896
|
+
|
|
897
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
898
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
899
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
900
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
901
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
902
|
+
opts = {
|
|
903
|
+
filters: VoucherifySdk::PointsEarningsReportListFilters.new # PointsEarningsReportListFilters | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
904
|
+
}
|
|
905
|
+
|
|
906
|
+
begin
|
|
907
|
+
# List program points-earnings daily reports
|
|
908
|
+
result = api_instance.get_program_points_earnings_daily_report(program_id, start_date, end_date, resolution, opts)
|
|
909
|
+
p result
|
|
910
|
+
rescue VoucherifySdk::ApiError => e
|
|
911
|
+
puts "Error when calling LV2ProgramsApi->get_program_points_earnings_daily_report: #{e}"
|
|
912
|
+
end
|
|
913
|
+
```
|
|
914
|
+
|
|
915
|
+
### Parameters
|
|
916
|
+
|
|
917
|
+
| Name | Type | Description | Notes |
|
|
918
|
+
| ---- | ---- | ----------- | ----- |
|
|
919
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
920
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
921
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
922
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
923
|
+
| **filters** | [**PointsEarningsReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
924
|
+
|
|
925
|
+
### Return type
|
|
926
|
+
|
|
927
|
+
[**V2LoyaltiesProgramsReportsPointsEarningsDailyListResponseBody**](V2LoyaltiesProgramsReportsPointsEarningsDailyListResponseBody.md)
|
|
928
|
+
|
|
929
|
+
### Authorization
|
|
930
|
+
|
|
931
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
932
|
+
|
|
933
|
+
### HTTP request headers
|
|
934
|
+
|
|
935
|
+
- **Content-Type**: Not defined
|
|
936
|
+
- **Accept**: application/json
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
## get_program_points_earnings_summary_report
|
|
940
|
+
|
|
941
|
+
> <V2LoyaltiesProgramsReportsPointsEarningsSummaryListResponseBody> get_program_points_earnings_summary_report(program_id, opts)
|
|
942
|
+
|
|
943
|
+
List program points-earnings summary reports
|
|
944
|
+
|
|
945
|
+
Returns total points-earnings statistics for the program (all time), optionally filtered by earning rule or card definition. Each entry sums earning operations for one earning rule, earning item, and card definition. Returns at most 100 rows, ordered by id descending. limit and order are not query parameters. A filter that matches no rows returns an empty data array. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
946
|
+
|
|
947
|
+
### Examples
|
|
948
|
+
|
|
949
|
+
```ruby
|
|
950
|
+
require 'time'
|
|
951
|
+
require 'VoucherifySdk'
|
|
952
|
+
# setup authorization
|
|
953
|
+
VoucherifySdk.configure do |config|
|
|
954
|
+
# Configure API key authorization: X-App-Id
|
|
955
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
956
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
957
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
958
|
+
|
|
959
|
+
# Configure API key authorization: X-App-Token
|
|
960
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
961
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
962
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
963
|
+
end
|
|
964
|
+
|
|
965
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
966
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
967
|
+
opts = {
|
|
968
|
+
filters: VoucherifySdk::PointsEarningsReportListFilters.new # PointsEarningsReportListFilters | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
begin
|
|
972
|
+
# List program points-earnings summary reports
|
|
973
|
+
result = api_instance.get_program_points_earnings_summary_report(program_id, opts)
|
|
974
|
+
p result
|
|
975
|
+
rescue VoucherifySdk::ApiError => e
|
|
976
|
+
puts "Error when calling LV2ProgramsApi->get_program_points_earnings_summary_report: #{e}"
|
|
977
|
+
end
|
|
978
|
+
```
|
|
979
|
+
|
|
980
|
+
### Parameters
|
|
981
|
+
|
|
982
|
+
| Name | Type | Description | Notes |
|
|
983
|
+
| ---- | ---- | ----------- | ----- |
|
|
984
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
985
|
+
| **filters** | [**PointsEarningsReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
986
|
+
|
|
987
|
+
### Return type
|
|
988
|
+
|
|
989
|
+
[**V2LoyaltiesProgramsReportsPointsEarningsSummaryListResponseBody**](V2LoyaltiesProgramsReportsPointsEarningsSummaryListResponseBody.md)
|
|
990
|
+
|
|
991
|
+
### Authorization
|
|
992
|
+
|
|
993
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
994
|
+
|
|
995
|
+
### HTTP request headers
|
|
996
|
+
|
|
997
|
+
- **Content-Type**: Not defined
|
|
998
|
+
- **Accept**: application/json
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
## list_card_activities
|
|
1002
|
+
|
|
1003
|
+
> <V2LoyaltiesProgramsMembersCardsActivitiesListResponseBody> list_card_activities(program_id, member_id, card_id, opts)
|
|
1004
|
+
|
|
1005
|
+
List card activities
|
|
1006
|
+
|
|
1007
|
+
Returns a cursor-paginated list of activities recorded for the members card. The card must still be assigned to that member. Filters are id, type, and created_at. Default order is -created_at, then id ascending. Returns 404 when the program doesnt exist, when the member doesnt exist in that program, or when the card isnt currently assigned to that member. The program is checked first, then the member. A DELETED member returns 404 with resource_type member. A missing assignment and a missing or deleted card both return 404 with resource_type card. Returns 400 with key invalid_query_params when the query fails validation. That check runs before the program, member, and card lookup. A cursor that doesnt match ^lcrsacrd_[a-f0-9]+$, a limit outside 1 to 100, an order other than created_at or -created_at, or an array that orders by both directions fails here. After the program, member, and card are found, an unknown or expired cursor returns invalid_or_expired_cursor. A cursor recorded for different filters or order returns cursor_and_query_mismatch. The cursor stays valid when only limit changes.
|
|
1008
|
+
|
|
1009
|
+
### Examples
|
|
1010
|
+
|
|
1011
|
+
```ruby
|
|
1012
|
+
require 'time'
|
|
1013
|
+
require 'VoucherifySdk'
|
|
1014
|
+
# setup authorization
|
|
1015
|
+
VoucherifySdk.configure do |config|
|
|
1016
|
+
# Configure API key authorization: X-App-Id
|
|
1017
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1018
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1019
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1020
|
+
|
|
1021
|
+
# Configure API key authorization: X-App-Token
|
|
1022
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1023
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1024
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1025
|
+
end
|
|
1026
|
+
|
|
1027
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1028
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1029
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1030
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
1031
|
+
opts = {
|
|
1032
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1033
|
+
order: 'created_at', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
1034
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsacrd_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1035
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFilters.new # V2LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFilters | Filters the results. Pass a deep object, for example filters[type][conditions][$is] vl.card.created. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1036
|
+
}
|
|
1037
|
+
|
|
1038
|
+
begin
|
|
1039
|
+
# List card activities
|
|
1040
|
+
result = api_instance.list_card_activities(program_id, member_id, card_id, opts)
|
|
1041
|
+
p result
|
|
1042
|
+
rescue VoucherifySdk::ApiError => e
|
|
1043
|
+
puts "Error when calling LV2ProgramsApi->list_card_activities: #{e}"
|
|
1044
|
+
end
|
|
1045
|
+
```
|
|
1046
|
+
|
|
1047
|
+
### Parameters
|
|
1048
|
+
|
|
1049
|
+
| Name | Type | Description | Notes |
|
|
1050
|
+
| ---- | ---- | ----------- | ----- |
|
|
1051
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1052
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1053
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
1054
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1055
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
1056
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsacrd_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1057
|
+
| **filters** | [**V2LoyaltiesProgramsMembersCardsActivitiesListRequestQueryFilters**](.md) | Filters the results. Pass a deep object, for example filters[type][conditions][$is] vl.card.created. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1058
|
+
|
|
1059
|
+
### Return type
|
|
1060
|
+
|
|
1061
|
+
[**V2LoyaltiesProgramsMembersCardsActivitiesListResponseBody**](V2LoyaltiesProgramsMembersCardsActivitiesListResponseBody.md)
|
|
1062
|
+
|
|
1063
|
+
### Authorization
|
|
1064
|
+
|
|
1065
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1066
|
+
|
|
1067
|
+
### HTTP request headers
|
|
1068
|
+
|
|
1069
|
+
- **Content-Type**: Not defined
|
|
1070
|
+
- **Accept**: application/json
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
## list_card_expiring_points
|
|
1074
|
+
|
|
1075
|
+
> <V2LoyaltiesProgramsMembersCardsExpiringPointsListResponseBody> list_card_expiring_points(program_id, member_id, card_id, opts)
|
|
1076
|
+
|
|
1077
|
+
List card expiring points buckets
|
|
1078
|
+
|
|
1079
|
+
Returns a cursor-paginated list of ACTIVE point expiration buckets for the members card. Each bucket groups points that share an expiration date and expiration type, including points from separate transactions. The list starts on the current project day. Earlier buckets are omitted. Results can be filtered by card definition ID and expiration date, and ordered by expiration_date. Returns an empty list when the card has no matching buckets. Returns 400 when the query is invalid or the cursor is invalid, expired, or doesnt match the query. Returns 404 when the program or the member doesnt exist, or when the card isnt assigned to that member.
|
|
1080
|
+
|
|
1081
|
+
### Examples
|
|
1082
|
+
|
|
1083
|
+
```ruby
|
|
1084
|
+
require 'time'
|
|
1085
|
+
require 'VoucherifySdk'
|
|
1086
|
+
# setup authorization
|
|
1087
|
+
VoucherifySdk.configure do |config|
|
|
1088
|
+
# Configure API key authorization: X-App-Id
|
|
1089
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1090
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1091
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1092
|
+
|
|
1093
|
+
# Configure API key authorization: X-App-Token
|
|
1094
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1095
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1096
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1097
|
+
end
|
|
1098
|
+
|
|
1099
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1100
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1101
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1102
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
1103
|
+
opts = {
|
|
1104
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1105
|
+
order: 'expiration_date', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to expiration_date. Soonest expiration first. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
1106
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrspeb_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1107
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersCardsExpiringPointsListRequestQuery.new # V2LoyaltiesProgramsMembersCardsExpiringPointsListRequestQuery | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_1297339938ae248cea. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1108
|
+
}
|
|
1109
|
+
|
|
1110
|
+
begin
|
|
1111
|
+
# List card expiring points buckets
|
|
1112
|
+
result = api_instance.list_card_expiring_points(program_id, member_id, card_id, opts)
|
|
1113
|
+
p result
|
|
1114
|
+
rescue VoucherifySdk::ApiError => e
|
|
1115
|
+
puts "Error when calling LV2ProgramsApi->list_card_expiring_points: #{e}"
|
|
1116
|
+
end
|
|
1117
|
+
```
|
|
1118
|
+
|
|
1119
|
+
### Parameters
|
|
1120
|
+
|
|
1121
|
+
| Name | Type | Description | Notes |
|
|
1122
|
+
| ---- | ---- | ----------- | ----- |
|
|
1123
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1124
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1125
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
1126
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1127
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to expiration_date. Soonest expiration first. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
1128
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrspeb_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1129
|
+
| **filters** | [**V2LoyaltiesProgramsMembersCardsExpiringPointsListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_1297339938ae248cea. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1130
|
+
|
|
1131
|
+
### Return type
|
|
1132
|
+
|
|
1133
|
+
[**V2LoyaltiesProgramsMembersCardsExpiringPointsListResponseBody**](V2LoyaltiesProgramsMembersCardsExpiringPointsListResponseBody.md)
|
|
1134
|
+
|
|
1135
|
+
### Authorization
|
|
1136
|
+
|
|
1137
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1138
|
+
|
|
1139
|
+
### HTTP request headers
|
|
1140
|
+
|
|
1141
|
+
- **Content-Type**: Not defined
|
|
1142
|
+
- **Accept**: application/json
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
## list_card_pending_points
|
|
1146
|
+
|
|
1147
|
+
> <V2LoyaltiesProgramsMembersCardsPendingPointsListResponseBody> list_card_pending_points(program_id, member_id, card_id, opts)
|
|
1148
|
+
|
|
1149
|
+
List card pending point buckets
|
|
1150
|
+
|
|
1151
|
+
Returns a cursor-paginated list of pending point buckets for the members card. Every bucket has status PENDING. Pending points wait for activation (PERIOD_BASED, FIXED_DATES, or EVENT_BASED), following the card definition. The list starts on the next project day. The current days bucket is omitted because its still accumulating. Results can be filtered by card definition ID and ordered by date. Returns 404 when the program or the member doesnt exist, or when the card isnt assigned to that member. Bucket IDs from this list are the bucketId for [Activate pending point bucket](/api-reference/programs/activate-pending-point-bucket) and [Cancel pending point bucket](/api-reference/programs/cancel-pending-point-bucket).
|
|
1152
|
+
|
|
1153
|
+
### Examples
|
|
1154
|
+
|
|
1155
|
+
```ruby
|
|
1156
|
+
require 'time'
|
|
1157
|
+
require 'VoucherifySdk'
|
|
1158
|
+
# setup authorization
|
|
1159
|
+
VoucherifySdk.configure do |config|
|
|
1160
|
+
# Configure API key authorization: X-App-Id
|
|
1161
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1162
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1163
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1164
|
+
|
|
1165
|
+
# Configure API key authorization: X-App-Token
|
|
1166
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1167
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1168
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1169
|
+
end
|
|
1170
|
+
|
|
1171
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1172
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1173
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1174
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
1175
|
+
opts = {
|
|
1176
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1177
|
+
order: 'date', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to date. Soonest activation first. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
1178
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrscppb_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1179
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersCardsPendingPointsListRequestQuery.new # V2LoyaltiesProgramsMembersCardsPendingPointsListRequestQuery | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_128f495f720c4bec8c. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
begin
|
|
1183
|
+
# List card pending point buckets
|
|
1184
|
+
result = api_instance.list_card_pending_points(program_id, member_id, card_id, opts)
|
|
1185
|
+
p result
|
|
1186
|
+
rescue VoucherifySdk::ApiError => e
|
|
1187
|
+
puts "Error when calling LV2ProgramsApi->list_card_pending_points: #{e}"
|
|
1188
|
+
end
|
|
1189
|
+
```
|
|
1190
|
+
|
|
1191
|
+
### Parameters
|
|
1192
|
+
|
|
1193
|
+
| Name | Type | Description | Notes |
|
|
1194
|
+
| ---- | ---- | ----------- | ----- |
|
|
1195
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1196
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1197
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
1198
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1199
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to date. Soonest activation first. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
1200
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrscppb_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1201
|
+
| **filters** | [**V2LoyaltiesProgramsMembersCardsPendingPointsListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_128f495f720c4bec8c. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1202
|
+
|
|
1203
|
+
### Return type
|
|
1204
|
+
|
|
1205
|
+
[**V2LoyaltiesProgramsMembersCardsPendingPointsListResponseBody**](V2LoyaltiesProgramsMembersCardsPendingPointsListResponseBody.md)
|
|
1206
|
+
|
|
1207
|
+
### Authorization
|
|
1208
|
+
|
|
1209
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1210
|
+
|
|
1211
|
+
### HTTP request headers
|
|
1212
|
+
|
|
1213
|
+
- **Content-Type**: Not defined
|
|
1214
|
+
- **Accept**: application/json
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
## list_card_transactions
|
|
1218
|
+
|
|
1219
|
+
> <V2LoyaltiesProgramsMembersCardsTransactionsListResponseBody> list_card_transactions(program_id, member_id, card_id, opts)
|
|
1220
|
+
|
|
1221
|
+
List card transactions
|
|
1222
|
+
|
|
1223
|
+
Returns a cursor-paginated list of transactions on the members card. Filter by id, card_definition_id, and created_at. Order by id (default -id, newest first). Returns 404 when the program, member, or card doesnt exist. The program is checked first, then the member, then the card. A member of another program, or a card that isnt assigned to this member, is not found.
|
|
1224
|
+
|
|
1225
|
+
### Examples
|
|
1226
|
+
|
|
1227
|
+
```ruby
|
|
1228
|
+
require 'time'
|
|
1229
|
+
require 'VoucherifySdk'
|
|
1230
|
+
# setup authorization
|
|
1231
|
+
VoucherifySdk.configure do |config|
|
|
1232
|
+
# Configure API key authorization: X-App-Id
|
|
1233
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1234
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1235
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1236
|
+
|
|
1237
|
+
# Configure API key authorization: X-App-Token
|
|
1238
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1239
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1240
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1241
|
+
end
|
|
1242
|
+
|
|
1243
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1244
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1245
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1246
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
1247
|
+
opts = {
|
|
1248
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1249
|
+
order: '-id', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions.
|
|
1250
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsctx_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1251
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersCardsTransactionsListRequestQuery.new # V2LoyaltiesProgramsMembersCardsTransactionsListRequestQuery | Filters the results. Pass a deep object, for example filters[id][conditions][$is] lctx_0f5d0a8878caa3ee5c. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1252
|
+
}
|
|
1253
|
+
|
|
1254
|
+
begin
|
|
1255
|
+
# List card transactions
|
|
1256
|
+
result = api_instance.list_card_transactions(program_id, member_id, card_id, opts)
|
|
1257
|
+
p result
|
|
1258
|
+
rescue VoucherifySdk::ApiError => e
|
|
1259
|
+
puts "Error when calling LV2ProgramsApi->list_card_transactions: #{e}"
|
|
1260
|
+
end
|
|
1261
|
+
```
|
|
1262
|
+
|
|
1263
|
+
### Parameters
|
|
1264
|
+
|
|
1265
|
+
| Name | Type | Description | Notes |
|
|
1266
|
+
| ---- | ---- | ----------- | ----- |
|
|
1267
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1268
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1269
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
1270
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1271
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions. | [optional] |
|
|
1272
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsctx_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1273
|
+
| **filters** | [**V2LoyaltiesProgramsMembersCardsTransactionsListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[id][conditions][$is] lctx_0f5d0a8878caa3ee5c. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1274
|
+
|
|
1275
|
+
### Return type
|
|
1276
|
+
|
|
1277
|
+
[**V2LoyaltiesProgramsMembersCardsTransactionsListResponseBody**](V2LoyaltiesProgramsMembersCardsTransactionsListResponseBody.md)
|
|
1278
|
+
|
|
1279
|
+
### Authorization
|
|
1280
|
+
|
|
1281
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1282
|
+
|
|
1283
|
+
### HTTP request headers
|
|
1284
|
+
|
|
1285
|
+
- **Content-Type**: Not defined
|
|
1286
|
+
- **Accept**: application/json
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
## list_member_benefit_transactions
|
|
1290
|
+
|
|
1291
|
+
> <V2LoyaltiesProgramsMembersBenefitsTransactionsListResponseBody> list_member_benefit_transactions(program_id, member_id, opts)
|
|
1292
|
+
|
|
1293
|
+
List member benefit transactions
|
|
1294
|
+
|
|
1295
|
+
Lists benefit transactions (benefit fulfillments) for a given program member, with cursor-based pagination. Supports filtering by benefit ID and creation date.
|
|
1296
|
+
|
|
1297
|
+
### Examples
|
|
1298
|
+
|
|
1299
|
+
```ruby
|
|
1300
|
+
require 'time'
|
|
1301
|
+
require 'VoucherifySdk'
|
|
1302
|
+
# setup authorization
|
|
1303
|
+
VoucherifySdk.configure do |config|
|
|
1304
|
+
# Configure API key authorization: X-App-Id
|
|
1305
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1306
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1307
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1308
|
+
|
|
1309
|
+
# Configure API key authorization: X-App-Token
|
|
1310
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1311
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1312
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1313
|
+
end
|
|
1314
|
+
|
|
1315
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1316
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1317
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1318
|
+
opts = {
|
|
1319
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1320
|
+
order: 'id', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions.
|
|
1321
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsbtx_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1322
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersBenefitsTransactionsListRequestQuery.new # V2LoyaltiesProgramsMembersBenefitsTransactionsListRequestQuery | Filters the results. Pass a deep object, for example filters[benefit_id][conditions][$is] lben_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1323
|
+
}
|
|
1324
|
+
|
|
1325
|
+
begin
|
|
1326
|
+
# List member benefit transactions
|
|
1327
|
+
result = api_instance.list_member_benefit_transactions(program_id, member_id, opts)
|
|
1328
|
+
p result
|
|
1329
|
+
rescue VoucherifySdk::ApiError => e
|
|
1330
|
+
puts "Error when calling LV2ProgramsApi->list_member_benefit_transactions: #{e}"
|
|
1331
|
+
end
|
|
1332
|
+
```
|
|
1333
|
+
|
|
1334
|
+
### Parameters
|
|
1335
|
+
|
|
1336
|
+
| Name | Type | Description | Notes |
|
|
1337
|
+
| ---- | ---- | ----------- | ----- |
|
|
1338
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1339
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1340
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1341
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions. | [optional] |
|
|
1342
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsbtx_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1343
|
+
| **filters** | [**V2LoyaltiesProgramsMembersBenefitsTransactionsListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[benefit_id][conditions][$is] lben_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1344
|
+
|
|
1345
|
+
### Return type
|
|
1346
|
+
|
|
1347
|
+
[**V2LoyaltiesProgramsMembersBenefitsTransactionsListResponseBody**](V2LoyaltiesProgramsMembersBenefitsTransactionsListResponseBody.md)
|
|
1348
|
+
|
|
1349
|
+
### Authorization
|
|
1350
|
+
|
|
1351
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1352
|
+
|
|
1353
|
+
### HTTP request headers
|
|
1354
|
+
|
|
1355
|
+
- **Content-Type**: Not defined
|
|
1356
|
+
- **Accept**: application/json
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
## list_member_card_daily_reports
|
|
1360
|
+
|
|
1361
|
+
> <LoyaltiesProgramsMembersCardsReportsDailyListResponseBody> list_member_card_daily_reports(program_id, member_id, card_id, start_date, end_date, resolution)
|
|
1362
|
+
|
|
1363
|
+
List card daily points reports
|
|
1364
|
+
|
|
1365
|
+
Returns aggregated points statistics for a members loyalty card over the given date range and resolution. Each entry sums the point operations recorded in one period. Periods without recorded activity are omitted. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program or member does not exist, or when the card does not exist or is not assigned to the member in the program.
|
|
1366
|
+
|
|
1367
|
+
### Examples
|
|
1368
|
+
|
|
1369
|
+
```ruby
|
|
1370
|
+
require 'time'
|
|
1371
|
+
require 'VoucherifySdk'
|
|
1372
|
+
# setup authorization
|
|
1373
|
+
VoucherifySdk.configure do |config|
|
|
1374
|
+
# Configure API key authorization: X-App-Id
|
|
1375
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1376
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1377
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1378
|
+
|
|
1379
|
+
# Configure API key authorization: X-App-Token
|
|
1380
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1381
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1382
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1383
|
+
end
|
|
1384
|
+
|
|
1385
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1386
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1387
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1388
|
+
card_id = 'card_id_example' # String | Identifies the loyalty card. Format lcrd_[a-f0-9]+.
|
|
1389
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
1390
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
1391
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
1392
|
+
|
|
1393
|
+
begin
|
|
1394
|
+
# List card daily points reports
|
|
1395
|
+
result = api_instance.list_member_card_daily_reports(program_id, member_id, card_id, start_date, end_date, resolution)
|
|
1396
|
+
p result
|
|
1397
|
+
rescue VoucherifySdk::ApiError => e
|
|
1398
|
+
puts "Error when calling LV2ProgramsApi->list_member_card_daily_reports: #{e}"
|
|
1399
|
+
end
|
|
1400
|
+
```
|
|
1401
|
+
|
|
1402
|
+
### Parameters
|
|
1403
|
+
|
|
1404
|
+
| Name | Type | Description | Notes |
|
|
1405
|
+
| ---- | ---- | ----------- | ----- |
|
|
1406
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1407
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1408
|
+
| **card_id** | **String** | Identifies the loyalty card. Format lcrd_[a-f0-9]+. | |
|
|
1409
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
1410
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
1411
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
1412
|
+
|
|
1413
|
+
### Return type
|
|
1414
|
+
|
|
1415
|
+
[**LoyaltiesProgramsMembersCardsReportsDailyListResponseBody**](LoyaltiesProgramsMembersCardsReportsDailyListResponseBody.md)
|
|
1416
|
+
|
|
1417
|
+
### Authorization
|
|
1418
|
+
|
|
1419
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1420
|
+
|
|
1421
|
+
### HTTP request headers
|
|
1422
|
+
|
|
1423
|
+
- **Content-Type**: Not defined
|
|
1424
|
+
- **Accept**: application/json
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
## list_member_order_payments
|
|
1428
|
+
|
|
1429
|
+
> <V2LoyaltiesProgramsMembersOrdersPaymentsListResponseBody> list_member_order_payments(program_id, member_id, opts)
|
|
1430
|
+
|
|
1431
|
+
List member order payments
|
|
1432
|
+
|
|
1433
|
+
Lists stored PAY_WITH_POINTS order transactions for the program member, with cursor pagination. Filter by id, card_definition_id, and created_at. Order by id (default -id, newest first). Dry-run (SIMULATED) results arent stored and dont appear. Returns 404 when the program or the member doesnt exist. The program is checked first.
|
|
1434
|
+
|
|
1435
|
+
### Examples
|
|
1436
|
+
|
|
1437
|
+
```ruby
|
|
1438
|
+
require 'time'
|
|
1439
|
+
require 'VoucherifySdk'
|
|
1440
|
+
# setup authorization
|
|
1441
|
+
VoucherifySdk.configure do |config|
|
|
1442
|
+
# Configure API key authorization: X-App-Id
|
|
1443
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1444
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1445
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1446
|
+
|
|
1447
|
+
# Configure API key authorization: X-App-Token
|
|
1448
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1449
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1450
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1451
|
+
end
|
|
1452
|
+
|
|
1453
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1454
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1455
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1456
|
+
opts = {
|
|
1457
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1458
|
+
order: '-id', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions.
|
|
1459
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsotx_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1460
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersOrdersPaymentsListRequestQuery.new # V2LoyaltiesProgramsMembersOrdersPaymentsListRequestQuery | Filters the results. Pass a deep object, for example filters[id][conditions][$is] lotx_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1461
|
+
}
|
|
1462
|
+
|
|
1463
|
+
begin
|
|
1464
|
+
# List member order payments
|
|
1465
|
+
result = api_instance.list_member_order_payments(program_id, member_id, opts)
|
|
1466
|
+
p result
|
|
1467
|
+
rescue VoucherifySdk::ApiError => e
|
|
1468
|
+
puts "Error when calling LV2ProgramsApi->list_member_order_payments: #{e}"
|
|
1469
|
+
end
|
|
1470
|
+
```
|
|
1471
|
+
|
|
1472
|
+
### Parameters
|
|
1473
|
+
|
|
1474
|
+
| Name | Type | Description | Notes |
|
|
1475
|
+
| ---- | ---- | ----------- | ----- |
|
|
1476
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1477
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1478
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1479
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions. | [optional] |
|
|
1480
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsotx_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1481
|
+
| **filters** | [**V2LoyaltiesProgramsMembersOrdersPaymentsListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[id][conditions][$is] lotx_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1482
|
+
|
|
1483
|
+
### Return type
|
|
1484
|
+
|
|
1485
|
+
[**V2LoyaltiesProgramsMembersOrdersPaymentsListResponseBody**](V2LoyaltiesProgramsMembersOrdersPaymentsListResponseBody.md)
|
|
1486
|
+
|
|
1487
|
+
### Authorization
|
|
1488
|
+
|
|
1489
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1490
|
+
|
|
1491
|
+
### HTTP request headers
|
|
1492
|
+
|
|
1493
|
+
- **Content-Type**: Not defined
|
|
1494
|
+
- **Accept**: application/json
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
## list_member_reward_purchases
|
|
1498
|
+
|
|
1499
|
+
> <V2LoyaltiesProgramsMembersRewardsPurchasesListResponseBody> list_member_reward_purchases(program_id, member_id, opts)
|
|
1500
|
+
|
|
1501
|
+
List member reward purchases
|
|
1502
|
+
|
|
1503
|
+
Lists stored PURCHASE reward transactions for the program member, with cursor pagination. Filter by id, reward_id, card_definition_id, and created_at. Order by id (default -id, newest first). Purchases rejected before a transaction is stored dont appear. A purchase accepted with 202 that later fails is stored as REJECTED with details.rejection. Returns 404 when the program or the member doesnt exist. The program is checked first.
|
|
1504
|
+
|
|
1505
|
+
### Examples
|
|
1506
|
+
|
|
1507
|
+
```ruby
|
|
1508
|
+
require 'time'
|
|
1509
|
+
require 'VoucherifySdk'
|
|
1510
|
+
# setup authorization
|
|
1511
|
+
VoucherifySdk.configure do |config|
|
|
1512
|
+
# Configure API key authorization: X-App-Id
|
|
1513
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1514
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1515
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1516
|
+
|
|
1517
|
+
# Configure API key authorization: X-App-Token
|
|
1518
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1519
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1520
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1521
|
+
end
|
|
1522
|
+
|
|
1523
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1524
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1525
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1526
|
+
opts = {
|
|
1527
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1528
|
+
order: '-id', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions.
|
|
1529
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrstrx_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1530
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersRewardsPurchasesListRequestQuery.new # V2LoyaltiesProgramsMembersRewardsPurchasesListRequestQuery | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1531
|
+
}
|
|
1532
|
+
|
|
1533
|
+
begin
|
|
1534
|
+
# List member reward purchases
|
|
1535
|
+
result = api_instance.list_member_reward_purchases(program_id, member_id, opts)
|
|
1536
|
+
p result
|
|
1537
|
+
rescue VoucherifySdk::ApiError => e
|
|
1538
|
+
puts "Error when calling LV2ProgramsApi->list_member_reward_purchases: #{e}"
|
|
1539
|
+
end
|
|
1540
|
+
```
|
|
1541
|
+
|
|
1542
|
+
### Parameters
|
|
1543
|
+
|
|
1544
|
+
| Name | Type | Description | Notes |
|
|
1545
|
+
| ---- | ---- | ----------- | ----- |
|
|
1546
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1547
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1548
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1549
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions. | [optional] |
|
|
1550
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrstrx_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1551
|
+
| **filters** | [**V2LoyaltiesProgramsMembersRewardsPurchasesListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1552
|
+
|
|
1553
|
+
### Return type
|
|
1554
|
+
|
|
1555
|
+
[**V2LoyaltiesProgramsMembersRewardsPurchasesListResponseBody**](V2LoyaltiesProgramsMembersRewardsPurchasesListResponseBody.md)
|
|
1556
|
+
|
|
1557
|
+
### Authorization
|
|
1558
|
+
|
|
1559
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1560
|
+
|
|
1561
|
+
### HTTP request headers
|
|
1562
|
+
|
|
1563
|
+
- **Content-Type**: Not defined
|
|
1564
|
+
- **Accept**: application/json
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
## list_member_tier_transactions
|
|
1568
|
+
|
|
1569
|
+
> <V2LoyaltiesProgramsMembersTiersTransactionsListResponseBody> list_member_tier_transactions(program_id, member_id, opts)
|
|
1570
|
+
|
|
1571
|
+
List member tier transactions
|
|
1572
|
+
|
|
1573
|
+
Lists tier transactions for the member: joins, leaves, upgrades, downgrades, expiration changes, and evaluation refreshes. Results use cursor pagination. Default order is -id, newest first. Filters are card_id, card_definition_id, and created_at. Returns 404 when the program doesnt exist, or when the member doesnt exist in that program. The program is checked first. A DELETED member returns 404. Returns 400 with key invalid_query_params when the query fails validation. That check runs before the program and member lookup. order must be id or -id. An array that orders by both directions is rejected. A cursor that doesnt match ^lcrsttx_[a-f0-9]+$ fails here. After the program and member are found, an unknown or expired cursor returns invalid_or_expired_cursor. A cursor recorded for different filters or order returns cursor_and_query_mismatch. The cursor stays valid when only limit changes.
|
|
1574
|
+
|
|
1575
|
+
### Examples
|
|
1576
|
+
|
|
1577
|
+
```ruby
|
|
1578
|
+
require 'time'
|
|
1579
|
+
require 'VoucherifySdk'
|
|
1580
|
+
# setup authorization
|
|
1581
|
+
VoucherifySdk.configure do |config|
|
|
1582
|
+
# Configure API key authorization: X-App-Id
|
|
1583
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1584
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1585
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1586
|
+
|
|
1587
|
+
# Configure API key authorization: X-App-Token
|
|
1588
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1589
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1590
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1591
|
+
end
|
|
1592
|
+
|
|
1593
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1594
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1595
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1596
|
+
opts = {
|
|
1597
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1598
|
+
order: '-id', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions.
|
|
1599
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsttx_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1600
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersTiersTransactionsListRequestQuery.new # V2LoyaltiesProgramsMembersTiersTransactionsListRequestQuery | Filters the results. Pass a deep object, for example filters[card_id][conditions][$is] lcrd_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1601
|
+
}
|
|
1602
|
+
|
|
1603
|
+
begin
|
|
1604
|
+
# List member tier transactions
|
|
1605
|
+
result = api_instance.list_member_tier_transactions(program_id, member_id, opts)
|
|
1606
|
+
p result
|
|
1607
|
+
rescue VoucherifySdk::ApiError => e
|
|
1608
|
+
puts "Error when calling LV2ProgramsApi->list_member_tier_transactions: #{e}"
|
|
1609
|
+
end
|
|
1610
|
+
```
|
|
1611
|
+
|
|
1612
|
+
### Parameters
|
|
1613
|
+
|
|
1614
|
+
| Name | Type | Description | Notes |
|
|
1615
|
+
| ---- | ---- | ----------- | ----- |
|
|
1616
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1617
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1618
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1619
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions. | [optional] |
|
|
1620
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsttx_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1621
|
+
| **filters** | [**V2LoyaltiesProgramsMembersTiersTransactionsListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[card_id][conditions][$is] lcrd_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1622
|
+
|
|
1623
|
+
### Return type
|
|
1624
|
+
|
|
1625
|
+
[**V2LoyaltiesProgramsMembersTiersTransactionsListResponseBody**](V2LoyaltiesProgramsMembersTiersTransactionsListResponseBody.md)
|
|
1626
|
+
|
|
1627
|
+
### Authorization
|
|
1628
|
+
|
|
1629
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1630
|
+
|
|
1631
|
+
### HTTP request headers
|
|
1632
|
+
|
|
1633
|
+
- **Content-Type**: Not defined
|
|
1634
|
+
- **Accept**: application/json
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
## list_program_earning_rule_assignments
|
|
1638
|
+
|
|
1639
|
+
> <V2LoyaltiesProgramsEarningRulesListResponseBody> list_program_earning_rule_assignments(program_id, opts)
|
|
1640
|
+
|
|
1641
|
+
List program earning rule assignments
|
|
1642
|
+
|
|
1643
|
+
Returns a cursor-paginated list of earning rules assigned to the program.
|
|
1644
|
+
|
|
1645
|
+
### Examples
|
|
1646
|
+
|
|
1647
|
+
```ruby
|
|
1648
|
+
require 'time'
|
|
1649
|
+
require 'VoucherifySdk'
|
|
1650
|
+
# setup authorization
|
|
1651
|
+
VoucherifySdk.configure do |config|
|
|
1652
|
+
# Configure API key authorization: X-App-Id
|
|
1653
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1654
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1655
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1656
|
+
|
|
1657
|
+
# Configure API key authorization: X-App-Token
|
|
1658
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1659
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1660
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1661
|
+
end
|
|
1662
|
+
|
|
1663
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1664
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1665
|
+
opts = {
|
|
1666
|
+
limit: 'limit_example', # String | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1667
|
+
order: '-created_at', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
1668
|
+
cursor: 'cursor_example' # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrserna_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1669
|
+
}
|
|
1670
|
+
|
|
1671
|
+
begin
|
|
1672
|
+
# List program earning rule assignments
|
|
1673
|
+
result = api_instance.list_program_earning_rule_assignments(program_id, opts)
|
|
1674
|
+
p result
|
|
1675
|
+
rescue VoucherifySdk::ApiError => e
|
|
1676
|
+
puts "Error when calling LV2ProgramsApi->list_program_earning_rule_assignments: #{e}"
|
|
1677
|
+
end
|
|
1678
|
+
```
|
|
1679
|
+
|
|
1680
|
+
### Parameters
|
|
1681
|
+
|
|
1682
|
+
| Name | Type | Description | Notes |
|
|
1683
|
+
| ---- | ---- | ----------- | ----- |
|
|
1684
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1685
|
+
| **limit** | **String** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to '10'] |
|
|
1686
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
1687
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrserna_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1688
|
+
|
|
1689
|
+
### Return type
|
|
1690
|
+
|
|
1691
|
+
[**V2LoyaltiesProgramsEarningRulesListResponseBody**](V2LoyaltiesProgramsEarningRulesListResponseBody.md)
|
|
1692
|
+
|
|
1693
|
+
### Authorization
|
|
1694
|
+
|
|
1695
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1696
|
+
|
|
1697
|
+
### HTTP request headers
|
|
1698
|
+
|
|
1699
|
+
- **Content-Type**: Not defined
|
|
1700
|
+
- **Accept**: application/json
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
## list_program_earning_rules_daily_reports
|
|
1704
|
+
|
|
1705
|
+
> <V2LoyaltiesProgramsReportsEarningRulesDailyListResponseBody> list_program_earning_rules_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
1706
|
+
|
|
1707
|
+
List program earning-rules daily reports
|
|
1708
|
+
|
|
1709
|
+
Returns aggregated daily earning-rule evaluation statistics for the program over the given date range and resolution, optionally filtered by earning rule. Each entry counts eligibility checks for one period and earning rule. Periods without recorded activity are omitted. failures_breakdown is always an empty object. A filter that matches no rows returns an empty data array. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
1710
|
+
|
|
1711
|
+
### Examples
|
|
1712
|
+
|
|
1713
|
+
```ruby
|
|
1714
|
+
require 'time'
|
|
1715
|
+
require 'VoucherifySdk'
|
|
1716
|
+
# setup authorization
|
|
1717
|
+
VoucherifySdk.configure do |config|
|
|
1718
|
+
# Configure API key authorization: X-App-Id
|
|
1719
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1720
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1721
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1722
|
+
|
|
1723
|
+
# Configure API key authorization: X-App-Token
|
|
1724
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1725
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1726
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1727
|
+
end
|
|
1728
|
+
|
|
1729
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1730
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1731
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
1732
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
1733
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
1734
|
+
opts = {
|
|
1735
|
+
filters: VoucherifySdk::EarningRulesReportListFilters.new # EarningRulesReportListFilters | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1736
|
+
}
|
|
1737
|
+
|
|
1738
|
+
begin
|
|
1739
|
+
# List program earning-rules daily reports
|
|
1740
|
+
result = api_instance.list_program_earning_rules_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
1741
|
+
p result
|
|
1742
|
+
rescue VoucherifySdk::ApiError => e
|
|
1743
|
+
puts "Error when calling LV2ProgramsApi->list_program_earning_rules_daily_reports: #{e}"
|
|
1744
|
+
end
|
|
1745
|
+
```
|
|
1746
|
+
|
|
1747
|
+
### Parameters
|
|
1748
|
+
|
|
1749
|
+
| Name | Type | Description | Notes |
|
|
1750
|
+
| ---- | ---- | ----------- | ----- |
|
|
1751
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1752
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
1753
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
1754
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
1755
|
+
| **filters** | [**EarningRulesReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1756
|
+
|
|
1757
|
+
### Return type
|
|
1758
|
+
|
|
1759
|
+
[**V2LoyaltiesProgramsReportsEarningRulesDailyListResponseBody**](V2LoyaltiesProgramsReportsEarningRulesDailyListResponseBody.md)
|
|
1760
|
+
|
|
1761
|
+
### Authorization
|
|
1762
|
+
|
|
1763
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1764
|
+
|
|
1765
|
+
### HTTP request headers
|
|
1766
|
+
|
|
1767
|
+
- **Content-Type**: Not defined
|
|
1768
|
+
- **Accept**: application/json
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
## list_program_earning_rules_summary_reports
|
|
1772
|
+
|
|
1773
|
+
> <V2LoyaltiesProgramsReportsEarningRulesSummaryListResponseBody> list_program_earning_rules_summary_reports(program_id, opts)
|
|
1774
|
+
|
|
1775
|
+
List program earning-rules summary reports
|
|
1776
|
+
|
|
1777
|
+
Returns total earning-rule evaluation statistics for the program (all time), optionally filtered by earning rule. Includes success and failure counts with a failures breakdown. Each entry counts eligibility checks for one earning rule. Returns at most 100 rows, ordered by id descending. limit and order are not query parameters. A filter that matches no rows returns an empty data array. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
1778
|
+
|
|
1779
|
+
### Examples
|
|
1780
|
+
|
|
1781
|
+
```ruby
|
|
1782
|
+
require 'time'
|
|
1783
|
+
require 'VoucherifySdk'
|
|
1784
|
+
# setup authorization
|
|
1785
|
+
VoucherifySdk.configure do |config|
|
|
1786
|
+
# Configure API key authorization: X-App-Id
|
|
1787
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1788
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1789
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1790
|
+
|
|
1791
|
+
# Configure API key authorization: X-App-Token
|
|
1792
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1793
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1794
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1795
|
+
end
|
|
1796
|
+
|
|
1797
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1798
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1799
|
+
opts = {
|
|
1800
|
+
filters: VoucherifySdk::EarningRulesReportListFilters.new # EarningRulesReportListFilters | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1801
|
+
}
|
|
1802
|
+
|
|
1803
|
+
begin
|
|
1804
|
+
# List program earning-rules summary reports
|
|
1805
|
+
result = api_instance.list_program_earning_rules_summary_reports(program_id, opts)
|
|
1806
|
+
p result
|
|
1807
|
+
rescue VoucherifySdk::ApiError => e
|
|
1808
|
+
puts "Error when calling LV2ProgramsApi->list_program_earning_rules_summary_reports: #{e}"
|
|
1809
|
+
end
|
|
1810
|
+
```
|
|
1811
|
+
|
|
1812
|
+
### Parameters
|
|
1813
|
+
|
|
1814
|
+
| Name | Type | Description | Notes |
|
|
1815
|
+
| ---- | ---- | ----------- | ----- |
|
|
1816
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1817
|
+
| **filters** | [**EarningRulesReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[earning_rule_id][conditions][$is] lern_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1818
|
+
|
|
1819
|
+
### Return type
|
|
1820
|
+
|
|
1821
|
+
[**V2LoyaltiesProgramsReportsEarningRulesSummaryListResponseBody**](V2LoyaltiesProgramsReportsEarningRulesSummaryListResponseBody.md)
|
|
1822
|
+
|
|
1823
|
+
### Authorization
|
|
1824
|
+
|
|
1825
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1826
|
+
|
|
1827
|
+
### HTTP request headers
|
|
1828
|
+
|
|
1829
|
+
- **Content-Type**: Not defined
|
|
1830
|
+
- **Accept**: application/json
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
## list_program_member_activities
|
|
1834
|
+
|
|
1835
|
+
> <V2LoyaltiesProgramsMembersActivitiesListResponseBody> list_program_member_activities(program_id, member_id, opts)
|
|
1836
|
+
|
|
1837
|
+
List program member activities
|
|
1838
|
+
|
|
1839
|
+
Returns a cursor-paginated list of lifecycle and card-assignment activities recorded for the member. Filters are id, type, and created_at. Default order is -created_at, then id ascending. Returns 404 when the program doesnt exist, or when the member doesnt exist in that program. The program is checked first. A DELETED member returns 404. Returns 400 with key invalid_query_params when the query fails validation. That check runs before the program and member lookup. A cursor that doesnt match ^lcrsambr_[a-f0-9]+$, a limit outside 1 to 100, an order other than created_at or -created_at, or an array that orders by both directions fails here. After the program and member are found, an unknown or expired cursor returns invalid_or_expired_cursor. A cursor recorded for different filters or order returns cursor_and_query_mismatch. The cursor stays valid when only limit changes.
|
|
1840
|
+
|
|
1841
|
+
### Examples
|
|
1842
|
+
|
|
1843
|
+
```ruby
|
|
1844
|
+
require 'time'
|
|
1845
|
+
require 'VoucherifySdk'
|
|
1846
|
+
# setup authorization
|
|
1847
|
+
VoucherifySdk.configure do |config|
|
|
1848
|
+
# Configure API key authorization: X-App-Id
|
|
1849
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1850
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1851
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1852
|
+
|
|
1853
|
+
# Configure API key authorization: X-App-Token
|
|
1854
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1855
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1856
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1857
|
+
end
|
|
1858
|
+
|
|
1859
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1860
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1861
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
1862
|
+
opts = {
|
|
1863
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1864
|
+
order: 'created_at', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
1865
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsambr_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1866
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersActivitiesListRequestQueryFilters.new # V2LoyaltiesProgramsMembersActivitiesListRequestQueryFilters | Filters the results. Pass a deep object, for example filters[type][conditions][$is] vl.member.created. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1867
|
+
}
|
|
1868
|
+
|
|
1869
|
+
begin
|
|
1870
|
+
# List program member activities
|
|
1871
|
+
result = api_instance.list_program_member_activities(program_id, member_id, opts)
|
|
1872
|
+
p result
|
|
1873
|
+
rescue VoucherifySdk::ApiError => e
|
|
1874
|
+
puts "Error when calling LV2ProgramsApi->list_program_member_activities: #{e}"
|
|
1875
|
+
end
|
|
1876
|
+
```
|
|
1877
|
+
|
|
1878
|
+
### Parameters
|
|
1879
|
+
|
|
1880
|
+
| Name | Type | Description | Notes |
|
|
1881
|
+
| ---- | ---- | ----------- | ----- |
|
|
1882
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1883
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
1884
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1885
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
1886
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsambr_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1887
|
+
| **filters** | [**V2LoyaltiesProgramsMembersActivitiesListRequestQueryFilters**](.md) | Filters the results. Pass a deep object, for example filters[type][conditions][$is] vl.member.created. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1888
|
+
|
|
1889
|
+
### Return type
|
|
1890
|
+
|
|
1891
|
+
[**V2LoyaltiesProgramsMembersActivitiesListResponseBody**](V2LoyaltiesProgramsMembersActivitiesListResponseBody.md)
|
|
1892
|
+
|
|
1893
|
+
### Authorization
|
|
1894
|
+
|
|
1895
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1896
|
+
|
|
1897
|
+
### HTTP request headers
|
|
1898
|
+
|
|
1899
|
+
- **Content-Type**: Not defined
|
|
1900
|
+
- **Accept**: application/json
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
## list_program_members
|
|
1904
|
+
|
|
1905
|
+
> <V2LoyaltiesProgramsMembersListResponseBody> list_program_members(program_id, opts)
|
|
1906
|
+
|
|
1907
|
+
List program members
|
|
1908
|
+
|
|
1909
|
+
Returns a cursor-paginated list of members of the program. Deleted members are omitted. Results can be filtered by ID, status, customer ID and creation date. Results can be ordered by creation date, status, or customer ID (ascending or descending). The same field cannot be ordered both ascending and descending at the same time. Returns 404 when the program does not exist. List items do not include the cards array. Use the following endpoints to retrieve cards for a given member: - [Get customer memberships](/api-reference/programs/get-customer-memberships), - [Get program member](/api-reference/programs/get-program-member), - [Get program membership](/api-reference/programs/get-program-membership).
|
|
1910
|
+
|
|
1911
|
+
### Examples
|
|
1912
|
+
|
|
1913
|
+
```ruby
|
|
1914
|
+
require 'time'
|
|
1915
|
+
require 'VoucherifySdk'
|
|
1916
|
+
# setup authorization
|
|
1917
|
+
VoucherifySdk.configure do |config|
|
|
1918
|
+
# Configure API key authorization: X-App-Id
|
|
1919
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1920
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1921
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1922
|
+
|
|
1923
|
+
# Configure API key authorization: X-App-Token
|
|
1924
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1925
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1926
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1927
|
+
end
|
|
1928
|
+
|
|
1929
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1930
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1931
|
+
opts = {
|
|
1932
|
+
limit: 56, # Integer | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
1933
|
+
order: '-created_at', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
1934
|
+
cursor: 'cursor_example', # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsmbr_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
1935
|
+
filters: VoucherifySdk::V2LoyaltiesProgramsMembersListRequestQuery.new # V2LoyaltiesProgramsMembersListRequestQuery | Filters the results. Pass a deep object, for example filters[status][conditions][$is] ACTIVE. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
1936
|
+
}
|
|
1937
|
+
|
|
1938
|
+
begin
|
|
1939
|
+
# List program members
|
|
1940
|
+
result = api_instance.list_program_members(program_id, opts)
|
|
1941
|
+
p result
|
|
1942
|
+
rescue VoucherifySdk::ApiError => e
|
|
1943
|
+
puts "Error when calling LV2ProgramsApi->list_program_members: #{e}"
|
|
1944
|
+
end
|
|
1945
|
+
```
|
|
1946
|
+
|
|
1947
|
+
### Parameters
|
|
1948
|
+
|
|
1949
|
+
| Name | Type | Description | Notes |
|
|
1950
|
+
| ---- | ---- | ----------- | ----- |
|
|
1951
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
1952
|
+
| **limit** | **Integer** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to 10] |
|
|
1953
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
1954
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsmbr_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
1955
|
+
| **filters** | [**V2LoyaltiesProgramsMembersListRequestQuery**](.md) | Filters the results. Pass a deep object, for example filters[status][conditions][$is] ACTIVE. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
1956
|
+
|
|
1957
|
+
### Return type
|
|
1958
|
+
|
|
1959
|
+
[**V2LoyaltiesProgramsMembersListResponseBody**](V2LoyaltiesProgramsMembersListResponseBody.md)
|
|
1960
|
+
|
|
1961
|
+
### Authorization
|
|
1962
|
+
|
|
1963
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1964
|
+
|
|
1965
|
+
### HTTP request headers
|
|
1966
|
+
|
|
1967
|
+
- **Content-Type**: Not defined
|
|
1968
|
+
- **Accept**: application/json
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
## list_program_members_daily_reports
|
|
1972
|
+
|
|
1973
|
+
> <LoyaltiesProgramsReportsMembersDailyListResponseBody> list_program_members_daily_reports(program_id, start_date, end_date, resolution)
|
|
1974
|
+
|
|
1975
|
+
List program members daily reports
|
|
1976
|
+
|
|
1977
|
+
Returns member and card changes for the program over the given date range and resolution. Each row covers one period with recorded activity. Periods without activity are omitted. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
1978
|
+
|
|
1979
|
+
### Examples
|
|
1980
|
+
|
|
1981
|
+
```ruby
|
|
1982
|
+
require 'time'
|
|
1983
|
+
require 'VoucherifySdk'
|
|
1984
|
+
# setup authorization
|
|
1985
|
+
VoucherifySdk.configure do |config|
|
|
1986
|
+
# Configure API key authorization: X-App-Id
|
|
1987
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1988
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1989
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1990
|
+
|
|
1991
|
+
# Configure API key authorization: X-App-Token
|
|
1992
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1993
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1994
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1995
|
+
end
|
|
1996
|
+
|
|
1997
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
1998
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
1999
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
2000
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
2001
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
2002
|
+
|
|
2003
|
+
begin
|
|
2004
|
+
# List program members daily reports
|
|
2005
|
+
result = api_instance.list_program_members_daily_reports(program_id, start_date, end_date, resolution)
|
|
2006
|
+
p result
|
|
2007
|
+
rescue VoucherifySdk::ApiError => e
|
|
2008
|
+
puts "Error when calling LV2ProgramsApi->list_program_members_daily_reports: #{e}"
|
|
2009
|
+
end
|
|
2010
|
+
```
|
|
2011
|
+
|
|
2012
|
+
### Parameters
|
|
2013
|
+
|
|
2014
|
+
| Name | Type | Description | Notes |
|
|
2015
|
+
| ---- | ---- | ----------- | ----- |
|
|
2016
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2017
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
2018
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
2019
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
2020
|
+
|
|
2021
|
+
### Return type
|
|
2022
|
+
|
|
2023
|
+
[**LoyaltiesProgramsReportsMembersDailyListResponseBody**](LoyaltiesProgramsReportsMembersDailyListResponseBody.md)
|
|
2024
|
+
|
|
2025
|
+
### Authorization
|
|
2026
|
+
|
|
2027
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2028
|
+
|
|
2029
|
+
### HTTP request headers
|
|
2030
|
+
|
|
2031
|
+
- **Content-Type**: Not defined
|
|
2032
|
+
- **Accept**: application/json
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
## list_program_members_summary_reports
|
|
2036
|
+
|
|
2037
|
+
> <LoyaltiesProgramsReportsMembersSummaryListResponseBody> list_program_members_summary_reports(program_id)
|
|
2038
|
+
|
|
2039
|
+
List program members summary reports
|
|
2040
|
+
|
|
2041
|
+
Returns all-time member and card totals for the program. The response contains one row when activity was recorded, and an empty data array otherwise. limit and order are not query parameters. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2042
|
+
|
|
2043
|
+
### Examples
|
|
2044
|
+
|
|
2045
|
+
```ruby
|
|
2046
|
+
require 'time'
|
|
2047
|
+
require 'VoucherifySdk'
|
|
2048
|
+
# setup authorization
|
|
2049
|
+
VoucherifySdk.configure do |config|
|
|
2050
|
+
# Configure API key authorization: X-App-Id
|
|
2051
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2052
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2053
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2054
|
+
|
|
2055
|
+
# Configure API key authorization: X-App-Token
|
|
2056
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2057
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2058
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2059
|
+
end
|
|
2060
|
+
|
|
2061
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2062
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2063
|
+
|
|
2064
|
+
begin
|
|
2065
|
+
# List program members summary reports
|
|
2066
|
+
result = api_instance.list_program_members_summary_reports(program_id)
|
|
2067
|
+
p result
|
|
2068
|
+
rescue VoucherifySdk::ApiError => e
|
|
2069
|
+
puts "Error when calling LV2ProgramsApi->list_program_members_summary_reports: #{e}"
|
|
2070
|
+
end
|
|
2071
|
+
```
|
|
2072
|
+
|
|
2073
|
+
### Parameters
|
|
2074
|
+
|
|
2075
|
+
| Name | Type | Description | Notes |
|
|
2076
|
+
| ---- | ---- | ----------- | ----- |
|
|
2077
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2078
|
+
|
|
2079
|
+
### Return type
|
|
2080
|
+
|
|
2081
|
+
[**LoyaltiesProgramsReportsMembersSummaryListResponseBody**](LoyaltiesProgramsReportsMembersSummaryListResponseBody.md)
|
|
2082
|
+
|
|
2083
|
+
### Authorization
|
|
2084
|
+
|
|
2085
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2086
|
+
|
|
2087
|
+
### HTTP request headers
|
|
2088
|
+
|
|
2089
|
+
- **Content-Type**: Not defined
|
|
2090
|
+
- **Accept**: application/json
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
## list_program_reward_assignments
|
|
2094
|
+
|
|
2095
|
+
> <V2LoyaltiesProgramsRewardsListResponseBody> list_program_reward_assignments(program_id, opts)
|
|
2096
|
+
|
|
2097
|
+
List program reward assignments
|
|
2098
|
+
|
|
2099
|
+
Returns a cursor-paginated list of rewards assigned to the program, including their stock configuration and redemption counters.
|
|
2100
|
+
|
|
2101
|
+
### Examples
|
|
2102
|
+
|
|
2103
|
+
```ruby
|
|
2104
|
+
require 'time'
|
|
2105
|
+
require 'VoucherifySdk'
|
|
2106
|
+
# setup authorization
|
|
2107
|
+
VoucherifySdk.configure do |config|
|
|
2108
|
+
# Configure API key authorization: X-App-Id
|
|
2109
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2110
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2111
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2112
|
+
|
|
2113
|
+
# Configure API key authorization: X-App-Token
|
|
2114
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2115
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2116
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2117
|
+
end
|
|
2118
|
+
|
|
2119
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2120
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2121
|
+
opts = {
|
|
2122
|
+
limit: 'limit_example', # String | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
2123
|
+
order: '-created_at', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
2124
|
+
cursor: 'cursor_example' # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsrewa_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
2125
|
+
}
|
|
2126
|
+
|
|
2127
|
+
begin
|
|
2128
|
+
# List program reward assignments
|
|
2129
|
+
result = api_instance.list_program_reward_assignments(program_id, opts)
|
|
2130
|
+
p result
|
|
2131
|
+
rescue VoucherifySdk::ApiError => e
|
|
2132
|
+
puts "Error when calling LV2ProgramsApi->list_program_reward_assignments: #{e}"
|
|
2133
|
+
end
|
|
2134
|
+
```
|
|
2135
|
+
|
|
2136
|
+
### Parameters
|
|
2137
|
+
|
|
2138
|
+
| Name | Type | Description | Notes |
|
|
2139
|
+
| ---- | ---- | ----------- | ----- |
|
|
2140
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2141
|
+
| **limit** | **String** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to '10'] |
|
|
2142
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
2143
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrsrewa_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
2144
|
+
|
|
2145
|
+
### Return type
|
|
2146
|
+
|
|
2147
|
+
[**V2LoyaltiesProgramsRewardsListResponseBody**](V2LoyaltiesProgramsRewardsListResponseBody.md)
|
|
2148
|
+
|
|
2149
|
+
### Authorization
|
|
2150
|
+
|
|
2151
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2152
|
+
|
|
2153
|
+
### HTTP request headers
|
|
2154
|
+
|
|
2155
|
+
- **Content-Type**: Not defined
|
|
2156
|
+
- **Accept**: application/json
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
## list_program_rewards_daily_reports
|
|
2160
|
+
|
|
2161
|
+
> <LoyaltiesProgramsReportsRewardsDailyListResponseBody> list_program_rewards_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2162
|
+
|
|
2163
|
+
List program rewards daily reports
|
|
2164
|
+
|
|
2165
|
+
Returns aggregated reward-purchase statistics for the program over the given date range and resolution, optionally filtered by reward. Each row covers one reward and one period with recorded purchases. Periods without recorded purchases are omitted. failures_breakdown is always an empty object. A filter that matches no rows returns an empty data array. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2166
|
+
|
|
2167
|
+
### Examples
|
|
2168
|
+
|
|
2169
|
+
```ruby
|
|
2170
|
+
require 'time'
|
|
2171
|
+
require 'VoucherifySdk'
|
|
2172
|
+
# setup authorization
|
|
2173
|
+
VoucherifySdk.configure do |config|
|
|
2174
|
+
# Configure API key authorization: X-App-Id
|
|
2175
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2176
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2177
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2178
|
+
|
|
2179
|
+
# Configure API key authorization: X-App-Token
|
|
2180
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2181
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2182
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2183
|
+
end
|
|
2184
|
+
|
|
2185
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2186
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2187
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
2188
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
2189
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
2190
|
+
opts = {
|
|
2191
|
+
filters: VoucherifySdk::RewardsReportListFilters.new # RewardsReportListFilters | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2192
|
+
}
|
|
2193
|
+
|
|
2194
|
+
begin
|
|
2195
|
+
# List program rewards daily reports
|
|
2196
|
+
result = api_instance.list_program_rewards_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2197
|
+
p result
|
|
2198
|
+
rescue VoucherifySdk::ApiError => e
|
|
2199
|
+
puts "Error when calling LV2ProgramsApi->list_program_rewards_daily_reports: #{e}"
|
|
2200
|
+
end
|
|
2201
|
+
```
|
|
2202
|
+
|
|
2203
|
+
### Parameters
|
|
2204
|
+
|
|
2205
|
+
| Name | Type | Description | Notes |
|
|
2206
|
+
| ---- | ---- | ----------- | ----- |
|
|
2207
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2208
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
2209
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
2210
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
2211
|
+
| **filters** | [**RewardsReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2212
|
+
|
|
2213
|
+
### Return type
|
|
2214
|
+
|
|
2215
|
+
[**LoyaltiesProgramsReportsRewardsDailyListResponseBody**](LoyaltiesProgramsReportsRewardsDailyListResponseBody.md)
|
|
2216
|
+
|
|
2217
|
+
### Authorization
|
|
2218
|
+
|
|
2219
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2220
|
+
|
|
2221
|
+
### HTTP request headers
|
|
2222
|
+
|
|
2223
|
+
- **Content-Type**: Not defined
|
|
2224
|
+
- **Accept**: application/json
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
## list_program_rewards_spendings_daily_reports
|
|
2228
|
+
|
|
2229
|
+
> <LoyaltiesProgramsReportsRewardsSpendingsDailyListResponseBody> list_program_rewards_spendings_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2230
|
+
|
|
2231
|
+
List program rewards spendings daily reports
|
|
2232
|
+
|
|
2233
|
+
Returns aggregated points spent on reward purchases for the program over the given date range and resolution. Each row covers one reward, reward cost, reward spending, card definition, and period with an approved point spend. Periods without an approved point spend are omitted. Optionally filters by reward, cost, spending, and card definition. A filter that matches no rows returns an empty data array. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2234
|
+
|
|
2235
|
+
### Examples
|
|
2236
|
+
|
|
2237
|
+
```ruby
|
|
2238
|
+
require 'time'
|
|
2239
|
+
require 'VoucherifySdk'
|
|
2240
|
+
# setup authorization
|
|
2241
|
+
VoucherifySdk.configure do |config|
|
|
2242
|
+
# Configure API key authorization: X-App-Id
|
|
2243
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2244
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2245
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2246
|
+
|
|
2247
|
+
# Configure API key authorization: X-App-Token
|
|
2248
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2249
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2250
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2251
|
+
end
|
|
2252
|
+
|
|
2253
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2254
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2255
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
2256
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
2257
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
2258
|
+
opts = {
|
|
2259
|
+
filters: VoucherifySdk::RewardsSpendingsReportListFilters.new # RewardsSpendingsReportListFilters | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2260
|
+
}
|
|
2261
|
+
|
|
2262
|
+
begin
|
|
2263
|
+
# List program rewards spendings daily reports
|
|
2264
|
+
result = api_instance.list_program_rewards_spendings_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2265
|
+
p result
|
|
2266
|
+
rescue VoucherifySdk::ApiError => e
|
|
2267
|
+
puts "Error when calling LV2ProgramsApi->list_program_rewards_spendings_daily_reports: #{e}"
|
|
2268
|
+
end
|
|
2269
|
+
```
|
|
2270
|
+
|
|
2271
|
+
### Parameters
|
|
2272
|
+
|
|
2273
|
+
| Name | Type | Description | Notes |
|
|
2274
|
+
| ---- | ---- | ----------- | ----- |
|
|
2275
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2276
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
2277
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
2278
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
2279
|
+
| **filters** | [**RewardsSpendingsReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2280
|
+
|
|
2281
|
+
### Return type
|
|
2282
|
+
|
|
2283
|
+
[**LoyaltiesProgramsReportsRewardsSpendingsDailyListResponseBody**](LoyaltiesProgramsReportsRewardsSpendingsDailyListResponseBody.md)
|
|
2284
|
+
|
|
2285
|
+
### Authorization
|
|
2286
|
+
|
|
2287
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2288
|
+
|
|
2289
|
+
### HTTP request headers
|
|
2290
|
+
|
|
2291
|
+
- **Content-Type**: Not defined
|
|
2292
|
+
- **Accept**: application/json
|
|
2293
|
+
|
|
2294
|
+
|
|
2295
|
+
## list_program_rewards_spendings_summary_reports
|
|
2296
|
+
|
|
2297
|
+
> <LoyaltiesProgramsReportsRewardsSpendingsSummaryListResponseBody> list_program_rewards_spendings_summary_reports(program_id, opts)
|
|
2298
|
+
|
|
2299
|
+
List program rewards spendings summary reports
|
|
2300
|
+
|
|
2301
|
+
Returns all-time points spent on reward purchases for the program. Each row covers one reward, reward cost, reward spending, and card definition with an approved point spend. Filters rows by reward, cost, spending, and card definition. Returns at most 100 rows, ordered by id descending. limit and order are not query parameters. A filter that matches no rows returns an empty data array. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2302
|
+
|
|
2303
|
+
### Examples
|
|
2304
|
+
|
|
2305
|
+
```ruby
|
|
2306
|
+
require 'time'
|
|
2307
|
+
require 'VoucherifySdk'
|
|
2308
|
+
# setup authorization
|
|
2309
|
+
VoucherifySdk.configure do |config|
|
|
2310
|
+
# Configure API key authorization: X-App-Id
|
|
2311
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2312
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2313
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2314
|
+
|
|
2315
|
+
# Configure API key authorization: X-App-Token
|
|
2316
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2317
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2318
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2319
|
+
end
|
|
2320
|
+
|
|
2321
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2322
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2323
|
+
opts = {
|
|
2324
|
+
filters: VoucherifySdk::RewardsSpendingsReportListFilters.new # RewardsSpendingsReportListFilters | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2325
|
+
}
|
|
2326
|
+
|
|
2327
|
+
begin
|
|
2328
|
+
# List program rewards spendings summary reports
|
|
2329
|
+
result = api_instance.list_program_rewards_spendings_summary_reports(program_id, opts)
|
|
2330
|
+
p result
|
|
2331
|
+
rescue VoucherifySdk::ApiError => e
|
|
2332
|
+
puts "Error when calling LV2ProgramsApi->list_program_rewards_spendings_summary_reports: #{e}"
|
|
2333
|
+
end
|
|
2334
|
+
```
|
|
2335
|
+
|
|
2336
|
+
### Parameters
|
|
2337
|
+
|
|
2338
|
+
| Name | Type | Description | Notes |
|
|
2339
|
+
| ---- | ---- | ----------- | ----- |
|
|
2340
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2341
|
+
| **filters** | [**RewardsSpendingsReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2342
|
+
|
|
2343
|
+
### Return type
|
|
2344
|
+
|
|
2345
|
+
[**LoyaltiesProgramsReportsRewardsSpendingsSummaryListResponseBody**](LoyaltiesProgramsReportsRewardsSpendingsSummaryListResponseBody.md)
|
|
2346
|
+
|
|
2347
|
+
### Authorization
|
|
2348
|
+
|
|
2349
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2350
|
+
|
|
2351
|
+
### HTTP request headers
|
|
2352
|
+
|
|
2353
|
+
- **Content-Type**: Not defined
|
|
2354
|
+
- **Accept**: application/json
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
## list_program_rewards_summary_reports
|
|
2358
|
+
|
|
2359
|
+
> <LoyaltiesProgramsReportsRewardsSummaryListResponseBody> list_program_rewards_summary_reports(program_id, opts)
|
|
2360
|
+
|
|
2361
|
+
List program rewards summary reports
|
|
2362
|
+
|
|
2363
|
+
Returns all-time reward-purchase totals for the program, one row per reward with a recorded purchase attempt. Filters rows with filters[reward_id]. Returns at most 100 rows, ordered by id descending. limit and order are not query parameters. A filter that matches no rows returns an empty data array. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2364
|
+
|
|
2365
|
+
### Examples
|
|
2366
|
+
|
|
2367
|
+
```ruby
|
|
2368
|
+
require 'time'
|
|
2369
|
+
require 'VoucherifySdk'
|
|
2370
|
+
# setup authorization
|
|
2371
|
+
VoucherifySdk.configure do |config|
|
|
2372
|
+
# Configure API key authorization: X-App-Id
|
|
2373
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2374
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2375
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2376
|
+
|
|
2377
|
+
# Configure API key authorization: X-App-Token
|
|
2378
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2379
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2380
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2381
|
+
end
|
|
2382
|
+
|
|
2383
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2384
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2385
|
+
opts = {
|
|
2386
|
+
filters: VoucherifySdk::RewardsReportListFilters.new # RewardsReportListFilters | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2387
|
+
}
|
|
2388
|
+
|
|
2389
|
+
begin
|
|
2390
|
+
# List program rewards summary reports
|
|
2391
|
+
result = api_instance.list_program_rewards_summary_reports(program_id, opts)
|
|
2392
|
+
p result
|
|
2393
|
+
rescue VoucherifySdk::ApiError => e
|
|
2394
|
+
puts "Error when calling LV2ProgramsApi->list_program_rewards_summary_reports: #{e}"
|
|
2395
|
+
end
|
|
2396
|
+
```
|
|
2397
|
+
|
|
2398
|
+
### Parameters
|
|
2399
|
+
|
|
2400
|
+
| Name | Type | Description | Notes |
|
|
2401
|
+
| ---- | ---- | ----------- | ----- |
|
|
2402
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2403
|
+
| **filters** | [**RewardsReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[reward_id][conditions][$is] lrew_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2404
|
+
|
|
2405
|
+
### Return type
|
|
2406
|
+
|
|
2407
|
+
[**LoyaltiesProgramsReportsRewardsSummaryListResponseBody**](LoyaltiesProgramsReportsRewardsSummaryListResponseBody.md)
|
|
2408
|
+
|
|
2409
|
+
### Authorization
|
|
2410
|
+
|
|
2411
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2412
|
+
|
|
2413
|
+
### HTTP request headers
|
|
2414
|
+
|
|
2415
|
+
- **Content-Type**: Not defined
|
|
2416
|
+
- **Accept**: application/json
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
## list_program_spending_daily_reports
|
|
2420
|
+
|
|
2421
|
+
> <LoyaltiesProgramsReportsSpendingDailyListResponseBody> list_program_spending_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2422
|
+
|
|
2423
|
+
List program spending daily reports
|
|
2424
|
+
|
|
2425
|
+
Returns aggregated points-spending statistics for the program over the given date range and resolution. Each row covers one card definition and one period with recorded spending. Periods without recorded spending are omitted. Optionally filters by card definition. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2426
|
+
|
|
2427
|
+
### Examples
|
|
2428
|
+
|
|
2429
|
+
```ruby
|
|
2430
|
+
require 'time'
|
|
2431
|
+
require 'VoucherifySdk'
|
|
2432
|
+
# setup authorization
|
|
2433
|
+
VoucherifySdk.configure do |config|
|
|
2434
|
+
# Configure API key authorization: X-App-Id
|
|
2435
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2436
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2437
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2438
|
+
|
|
2439
|
+
# Configure API key authorization: X-App-Token
|
|
2440
|
+
config.api_key['X-App-Token'] = '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-Token'] = 'Bearer'
|
|
2443
|
+
end
|
|
2444
|
+
|
|
2445
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2446
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2447
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
2448
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
2449
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
2450
|
+
opts = {
|
|
2451
|
+
filters: VoucherifySdk::SpendingReportListFilters.new # SpendingReportListFilters | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2452
|
+
}
|
|
2453
|
+
|
|
2454
|
+
begin
|
|
2455
|
+
# List program spending daily reports
|
|
2456
|
+
result = api_instance.list_program_spending_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2457
|
+
p result
|
|
2458
|
+
rescue VoucherifySdk::ApiError => e
|
|
2459
|
+
puts "Error when calling LV2ProgramsApi->list_program_spending_daily_reports: #{e}"
|
|
2460
|
+
end
|
|
2461
|
+
```
|
|
2462
|
+
|
|
2463
|
+
### Parameters
|
|
2464
|
+
|
|
2465
|
+
| Name | Type | Description | Notes |
|
|
2466
|
+
| ---- | ---- | ----------- | ----- |
|
|
2467
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2468
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
2469
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
2470
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
2471
|
+
| **filters** | [**SpendingReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2472
|
+
|
|
2473
|
+
### Return type
|
|
2474
|
+
|
|
2475
|
+
[**LoyaltiesProgramsReportsSpendingDailyListResponseBody**](LoyaltiesProgramsReportsSpendingDailyListResponseBody.md)
|
|
2476
|
+
|
|
2477
|
+
### Authorization
|
|
2478
|
+
|
|
2479
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2480
|
+
|
|
2481
|
+
### HTTP request headers
|
|
2482
|
+
|
|
2483
|
+
- **Content-Type**: Not defined
|
|
2484
|
+
- **Accept**: application/json
|
|
2485
|
+
|
|
2486
|
+
|
|
2487
|
+
## list_program_spending_summary_reports
|
|
2488
|
+
|
|
2489
|
+
> <LoyaltiesProgramsReportsSpendingSummaryListResponseBody> list_program_spending_summary_reports(program_id, opts)
|
|
2490
|
+
|
|
2491
|
+
List program spending summary reports
|
|
2492
|
+
|
|
2493
|
+
Returns all-time point-spending totals for the program, one row per card definition that has recorded spending. Filters rows with filters[card_definition_id]. Returns at most 10 rows (max number of card definitions per program), ordered by id descending. limit and order are not query parameters. Returns 200 with an empty data array when no spending is recorded. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2494
|
+
|
|
2495
|
+
### Examples
|
|
2496
|
+
|
|
2497
|
+
```ruby
|
|
2498
|
+
require 'time'
|
|
2499
|
+
require 'VoucherifySdk'
|
|
2500
|
+
# setup authorization
|
|
2501
|
+
VoucherifySdk.configure do |config|
|
|
2502
|
+
# Configure API key authorization: X-App-Id
|
|
2503
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2504
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2505
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2506
|
+
|
|
2507
|
+
# Configure API key authorization: X-App-Token
|
|
2508
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2509
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2510
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2511
|
+
end
|
|
2512
|
+
|
|
2513
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2514
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2515
|
+
opts = {
|
|
2516
|
+
filters: VoucherifySdk::SpendingReportListFilters.new # SpendingReportListFilters | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2517
|
+
}
|
|
2518
|
+
|
|
2519
|
+
begin
|
|
2520
|
+
# List program spending summary reports
|
|
2521
|
+
result = api_instance.list_program_spending_summary_reports(program_id, opts)
|
|
2522
|
+
p result
|
|
2523
|
+
rescue VoucherifySdk::ApiError => e
|
|
2524
|
+
puts "Error when calling LV2ProgramsApi->list_program_spending_summary_reports: #{e}"
|
|
2525
|
+
end
|
|
2526
|
+
```
|
|
2527
|
+
|
|
2528
|
+
### Parameters
|
|
2529
|
+
|
|
2530
|
+
| Name | Type | Description | Notes |
|
|
2531
|
+
| ---- | ---- | ----------- | ----- |
|
|
2532
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2533
|
+
| **filters** | [**SpendingReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is] lcdef_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2534
|
+
|
|
2535
|
+
### Return type
|
|
2536
|
+
|
|
2537
|
+
[**LoyaltiesProgramsReportsSpendingSummaryListResponseBody**](LoyaltiesProgramsReportsSpendingSummaryListResponseBody.md)
|
|
2538
|
+
|
|
2539
|
+
### Authorization
|
|
2540
|
+
|
|
2541
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2542
|
+
|
|
2543
|
+
### HTTP request headers
|
|
2544
|
+
|
|
2545
|
+
- **Content-Type**: Not defined
|
|
2546
|
+
- **Accept**: application/json
|
|
2547
|
+
|
|
2548
|
+
|
|
2549
|
+
## list_program_tier_structure_assignments
|
|
2550
|
+
|
|
2551
|
+
> <V2LoyaltiesProgramsTierStructuresListResponseBody> list_program_tier_structure_assignments(program_id, opts)
|
|
2552
|
+
|
|
2553
|
+
List program tier structure assignments
|
|
2554
|
+
|
|
2555
|
+
Returns a cursor-paginated list of tier structures assigned to the program. Currently, a program can have only one tier structure assigned.
|
|
2556
|
+
|
|
2557
|
+
### Examples
|
|
2558
|
+
|
|
2559
|
+
```ruby
|
|
2560
|
+
require 'time'
|
|
2561
|
+
require 'VoucherifySdk'
|
|
2562
|
+
# setup authorization
|
|
2563
|
+
VoucherifySdk.configure do |config|
|
|
2564
|
+
# Configure API key authorization: X-App-Id
|
|
2565
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2566
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2567
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2568
|
+
|
|
2569
|
+
# Configure API key authorization: X-App-Token
|
|
2570
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2571
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2572
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2573
|
+
end
|
|
2574
|
+
|
|
2575
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2576
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2577
|
+
opts = {
|
|
2578
|
+
limit: 'limit_example', # String | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.
|
|
2579
|
+
order: '-created_at', # String | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.
|
|
2580
|
+
cursor: 'cursor_example' # String | Continues pagination. Pass the cursor.next value from a previous response. Format lcrstsa_[a-f0-9]+. The cursor matches the filters and order of that response.
|
|
2581
|
+
}
|
|
2582
|
+
|
|
2583
|
+
begin
|
|
2584
|
+
# List program tier structure assignments
|
|
2585
|
+
result = api_instance.list_program_tier_structure_assignments(program_id, opts)
|
|
2586
|
+
p result
|
|
2587
|
+
rescue VoucherifySdk::ApiError => e
|
|
2588
|
+
puts "Error when calling LV2ProgramsApi->list_program_tier_structure_assignments: #{e}"
|
|
2589
|
+
end
|
|
2590
|
+
```
|
|
2591
|
+
|
|
2592
|
+
### Parameters
|
|
2593
|
+
|
|
2594
|
+
| Name | Type | Description | Notes |
|
|
2595
|
+
| ---- | ---- | ----------- | ----- |
|
|
2596
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2597
|
+
| **limit** | **String** | Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer. | [optional][default to '10'] |
|
|
2598
|
+
| **order** | **String** | Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending. | [optional] |
|
|
2599
|
+
| **cursor** | **String** | Continues pagination. Pass the cursor.next value from a previous response. Format lcrstsa_[a-f0-9]+. The cursor matches the filters and order of that response. | [optional] |
|
|
2600
|
+
|
|
2601
|
+
### Return type
|
|
2602
|
+
|
|
2603
|
+
[**V2LoyaltiesProgramsTierStructuresListResponseBody**](V2LoyaltiesProgramsTierStructuresListResponseBody.md)
|
|
2604
|
+
|
|
2605
|
+
### Authorization
|
|
2606
|
+
|
|
2607
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2608
|
+
|
|
2609
|
+
### HTTP request headers
|
|
2610
|
+
|
|
2611
|
+
- **Content-Type**: Not defined
|
|
2612
|
+
- **Accept**: application/json
|
|
2613
|
+
|
|
2614
|
+
|
|
2615
|
+
## list_program_tiers_daily_reports
|
|
2616
|
+
|
|
2617
|
+
> <V2LoyaltiesProgramsReportsTiersDailyListResponseBody> list_program_tiers_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2618
|
+
|
|
2619
|
+
List program tiers daily reports
|
|
2620
|
+
|
|
2621
|
+
Returns aggregated tier-movement statistics for the program over the given date range and resolution, optionally filtered by tier structure and tier. Each row covers one tier structure, one tier, and one period with recorded movement. Periods without recorded movement are omitted. A filter that matches no rows returns an empty data array. The date range is limited per resolution: - 90 days for day, - 12 weeks for week, - 12 months for month, - 4 quarters for quarter, - start_date must be before end_date, - start_date and end_date are inclusive. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2622
|
+
|
|
2623
|
+
### Examples
|
|
2624
|
+
|
|
2625
|
+
```ruby
|
|
2626
|
+
require 'time'
|
|
2627
|
+
require 'VoucherifySdk'
|
|
2628
|
+
# setup authorization
|
|
2629
|
+
VoucherifySdk.configure do |config|
|
|
2630
|
+
# Configure API key authorization: X-App-Id
|
|
2631
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2632
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2633
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2634
|
+
|
|
2635
|
+
# Configure API key authorization: X-App-Token
|
|
2636
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2637
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2638
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2639
|
+
end
|
|
2640
|
+
|
|
2641
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2642
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2643
|
+
start_date = Date.parse('2013-10-20') # Date | Sets the inclusive start of the report date range. Format YYYY-MM-DD.
|
|
2644
|
+
end_date = Date.parse('2013-10-20') # Date | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date.
|
|
2645
|
+
resolution = 'day' # String | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters.
|
|
2646
|
+
opts = {
|
|
2647
|
+
filters: VoucherifySdk::TiersReportListFilters.new # TiersReportListFilters | Filters the results. Pass a deep object, for example filters[tier_structure_id][conditions][$is] lts_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2648
|
+
}
|
|
2649
|
+
|
|
2650
|
+
begin
|
|
2651
|
+
# List program tiers daily reports
|
|
2652
|
+
result = api_instance.list_program_tiers_daily_reports(program_id, start_date, end_date, resolution, opts)
|
|
2653
|
+
p result
|
|
2654
|
+
rescue VoucherifySdk::ApiError => e
|
|
2655
|
+
puts "Error when calling LV2ProgramsApi->list_program_tiers_daily_reports: #{e}"
|
|
2656
|
+
end
|
|
2657
|
+
```
|
|
2658
|
+
|
|
2659
|
+
### Parameters
|
|
2660
|
+
|
|
2661
|
+
| Name | Type | Description | Notes |
|
|
2662
|
+
| ---- | ---- | ----------- | ----- |
|
|
2663
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2664
|
+
| **start_date** | **Date** | Sets the inclusive start of the report date range. Format YYYY-MM-DD. | |
|
|
2665
|
+
| **end_date** | **Date** | Sets the inclusive end of the report date range. Format YYYY-MM-DD. Must be after start_date. | |
|
|
2666
|
+
| **resolution** | **String** | Sets the aggregation resolution. day allows at most 90 days, week at most 12 weeks, month at most 12 months, and quarter at most 4 quarters. | |
|
|
2667
|
+
| **filters** | [**TiersReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[tier_structure_id][conditions][$is] lts_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2668
|
+
|
|
2669
|
+
### Return type
|
|
2670
|
+
|
|
2671
|
+
[**V2LoyaltiesProgramsReportsTiersDailyListResponseBody**](V2LoyaltiesProgramsReportsTiersDailyListResponseBody.md)
|
|
2672
|
+
|
|
2673
|
+
### Authorization
|
|
2674
|
+
|
|
2675
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2676
|
+
|
|
2677
|
+
### HTTP request headers
|
|
2678
|
+
|
|
2679
|
+
- **Content-Type**: Not defined
|
|
2680
|
+
- **Accept**: application/json
|
|
2681
|
+
|
|
2682
|
+
|
|
2683
|
+
## list_program_tiers_summary_reports
|
|
2684
|
+
|
|
2685
|
+
> <V2LoyaltiesProgramsReportsTiersSummaryListResponseBody> list_program_tiers_summary_reports(program_id, opts)
|
|
2686
|
+
|
|
2687
|
+
List program tiers summary reports
|
|
2688
|
+
|
|
2689
|
+
Returns all-time tier-movement totals for the program, one row per tier structure and tier that has recorded movement. Filters rows with filters[tier_structure_id] and filters[tier_id]. Returns at most 100 rows, ordered by id descending. limit and order are not query parameters. A filter that matches no rows returns an empty data array. Returns 400 when query validation fails. Returns 404 when the program does not exist.
|
|
2690
|
+
|
|
2691
|
+
### Examples
|
|
2692
|
+
|
|
2693
|
+
```ruby
|
|
2694
|
+
require 'time'
|
|
2695
|
+
require 'VoucherifySdk'
|
|
2696
|
+
# setup authorization
|
|
2697
|
+
VoucherifySdk.configure do |config|
|
|
2698
|
+
# Configure API key authorization: X-App-Id
|
|
2699
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2700
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2701
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2702
|
+
|
|
2703
|
+
# Configure API key authorization: X-App-Token
|
|
2704
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2705
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2706
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2707
|
+
end
|
|
2708
|
+
|
|
2709
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2710
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2711
|
+
opts = {
|
|
2712
|
+
filters: VoucherifySdk::TiersReportListFilters.new # TiersReportListFilters | Filters the results. Pass a deep object, for example filters[tier_id][conditions][$is] lt_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.
|
|
2713
|
+
}
|
|
2714
|
+
|
|
2715
|
+
begin
|
|
2716
|
+
# List program tiers summary reports
|
|
2717
|
+
result = api_instance.list_program_tiers_summary_reports(program_id, opts)
|
|
2718
|
+
p result
|
|
2719
|
+
rescue VoucherifySdk::ApiError => e
|
|
2720
|
+
puts "Error when calling LV2ProgramsApi->list_program_tiers_summary_reports: #{e}"
|
|
2721
|
+
end
|
|
2722
|
+
```
|
|
2723
|
+
|
|
2724
|
+
### Parameters
|
|
2725
|
+
|
|
2726
|
+
| Name | Type | Description | Notes |
|
|
2727
|
+
| ---- | ---- | ----------- | ----- |
|
|
2728
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2729
|
+
| **filters** | [**TiersReportListFilters**](.md) | Filters the results. Pass a deep object, for example filters[tier_id][conditions][$is] lt_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. | [optional] |
|
|
2730
|
+
|
|
2731
|
+
### Return type
|
|
2732
|
+
|
|
2733
|
+
[**V2LoyaltiesProgramsReportsTiersSummaryListResponseBody**](V2LoyaltiesProgramsReportsTiersSummaryListResponseBody.md)
|
|
2734
|
+
|
|
2735
|
+
### Authorization
|
|
2736
|
+
|
|
2737
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2738
|
+
|
|
2739
|
+
### HTTP request headers
|
|
2740
|
+
|
|
2741
|
+
- **Content-Type**: Not defined
|
|
2742
|
+
- **Accept**: application/json
|
|
2743
|
+
|
|
2744
|
+
|
|
2745
|
+
## purchase_member_reward
|
|
2746
|
+
|
|
2747
|
+
> <LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBody> purchase_member_reward(program_id, member_id, opts)
|
|
2748
|
+
|
|
2749
|
+
Purchase reward with points
|
|
2750
|
+
|
|
2751
|
+
Purchases a reward for the program member by spending points from the members card. The card comes from the matching reward costs card definition. The program, reward, and member must be ACTIVE. The program and reward must be inside their validity windows. The reward must be assigned to the program with stock available, a cost must match the customer, and the purchase must stay inside frequency, cooldown, balance, and spending limits. Modes: - TRANSACTION (default): creates a PENDING reward transaction and a PENDING card transaction. Returns 202. - DRY_RUN: simulates the purchase and doesnt create a transaction. Returns 200 with status SIMULATED.
|
|
2752
|
+
|
|
2753
|
+
### Examples
|
|
2754
|
+
|
|
2755
|
+
```ruby
|
|
2756
|
+
require 'time'
|
|
2757
|
+
require 'VoucherifySdk'
|
|
2758
|
+
# setup authorization
|
|
2759
|
+
VoucherifySdk.configure do |config|
|
|
2760
|
+
# Configure API key authorization: X-App-Id
|
|
2761
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2762
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2763
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2764
|
+
|
|
2765
|
+
# Configure API key authorization: X-App-Token
|
|
2766
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2767
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2768
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2769
|
+
end
|
|
2770
|
+
|
|
2771
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2772
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2773
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
2774
|
+
opts = {
|
|
2775
|
+
v2_loyalties_programs_members_rewards_purchases_create_request_body: VoucherifySdk::V2LoyaltiesProgramsMembersRewardsPurchasesCreateRequestBody.new # V2LoyaltiesProgramsMembersRewardsPurchasesCreateRequestBody |
|
|
2776
|
+
}
|
|
2777
|
+
|
|
2778
|
+
begin
|
|
2779
|
+
# Purchase reward with points
|
|
2780
|
+
result = api_instance.purchase_member_reward(program_id, member_id, opts)
|
|
2781
|
+
p result
|
|
2782
|
+
rescue VoucherifySdk::ApiError => e
|
|
2783
|
+
puts "Error when calling LV2ProgramsApi->purchase_member_reward: #{e}"
|
|
2784
|
+
end
|
|
2785
|
+
```
|
|
2786
|
+
|
|
2787
|
+
### Parameters
|
|
2788
|
+
|
|
2789
|
+
| Name | Type | Description | Notes |
|
|
2790
|
+
| ---- | ---- | ----------- | ----- |
|
|
2791
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2792
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
2793
|
+
| **v2_loyalties_programs_members_rewards_purchases_create_request_body** | [**V2LoyaltiesProgramsMembersRewardsPurchasesCreateRequestBody**](V2LoyaltiesProgramsMembersRewardsPurchasesCreateRequestBody.md) | | [optional] |
|
|
2794
|
+
|
|
2795
|
+
### Return type
|
|
2796
|
+
|
|
2797
|
+
[**LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBody**](LoyaltiesProgramsMembersRewardsPurchasesCreateCombinedResponseBody.md)
|
|
2798
|
+
|
|
2799
|
+
### Authorization
|
|
2800
|
+
|
|
2801
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2802
|
+
|
|
2803
|
+
### HTTP request headers
|
|
2804
|
+
|
|
2805
|
+
- **Content-Type**: application/json
|
|
2806
|
+
- **Accept**: application/json
|
|
2807
|
+
|
|
2808
|
+
|
|
2809
|
+
## refund_reward_purchase
|
|
2810
|
+
|
|
2811
|
+
> <V2LoyaltiesProgramsRewardsPurchasesRefundResponseBody> refund_reward_purchase(program_id, reward_transaction_id, opts)
|
|
2812
|
+
|
|
2813
|
+
Refund reward purchase
|
|
2814
|
+
|
|
2815
|
+
Refunds an APPROVED reward purchase made by a program member. The purchase transaction is marked REFUNDED, a new REFUND reward transaction is created with status APPROVED, and the points spent on the purchase are returned to the members card. The request body is optional and an empty payload is allowed. Policies default to refund: DEFAULT and stock: DEFAULT. The endpoint responds with 202 before the card balance changes. A POINTS_RETURNED card transaction is created for the members card and processed shortly after the response. When the members tier or the card definition expires points, returned points receive a new expiration date from that setting. They dont inherit the expiration of the originally spent points. A NO_EXPIRATION setting leaves the returned points without an expiration date. Card earning limits dont block the refund. For a LOYALTY_CARD_POINTS reward, the points credited to the target card are also reversed, with a POINTS_PURCHASE_REVERSED card transaction on that card. That transaction is processed shortly after the response. Its expiration is copied from the original points-purchased transaction. A DISCOUNT_COUPONS refund deletes the issued vouchers. details.result.digital.discount_coupons[].result is DELETED, or SKIPPED when the voucher isnt deleted. A GIFT_VOUCHERS refund subtracts the credited amount. details.result.digital.gift_vouchers[].result is CREDITS_SUBTRACTED, or SKIPPED when the balance update is rejected. The refund reverses that purchase in the rewards purchase limits for the project-local day of the original purchase. A day whose purchases are all refunded no longer counts as the members last purchase. Only rewards whose refunds.type is REFUNDABLE can be refunded. Any other reward is rejected with 423 and key reward_refund_policy_does_not_allow_refunds. policies.refund set to ALLOW refunds it anyway. The program must exist, and the reward transaction must belong to that program. Otherwise the request fails with 404. The program is checked first. The request is rejected with 423 when: - The program isnt ACTIVE (non_active_program) or is outside its validity window (program_outside_validity_window), - The transaction isnt a purchase (non_purchase_reward_transaction) or isnt APPROVED (non_approved_reward_transaction); refunding the same purchase twice fails here, - The reward no longer exists (reward_not_found), isnt assigned to the program (refund_reward_not_assigned_to_program), the members card is gone (refund_card_not_found), or the card definition is gone (refund_card_definition_not_found), - The reward type isnt supported (reward_type_not_supported_for_refunds), - For a LOYALTY_CARD_POINTS reward, the purchase result is missing (loyalty_card_points_purchase_result_not_found), the target card is gone (loyalty_card_points_target_card_not_found), the points-purchased card transaction is missing (loyalty_card_points_purchase_not_found), the target cards available balance is lower than the purchased points (loyalty_card_points_insufficient_balance), or the target card definition is gone (loyalty_card_points_target_card_definition_not_found).
|
|
2816
|
+
|
|
2817
|
+
### Examples
|
|
2818
|
+
|
|
2819
|
+
```ruby
|
|
2820
|
+
require 'time'
|
|
2821
|
+
require 'VoucherifySdk'
|
|
2822
|
+
# setup authorization
|
|
2823
|
+
VoucherifySdk.configure do |config|
|
|
2824
|
+
# Configure API key authorization: X-App-Id
|
|
2825
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2826
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2827
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2828
|
+
|
|
2829
|
+
# Configure API key authorization: X-App-Token
|
|
2830
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2831
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2832
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2833
|
+
end
|
|
2834
|
+
|
|
2835
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2836
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2837
|
+
reward_transaction_id = 'reward_transaction_id_example' # String | Identifies the reward transaction of the purchase to refund. Format lrtx_[a-f0-9]+.
|
|
2838
|
+
opts = {
|
|
2839
|
+
v2_loyalties_programs_rewards_purchases_refund_request_body: VoucherifySdk::V2LoyaltiesProgramsRewardsPurchasesRefundRequestBody.new # V2LoyaltiesProgramsRewardsPurchasesRefundRequestBody | Optional refund policies. An empty payload is allowed.
|
|
2840
|
+
}
|
|
2841
|
+
|
|
2842
|
+
begin
|
|
2843
|
+
# Refund reward purchase
|
|
2844
|
+
result = api_instance.refund_reward_purchase(program_id, reward_transaction_id, opts)
|
|
2845
|
+
p result
|
|
2846
|
+
rescue VoucherifySdk::ApiError => e
|
|
2847
|
+
puts "Error when calling LV2ProgramsApi->refund_reward_purchase: #{e}"
|
|
2848
|
+
end
|
|
2849
|
+
```
|
|
2850
|
+
|
|
2851
|
+
### Parameters
|
|
2852
|
+
|
|
2853
|
+
| Name | Type | Description | Notes |
|
|
2854
|
+
| ---- | ---- | ----------- | ----- |
|
|
2855
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2856
|
+
| **reward_transaction_id** | **String** | Identifies the reward transaction of the purchase to refund. Format lrtx_[a-f0-9]+. | |
|
|
2857
|
+
| **v2_loyalties_programs_rewards_purchases_refund_request_body** | [**V2LoyaltiesProgramsRewardsPurchasesRefundRequestBody**](V2LoyaltiesProgramsRewardsPurchasesRefundRequestBody.md) | Optional refund policies. An empty payload is allowed. | [optional] |
|
|
2858
|
+
|
|
2859
|
+
### Return type
|
|
2860
|
+
|
|
2861
|
+
[**V2LoyaltiesProgramsRewardsPurchasesRefundResponseBody**](V2LoyaltiesProgramsRewardsPurchasesRefundResponseBody.md)
|
|
2862
|
+
|
|
2863
|
+
### Authorization
|
|
2864
|
+
|
|
2865
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2866
|
+
|
|
2867
|
+
### HTTP request headers
|
|
2868
|
+
|
|
2869
|
+
- **Content-Type**: application/json
|
|
2870
|
+
- **Accept**: application/json
|
|
2871
|
+
|
|
2872
|
+
|
|
2873
|
+
## update_program_member
|
|
2874
|
+
|
|
2875
|
+
> <V2LoyaltiesProgramsMembersUpdateResponseBody> update_program_member(program_id, member_id, opts)
|
|
2876
|
+
|
|
2877
|
+
Update program member
|
|
2878
|
+
|
|
2879
|
+
Updates a program members metadata. Provided object keys are merged into the existing metadata; omitted keys are preserved. Pass metadata: null to clear all metadata (sets it to an empty object). This endpoint cannot change status. Use [Activate program member](/api-reference/programs/activate-program-member) or [Deactivate program member](/api-reference/programs/deactivate-program-member) for status transitions. Records a vl.member.updated activity. Returns the updated member without the cards array. Returns 404 when the program or member does not exist. Returns 400 when the request body fails validation or the project vl_member metadata schema rejects the payload.
|
|
2880
|
+
|
|
2881
|
+
### Examples
|
|
2882
|
+
|
|
2883
|
+
```ruby
|
|
2884
|
+
require 'time'
|
|
2885
|
+
require 'VoucherifySdk'
|
|
2886
|
+
# setup authorization
|
|
2887
|
+
VoucherifySdk.configure do |config|
|
|
2888
|
+
# Configure API key authorization: X-App-Id
|
|
2889
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
2890
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2891
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
2892
|
+
|
|
2893
|
+
# Configure API key authorization: X-App-Token
|
|
2894
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
2895
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2896
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
2897
|
+
end
|
|
2898
|
+
|
|
2899
|
+
api_instance = VoucherifySdk::LV2ProgramsApi.new
|
|
2900
|
+
program_id = 'program_id_example' # String | Identifies the loyalty program. Format lprg_[a-f0-9]+.
|
|
2901
|
+
member_id = 'member_id_example' # String | Identifies the member. Format lmbr_[a-f0-9]+.
|
|
2902
|
+
opts = {
|
|
2903
|
+
v2_loyalties_programs_members_update_request_body: VoucherifySdk::V2LoyaltiesProgramsMembersUpdateRequestBody.new # V2LoyaltiesProgramsMembersUpdateRequestBody |
|
|
2904
|
+
}
|
|
2905
|
+
|
|
2906
|
+
begin
|
|
2907
|
+
# Update program member
|
|
2908
|
+
result = api_instance.update_program_member(program_id, member_id, opts)
|
|
2909
|
+
p result
|
|
2910
|
+
rescue VoucherifySdk::ApiError => e
|
|
2911
|
+
puts "Error when calling LV2ProgramsApi->update_program_member: #{e}"
|
|
2912
|
+
end
|
|
2913
|
+
```
|
|
2914
|
+
|
|
2915
|
+
### Parameters
|
|
2916
|
+
|
|
2917
|
+
| Name | Type | Description | Notes |
|
|
2918
|
+
| ---- | ---- | ----------- | ----- |
|
|
2919
|
+
| **program_id** | **String** | Identifies the loyalty program. Format lprg_[a-f0-9]+. | |
|
|
2920
|
+
| **member_id** | **String** | Identifies the member. Format lmbr_[a-f0-9]+. | |
|
|
2921
|
+
| **v2_loyalties_programs_members_update_request_body** | [**V2LoyaltiesProgramsMembersUpdateRequestBody**](V2LoyaltiesProgramsMembersUpdateRequestBody.md) | | [optional] |
|
|
2922
|
+
|
|
2923
|
+
### Return type
|
|
2924
|
+
|
|
2925
|
+
[**V2LoyaltiesProgramsMembersUpdateResponseBody**](V2LoyaltiesProgramsMembersUpdateResponseBody.md)
|
|
2926
|
+
|
|
2927
|
+
### Authorization
|
|
2928
|
+
|
|
2929
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
2930
|
+
|
|
2931
|
+
### HTTP request headers
|
|
2932
|
+
|
|
2933
|
+
- **Content-Type**: application/json
|
|
2934
|
+
- **Accept**: application/json
|
|
2935
|
+
|