voucherify 4.1.0 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Dockerfile +14 -0
- data/ENDPOINTS-COVERAGE.md +868 -0
- data/EXAMPLES.md +112 -0
- data/Gemfile +6 -1
- data/Gemfile.lock +72 -0
- data/LICENSE +2 -2
- data/README.md +881 -867
- data/Rakefile +9 -4
- data/VoucherifySdk.gemspec +37 -0
- data/__tests__/README.md +35 -0
- data/__tests__/lib/campaigns.rb +128 -0
- data/__tests__/lib/config.rb +70 -0
- data/__tests__/lib/customers.rb +34 -0
- data/__tests__/lib/events.rb +24 -0
- data/__tests__/lib/products.rb +116 -0
- data/__tests__/lib/stackables.rb +59 -0
- data/__tests__/lib/utils.rb +5 -0
- data/__tests__/lib/voucherify_data.rb +95 -0
- data/__tests__/spec/1_products_spec.rb +101 -0
- data/__tests__/spec/2_campaigns_spec.rb +95 -0
- data/__tests__/spec/3_customers_spec.rb +24 -0
- data/__tests__/spec/4_publications_spec.rb +23 -0
- data/__tests__/spec/5_qualifications_spec.rb +27 -0
- data/__tests__/spec/6_validations_spec.rb +126 -0
- data/__tests__/spec/7_vouchers_spec.rb +40 -0
- data/__tests__/spec/8_events_spec.rb +16 -0
- data/__tests__/spec/9_redemptions_spec.rb +14 -0
- data/docs/Any.md +53 -0
- data/docs/ApplicableTo.md +21 -0
- data/docs/ApplicableToEffect.md +7 -0
- data/docs/ApplicableToResultList.md +11 -0
- data/docs/ArrayInner.md +51 -0
- data/docs/AsyncActions.md +8 -0
- data/docs/BusValRuleAssignment.md +16 -0
- data/docs/Campaign.md +37 -0
- data/docs/CampaignBase.md +35 -0
- data/docs/CampaignBaseValidityTimeframe.md +9 -0
- data/docs/CampaignLoyaltyCard.md +9 -0
- data/docs/CampaignLoyaltyCardExpirationRules.md +11 -0
- data/docs/CampaignLoyaltyVoucher.md +11 -0
- data/docs/CampaignLoyaltyVoucherRedemption.md +8 -0
- data/docs/CampaignVoucher.md +17 -0
- data/docs/CampaignVoucherRedemption.md +8 -0
- data/docs/CampaignsApi.md +694 -0
- data/docs/CampaignsCreateBase.md +23 -0
- data/docs/CampaignsCreateDiscountCouponsCampaign.md +25 -0
- data/docs/CampaignsCreateGiftCampaign.md +25 -0
- data/docs/CampaignsCreateGiveawayCampaign.md +26 -0
- data/docs/CampaignsCreateLoyaltyCampaign.md +25 -0
- data/docs/CampaignsCreatePromotionCampaign.md +25 -0
- data/docs/CampaignsCreateReferralCampaign.md +26 -0
- data/docs/CampaignsCreateRequestBody.md +57 -0
- data/docs/CampaignsCreateResponseBody.md +37 -0
- data/docs/CampaignsDeleteResponseBody.md +8 -0
- data/docs/CampaignsDisableResponseBody.md +7 -0
- data/docs/CampaignsEnableResponseBody.md +7 -0
- data/docs/CampaignsGetResponseBody.md +37 -0
- data/docs/CampaignsImportCreateResponseBody.md +8 -0
- data/docs/CampaignsImportCsvCreateResponseBody.md +8 -0
- data/docs/CampaignsImportVoucherItem.md +20 -0
- data/docs/CampaignsImportVoucherItemRedemption.md +8 -0
- data/docs/CampaignsImportVoucherLoyaltyCard.md +8 -0
- data/docs/CampaignsListResponseBody.md +11 -0
- data/docs/CampaignsUpdateBase.md +16 -0
- data/docs/CampaignsUpdateCouponCampaignBase.md +20 -0
- data/docs/CampaignsUpdateDiscountCouponsCampaign.md +21 -0
- data/docs/CampaignsUpdateGiftCampaign.md +21 -0
- data/docs/CampaignsUpdateGiveawayCampaign.md +23 -0
- data/docs/CampaignsUpdateLoyaltyCampaign.md +22 -0
- data/docs/CampaignsUpdatePromotionCampaign.md +16 -0
- data/docs/CampaignsUpdateReferralCampaign.md +22 -0
- data/docs/CampaignsUpdateRequestBody.md +57 -0
- data/docs/CampaignsUpdateResponseBody.md +37 -0
- data/docs/CampaignsVouchersCreateBaseRequestBody.md +13 -0
- data/docs/CampaignsVouchersCreateInBulkRequestBody.md +15 -0
- data/docs/CampaignsVouchersCreateInBulkResponseBody.md +8 -0
- data/docs/CampaignsVouchersCreateRequestBody.md +13 -0
- data/docs/CampaignsVouchersCreateResponseBody.md +37 -0
- data/docs/CategoriesApi.md +304 -0
- data/docs/CategoriesCreateRequestBody.md +9 -0
- data/docs/CategoriesCreateResponseBody.md +12 -0
- data/docs/CategoriesGetResponseBody.md +14 -0
- data/docs/CategoriesListResponseBody.md +11 -0
- data/docs/CategoriesUpdateRequestBody.md +9 -0
- data/docs/CategoriesUpdateResponseBody.md +13 -0
- data/docs/Category.md +14 -0
- data/docs/ClientEventsCreateRequestBody.md +12 -0
- data/docs/ClientEventsCreateRequestBodyLoyalty.md +8 -0
- data/docs/ClientEventsCreateRequestBodyReferral.md +9 -0
- data/docs/ClientEventsCreateResponseBody.md +12 -0
- data/docs/ClientQualificationsCheckEligibilityRequestBody.md +14 -0
- data/docs/ClientQualificationsCheckEligibilityRequestBodyOptions.md +12 -0
- data/docs/ClientQualificationsCheckEligibilityRequestBodyOptionsFilters.md +14 -0
- data/docs/ClientQualificationsCheckEligibilityResponseBody.md +11 -0
- data/docs/ClientRedemptionsRedeemRequestBody.md +14 -0
- data/docs/ClientRedemptionsRedeemRequestBodyAllOfOptions.md +8 -0
- data/docs/ClientRedemptionsRedeemResponseBody.md +12 -0
- data/docs/ClientSideApi.md +319 -0
- data/docs/ClientValidationsValidateRequestBody.md +14 -0
- data/docs/ClientValidationsValidateRequestBodyAllOfOptions.md +8 -0
- data/docs/ClientValidationsValidateResponseBody.md +14 -0
- data/docs/CodeConfig.md +13 -0
- data/docs/CodeConfigRequiredLengthCharsetPattern.md +13 -0
- data/docs/CreatePublicationBase.md +10 -0
- data/docs/CreatePublicationCampaign.md +9 -0
- data/docs/CreatePublicationWithCampaign.md +11 -0
- data/docs/CreatePublicationWithSpecificVoucher.md +11 -0
- data/docs/CustomEvent.md +15 -0
- data/docs/CustomEventReferral.md +10 -0
- data/docs/Customer.md +17 -0
- data/docs/CustomerActivity.md +11 -0
- data/docs/CustomerActivityData.md +183 -0
- data/docs/CustomerBase.md +15 -0
- data/docs/CustomerBaseAddress.md +13 -0
- data/docs/CustomerId.md +9 -0
- data/docs/CustomerLoyalty.md +10 -0
- data/docs/CustomerLoyaltyCampaignsValue.md +10 -0
- data/docs/CustomerReferrals.md +9 -0
- data/docs/CustomerReferralsCampaignsItem.md +12 -0
- data/docs/CustomerResponseDataAssets.md +8 -0
- data/docs/CustomerSegmentsList.md +11 -0
- data/docs/CustomerSummary.md +9 -0
- data/docs/CustomerSummaryOrders.md +12 -0
- data/docs/CustomerSummaryRedemptions.md +15 -0
- data/docs/CustomerSummaryRedemptionsGift.md +9 -0
- data/docs/CustomerSummaryRedemptionsLoyaltyCard.md +9 -0
- data/docs/CustomerWithSummaryLoyaltyReferrals.md +25 -0
- data/docs/CustomersActivitiesListResponseBody.md +11 -0
- data/docs/CustomersApi.md +771 -0
- data/docs/CustomersCreateRequestBody.md +17 -0
- data/docs/CustomersCreateResponseBody.md +25 -0
- data/docs/CustomersGetResponseBody.md +25 -0
- data/docs/CustomersImportCsvCreateResponseBody.md +8 -0
- data/docs/CustomersListResponseBody.md +12 -0
- data/docs/CustomersMetadataUpdateInBulkRequestBody.md +9 -0
- data/docs/CustomersMetadataUpdateInBulkResponseBody.md +8 -0
- data/docs/CustomersPermanentDeletionCreateResponseBody.md +14 -0
- data/docs/CustomersPermanentDeletionCreateResponseBodyDataJson.md +14 -0
- data/docs/CustomersSegmentsListResponseBody.md +11 -0
- data/docs/CustomersUpdateInBulkRequestBody.md +16 -0
- data/docs/CustomersUpdateInBulkResponseBody.md +8 -0
- data/docs/CustomersUpdateRequestBody.md +15 -0
- data/docs/CustomersUpdateResponseBody.md +25 -0
- data/docs/Discount.md +55 -0
- data/docs/DiscountAmount.md +13 -0
- data/docs/DiscountAmountVouchersEffectTypes.md +7 -0
- data/docs/DiscountCouponsCampaignVoucher.md +11 -0
- data/docs/DiscountFixed.md +12 -0
- data/docs/DiscountFixedVouchersEffectTypes.md +7 -0
- data/docs/DiscountPercent.md +14 -0
- data/docs/DiscountPercentVouchersEffectTypes.md +7 -0
- data/docs/DiscountUnit.md +15 -0
- data/docs/DiscountUnitMultiple.md +10 -0
- data/docs/DiscountUnitMultipleOneUnit.md +13 -0
- data/docs/DiscountUnitVouchersEffectTypes.md +7 -0
- data/docs/EarningRule.md +24 -0
- data/docs/EarningRuleBase.md +21 -0
- data/docs/EarningRuleBaseCustomEvent.md +8 -0
- data/docs/EarningRuleBaseLoyalty.md +49 -0
- data/docs/EarningRuleBaseSegment.md +8 -0
- data/docs/EarningRuleBaseSource.md +10 -0
- data/docs/EarningRuleBaseValidityTimeframe.md +9 -0
- data/docs/EarningRuleEvent.md +7 -0
- data/docs/EarningRuleFixed.md +9 -0
- data/docs/EarningRuleProportional.md +53 -0
- data/docs/EarningRuleProportionalCustomEvent.md +10 -0
- data/docs/EarningRuleProportionalCustomEventCustomEvent.md +8 -0
- data/docs/EarningRuleProportionalCustomEventCustomEventMetadata.md +10 -0
- data/docs/EarningRuleProportionalCustomerMetadata.md +10 -0
- data/docs/EarningRuleProportionalCustomerMetadataCustomer.md +8 -0
- data/docs/EarningRuleProportionalCustomerMetadataCustomerMetadata.md +10 -0
- data/docs/EarningRuleProportionalOrder.md +51 -0
- data/docs/EarningRuleProportionalOrderAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderAmountOrder.md +8 -0
- data/docs/EarningRuleProportionalOrderAmountOrderAmount.md +9 -0
- data/docs/EarningRuleProportionalOrderItems.md +51 -0
- data/docs/EarningRuleProportionalOrderItemsAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderItemsAmountOrderItems.md +8 -0
- data/docs/EarningRuleProportionalOrderItemsAmountOrderItemsAmount.md +11 -0
- data/docs/EarningRuleProportionalOrderItemsQuantity.md +10 -0
- data/docs/EarningRuleProportionalOrderItemsQuantityOrderItems.md +8 -0
- data/docs/EarningRuleProportionalOrderItemsSubtotalAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderItemsSubtotalAmountOrderItems.md +8 -0
- data/docs/EarningRuleProportionalOrderMetadata.md +10 -0
- data/docs/EarningRuleProportionalOrderMetadataOrder.md +8 -0
- data/docs/EarningRuleProportionalOrderMetadataOrderMetadata.md +10 -0
- data/docs/EarningRuleProportionalOrderTotalAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderTotalAmountOrder.md +8 -0
- data/docs/Error.md +14 -0
- data/docs/EventCustomerActiveCampaignFailed.md +10 -0
- data/docs/EventCustomerActiveCampaignRecovered.md +10 -0
- data/docs/EventCustomerActiveCampaignSent.md +10 -0
- data/docs/EventCustomerBatchFailed.md +10 -0
- data/docs/EventCustomerBatchRecovered.md +10 -0
- data/docs/EventCustomerBatchSent.md +10 -0
- data/docs/EventCustomerBrazeFailed.md +10 -0
- data/docs/EventCustomerBrazeRecovered.md +10 -0
- data/docs/EventCustomerBrazeSent.md +10 -0
- data/docs/EventCustomerConfirmed.md +9 -0
- data/docs/EventCustomerConfirmedUnconfirmedCustomer.md +8 -0
- data/docs/EventCustomerConsents.md +9 -0
- data/docs/EventCustomerConsentsGiven.md +9 -0
- data/docs/EventCustomerConsentsRevoked.md +9 -0
- data/docs/EventCustomerCreated.md +8 -0
- data/docs/EventCustomerCustomEvent.md +8 -0
- data/docs/EventCustomerDeleted.md +8 -0
- data/docs/EventCustomerEmailFailed.md +10 -0
- data/docs/EventCustomerEmailRecovered.md +10 -0
- data/docs/EventCustomerEmailSent.md +10 -0
- data/docs/EventCustomerFailed.md +10 -0
- data/docs/EventCustomerGiftVoucherBalanceAdded.md +12 -0
- data/docs/EventCustomerIntercomFailed.md +10 -0
- data/docs/EventCustomerIntercomRecovered.md +10 -0
- data/docs/EventCustomerIntercomSent.md +10 -0
- data/docs/EventCustomerKlaviyoFailed.md +10 -0
- data/docs/EventCustomerKlaviyoRecovered.md +10 -0
- data/docs/EventCustomerKlaviyoSent.md +10 -0
- data/docs/EventCustomerLoyaltyCardPointsAdded.md +12 -0
- data/docs/EventCustomerLoyaltyCardPointsTransferred.md +14 -0
- data/docs/EventCustomerLoyaltyTierBase.md +9 -0
- data/docs/EventCustomerLoyaltyTierDowngraded.md +12 -0
- data/docs/EventCustomerLoyaltyTierExpirationChanged.md +12 -0
- data/docs/EventCustomerLoyaltyTierJoined.md +11 -0
- data/docs/EventCustomerLoyaltyTierLeft.md +11 -0
- data/docs/EventCustomerLoyaltyTierProlonged.md +11 -0
- data/docs/EventCustomerLoyaltyTierUpgraded.md +12 -0
- data/docs/EventCustomerLoyaltyUpdated.md +11 -0
- data/docs/EventCustomerMailchimpFailed.md +10 -0
- data/docs/EventCustomerMailchimpRecovered.md +10 -0
- data/docs/EventCustomerMailchimpSent.md +10 -0
- data/docs/EventCustomerOrder.md +11 -0
- data/docs/EventCustomerOrderCanceled.md +11 -0
- data/docs/EventCustomerOrderCreated.md +11 -0
- data/docs/EventCustomerOrderFulfilled.md +11 -0
- data/docs/EventCustomerOrderPaid.md +11 -0
- data/docs/EventCustomerOrderProcessing.md +11 -0
- data/docs/EventCustomerOrderUpdated.md +11 -0
- data/docs/EventCustomerPublicationFailed.md +10 -0
- data/docs/EventCustomerPublicationSucceeded.md +10 -0
- data/docs/EventCustomerRecovered.md +10 -0
- data/docs/EventCustomerRedemption.md +14 -0
- data/docs/EventCustomerRedemptionFailed.md +14 -0
- data/docs/EventCustomerRedemptionRollbackFailed.md +15 -0
- data/docs/EventCustomerRedemptionRollbackSucceeded.md +15 -0
- data/docs/EventCustomerRedemptionSucceeded.md +14 -0
- data/docs/EventCustomerReferred.md +13 -0
- data/docs/EventCustomerRewardRedemptions.md +16 -0
- data/docs/EventCustomerRewardRedemptionsCompleted.md +16 -0
- data/docs/EventCustomerRewardRedemptionsCreated.md +16 -0
- data/docs/EventCustomerRewardRedemptionsPending.md +16 -0
- data/docs/EventCustomerRewardRedemptionsRolledBack.md +16 -0
- data/docs/EventCustomerRewarded.md +17 -0
- data/docs/EventCustomerRewardedLoyaltyPoints.md +16 -0
- data/docs/EventCustomerSegmentEntered.md +9 -0
- data/docs/EventCustomerSegmentLeft.md +9 -0
- data/docs/EventCustomerSent.md +10 -0
- data/docs/EventCustomerShopifyFailed.md +10 -0
- data/docs/EventCustomerShopifyRecovered.md +10 -0
- data/docs/EventCustomerShopifySent.md +10 -0
- data/docs/EventCustomerSmsFailed.md +10 -0
- data/docs/EventCustomerSmsRecovered.md +10 -0
- data/docs/EventCustomerSmsSent.md +10 -0
- data/docs/EventCustomerUpdated.md +8 -0
- data/docs/EventCustomerValidationFailed.md +9 -0
- data/docs/EventCustomerValidationSucceeded.md +9 -0
- data/docs/EventCustomerVoucherDeleted.md +10 -0
- data/docs/EventCustomerVouchersLoyaltyPointsExpired.md +13 -0
- data/docs/EventsApi.md +68 -0
- data/docs/EventsCreateRequestBody.md +12 -0
- data/docs/EventsCreateResponseBody.md +12 -0
- data/docs/Export.md +59 -0
- data/docs/ExportBase.md +14 -0
- data/docs/ExportBaseResult.md +8 -0
- data/docs/ExportCustomer.md +16 -0
- data/docs/ExportCustomerBase.md +9 -0
- data/docs/ExportCustomerBaseParameters.md +10 -0
- data/docs/ExportCustomerFields.md +7 -0
- data/docs/ExportCustomerFilters.md +38 -0
- data/docs/ExportCustomerOrder.md +7 -0
- data/docs/ExportCustomerScheduled.md +16 -0
- data/docs/ExportOrder.md +16 -0
- data/docs/ExportOrderBase.md +9 -0
- data/docs/ExportOrderFields.md +7 -0
- data/docs/ExportOrderFilters.md +21 -0
- data/docs/ExportOrderOrder.md +7 -0
- data/docs/ExportOrderScheduled.md +16 -0
- data/docs/ExportPointsExpiration.md +16 -0
- data/docs/ExportPointsExpirationBase.md +9 -0
- data/docs/ExportPointsExpirationBaseParameters.md +10 -0
- data/docs/ExportPointsExpirationFields.md +7 -0
- data/docs/ExportPointsExpirationFilters.md +10 -0
- data/docs/ExportPointsExpirationOrder.md +7 -0
- data/docs/ExportPointsExpirationScheduled.md +16 -0
- data/docs/ExportPublication.md +16 -0
- data/docs/ExportPublicationBase.md +9 -0
- data/docs/ExportPublicationBaseParameters.md +10 -0
- data/docs/ExportPublicationFields.md +7 -0
- data/docs/ExportPublicationFilters.md +16 -0
- data/docs/ExportPublicationOrder.md +7 -0
- data/docs/ExportPublicationScheduled.md +16 -0
- data/docs/ExportRedemption.md +16 -0
- data/docs/ExportRedemptionBase.md +9 -0
- data/docs/ExportRedemptionBaseParameters.md +10 -0
- data/docs/ExportRedemptionFields.md +7 -0
- data/docs/ExportRedemptionFilters.md +25 -0
- data/docs/ExportRedemptionOrder.md +7 -0
- data/docs/ExportRedemptionScheduled.md +16 -0
- data/docs/ExportScheduledBase.md +14 -0
- data/docs/ExportVoucher.md +16 -0
- data/docs/ExportVoucherBase.md +9 -0
- data/docs/ExportVoucherBaseParameters.md +10 -0
- data/docs/ExportVoucherFields.md +7 -0
- data/docs/ExportVoucherFilters.md +38 -0
- data/docs/ExportVoucherOrder.md +7 -0
- data/docs/ExportVoucherScheduled.md +16 -0
- data/docs/ExportVoucherTransactions.md +16 -0
- data/docs/ExportVoucherTransactionsBase.md +9 -0
- data/docs/ExportVoucherTransactionsFields.md +7 -0
- data/docs/ExportVoucherTransactionsFilters.md +11 -0
- data/docs/ExportVoucherTransactionsOrder.md +7 -0
- data/docs/ExportVoucherTransactionsScheduled.md +16 -0
- data/docs/ExportsApi.md +301 -0
- data/docs/ExportsCreateRequestBody.md +59 -0
- data/docs/ExportsCreateResponseBody.md +59 -0
- data/docs/ExportsGetResponseBody.md +16 -0
- data/docs/ExportsListResponseBody.md +11 -0
- data/docs/FieldConditions.md +8 -0
- data/docs/FilterConditionsString.md +15 -0
- data/docs/FiltersCondition.md +32 -0
- data/docs/Gift.md +10 -0
- data/docs/GiftCampaignVoucher.md +11 -0
- data/docs/GiveawayCampaignVoucher.md +12 -0
- data/docs/InapplicableTo.md +21 -0
- data/docs/InapplicableToResultList.md +11 -0
- data/docs/Junction.md +7 -0
- data/docs/ListPublicationsItemBase.md +17 -0
- data/docs/ListPublicationsItemInvalid.md +20 -0
- data/docs/ListPublicationsItemValidMultipleVouchers.md +19 -0
- data/docs/ListPublicationsItemValidSingleVoucher.md +19 -0
- data/docs/ListPublicationsItemVoucher.md +14 -0
- data/docs/LoyaltiesApi.md +1643 -0
- data/docs/LoyaltiesDeleteResponseBody.md +8 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBody.md +23 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBody.md +23 -0
- data/docs/LoyaltiesEarningRulesGetResponseBody.md +24 -0
- data/docs/LoyaltiesLoyaltyTierReward.md +10 -0
- data/docs/LoyaltiesMembersBalanceUpdateRequestBody.md +12 -0
- data/docs/LoyaltiesMembersBalanceUpdateResponseBody.md +14 -0
- data/docs/LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +16 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md +8 -0
- data/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +10 -0
- data/docs/LoyaltiesMembersRedemptionRedeemRequestBodyReward.md +9 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +30 -0
- data/docs/LoyaltiesMembersRewardsListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersRewardsListResponseBodyDataItem.md +10 -0
- data/docs/LoyaltiesMembersTiersListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersTransactionsExportCreateRequestBody.md +8 -0
- data/docs/LoyaltiesMembersTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/LoyaltiesMembersTransactionsExportCreateResponseBody.md +16 -0
- data/docs/LoyaltiesMembersTransactionsListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBody.md +30 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyAssets.md +9 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyAssetsBarcode.md +9 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyAssetsQr.md +9 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +11 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyPublish.md +11 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyRedemption.md +13 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyValidityTimeframe.md +9 -0
- data/docs/LoyaltiesRewardAssignmentsGetResponseBody.md +15 -0
- data/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +18 -0
- data/docs/LoyaltiesRewardsGetResponseBody.md +15 -0
- data/docs/LoyaltiesTiersCreateInBulkRequestBodyItem.md +12 -0
- data/docs/LoyaltiesTiersEarningRulesListResponseBody.md +11 -0
- data/docs/LoyaltiesTiersGetResponseBody.md +19 -0
- data/docs/LoyaltiesTiersListResponseBody.md +11 -0
- data/docs/LoyaltiesTiersRewardsListResponseBody.md +11 -0
- data/docs/LoyaltiesTransferPoints.md +11 -0
- data/docs/LoyaltyCardTransaction.md +17 -0
- data/docs/LoyaltyCardTransactionsType.md +7 -0
- data/docs/LoyaltyTier.md +19 -0
- data/docs/LoyaltyTierAllOfConfig.md +8 -0
- data/docs/LoyaltyTierAllOfConfigPoints.md +9 -0
- data/docs/LoyaltyTierBase.md +11 -0
- data/docs/LoyaltyTierBasePoints.md +9 -0
- data/docs/LoyaltyTierExpiration.md +14 -0
- data/docs/LoyaltyTiersExpirationAll.md +11 -0
- data/docs/LoyaltyTiersExpirationAllExpirationDate.md +10 -0
- data/docs/LoyaltyTiersExpirationAllExpirationDateRounding.md +11 -0
- data/docs/LoyaltyTiersExpirationAllStartDate.md +8 -0
- data/docs/LuckyDraw.md +10 -0
- data/docs/MappingFixed.md +9 -0
- data/docs/MappingMultiply.md +9 -0
- data/docs/MappingPoints.md +49 -0
- data/docs/Order.md +19 -0
- data/docs/OrderBase.md +17 -0
- data/docs/OrderCalculated.md +29 -0
- data/docs/OrderCalculatedBase.md +27 -0
- data/docs/OrderCalculatedCustomer.md +49 -0
- data/docs/OrderCalculatedNoCustomerData.md +29 -0
- data/docs/OrderCalculatedReferrer.md +49 -0
- data/docs/OrderItem.md +21 -0
- data/docs/OrderItemCalculated.md +25 -0
- data/docs/OrderItemProduct.md +13 -0
- data/docs/OrderItemSku.md +12 -0
- data/docs/OrderRedemptions.md +15 -0
- data/docs/OrdersApi.md +377 -0
- data/docs/OrdersCreateRequestBody.md +19 -0
- data/docs/OrdersCreateResponseBody.md +29 -0
- data/docs/OrdersExportCreateRequestBody.md +8 -0
- data/docs/OrdersExportCreateRequestBodyParameters.md +10 -0
- data/docs/OrdersExportCreateResponseBody.md +16 -0
- data/docs/OrdersGetResponseBody.md +29 -0
- data/docs/OrdersImportCreateRequestBodyItem.md +18 -0
- data/docs/OrdersImportCreateResponseBody.md +8 -0
- data/docs/OrdersListResponseBody.md +11 -0
- data/docs/OrdersUpdateRequestBody.md +17 -0
- data/docs/OrdersUpdateResponseBody.md +29 -0
- data/docs/ParameterCampaignType.md +7 -0
- data/docs/ParameterCreatedBeforeAfter.md +9 -0
- data/docs/ParameterExpandListCampaigns.md +7 -0
- data/docs/ParameterFiltersListRedemptions.md +17 -0
- data/docs/ParameterFiltersListRedemptionsCampaignName.md +9 -0
- data/docs/ParameterFiltersListRedemptionsCustomerId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsFailureCode.md +9 -0
- data/docs/ParameterFiltersListRedemptionsObject.md +9 -0
- data/docs/ParameterFiltersListRedemptionsParentRedemptionId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsRelatedObjectId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsRelatedObjectParentId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsResult.md +9 -0
- data/docs/ParameterFiltersListRedemptionsUserLogin.md +9 -0
- data/docs/ParameterFiltersListRedemptionsVoucherCode.md +9 -0
- data/docs/ParameterOrder.md +7 -0
- data/docs/ParameterOrderListAllPromotionStacks.md +7 -0
- data/docs/ParameterOrderListCampaigns.md +7 -0
- data/docs/ParameterOrderListCustomers.md +7 -0
- data/docs/ParameterOrderListExports.md +7 -0
- data/docs/ParameterOrderListLoyaltyTiers.md +7 -0
- data/docs/ParameterOrderListOrders.md +7 -0
- data/docs/ParameterOrderListPublications.md +7 -0
- data/docs/ParameterOrderListRedemptions.md +7 -0
- data/docs/ParameterOrderListValidationRuleAssignments.md +7 -0
- data/docs/ParameterOrderListValidationRules.md +7 -0
- data/docs/ParameterResultListPublications.md +7 -0
- data/docs/ParameterUpdatedBeforeAfter.md +9 -0
- data/docs/ParameterVoucherTypeListPublications.md +7 -0
- data/docs/PointsExpirationTypes.md +7 -0
- data/docs/Product.md +18 -0
- data/docs/ProductCollectionsApi.md +319 -0
- data/docs/ProductCollectionsCreateDynamicRequestBody.md +10 -0
- data/docs/ProductCollectionsCreateDynamicRequestBodyFilter.md +20 -0
- data/docs/ProductCollectionsCreateDynamicRequestBodyProductsItem.md +10 -0
- data/docs/ProductCollectionsCreateRequestBody.md +49 -0
- data/docs/ProductCollectionsCreateResponseBody.md +14 -0
- data/docs/ProductCollectionsCreateStaticRequestBody.md +10 -0
- data/docs/ProductCollectionsGetResponseBody.md +14 -0
- data/docs/ProductCollectionsItem.md +14 -0
- data/docs/ProductCollectionsItemProductsItem.md +10 -0
- data/docs/ProductCollectionsList.md +11 -0
- data/docs/ProductCollectionsListResponseBody.md +11 -0
- data/docs/ProductCollectionsProductsList.md +11 -0
- data/docs/ProductCollectionsProductsListProductsItem.md +49 -0
- data/docs/ProductCollectionsProductsListResponseBody.md +11 -0
- data/docs/ProductWithoutSkus.md +17 -0
- data/docs/ProductsApi.md +883 -0
- data/docs/ProductsCreateRequestBody.md +14 -0
- data/docs/ProductsCreateResponseBody.md +18 -0
- data/docs/ProductsGetResponseBody.md +18 -0
- data/docs/ProductsImportCsvCreateResponseBody.md +8 -0
- data/docs/ProductsListResponseBody.md +11 -0
- data/docs/ProductsMetadataUpdateInBulkRequestBody.md +9 -0
- data/docs/ProductsMetadataUpdateInBulkResponseBody.md +8 -0
- data/docs/ProductsSkusCreateRequestBody.md +15 -0
- data/docs/ProductsSkusCreateResponseBody.md +19 -0
- data/docs/ProductsSkusListResponseBody.md +11 -0
- data/docs/ProductsSkusUpdateRequestBody.md +13 -0
- data/docs/ProductsSkusUpdateResponseBody.md +19 -0
- data/docs/ProductsUpdateInBulkRequestBody.md +13 -0
- data/docs/ProductsUpdateInBulkResponseBody.md +8 -0
- data/docs/ProductsUpdateRequestBody.md +12 -0
- data/docs/ProductsUpdateResponseBody.md +18 -0
- data/docs/PromotionStack.md +16 -0
- data/docs/PromotionStackBase.md +9 -0
- data/docs/PromotionStackBaseTiers.md +9 -0
- data/docs/PromotionTier.md +28 -0
- data/docs/PromotionTierAction.md +8 -0
- data/docs/PromotionTierCampaign.md +15 -0
- data/docs/PromotionTierCampaignValidityTimeframe.md +9 -0
- data/docs/PromotionTierCreateParams.md +20 -0
- data/docs/PromotionTierSummary.md +9 -0
- data/docs/PromotionTierSummaryOrders.md +9 -0
- data/docs/PromotionTierSummaryRedemptions.md +8 -0
- data/docs/PromotionTierValidityTimeframe.md +9 -0
- data/docs/PromotionTiersList.md +12 -0
- data/docs/PromotionsApi.md +678 -0
- data/docs/PromotionsStacksCreateRequestBody.md +10 -0
- data/docs/PromotionsStacksCreateResponseBody.md +15 -0
- data/docs/PromotionsStacksGetResponseBody.md +16 -0
- data/docs/PromotionsStacksListResponseBody.md +11 -0
- data/docs/PromotionsStacksUpdateRequestBody.md +10 -0
- data/docs/PromotionsStacksUpdateRequestBodyTiers.md +9 -0
- data/docs/PromotionsStacksUpdateResponseBody.md +16 -0
- data/docs/PromotionsTiersDisableResponseBody.md +28 -0
- data/docs/PromotionsTiersEnableResponseBody.md +28 -0
- data/docs/PromotionsTiersGetResponseBody.md +28 -0
- data/docs/PromotionsTiersListResponseBody.md +12 -0
- data/docs/PropertiesForLoyaltyCampaignOptions.md +8 -0
- data/docs/PublicationsApi.md +222 -0
- data/docs/PublicationsCreateBaseResponseBody.md +18 -0
- data/docs/PublicationsCreateRequestBody.md +49 -0
- data/docs/PublicationsCreateResponseBody.md +49 -0
- data/docs/PublicationsCreateVoucherResponseBody.md +19 -0
- data/docs/PublicationsCreateVouchersResponseBody.md +19 -0
- data/docs/PublicationsListResponseBody.md +11 -0
- data/docs/PublicationsListResponseBodyPublicationsItem.md +51 -0
- data/docs/QualificationsApi.md +68 -0
- data/docs/QualificationsCheckEligibilityRequestBody.md +14 -0
- data/docs/QualificationsCheckEligibilityResponseBody.md +11 -0
- data/docs/QualificationsFieldConditions.md +8 -0
- data/docs/QualificationsFiltersCondition.md +13 -0
- data/docs/QualificationsOption.md +12 -0
- data/docs/QualificationsOptionFilters.md +14 -0
- data/docs/QualificationsOptionFiltersResourceType.md +8 -0
- data/docs/QualificationsOptionFiltersResourceTypeConditions.md +11 -0
- data/docs/QualificationsRedeemable.md +23 -0
- data/docs/QualificationsRedeemableBase.md +22 -0
- data/docs/QualificationsRedeemables.md +13 -0
- data/docs/QualificationsStackingRules.md +12 -0
- data/docs/RedeemGiftCard.md +10 -0
- data/docs/RedeemGiftCardAllOfGift.md +8 -0
- data/docs/RedeemLoyaltyCard.md +10 -0
- data/docs/RedeemLoyaltyCardAllOfReward.md +9 -0
- data/docs/RedeemPromotionStack.md +9 -0
- data/docs/RedeemPromotionTier.md +9 -0
- data/docs/RedeemVoucher.md +9 -0
- data/docs/RedeemableGift.md +9 -0
- data/docs/RedeemableLoyaltyCard.md +12 -0
- data/docs/RedeemableResult.md +11 -0
- data/docs/RedeemableResultGiftCard.md +8 -0
- data/docs/RedeemableResultGiftCardGift.md +8 -0
- data/docs/RedeemableResultLoyaltyCard.md +8 -0
- data/docs/RedeemableResultLoyaltyCardLoyaltyCard.md +8 -0
- data/docs/RedeemableResultPromotionStack.md +8 -0
- data/docs/RedeemableResultPromotionTier.md +8 -0
- data/docs/RedeemableResultPromotionTierDiscount.md +55 -0
- data/docs/RedeemableResultVoucherCode.md +8 -0
- data/docs/Redemption.md +30 -0
- data/docs/RedemptionChannel.md +9 -0
- data/docs/RedemptionGift.md +8 -0
- data/docs/RedemptionInternal.md +34 -0
- data/docs/RedemptionInternalRelatedRedemptions.md +9 -0
- data/docs/RedemptionInternalRelatedRedemptionsItem.md +9 -0
- data/docs/RedemptionInternalRelatedRedemptionsRollbacksItem.md +9 -0
- data/docs/RedemptionLoyaltyCard.md +8 -0
- data/docs/RedemptionRelatedRedemptions.md +9 -0
- data/docs/RedemptionRelatedRedemptionsItem.md +9 -0
- data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +9 -0
- data/docs/RedemptionRewardResult.md +20 -0
- data/docs/RedemptionRewardResultParameters.md +10 -0
- data/docs/RedemptionRewardResultParametersCampaign.md +10 -0
- data/docs/RedemptionRewardResultParametersCoin.md +9 -0
- data/docs/RedemptionRewardResultParametersProduct.md +9 -0
- data/docs/RedemptionRewardResultProduct.md +18 -0
- data/docs/RedemptionRewardResultSku.md +19 -0
- data/docs/RedemptionRewardResultVoucher.md +37 -0
- data/docs/RedemptionRollback.md +31 -0
- data/docs/RedemptionRollbackRelatedRedemptions.md +9 -0
- data/docs/RedemptionRollbackRelatedRedemptionsItem.md +9 -0
- data/docs/RedemptionRollbackRelatedRedemptionsRollbacksItem.md +9 -0
- data/docs/RedemptionsApi.md +395 -0
- data/docs/RedemptionsGetResponseBody.md +49 -0
- data/docs/RedemptionsListResponseBody.md +11 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItem.md +49 -0
- data/docs/RedemptionsRedeemRequestBody.md +14 -0
- data/docs/RedemptionsRedeemResponseBody.md +12 -0
- data/docs/RedemptionsRollbackCreateRequestBody.md +12 -0
- data/docs/RedemptionsRollbackCreateResponseBody.md +31 -0
- data/docs/RedemptionsRollbacksCreateRequestBody.md +12 -0
- data/docs/RedemptionsRollbacksCreateResponseBody.md +10 -0
- data/docs/ReferralCampaignVoucher.md +12 -0
- data/docs/ReferralProgram.md +10 -0
- data/docs/ReferralProgramCustomEvent.md +9 -0
- data/docs/ReferralProgramRefereeReward.md +10 -0
- data/docs/ReferralProgramRefereeRewardRelatedObjectParent.md +10 -0
- data/docs/Referrer.md +17 -0
- data/docs/ReferrerId.md +9 -0
- data/docs/ReferrerWithSummaryLoyaltyReferrals.md +25 -0
- data/docs/ResourceTypes.md +7 -0
- data/docs/Reward.md +18 -0
- data/docs/RewardAssignment.md +15 -0
- data/docs/RewardAssignmentBase.md +14 -0
- data/docs/RewardAssignmentParameters.md +8 -0
- data/docs/RewardAssignmentParametersParameters.md +8 -0
- data/docs/RewardAssignmentParametersParametersLoyalty.md +8 -0
- data/docs/RewardAssignmentsCreateCoinRewardRequestBody.md +9 -0
- data/docs/RewardAssignmentsCreateDigitalOrMaterialRewardRequestBody.md +9 -0
- data/docs/RewardAssignmentsCreateDigitalOrMaterialRewardRequestBodyParameters.md +8 -0
- data/docs/RewardAssignmentsCreateDigitalOrMaterialRewardRequestBodyParametersLoyalty.md +8 -0
- data/docs/RewardAttributes.md +9 -0
- data/docs/RewardType.md +51 -0
- data/docs/RewardTypeCampaign.md +8 -0
- data/docs/RewardTypeCampaignCampaign.md +10 -0
- data/docs/RewardTypeCoin.md +8 -0
- data/docs/RewardTypeCoinCoin.md +9 -0
- data/docs/RewardTypeMaterial.md +8 -0
- data/docs/RewardTypeMaterialProduct.md +9 -0
- data/docs/RewardsApi.md +379 -0
- data/docs/RewardsAssignmentsCreateRequestBody.md +49 -0
- data/docs/RewardsAssignmentsCreateResponseBody.md +15 -0
- data/docs/RewardsAssignmentsGetResponseBody.md +15 -0
- data/docs/RewardsAssignmentsListResponseBody.md +11 -0
- data/docs/RewardsAssignmentsUpdateRequestBody.md +8 -0
- data/docs/RewardsAssignmentsUpdateRequestBodyParameters.md +8 -0
- data/docs/RewardsAssignmentsUpdateRequestBodyParametersLoyalty.md +8 -0
- data/docs/RewardsAssignmentsUpdateResponseBody.md +15 -0
- data/docs/SchemaThatContainsUniquePropertiesForPromotionCampaignPromotion.md +8 -0
- data/docs/SegmentsApi.md +65 -0
- data/docs/Session.md +11 -0
- data/docs/SimpleCampaign.md +20 -0
- data/docs/SimpleConsent.md +10 -0
- data/docs/SimpleCustomer.md +13 -0
- data/docs/SimpleCustomerRequiredObjectType.md +13 -0
- data/docs/SimpleOrder.md +23 -0
- data/docs/SimpleOrderItem.md +18 -0
- data/docs/SimpleProduct.md +10 -0
- data/docs/SimpleProductDiscountUnit.md +10 -0
- data/docs/SimplePromotionTier.md +11 -0
- data/docs/SimplePromotionTierCampaign.md +8 -0
- data/docs/SimpleRedemption.md +20 -0
- data/docs/SimpleRedemptionRewardResult.md +20 -0
- data/docs/SimpleReferralTier.md +11 -0
- data/docs/SimpleSegment.md +10 -0
- data/docs/SimpleSku.md +10 -0
- data/docs/SimpleSkuDiscountUnit.md +10 -0
- data/docs/SimpleVoucher.md +20 -0
- data/docs/Sku.md +19 -0
- data/docs/SkuWithProduct.md +20 -0
- data/docs/SkusGetResponseBody.md +19 -0
- data/docs/SkusImportCsvCreateResponseBody.md +8 -0
- data/docs/SkusList.md +11 -0
- data/docs/SkusListForProduct.md +11 -0
- data/docs/StackableDiscountsApi.md +412 -0
- data/docs/StackableValidateRedeemBase.md +13 -0
- data/docs/StackableValidateRedeemBaseRedeemablesItem.md +55 -0
- data/docs/StackingRules.md +15 -0
- data/docs/ValidationEntity.md +15 -0
- data/docs/ValidationRule.md +18 -0
- data/docs/ValidationRuleAssignment.md +13 -0
- data/docs/ValidationRuleAssignmentsList.md +11 -0
- data/docs/ValidationRuleBase.md +13 -0
- data/docs/ValidationRuleBaseApplicableTo.md +10 -0
- data/docs/ValidationRuleBaseError.md +8 -0
- data/docs/ValidationRulesApi.md +513 -0
- data/docs/ValidationRulesAssignmentsList.md +11 -0
- data/docs/ValidationRulesAssignmentsListResponseBody.md +11 -0
- data/docs/ValidationRulesCreateRequestBody.md +13 -0
- data/docs/ValidationRulesCreateResponseBody.md +18 -0
- data/docs/ValidationRulesGetResponseBody.md +18 -0
- data/docs/ValidationRulesListResponseBody.md +11 -0
- data/docs/ValidationRulesUpdateRequestBody.md +13 -0
- data/docs/ValidationRulesUpdateResponseBody.md +18 -0
- data/docs/ValidationsApi.md +68 -0
- data/docs/ValidationsRedeemableApplicable.md +16 -0
- data/docs/ValidationsRedeemableApplicableResult.md +55 -0
- data/docs/ValidationsRedeemableInapplicable.md +11 -0
- data/docs/ValidationsRedeemableInapplicableResult.md +8 -0
- data/docs/ValidationsRedeemableSkipped.md +11 -0
- data/docs/ValidationsValidateAllResponseBody.md +13 -0
- data/docs/ValidationsValidateAllResponseBodyRedeemablesItem.md +51 -0
- data/docs/ValidationsValidatePartialResponseBody.md +14 -0
- data/docs/ValidationsValidateRequestBody.md +14 -0
- data/docs/ValidationsValidateResponseBody.md +14 -0
- data/docs/Voucher.md +37 -0
- data/docs/VoucherAssets.md +9 -0
- data/docs/VoucherGift.md +10 -0
- data/docs/VoucherLoyaltyCard.md +11 -0
- data/docs/VoucherPublish.md +10 -0
- data/docs/VoucherRedemption.md +13 -0
- data/docs/VoucherTransaction.md +17 -0
- data/docs/VoucherTransactionDetails.md +20 -0
- data/docs/VoucherTransactionDetailsBalance.md +13 -0
- data/docs/VoucherTransactionDetailsBalanceRelatedObject.md +9 -0
- data/docs/VoucherTransactionDetailsCustomEvent.md +9 -0
- data/docs/VoucherTransactionDetailsEarningRule.md +9 -0
- data/docs/VoucherTransactionDetailsEarningRuleSource.md +8 -0
- data/docs/VoucherTransactionDetailsEvent.md +9 -0
- data/docs/VoucherTransactionDetailsEventSchema.md +9 -0
- data/docs/VoucherTransactionDetailsLoyaltyTier.md +9 -0
- data/docs/VoucherTransactionDetailsOrder.md +9 -0
- data/docs/VoucherTransactionDetailsRedemption.md +8 -0
- data/docs/VoucherTransactionDetailsReward.md +9 -0
- data/docs/VoucherTransactionDetailsRollback.md +8 -0
- data/docs/VoucherTransactionDetailsSegment.md +9 -0
- data/docs/VoucherTransactionsExport.md +16 -0
- data/docs/VoucherTransactionsExportFilterConditions.md +8 -0
- data/docs/VoucherTransactionsExportFilterConditionsVoucherId.md +8 -0
- data/docs/VoucherTransactionsExportFilterConditionsVoucherIdConditions.md +8 -0
- data/docs/VoucherTransactionsExportParameters.md +9 -0
- data/docs/VoucherTransactionsExportResult.md +8 -0
- data/docs/VoucherTransactionsFilters.md +10 -0
- data/docs/VoucherValidityTimeframe.md +9 -0
- data/docs/VouchersApi.md +554 -0
- data/docs/VouchersBalanceUpdateRequestBody.md +10 -0
- data/docs/VouchersBalanceUpdateResponseBody.md +14 -0
- data/docs/VouchersBalanceUpdateResponseBodyRelatedObject.md +9 -0
- data/docs/VouchersDisableResponseBody.md +37 -0
- data/docs/VouchersEnableResponseBody.md +37 -0
- data/docs/VouchersGetResponseBody.md +37 -0
- data/docs/VouchersImportCsvCreateResponseBody.md +8 -0
- data/docs/VouchersRedemptionGetResponseBody.md +14 -0
- data/docs/VouchersRedemptionGetResponseBodyRedemptionEntriesItem.md +49 -0
- data/docs/VouchersTransactionsExportCreateRequestBody.md +8 -0
- data/docs/VouchersTransactionsExportCreateResponseBody.md +16 -0
- data/docs/VouchersTransactionsListResponseBody.md +11 -0
- data/example.rb +25 -0
- data/lib/VoucherifySdk/api/campaigns_api.rb +789 -0
- data/lib/VoucherifySdk/api/categories_api.rb +337 -0
- data/lib/VoucherifySdk/api/client_side_api.rb +367 -0
- data/lib/VoucherifySdk/api/customers_api.rb +874 -0
- data/lib/VoucherifySdk/api/events_api.rb +86 -0
- data/lib/VoucherifySdk/api/exports_api.rb +354 -0
- data/lib/VoucherifySdk/api/loyalties_api.rb +1906 -0
- data/lib/VoucherifySdk/api/orders_api.rb +425 -0
- data/lib/VoucherifySdk/api/product_collections_api.rb +375 -0
- data/lib/VoucherifySdk/api/products_api.rb +1002 -0
- data/lib/VoucherifySdk/api/promotions_api.rb +764 -0
- data/lib/VoucherifySdk/api/publications_api.rb +270 -0
- data/lib/VoucherifySdk/api/qualifications_api.rb +86 -0
- data/lib/VoucherifySdk/api/redemptions_api.rb +457 -0
- data/lib/VoucherifySdk/api/rewards_api.rb +446 -0
- data/lib/VoucherifySdk/api/segments_api.rb +83 -0
- data/lib/VoucherifySdk/api/validation_rules_api.rb +599 -0
- data/lib/VoucherifySdk/api/validations_api.rb +86 -0
- data/lib/VoucherifySdk/api/vouchers_api.rb +636 -0
- data/lib/VoucherifySdk/api_client.rb +392 -0
- data/lib/VoucherifySdk/api_error.rb +58 -0
- data/lib/VoucherifySdk/configuration.rb +332 -0
- data/lib/VoucherifySdk/models/any.rb +107 -0
- data/lib/VoucherifySdk/models/applicable_to.rb +406 -0
- data/lib/VoucherifySdk/models/applicable_to_effect.rb +41 -0
- data/lib/VoucherifySdk/models/applicable_to_result_list.rb +340 -0
- data/lib/VoucherifySdk/models/array_inner.rb +106 -0
- data/lib/VoucherifySdk/models/async_actions.rb +223 -0
- data/lib/VoucherifySdk/models/bus_val_rule_assignment.rb +379 -0
- data/lib/VoucherifySdk/models/campaign.rb +674 -0
- data/lib/VoucherifySdk/models/campaign_base.rb +650 -0
- data/lib/VoucherifySdk/models/campaign_base_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_card.rb +232 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +273 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_voucher.rb +291 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_voucher_redemption.rb +217 -0
- data/lib/VoucherifySdk/models/campaign_voucher.rb +328 -0
- data/lib/VoucherifySdk/models/campaign_voucher_redemption.rb +219 -0
- data/lib/VoucherifySdk/models/campaigns_create_base.rb +422 -0
- data/lib/VoucherifySdk/models/campaigns_create_discount_coupons_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_gift_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_giveaway_campaign.rb +470 -0
- data/lib/VoucherifySdk/models/campaigns_create_loyalty_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_promotion_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_referral_campaign.rb +470 -0
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +110 -0
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +675 -0
- data/lib/VoucherifySdk/models/campaigns_delete_response_body.rb +216 -0
- data/lib/VoucherifySdk/models/campaigns_disable_response_body.rb +206 -0
- data/lib/VoucherifySdk/models/campaigns_enable_response_body.rb +206 -0
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +675 -0
- data/lib/VoucherifySdk/models/campaigns_import_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/campaigns_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/campaigns_import_voucher_item.rb +374 -0
- data/lib/VoucherifySdk/models/campaigns_import_voucher_item_redemption.rb +216 -0
- data/lib/VoucherifySdk/models/campaigns_import_voucher_loyalty_card.rb +223 -0
- data/lib/VoucherifySdk/models/campaigns_list_response_body.rb +252 -0
- data/lib/VoucherifySdk/models/campaigns_update_base.rb +300 -0
- data/lib/VoucherifySdk/models/campaigns_update_coupon_campaign_base.rb +381 -0
- data/lib/VoucherifySdk/models/campaigns_update_discount_coupons_campaign.rb +389 -0
- data/lib/VoucherifySdk/models/campaigns_update_gift_campaign.rb +389 -0
- data/lib/VoucherifySdk/models/campaigns_update_giveaway_campaign.rb +420 -0
- data/lib/VoucherifySdk/models/campaigns_update_loyalty_campaign.rb +398 -0
- data/lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb +306 -0
- data/lib/VoucherifySdk/models/campaigns_update_referral_campaign.rb +398 -0
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +110 -0
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +675 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_base_request_body.rb +264 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_in_bulk_request_body.rb +291 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb +272 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/categories_create_request_body.rb +240 -0
- data/lib/VoucherifySdk/models/categories_create_response_body.rb +324 -0
- data/lib/VoucherifySdk/models/categories_get_response_body.rb +364 -0
- data/lib/VoucherifySdk/models/categories_list_response_body.rb +321 -0
- data/lib/VoucherifySdk/models/categories_update_request_body.rb +240 -0
- data/lib/VoucherifySdk/models/categories_update_response_body.rb +341 -0
- data/lib/VoucherifySdk/models/category.rb +357 -0
- data/lib/VoucherifySdk/models/client_events_create_request_body.rb +295 -0
- data/lib/VoucherifySdk/models/client_events_create_request_body_loyalty.rb +223 -0
- data/lib/VoucherifySdk/models/client_events_create_request_body_referral.rb +233 -0
- data/lib/VoucherifySdk/models/client_events_create_response_body.rb +316 -0
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb +319 -0
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_response_body.rb +243 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_all_of_options.rb +240 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_all_of_options.rb +240 -0
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +301 -0
- data/lib/VoucherifySdk/models/code_config.rb +266 -0
- data/lib/VoucherifySdk/models/code_config_required_length_charset_pattern.rb +293 -0
- data/lib/VoucherifySdk/models/create_publication_base.rb +242 -0
- data/lib/VoucherifySdk/models/create_publication_campaign.rb +261 -0
- data/lib/VoucherifySdk/models/create_publication_with_campaign.rb +265 -0
- data/lib/VoucherifySdk/models/create_publication_with_specific_voucher.rb +266 -0
- data/lib/VoucherifySdk/models/custom_event.rb +351 -0
- data/lib/VoucherifySdk/models/custom_event_referral.rb +236 -0
- data/lib/VoucherifySdk/models/customer.rb +312 -0
- data/lib/VoucherifySdk/models/customer_activity.rb +282 -0
- data/lib/VoucherifySdk/models/customer_activity_data.rb +173 -0
- data/lib/VoucherifySdk/models/customer_base.rb +285 -0
- data/lib/VoucherifySdk/models/customer_base_address.rb +266 -0
- data/lib/VoucherifySdk/models/customer_id.rb +273 -0
- data/lib/VoucherifySdk/models/customer_loyalty.rb +258 -0
- data/lib/VoucherifySdk/models/customer_loyalty_campaigns_value.rb +236 -0
- data/lib/VoucherifySdk/models/customer_referrals.rb +242 -0
- data/lib/VoucherifySdk/models/customer_referrals_campaigns_item.rb +291 -0
- data/lib/VoucherifySdk/models/customer_response_data_assets.rb +216 -0
- data/lib/VoucherifySdk/models/customer_segments_list.rb +276 -0
- data/lib/VoucherifySdk/models/customer_summary.rb +237 -0
- data/lib/VoucherifySdk/models/customer_summary_orders.rb +283 -0
- data/lib/VoucherifySdk/models/customer_summary_redemptions.rb +339 -0
- data/lib/VoucherifySdk/models/customer_summary_redemptions_gift.rb +240 -0
- data/lib/VoucherifySdk/models/customer_summary_redemptions_loyalty_card.rb +240 -0
- data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb +438 -0
- data/lib/VoucherifySdk/models/customers_activities_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/customers_create_request_body.rb +313 -0
- data/lib/VoucherifySdk/models/customers_create_response_body.rb +439 -0
- data/lib/VoucherifySdk/models/customers_get_response_body.rb +439 -0
- data/lib/VoucherifySdk/models/customers_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/customers_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/customers_metadata_update_in_bulk_request_body.rb +242 -0
- data/lib/VoucherifySdk/models/customers_metadata_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/customers_permanent_deletion_create_response_body.rb +324 -0
- data/lib/VoucherifySdk/models/customers_permanent_deletion_create_response_body_data_json.rb +325 -0
- data/lib/VoucherifySdk/models/customers_segments_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/customers_update_in_bulk_request_body.rb +310 -0
- data/lib/VoucherifySdk/models/customers_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/customers_update_request_body.rb +293 -0
- data/lib/VoucherifySdk/models/customers_update_response_body.rb +439 -0
- data/lib/VoucherifySdk/models/discount.rb +109 -0
- data/lib/VoucherifySdk/models/discount_amount.rb +311 -0
- data/lib/VoucherifySdk/models/discount_amount_vouchers_effect_types.rb +43 -0
- data/lib/VoucherifySdk/models/discount_coupons_campaign_voucher.rb +290 -0
- data/lib/VoucherifySdk/models/discount_fixed.rb +301 -0
- data/lib/VoucherifySdk/models/discount_fixed_vouchers_effect_types.rb +40 -0
- data/lib/VoucherifySdk/models/discount_percent.rb +321 -0
- data/lib/VoucherifySdk/models/discount_percent_vouchers_effect_types.rb +40 -0
- data/lib/VoucherifySdk/models/discount_unit.rb +329 -0
- data/lib/VoucherifySdk/models/discount_unit_multiple.rb +298 -0
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +310 -0
- data/lib/VoucherifySdk/models/discount_unit_vouchers_effect_types.rb +41 -0
- data/lib/VoucherifySdk/models/earning_rule.rb +474 -0
- data/lib/VoucherifySdk/models/earning_rule_base.rb +424 -0
- data/lib/VoucherifySdk/models/earning_rule_base_custom_event.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_base_loyalty.rb +105 -0
- data/lib/VoucherifySdk/models/earning_rule_base_segment.rb +223 -0
- data/lib/VoucherifySdk/models/earning_rule_base_source.rb +284 -0
- data/lib/VoucherifySdk/models/earning_rule_base_validity_timeframe.rb +240 -0
- data/lib/VoucherifySdk/models/earning_rule_event.rb +46 -0
- data/lib/VoucherifySdk/models/earning_rule_fixed.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional.rb +107 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_custom_event.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_custom_event_custom_event.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_custom_event_custom_event_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_customer_metadata.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_customer_metadata_customer.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_customer_metadata_customer_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order.rb +106 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_amount_order.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_amount_order_amount.rb +240 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items.rb +106 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_amount_order_items.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_amount_order_items_amount.rb +308 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_quantity.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_quantity_order_items.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_subtotal_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_subtotal_amount_order_items.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_metadata.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_metadata_order.rb +222 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_metadata_order_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_total_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_total_amount_order.rb +221 -0
- data/lib/VoucherifySdk/models/error.rb +311 -0
- data/lib/VoucherifySdk/models/event_customer_active_campaign_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_active_campaign_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_active_campaign_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_batch_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_batch_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_batch_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_braze_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_braze_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_braze_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_confirmed.rb +224 -0
- data/lib/VoucherifySdk/models/event_customer_confirmed_unconfirmed_customer.rb +214 -0
- data/lib/VoucherifySdk/models/event_customer_consents.rb +225 -0
- data/lib/VoucherifySdk/models/event_customer_consents_given.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_consents_revoked.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_created.rb +215 -0
- data/lib/VoucherifySdk/models/event_customer_custom_event.rb +222 -0
- data/lib/VoucherifySdk/models/event_customer_deleted.rb +215 -0
- data/lib/VoucherifySdk/models/event_customer_email_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_email_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_email_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_failed.rb +240 -0
- data/lib/VoucherifySdk/models/event_customer_gift_voucher_balance_added.rb +251 -0
- data/lib/VoucherifySdk/models/event_customer_intercom_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_intercom_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_intercom_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_klaviyo_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_klaviyo_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_klaviyo_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_card_points_added.rb +251 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_card_points_transferred.rb +269 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_base.rb +223 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_downgraded.rb +279 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_expiration_changed.rb +279 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_joined.rb +263 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_left.rb +263 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_prolonged.rb +263 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_upgraded.rb +272 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_updated.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_mailchimp_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_mailchimp_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_mailchimp_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_order.rb +241 -0
- data/lib/VoucherifySdk/models/event_customer_order_canceled.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_created.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_fulfilled.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_paid.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_processing.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_updated.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_publication_failed.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_publication_succeeded.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_recovered.rb +240 -0
- data/lib/VoucherifySdk/models/event_customer_redemption.rb +268 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_failed.rb +276 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_rollback_failed.rb +285 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_rollback_succeeded.rb +285 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_succeeded.rb +276 -0
- data/lib/VoucherifySdk/models/event_customer_referred.rb +288 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions.rb +286 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_completed.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_created.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_pending.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_rolled_back.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_rewarded.rb +296 -0
- data/lib/VoucherifySdk/models/event_customer_rewarded_loyalty_points.rb +287 -0
- data/lib/VoucherifySdk/models/event_customer_segment_entered.rb +238 -0
- data/lib/VoucherifySdk/models/event_customer_segment_left.rb +238 -0
- data/lib/VoucherifySdk/models/event_customer_sent.rb +240 -0
- data/lib/VoucherifySdk/models/event_customer_shopify_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_shopify_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_shopify_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_sms_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_sms_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_sms_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_updated.rb +215 -0
- data/lib/VoucherifySdk/models/event_customer_validation_failed.rb +224 -0
- data/lib/VoucherifySdk/models/event_customer_validation_succeeded.rb +224 -0
- data/lib/VoucherifySdk/models/event_customer_voucher_deleted.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_vouchers_loyalty_points_expired.rb +262 -0
- data/lib/VoucherifySdk/models/events_create_request_body.rb +295 -0
- data/lib/VoucherifySdk/models/events_create_response_body.rb +316 -0
- data/lib/VoucherifySdk/models/export.rb +110 -0
- data/lib/VoucherifySdk/models/export_base.rb +354 -0
- data/lib/VoucherifySdk/models/export_base_result.rb +223 -0
- data/lib/VoucherifySdk/models/export_customer.rb +400 -0
- data/lib/VoucherifySdk/models/export_customer_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_customer_base_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/export_customer_fields.rb +68 -0
- data/lib/VoucherifySdk/models/export_customer_order.rb +50 -0
- data/lib/VoucherifySdk/models/export_customer_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_order.rb +400 -0
- data/lib/VoucherifySdk/models/export_order_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_order_fields.rb +51 -0
- data/lib/VoucherifySdk/models/export_order_order.rb +44 -0
- data/lib/VoucherifySdk/models/export_order_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_points_expiration.rb +400 -0
- data/lib/VoucherifySdk/models/export_points_expiration_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_points_expiration_base_parameters.rb +258 -0
- data/lib/VoucherifySdk/models/export_points_expiration_fields.rb +44 -0
- data/lib/VoucherifySdk/models/export_points_expiration_filters.rb +254 -0
- data/lib/VoucherifySdk/models/export_points_expiration_order.rb +40 -0
- data/lib/VoucherifySdk/models/export_points_expiration_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_publication.rb +400 -0
- data/lib/VoucherifySdk/models/export_publication_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_publication_base_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/export_publication_fields.rb +46 -0
- data/lib/VoucherifySdk/models/export_publication_order.rb +50 -0
- data/lib/VoucherifySdk/models/export_publication_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_redemption.rb +400 -0
- data/lib/VoucherifySdk/models/export_redemption_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_redemption_base_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/export_redemption_fields.rb +55 -0
- data/lib/VoucherifySdk/models/export_redemption_order.rb +48 -0
- data/lib/VoucherifySdk/models/export_redemption_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_scheduled_base.rb +359 -0
- data/lib/VoucherifySdk/models/export_voucher.rb +400 -0
- data/lib/VoucherifySdk/models/export_voucher_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_voucher_base_parameters.rb +258 -0
- data/lib/VoucherifySdk/models/export_voucher_fields.rb +68 -0
- data/lib/VoucherifySdk/models/export_voucher_order.rb +44 -0
- data/lib/VoucherifySdk/models/export_voucher_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions.rb +400 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_fields.rb +50 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_filters.rb +263 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_order.rb +40 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +111 -0
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +111 -0
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +400 -0
- data/lib/VoucherifySdk/models/exports_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/field_conditions.rb +214 -0
- data/lib/VoucherifySdk/models/filter_conditions_string.rb +290 -0
- data/lib/VoucherifySdk/models/filters_condition.rb +430 -0
- data/lib/VoucherifySdk/models/gift.rb +284 -0
- data/lib/VoucherifySdk/models/gift_campaign_voucher.rb +291 -0
- data/lib/VoucherifySdk/models/giveaway_campaign_voucher.rb +300 -0
- data/lib/VoucherifySdk/models/inapplicable_to.rb +413 -0
- data/lib/VoucherifySdk/models/inapplicable_to_result_list.rb +340 -0
- data/lib/VoucherifySdk/models/junction.rb +40 -0
- data/lib/VoucherifySdk/models/list_publications_item_base.rb +399 -0
- data/lib/VoucherifySdk/models/list_publications_item_invalid.rb +455 -0
- data/lib/VoucherifySdk/models/list_publications_item_valid_multiple_vouchers.rb +454 -0
- data/lib/VoucherifySdk/models/list_publications_item_valid_single_voucher.rb +451 -0
- data/lib/VoucherifySdk/models/list_publications_item_voucher.rb +328 -0
- data/lib/VoucherifySdk/models/loyalties_delete_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +462 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +462 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +475 -0
- data/lib/VoucherifySdk/models/loyalties_loyalty_tier_reward.rb +289 -0
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_request_body.rb +284 -0
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body.rb +399 -0
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body_related_object.rb +274 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body.rb +334 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +390 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item_bucket.rb +223 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body.rb +234 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body_reward.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +585 -0
- data/lib/VoucherifySdk/models/loyalties_members_rewards_list_response_body.rb +341 -0
- data/lib/VoucherifySdk/models/loyalties_members_rewards_list_response_body_data_item.rb +269 -0
- data/lib/VoucherifySdk/models/loyalties_members_tiers_list_response_body.rb +321 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_export_create_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_export_create_request_body_parameters.rb +258 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_export_create_response_body.rb +405 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_list_response_body.rb +334 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body.rb +544 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_assets.rb +224 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_assets_barcode.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_assets_qr.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +260 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_publish.rb +288 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb +306 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_get_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb +418 -0
- data/lib/VoucherifySdk/models/loyalties_rewards_get_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_create_in_bulk_request_body_item.rb +279 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_earning_rules_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb +421 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_rewards_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/loyalties_transfer_points.rb +266 -0
- data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +386 -0
- data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +47 -0
- data/lib/VoucherifySdk/models/loyalty_tier.rb +420 -0
- data/lib/VoucherifySdk/models/loyalty_tier_all_of_config.rb +222 -0
- data/lib/VoucherifySdk/models/loyalty_tier_all_of_config_points.rb +226 -0
- data/lib/VoucherifySdk/models/loyalty_tier_base.rb +262 -0
- data/lib/VoucherifySdk/models/loyalty_tier_base_points.rb +226 -0
- data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +304 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb +311 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all_expiration_date.rb +283 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all_expiration_date_rounding.rb +306 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all_start_date.rb +257 -0
- data/lib/VoucherifySdk/models/lucky_draw.rb +246 -0
- data/lib/VoucherifySdk/models/mapping_fixed.rb +261 -0
- data/lib/VoucherifySdk/models/mapping_multiply.rb +261 -0
- data/lib/VoucherifySdk/models/mapping_points.rb +105 -0
- data/lib/VoucherifySdk/models/order.rb +366 -0
- data/lib/VoucherifySdk/models/order_base.rb +339 -0
- data/lib/VoucherifySdk/models/order_calculated.rb +496 -0
- data/lib/VoucherifySdk/models/order_calculated_base.rb +472 -0
- data/lib/VoucherifySdk/models/order_calculated_customer.rb +105 -0
- data/lib/VoucherifySdk/models/order_calculated_no_customer_data.rb +496 -0
- data/lib/VoucherifySdk/models/order_calculated_referrer.rb +105 -0
- data/lib/VoucherifySdk/models/order_item.rb +377 -0
- data/lib/VoucherifySdk/models/order_item_calculated.rb +436 -0
- data/lib/VoucherifySdk/models/order_item_product.rb +266 -0
- data/lib/VoucherifySdk/models/order_item_sku.rb +256 -0
- data/lib/VoucherifySdk/models/order_redemptions.rb +291 -0
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +367 -0
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +497 -0
- data/lib/VoucherifySdk/models/orders_export_create_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/orders_export_create_request_body_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/orders_export_create_response_body.rb +406 -0
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +497 -0
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +356 -0
- data/lib/VoucherifySdk/models/orders_import_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/orders_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +347 -0
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +497 -0
- data/lib/VoucherifySdk/models/parameter_campaign_type.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_created_before_after.rb +225 -0
- data/lib/VoucherifySdk/models/parameter_expand_list_campaigns.rb +39 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions.rb +295 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_campaign_name.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_customer_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_failure_code.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_object.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_parent_redemption_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_related_object_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_related_object_parent_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_result.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_user_login.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_voucher_code.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_order.rb +50 -0
- data/lib/VoucherifySdk/models/parameter_order_list_all_promotion_stacks.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_order_list_campaigns.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_customers.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_order_list_exports.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_loyalty_tiers.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_orders.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_publications.rb +50 -0
- data/lib/VoucherifySdk/models/parameter_order_list_redemptions.rb +48 -0
- data/lib/VoucherifySdk/models/parameter_order_list_validation_rule_assignments.rb +40 -0
- data/lib/VoucherifySdk/models/parameter_order_list_validation_rules.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_result_list_publications.rb +40 -0
- data/lib/VoucherifySdk/models/parameter_updated_before_after.rb +225 -0
- data/lib/VoucherifySdk/models/parameter_voucher_type_list_publications.rb +41 -0
- data/lib/VoucherifySdk/models/points_expiration_types.rb +41 -0
- data/lib/VoucherifySdk/models/product.rb +397 -0
- data/lib/VoucherifySdk/models/product_collections_create_dynamic_request_body.rb +290 -0
- data/lib/VoucherifySdk/models/product_collections_create_dynamic_request_body_filter.rb +352 -0
- data/lib/VoucherifySdk/models/product_collections_create_dynamic_request_body_products_item.rb +283 -0
- data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +106 -0
- data/lib/VoucherifySdk/models/product_collections_create_response_body.rb +365 -0
- data/lib/VoucherifySdk/models/product_collections_create_static_request_body.rb +286 -0
- data/lib/VoucherifySdk/models/product_collections_get_response_body.rb +365 -0
- data/lib/VoucherifySdk/models/product_collections_item.rb +358 -0
- data/lib/VoucherifySdk/models/product_collections_item_products_item.rb +283 -0
- data/lib/VoucherifySdk/models/product_collections_list.rb +322 -0
- data/lib/VoucherifySdk/models/product_collections_list_response_body.rb +329 -0
- data/lib/VoucherifySdk/models/product_collections_products_list.rb +276 -0
- data/lib/VoucherifySdk/models/product_collections_products_list_products_item.rb +105 -0
- data/lib/VoucherifySdk/models/product_collections_products_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/product_without_skus.rb +380 -0
- data/lib/VoucherifySdk/models/products_create_request_body.rb +278 -0
- data/lib/VoucherifySdk/models/products_create_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/products_get_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/products_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/products_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/products_metadata_update_in_bulk_request_body.rb +242 -0
- data/lib/VoucherifySdk/models/products_metadata_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/products_skus_create_request_body.rb +286 -0
- data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/products_skus_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/products_skus_update_request_body.rb +266 -0
- data/lib/VoucherifySdk/models/products_skus_update_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/products_update_in_bulk_request_body.rb +275 -0
- data/lib/VoucherifySdk/models/products_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/products_update_request_body.rb +258 -0
- data/lib/VoucherifySdk/models/products_update_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/promotion_stack.rb +389 -0
- data/lib/VoucherifySdk/models/promotion_stack_base.rb +238 -0
- data/lib/VoucherifySdk/models/promotion_stack_base_tiers.rb +289 -0
- data/lib/VoucherifySdk/models/promotion_tier.rb +416 -0
- data/lib/VoucherifySdk/models/promotion_tier_action.rb +215 -0
- data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +289 -0
- data/lib/VoucherifySdk/models/promotion_tier_campaign_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/promotion_tier_create_params.rb +345 -0
- data/lib/VoucherifySdk/models/promotion_tier_summary.rb +224 -0
- data/lib/VoucherifySdk/models/promotion_tier_summary_orders.rb +226 -0
- data/lib/VoucherifySdk/models/promotion_tier_summary_redemptions.rb +216 -0
- data/lib/VoucherifySdk/models/promotion_tier_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/promotion_tiers_list.rb +262 -0
- data/lib/VoucherifySdk/models/promotions_stacks_create_request_body.rb +256 -0
- data/lib/VoucherifySdk/models/promotions_stacks_create_response_body.rb +380 -0
- data/lib/VoucherifySdk/models/promotions_stacks_get_response_body.rb +390 -0
- data/lib/VoucherifySdk/models/promotions_stacks_list_response_body.rb +341 -0
- data/lib/VoucherifySdk/models/promotions_stacks_update_request_body.rb +235 -0
- data/lib/VoucherifySdk/models/promotions_stacks_update_request_body_tiers.rb +264 -0
- data/lib/VoucherifySdk/models/promotions_stacks_update_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/promotions_tiers_get_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/promotions_tiers_list_response_body.rb +269 -0
- data/lib/VoucherifySdk/models/properties_for_loyalty_campaign_options.rb +215 -0
- data/lib/VoucherifySdk/models/publications_create_base_response_body.rb +440 -0
- data/lib/VoucherifySdk/models/publications_create_request_body.rb +106 -0
- data/lib/VoucherifySdk/models/publications_create_response_body.rb +106 -0
- data/lib/VoucherifySdk/models/publications_create_voucher_response_body.rb +464 -0
- data/lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb +467 -0
- data/lib/VoucherifySdk/models/publications_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb +107 -0
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body.rb +319 -0
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_response_body.rb +243 -0
- data/lib/VoucherifySdk/models/qualifications_field_conditions.rb +214 -0
- data/lib/VoucherifySdk/models/qualifications_filters_condition.rb +259 -0
- data/lib/VoucherifySdk/models/qualifications_option.rb +311 -0
- data/lib/VoucherifySdk/models/qualifications_option_filters.rb +291 -0
- data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type.rb +214 -0
- data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type_conditions.rb +270 -0
- data/lib/VoucherifySdk/models/qualifications_redeemable.rb +404 -0
- data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +387 -0
- data/lib/VoucherifySdk/models/qualifications_redeemables.rb +349 -0
- data/lib/VoucherifySdk/models/redeem_gift_card.rb +289 -0
- data/lib/VoucherifySdk/models/redeem_gift_card_all_of_gift.rb +216 -0
- data/lib/VoucherifySdk/models/redeem_loyalty_card.rb +289 -0
- data/lib/VoucherifySdk/models/redeem_loyalty_card_all_of_reward.rb +226 -0
- data/lib/VoucherifySdk/models/redeem_promotion_stack.rb +274 -0
- data/lib/VoucherifySdk/models/redeem_promotion_tier.rb +274 -0
- data/lib/VoucherifySdk/models/redeem_voucher.rb +274 -0
- data/lib/VoucherifySdk/models/redeemable_gift.rb +226 -0
- data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +257 -0
- data/lib/VoucherifySdk/models/redeemable_result.rb +242 -0
- data/lib/VoucherifySdk/models/redeemable_result_gift_card.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_gift_card_gift.rb +216 -0
- data/lib/VoucherifySdk/models/redeemable_result_loyalty_card.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_loyalty_card_loyalty_card.rb +216 -0
- data/lib/VoucherifySdk/models/redeemable_result_promotion_stack.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_promotion_tier.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_promotion_tier_discount.rb +109 -0
- data/lib/VoucherifySdk/models/redeemable_result_voucher_code.rb +215 -0
- data/lib/VoucherifySdk/models/redemption.rb +571 -0
- data/lib/VoucherifySdk/models/redemption_channel.rb +260 -0
- data/lib/VoucherifySdk/models/redemption_gift.rb +216 -0
- data/lib/VoucherifySdk/models/redemption_internal.rb +542 -0
- data/lib/VoucherifySdk/models/redemption_internal_related_redemptions.rb +227 -0
- data/lib/VoucherifySdk/models/redemption_internal_related_redemptions_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_internal_related_redemptions_rollbacks_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_loyalty_card.rb +216 -0
- data/lib/VoucherifySdk/models/redemption_related_redemptions.rb +227 -0
- data/lib/VoucherifySdk/models/redemption_related_redemptions_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_reward_result.rb +396 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters.rb +233 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb +236 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +226 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_product.rb +226 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_product.rb +397 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_sku.rb +425 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_voucher.rb +547 -0
- data/lib/VoucherifySdk/models/redemption_rollback.rb +581 -0
- data/lib/VoucherifySdk/models/redemption_rollback_related_redemptions.rb +227 -0
- data/lib/VoucherifySdk/models/redemption_rollback_related_redemptions_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_rollback_related_redemptions_rollbacks_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +106 -0
- data/lib/VoucherifySdk/models/redemptions_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +105 -0
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/redemptions_redeem_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/redemptions_rollback_create_request_body.rb +254 -0
- data/lib/VoucherifySdk/models/redemptions_rollback_create_response_body.rb +588 -0
- data/lib/VoucherifySdk/models/redemptions_rollbacks_create_request_body.rb +254 -0
- data/lib/VoucherifySdk/models/redemptions_rollbacks_create_response_body.rb +236 -0
- data/lib/VoucherifySdk/models/referral_campaign_voucher.rb +307 -0
- data/lib/VoucherifySdk/models/referral_program.rb +268 -0
- data/lib/VoucherifySdk/models/referral_program_custom_event.rb +226 -0
- data/lib/VoucherifySdk/models/referral_program_referee_reward.rb +269 -0
- data/lib/VoucherifySdk/models/referral_program_referee_reward_related_object_parent.rb +272 -0
- data/lib/VoucherifySdk/models/referrer.rb +312 -0
- data/lib/VoucherifySdk/models/referrer_id.rb +280 -0
- data/lib/VoucherifySdk/models/referrer_with_summary_loyalty_referrals.rb +438 -0
- data/lib/VoucherifySdk/models/resource_types.rb +41 -0
- data/lib/VoucherifySdk/models/reward.rb +410 -0
- data/lib/VoucherifySdk/models/reward_assignment.rb +383 -0
- data/lib/VoucherifySdk/models/reward_assignment_base.rb +366 -0
- data/lib/VoucherifySdk/models/reward_assignment_parameters.rb +214 -0
- data/lib/VoucherifySdk/models/reward_assignment_parameters_parameters.rb +222 -0
- data/lib/VoucherifySdk/models/reward_assignment_parameters_parameters_loyalty.rb +216 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_coin_reward_request_body.rb +234 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_digital_or_material_reward_request_body.rb +239 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_digital_or_material_reward_request_body_parameters.rb +222 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_digital_or_material_reward_request_body_parameters_loyalty.rb +216 -0
- data/lib/VoucherifySdk/models/reward_attributes.rb +226 -0
- data/lib/VoucherifySdk/models/reward_type.rb +106 -0
- data/lib/VoucherifySdk/models/reward_type_campaign.rb +221 -0
- data/lib/VoucherifySdk/models/reward_type_campaign_campaign.rb +284 -0
- data/lib/VoucherifySdk/models/reward_type_coin.rb +221 -0
- data/lib/VoucherifySdk/models/reward_type_coin_coin.rb +233 -0
- data/lib/VoucherifySdk/models/reward_type_material.rb +221 -0
- data/lib/VoucherifySdk/models/reward_type_material_product.rb +236 -0
- data/lib/VoucherifySdk/models/rewards_assignments_create_request_body.rb +106 -0
- data/lib/VoucherifySdk/models/rewards_assignments_create_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/rewards_assignments_get_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/rewards_assignments_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_request_body_parameters.rb +215 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_request_body_parameters_loyalty.rb +216 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/schema_that_contains_unique_properties_for_promotion_campaign_promotion.rb +217 -0
- data/lib/VoucherifySdk/models/session.rb +307 -0
- data/lib/VoucherifySdk/models/simple_campaign.rb +381 -0
- data/lib/VoucherifySdk/models/simple_consent.rb +273 -0
- data/lib/VoucherifySdk/models/simple_customer.rb +301 -0
- data/lib/VoucherifySdk/models/simple_customer_required_object_type.rb +273 -0
- data/lib/VoucherifySdk/models/simple_order.rb +423 -0
- data/lib/VoucherifySdk/models/simple_order_item.rb +363 -0
- data/lib/VoucherifySdk/models/simple_product.rb +235 -0
- data/lib/VoucherifySdk/models/simple_product_discount_unit.rb +249 -0
- data/lib/VoucherifySdk/models/simple_promotion_tier.rb +245 -0
- data/lib/VoucherifySdk/models/simple_promotion_tier_campaign.rb +216 -0
- data/lib/VoucherifySdk/models/simple_redemption.rb +368 -0
- data/lib/VoucherifySdk/models/simple_redemption_reward_result.rb +380 -0
- data/lib/VoucherifySdk/models/simple_referral_tier.rb +245 -0
- data/lib/VoucherifySdk/models/simple_segment.rb +290 -0
- data/lib/VoucherifySdk/models/simple_sku.rb +235 -0
- data/lib/VoucherifySdk/models/simple_sku_discount_unit.rb +249 -0
- data/lib/VoucherifySdk/models/simple_voucher.rb +390 -0
- data/lib/VoucherifySdk/models/sku.rb +418 -0
- data/lib/VoucherifySdk/models/sku_with_product.rb +433 -0
- data/lib/VoucherifySdk/models/skus_get_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/skus_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/skus_list.rb +276 -0
- data/lib/VoucherifySdk/models/skus_list_for_product.rb +276 -0
- data/lib/VoucherifySdk/models/stackable_validate_redeem_base.rb +299 -0
- data/lib/VoucherifySdk/models/stackable_validate_redeem_base_redeemables_item.rb +108 -0
- data/lib/VoucherifySdk/models/stacking_rules.rb +487 -0
- data/lib/VoucherifySdk/models/validation_entity.rb +325 -0
- data/lib/VoucherifySdk/models/validation_rule.rb +422 -0
- data/lib/VoucherifySdk/models/validation_rule_assignment.rb +354 -0
- data/lib/VoucherifySdk/models/validation_rule_assignments_list.rb +276 -0
- data/lib/VoucherifySdk/models/validation_rule_base.rb +314 -0
- data/lib/VoucherifySdk/models/validation_rule_base_applicable_to.rb +239 -0
- data/lib/VoucherifySdk/models/validation_rule_base_error.rb +216 -0
- data/lib/VoucherifySdk/models/validation_rules_assignments_list.rb +341 -0
- data/lib/VoucherifySdk/models/validation_rules_assignments_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +328 -0
- data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/validation_rules_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +321 -0
- data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/validations_redeemable_applicable.rb +340 -0
- data/lib/VoucherifySdk/models/validations_redeemable_applicable_result.rb +109 -0
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable.rb +292 -0
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable_result.rb +214 -0
- data/lib/VoucherifySdk/models/validations_redeemable_skipped.rb +292 -0
- data/lib/VoucherifySdk/models/validations_validate_all_response_body_redeemables_item.rb +106 -0
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +294 -0
- data/lib/VoucherifySdk/models/voucher.rb +540 -0
- data/lib/VoucherifySdk/models/voucher_assets.rb +224 -0
- data/lib/VoucherifySdk/models/voucher_gift.rb +270 -0
- data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +246 -0
- data/lib/VoucherifySdk/models/voucher_publish.rb +238 -0
- data/lib/VoucherifySdk/models/voucher_redemption.rb +268 -0
- data/lib/VoucherifySdk/models/voucher_transaction.rb +379 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details.rb +323 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +365 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance_related_object.rb +280 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +239 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule_source.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_event.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +238 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_order.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_redemption.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_reward.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +238 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export.rb +407 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_filter_conditions.rb +222 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_filter_conditions_voucher_id.rb +222 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_filter_conditions_voucher_id_conditions.rb +252 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_parameters.rb +262 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_result.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transactions_filters.rb +278 -0
- data/lib/VoucherifySdk/models/voucher_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/vouchers_balance_update_request_body.rb +243 -0
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +381 -0
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body_related_object.rb +274 -0
- data/lib/VoucherifySdk/models/vouchers_disable_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/vouchers_enable_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/vouchers_get_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/vouchers_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb +323 -0
- data/lib/VoucherifySdk/models/vouchers_redemption_get_response_body_redemption_entries_item.rb +105 -0
- data/lib/VoucherifySdk/models/vouchers_transactions_export_create_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/vouchers_transactions_export_create_response_body.rb +414 -0
- data/lib/VoucherifySdk/models/vouchers_transactions_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/version.rb +15 -0
- data/lib/VoucherifySdk.rb +716 -0
- metadata +1430 -72
- data/.gitignore +0 -43
- data/.rspec +0 -2
- data/.travis.yml +0 -9
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/examples/customers.rb +0 -32
- data/examples/utils.rb +0 -71
- data/examples/vouchers.rb +0 -25
- data/lib/voucherify/client.rb +0 -154
- data/lib/voucherify/service/async_actions.rb +0 -22
- data/lib/voucherify/service/campaigns.rb +0 -39
- data/lib/voucherify/service/consents.rb +0 -17
- data/lib/voucherify/service/customers.rb +0 -37
- data/lib/voucherify/service/distributions.rb +0 -45
- data/lib/voucherify/service/events.rb +0 -24
- data/lib/voucherify/service/loyalties.rb +0 -133
- data/lib/voucherify/service/orders.rb +0 -29
- data/lib/voucherify/service/products.rb +0 -53
- data/lib/voucherify/service/promotions.rb +0 -58
- data/lib/voucherify/service/redemptions.rb +0 -42
- data/lib/voucherify/service/rewards.rb +0 -63
- data/lib/voucherify/service/segments.rb +0 -25
- data/lib/voucherify/service/validation_rules.rb +0 -69
- data/lib/voucherify/service/validations.rb +0 -26
- data/lib/voucherify/service/vouchers.rb +0 -54
- data/lib/voucherify/utils.rb +0 -101
- data/lib/voucherify/version.rb +0 -3
- data/lib/voucherify.rb +0 -23
- data/voucherify.gemspec +0 -28
|
@@ -0,0 +1,1643 @@
|
|
|
1
|
+
# VoucherifySdk::LoyaltiesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.voucherify.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_in_bulk_loyalty_tiers**](LoyaltiesApi.md#create_in_bulk_loyalty_tiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers |
|
|
8
|
+
| [**delete_earning_rule**](LoyaltiesApi.md#delete_earning_rule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule |
|
|
9
|
+
| [**delete_loyalty_program**](LoyaltiesApi.md#delete_loyalty_program) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign |
|
|
10
|
+
| [**delete_reward_assignment1**](LoyaltiesApi.md#delete_reward_assignment1) | **DELETE** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Reward Assignment |
|
|
11
|
+
| [**disable_earning_rule**](LoyaltiesApi.md#disable_earning_rule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule |
|
|
12
|
+
| [**enable_earning_rule**](LoyaltiesApi.md#enable_earning_rule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule |
|
|
13
|
+
| [**export_loyalty_card_transactions**](LoyaltiesApi.md#export_loyalty_card_transactions) | **POST** /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions |
|
|
14
|
+
| [**export_loyalty_card_transactions1**](LoyaltiesApi.md#export_loyalty_card_transactions1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions |
|
|
15
|
+
| [**get_earning_rule**](LoyaltiesApi.md#get_earning_rule) | **GET** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule |
|
|
16
|
+
| [**get_loyalty_tier**](LoyaltiesApi.md#get_loyalty_tier) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier |
|
|
17
|
+
| [**get_reward_assignment1**](LoyaltiesApi.md#get_reward_assignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Reward Assignment |
|
|
18
|
+
| [**get_reward_assignment2**](LoyaltiesApi.md#get_reward_assignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Reward Assignment |
|
|
19
|
+
| [**get_reward_details**](LoyaltiesApi.md#get_reward_details) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details |
|
|
20
|
+
| [**list_loyalty_card_transactions**](LoyaltiesApi.md#list_loyalty_card_transactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions |
|
|
21
|
+
| [**list_loyalty_card_transactions1**](LoyaltiesApi.md#list_loyalty_card_transactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions |
|
|
22
|
+
| [**list_loyalty_tier_earning_rules**](LoyaltiesApi.md#list_loyalty_tier_earning_rules) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules |
|
|
23
|
+
| [**list_loyalty_tier_rewards**](LoyaltiesApi.md#list_loyalty_tier_rewards) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards |
|
|
24
|
+
| [**list_loyalty_tiers**](LoyaltiesApi.md#list_loyalty_tiers) | **GET** /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers |
|
|
25
|
+
| [**list_member_loyalty_tier**](LoyaltiesApi.md#list_member_loyalty_tier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers |
|
|
26
|
+
| [**list_member_rewards**](LoyaltiesApi.md#list_member_rewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards |
|
|
27
|
+
| [**list_points_expiration**](LoyaltiesApi.md#list_points_expiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | Get Points Expiration |
|
|
28
|
+
| [**redeem_reward**](LoyaltiesApi.md#redeem_reward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward |
|
|
29
|
+
| [**redeem_reward1**](LoyaltiesApi.md#redeem_reward1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward |
|
|
30
|
+
| [**transfer_points**](LoyaltiesApi.md#transfer_points) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points |
|
|
31
|
+
| [**update_loyalty_card_balance**](LoyaltiesApi.md#update_loyalty_card_balance) | **POST** /v1/loyalties/members/{memberId}/balance | Add or Remove Loyalty Card Balance |
|
|
32
|
+
| [**update_loyalty_card_balance1**](LoyaltiesApi.md#update_loyalty_card_balance1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/balance | Add or Remove Loyalty Card Balance |
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
## create_in_bulk_loyalty_tiers
|
|
36
|
+
|
|
37
|
+
> <Array<LoyaltyTier>> create_in_bulk_loyalty_tiers(campaign_id, opts)
|
|
38
|
+
|
|
39
|
+
Create loyalty tiers
|
|
40
|
+
|
|
41
|
+
Creates loyalty tiers for desired campaign.
|
|
42
|
+
|
|
43
|
+
### Examples
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
require 'time'
|
|
47
|
+
require 'VoucherifySdk'
|
|
48
|
+
# setup authorization
|
|
49
|
+
VoucherifySdk.configure do |config|
|
|
50
|
+
# Configure API key authorization: X-App-Id
|
|
51
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
52
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
53
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
54
|
+
|
|
55
|
+
# Configure API key authorization: X-App-Token
|
|
56
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
57
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
58
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
62
|
+
campaign_id = 'campaign_id_example' # String | Unique loyalty campaign ID or name.
|
|
63
|
+
opts = {
|
|
64
|
+
loyalties_tiers_create_in_bulk_request_body_item: [VoucherifySdk::LoyaltiesTiersCreateInBulkRequestBodyItem.new({name: 'name_example', points: VoucherifySdk::LoyaltyTierBasePoints.new})] # Array<LoyaltiesTiersCreateInBulkRequestBodyItem> | Provide tier definitions you want to add to existing loyalty campaign.
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
begin
|
|
68
|
+
# Create loyalty tiers
|
|
69
|
+
result = api_instance.create_in_bulk_loyalty_tiers(campaign_id, opts)
|
|
70
|
+
p result
|
|
71
|
+
rescue VoucherifySdk::ApiError => e
|
|
72
|
+
puts "Error when calling LoyaltiesApi->create_in_bulk_loyalty_tiers: #{e}"
|
|
73
|
+
end
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
|
|
78
|
+
| Name | Type | Description | Notes |
|
|
79
|
+
| ---- | ---- | ----------- | ----- |
|
|
80
|
+
| **campaign_id** | **String** | Unique loyalty campaign ID or name. | |
|
|
81
|
+
| **loyalties_tiers_create_in_bulk_request_body_item** | [**Array<LoyaltiesTiersCreateInBulkRequestBodyItem>**](LoyaltiesTiersCreateInBulkRequestBodyItem.md) | Provide tier definitions you want to add to existing loyalty campaign. | [optional] |
|
|
82
|
+
|
|
83
|
+
### Return type
|
|
84
|
+
|
|
85
|
+
[**Array<LoyaltyTier>**](LoyaltyTier.md)
|
|
86
|
+
|
|
87
|
+
### Authorization
|
|
88
|
+
|
|
89
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
90
|
+
|
|
91
|
+
### HTTP request headers
|
|
92
|
+
|
|
93
|
+
- **Content-Type**: application/json
|
|
94
|
+
- **Accept**: application/json
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
## delete_earning_rule
|
|
98
|
+
|
|
99
|
+
> delete_earning_rule(campaign_id, earning_rule_id)
|
|
100
|
+
|
|
101
|
+
Delete Earning Rule
|
|
102
|
+
|
|
103
|
+
This method deletes an earning rule for a specific loyalty campaign.
|
|
104
|
+
|
|
105
|
+
### Examples
|
|
106
|
+
|
|
107
|
+
```ruby
|
|
108
|
+
require 'time'
|
|
109
|
+
require 'VoucherifySdk'
|
|
110
|
+
# setup authorization
|
|
111
|
+
VoucherifySdk.configure do |config|
|
|
112
|
+
# Configure API key authorization: X-App-Id
|
|
113
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
115
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
116
|
+
|
|
117
|
+
# Configure API key authorization: X-App-Token
|
|
118
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
119
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
120
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
124
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
125
|
+
earning_rule_id = 'earning_rule_id_example' # String | A unique earning rule ID.
|
|
126
|
+
|
|
127
|
+
begin
|
|
128
|
+
# Delete Earning Rule
|
|
129
|
+
api_instance.delete_earning_rule(campaign_id, earning_rule_id)
|
|
130
|
+
rescue VoucherifySdk::ApiError => e
|
|
131
|
+
puts "Error when calling LoyaltiesApi->delete_earning_rule: #{e}"
|
|
132
|
+
end
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
| Name | Type | Description | Notes |
|
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
|
139
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
140
|
+
| **earning_rule_id** | **String** | A unique earning rule ID. | |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
nil (empty response body)
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
152
|
+
- **Content-Type**: Not defined
|
|
153
|
+
- **Accept**: Not defined
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
## delete_loyalty_program
|
|
157
|
+
|
|
158
|
+
> <LoyaltiesDeleteResponseBody> delete_loyalty_program(campaign_id, opts)
|
|
159
|
+
|
|
160
|
+
Delete Loyalty Campaign
|
|
161
|
+
|
|
162
|
+
This method permanently deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards.
|
|
163
|
+
|
|
164
|
+
### Examples
|
|
165
|
+
|
|
166
|
+
```ruby
|
|
167
|
+
require 'time'
|
|
168
|
+
require 'VoucherifySdk'
|
|
169
|
+
# setup authorization
|
|
170
|
+
VoucherifySdk.configure do |config|
|
|
171
|
+
# Configure API key authorization: X-App-Id
|
|
172
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
173
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
174
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
175
|
+
|
|
176
|
+
# Configure API key authorization: X-App-Token
|
|
177
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
179
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
183
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
184
|
+
opts = {
|
|
185
|
+
force: true # Boolean | If this flag is set to true, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with the same name.
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
begin
|
|
189
|
+
# Delete Loyalty Campaign
|
|
190
|
+
result = api_instance.delete_loyalty_program(campaign_id, opts)
|
|
191
|
+
p result
|
|
192
|
+
rescue VoucherifySdk::ApiError => e
|
|
193
|
+
puts "Error when calling LoyaltiesApi->delete_loyalty_program: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
| Name | Type | Description | Notes |
|
|
200
|
+
| ---- | ---- | ----------- | ----- |
|
|
201
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
202
|
+
| **force** | **Boolean** | If this flag is set to true, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with the same name. | [optional] |
|
|
203
|
+
|
|
204
|
+
### Return type
|
|
205
|
+
|
|
206
|
+
[**LoyaltiesDeleteResponseBody**](LoyaltiesDeleteResponseBody.md)
|
|
207
|
+
|
|
208
|
+
### Authorization
|
|
209
|
+
|
|
210
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
211
|
+
|
|
212
|
+
### HTTP request headers
|
|
213
|
+
|
|
214
|
+
- **Content-Type**: Not defined
|
|
215
|
+
- **Accept**: application/json
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
## delete_reward_assignment1
|
|
219
|
+
|
|
220
|
+
> delete_reward_assignment1(campaign_id, assignment_id)
|
|
221
|
+
|
|
222
|
+
Delete Reward Assignment
|
|
223
|
+
|
|
224
|
+
This method deletes a reward assignment for a particular loyalty campaign.
|
|
225
|
+
|
|
226
|
+
### Examples
|
|
227
|
+
|
|
228
|
+
```ruby
|
|
229
|
+
require 'time'
|
|
230
|
+
require 'VoucherifySdk'
|
|
231
|
+
# setup authorization
|
|
232
|
+
VoucherifySdk.configure do |config|
|
|
233
|
+
# Configure API key authorization: X-App-Id
|
|
234
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
235
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
236
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
237
|
+
|
|
238
|
+
# Configure API key authorization: X-App-Token
|
|
239
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
240
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
241
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
242
|
+
end
|
|
243
|
+
|
|
244
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
245
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
246
|
+
assignment_id = 'assignment_id_example' # String | A unique reward assignment ID.
|
|
247
|
+
|
|
248
|
+
begin
|
|
249
|
+
# Delete Reward Assignment
|
|
250
|
+
api_instance.delete_reward_assignment1(campaign_id, assignment_id)
|
|
251
|
+
rescue VoucherifySdk::ApiError => e
|
|
252
|
+
puts "Error when calling LoyaltiesApi->delete_reward_assignment1: #{e}"
|
|
253
|
+
end
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Parameters
|
|
257
|
+
|
|
258
|
+
| Name | Type | Description | Notes |
|
|
259
|
+
| ---- | ---- | ----------- | ----- |
|
|
260
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
261
|
+
| **assignment_id** | **String** | A unique reward assignment ID. | |
|
|
262
|
+
|
|
263
|
+
### Return type
|
|
264
|
+
|
|
265
|
+
nil (empty response body)
|
|
266
|
+
|
|
267
|
+
### Authorization
|
|
268
|
+
|
|
269
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
270
|
+
|
|
271
|
+
### HTTP request headers
|
|
272
|
+
|
|
273
|
+
- **Content-Type**: Not defined
|
|
274
|
+
- **Accept**: Not defined
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
## disable_earning_rule
|
|
278
|
+
|
|
279
|
+
> <LoyaltiesEarningRulesDisableResponseBody> disable_earning_rule(campaign_id, earning_rule_id)
|
|
280
|
+
|
|
281
|
+
Disable Earning Rule
|
|
282
|
+
|
|
283
|
+
Disable an earning rule.
|
|
284
|
+
|
|
285
|
+
### Examples
|
|
286
|
+
|
|
287
|
+
```ruby
|
|
288
|
+
require 'time'
|
|
289
|
+
require 'VoucherifySdk'
|
|
290
|
+
# setup authorization
|
|
291
|
+
VoucherifySdk.configure do |config|
|
|
292
|
+
# Configure API key authorization: X-App-Id
|
|
293
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
294
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
295
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
296
|
+
|
|
297
|
+
# Configure API key authorization: X-App-Token
|
|
298
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
299
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
300
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
301
|
+
end
|
|
302
|
+
|
|
303
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
304
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
|
305
|
+
earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule ID.
|
|
306
|
+
|
|
307
|
+
begin
|
|
308
|
+
# Disable Earning Rule
|
|
309
|
+
result = api_instance.disable_earning_rule(campaign_id, earning_rule_id)
|
|
310
|
+
p result
|
|
311
|
+
rescue VoucherifySdk::ApiError => e
|
|
312
|
+
puts "Error when calling LoyaltiesApi->disable_earning_rule: #{e}"
|
|
313
|
+
end
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### Parameters
|
|
317
|
+
|
|
318
|
+
| Name | Type | Description | Notes |
|
|
319
|
+
| ---- | ---- | ----------- | ----- |
|
|
320
|
+
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
|
321
|
+
| **earning_rule_id** | **String** | Unique earning rule ID. | |
|
|
322
|
+
|
|
323
|
+
### Return type
|
|
324
|
+
|
|
325
|
+
[**LoyaltiesEarningRulesDisableResponseBody**](LoyaltiesEarningRulesDisableResponseBody.md)
|
|
326
|
+
|
|
327
|
+
### Authorization
|
|
328
|
+
|
|
329
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
330
|
+
|
|
331
|
+
### HTTP request headers
|
|
332
|
+
|
|
333
|
+
- **Content-Type**: Not defined
|
|
334
|
+
- **Accept**: application/json
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
## enable_earning_rule
|
|
338
|
+
|
|
339
|
+
> <LoyaltiesEarningRulesEnableResponseBody> enable_earning_rule(campaign_id, earning_rule_id)
|
|
340
|
+
|
|
341
|
+
Enable Earning Rule
|
|
342
|
+
|
|
343
|
+
Enable an earning rule.
|
|
344
|
+
|
|
345
|
+
### Examples
|
|
346
|
+
|
|
347
|
+
```ruby
|
|
348
|
+
require 'time'
|
|
349
|
+
require 'VoucherifySdk'
|
|
350
|
+
# setup authorization
|
|
351
|
+
VoucherifySdk.configure do |config|
|
|
352
|
+
# Configure API key authorization: X-App-Id
|
|
353
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
354
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
355
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
356
|
+
|
|
357
|
+
# Configure API key authorization: X-App-Token
|
|
358
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
359
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
360
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
364
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
|
365
|
+
earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule ID.
|
|
366
|
+
|
|
367
|
+
begin
|
|
368
|
+
# Enable Earning Rule
|
|
369
|
+
result = api_instance.enable_earning_rule(campaign_id, earning_rule_id)
|
|
370
|
+
p result
|
|
371
|
+
rescue VoucherifySdk::ApiError => e
|
|
372
|
+
puts "Error when calling LoyaltiesApi->enable_earning_rule: #{e}"
|
|
373
|
+
end
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Parameters
|
|
377
|
+
|
|
378
|
+
| Name | Type | Description | Notes |
|
|
379
|
+
| ---- | ---- | ----------- | ----- |
|
|
380
|
+
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
|
381
|
+
| **earning_rule_id** | **String** | Unique earning rule ID. | |
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
[**LoyaltiesEarningRulesEnableResponseBody**](LoyaltiesEarningRulesEnableResponseBody.md)
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: Not defined
|
|
394
|
+
- **Accept**: application/json
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
## export_loyalty_card_transactions
|
|
398
|
+
|
|
399
|
+
> <LoyaltiesMembersTransactionsExportCreateResponseBody> export_loyalty_card_transactions(member_id, opts)
|
|
400
|
+
|
|
401
|
+
Export Loyalty Card Transactions
|
|
402
|
+
|
|
403
|
+
Export transactions that are associated with point movements on a loyalty card.
|
|
404
|
+
|
|
405
|
+
### Examples
|
|
406
|
+
|
|
407
|
+
```ruby
|
|
408
|
+
require 'time'
|
|
409
|
+
require 'VoucherifySdk'
|
|
410
|
+
# setup authorization
|
|
411
|
+
VoucherifySdk.configure do |config|
|
|
412
|
+
# Configure API key authorization: X-App-Id
|
|
413
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
414
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
415
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
416
|
+
|
|
417
|
+
# Configure API key authorization: X-App-Token
|
|
418
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
419
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
420
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
421
|
+
end
|
|
422
|
+
|
|
423
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
424
|
+
member_id = 'member_id_example' # String | A unique code identifying the loyalty card that you are looking to export transaction data for.
|
|
425
|
+
opts = {
|
|
426
|
+
loyalties_members_transactions_export_create_request_body: VoucherifySdk::LoyaltiesMembersTransactionsExportCreateRequestBody.new # LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export.
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
begin
|
|
430
|
+
# Export Loyalty Card Transactions
|
|
431
|
+
result = api_instance.export_loyalty_card_transactions(member_id, opts)
|
|
432
|
+
p result
|
|
433
|
+
rescue VoucherifySdk::ApiError => e
|
|
434
|
+
puts "Error when calling LoyaltiesApi->export_loyalty_card_transactions: #{e}"
|
|
435
|
+
end
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
### Parameters
|
|
439
|
+
|
|
440
|
+
| Name | Type | Description | Notes |
|
|
441
|
+
| ---- | ---- | ----------- | ----- |
|
|
442
|
+
| **member_id** | **String** | A unique code identifying the loyalty card that you are looking to export transaction data for. | |
|
|
443
|
+
| **loyalties_members_transactions_export_create_request_body** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md) | Specify the parameters and filters for the transaction export. | [optional] |
|
|
444
|
+
|
|
445
|
+
### Return type
|
|
446
|
+
|
|
447
|
+
[**LoyaltiesMembersTransactionsExportCreateResponseBody**](LoyaltiesMembersTransactionsExportCreateResponseBody.md)
|
|
448
|
+
|
|
449
|
+
### Authorization
|
|
450
|
+
|
|
451
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
452
|
+
|
|
453
|
+
### HTTP request headers
|
|
454
|
+
|
|
455
|
+
- **Content-Type**: application/json
|
|
456
|
+
- **Accept**: application/json
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
## export_loyalty_card_transactions1
|
|
460
|
+
|
|
461
|
+
> <LoyaltiesMembersTransactionsExportCreateResponseBody> export_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
462
|
+
|
|
463
|
+
Export Loyalty Card Transactions
|
|
464
|
+
|
|
465
|
+
Export transactions that are associated with point movements on a loyalty card.
|
|
466
|
+
|
|
467
|
+
### Examples
|
|
468
|
+
|
|
469
|
+
```ruby
|
|
470
|
+
require 'time'
|
|
471
|
+
require 'VoucherifySdk'
|
|
472
|
+
# setup authorization
|
|
473
|
+
VoucherifySdk.configure do |config|
|
|
474
|
+
# Configure API key authorization: X-App-Id
|
|
475
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
476
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
477
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
478
|
+
|
|
479
|
+
# Configure API key authorization: X-App-Token
|
|
480
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
481
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
482
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
486
|
+
campaign_id = 'campaign_id_example' # String | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
|
|
487
|
+
member_id = 'member_id_example' # String | A unique code identifying the loyalty card that you are looking to export transaction data for.
|
|
488
|
+
opts = {
|
|
489
|
+
loyalties_members_transactions_export_create_request_body: VoucherifySdk::LoyaltiesMembersTransactionsExportCreateRequestBody.new # LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export.
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
begin
|
|
493
|
+
# Export Loyalty Card Transactions
|
|
494
|
+
result = api_instance.export_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
495
|
+
p result
|
|
496
|
+
rescue VoucherifySdk::ApiError => e
|
|
497
|
+
puts "Error when calling LoyaltiesApi->export_loyalty_card_transactions1: #{e}"
|
|
498
|
+
end
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Parameters
|
|
502
|
+
|
|
503
|
+
| Name | Type | Description | Notes |
|
|
504
|
+
| ---- | ---- | ----------- | ----- |
|
|
505
|
+
| **campaign_id** | **String** | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. | |
|
|
506
|
+
| **member_id** | **String** | A unique code identifying the loyalty card that you are looking to export transaction data for. | |
|
|
507
|
+
| **loyalties_members_transactions_export_create_request_body** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md) | Specify the parameters and filters for the transaction export. | [optional] |
|
|
508
|
+
|
|
509
|
+
### Return type
|
|
510
|
+
|
|
511
|
+
[**LoyaltiesMembersTransactionsExportCreateResponseBody**](LoyaltiesMembersTransactionsExportCreateResponseBody.md)
|
|
512
|
+
|
|
513
|
+
### Authorization
|
|
514
|
+
|
|
515
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
516
|
+
|
|
517
|
+
### HTTP request headers
|
|
518
|
+
|
|
519
|
+
- **Content-Type**: application/json
|
|
520
|
+
- **Accept**: application/json
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
## get_earning_rule
|
|
524
|
+
|
|
525
|
+
> <LoyaltiesEarningRulesGetResponseBody> get_earning_rule(campaign_id, earning_rule_id)
|
|
526
|
+
|
|
527
|
+
Get Earning Rule
|
|
528
|
+
|
|
529
|
+
Retrieves an earning rule assigned to a campaign.
|
|
530
|
+
|
|
531
|
+
### Examples
|
|
532
|
+
|
|
533
|
+
```ruby
|
|
534
|
+
require 'time'
|
|
535
|
+
require 'VoucherifySdk'
|
|
536
|
+
# setup authorization
|
|
537
|
+
VoucherifySdk.configure do |config|
|
|
538
|
+
# Configure API key authorization: X-App-Id
|
|
539
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
540
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
541
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
542
|
+
|
|
543
|
+
# Configure API key authorization: X-App-Token
|
|
544
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
545
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
546
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
547
|
+
end
|
|
548
|
+
|
|
549
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
550
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
551
|
+
earning_rule_id = 'earning_rule_id_example' # String | A unique earning rule ID.
|
|
552
|
+
|
|
553
|
+
begin
|
|
554
|
+
# Get Earning Rule
|
|
555
|
+
result = api_instance.get_earning_rule(campaign_id, earning_rule_id)
|
|
556
|
+
p result
|
|
557
|
+
rescue VoucherifySdk::ApiError => e
|
|
558
|
+
puts "Error when calling LoyaltiesApi->get_earning_rule: #{e}"
|
|
559
|
+
end
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
### Parameters
|
|
563
|
+
|
|
564
|
+
| Name | Type | Description | Notes |
|
|
565
|
+
| ---- | ---- | ----------- | ----- |
|
|
566
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
567
|
+
| **earning_rule_id** | **String** | A unique earning rule ID. | |
|
|
568
|
+
|
|
569
|
+
### Return type
|
|
570
|
+
|
|
571
|
+
[**LoyaltiesEarningRulesGetResponseBody**](LoyaltiesEarningRulesGetResponseBody.md)
|
|
572
|
+
|
|
573
|
+
### Authorization
|
|
574
|
+
|
|
575
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
576
|
+
|
|
577
|
+
### HTTP request headers
|
|
578
|
+
|
|
579
|
+
- **Content-Type**: Not defined
|
|
580
|
+
- **Accept**: application/json
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
## get_loyalty_tier
|
|
584
|
+
|
|
585
|
+
> <LoyaltiesTiersGetResponseBody> get_loyalty_tier(campaign_id, loyalty_tier_id)
|
|
586
|
+
|
|
587
|
+
Get Loyalty Tier
|
|
588
|
+
|
|
589
|
+
Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
|
|
590
|
+
|
|
591
|
+
### Examples
|
|
592
|
+
|
|
593
|
+
```ruby
|
|
594
|
+
require 'time'
|
|
595
|
+
require 'VoucherifySdk'
|
|
596
|
+
# setup authorization
|
|
597
|
+
VoucherifySdk.configure do |config|
|
|
598
|
+
# Configure API key authorization: X-App-Id
|
|
599
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
600
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
601
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
602
|
+
|
|
603
|
+
# Configure API key authorization: X-App-Token
|
|
604
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
605
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
606
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
607
|
+
end
|
|
608
|
+
|
|
609
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
610
|
+
campaign_id = 'campaign_id_example' # String | Unique loyalty campaign ID or name.
|
|
611
|
+
loyalty_tier_id = 'loyalty_tier_id_example' # String | Unique loyalty tier ID.
|
|
612
|
+
|
|
613
|
+
begin
|
|
614
|
+
# Get Loyalty Tier
|
|
615
|
+
result = api_instance.get_loyalty_tier(campaign_id, loyalty_tier_id)
|
|
616
|
+
p result
|
|
617
|
+
rescue VoucherifySdk::ApiError => e
|
|
618
|
+
puts "Error when calling LoyaltiesApi->get_loyalty_tier: #{e}"
|
|
619
|
+
end
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
### Parameters
|
|
623
|
+
|
|
624
|
+
| Name | Type | Description | Notes |
|
|
625
|
+
| ---- | ---- | ----------- | ----- |
|
|
626
|
+
| **campaign_id** | **String** | Unique loyalty campaign ID or name. | |
|
|
627
|
+
| **loyalty_tier_id** | **String** | Unique loyalty tier ID. | |
|
|
628
|
+
|
|
629
|
+
### Return type
|
|
630
|
+
|
|
631
|
+
[**LoyaltiesTiersGetResponseBody**](LoyaltiesTiersGetResponseBody.md)
|
|
632
|
+
|
|
633
|
+
### Authorization
|
|
634
|
+
|
|
635
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
636
|
+
|
|
637
|
+
### HTTP request headers
|
|
638
|
+
|
|
639
|
+
- **Content-Type**: Not defined
|
|
640
|
+
- **Accept**: application/json
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
## get_reward_assignment1
|
|
644
|
+
|
|
645
|
+
> <LoyaltiesRewardAssignmentsGetResponseBody> get_reward_assignment1(campaign_id, assignment_id)
|
|
646
|
+
|
|
647
|
+
Get Reward Assignment
|
|
648
|
+
|
|
649
|
+
Retrieve specific reward assignment.
|
|
650
|
+
|
|
651
|
+
### Examples
|
|
652
|
+
|
|
653
|
+
```ruby
|
|
654
|
+
require 'time'
|
|
655
|
+
require 'VoucherifySdk'
|
|
656
|
+
# setup authorization
|
|
657
|
+
VoucherifySdk.configure do |config|
|
|
658
|
+
# Configure API key authorization: X-App-Id
|
|
659
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
660
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
661
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
662
|
+
|
|
663
|
+
# Configure API key authorization: X-App-Token
|
|
664
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
665
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
666
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
667
|
+
end
|
|
668
|
+
|
|
669
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
670
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
671
|
+
assignment_id = 'assignment_id_example' # String | Unique reward assignment ID.
|
|
672
|
+
|
|
673
|
+
begin
|
|
674
|
+
# Get Reward Assignment
|
|
675
|
+
result = api_instance.get_reward_assignment1(campaign_id, assignment_id)
|
|
676
|
+
p result
|
|
677
|
+
rescue VoucherifySdk::ApiError => e
|
|
678
|
+
puts "Error when calling LoyaltiesApi->get_reward_assignment1: #{e}"
|
|
679
|
+
end
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
### Parameters
|
|
683
|
+
|
|
684
|
+
| Name | Type | Description | Notes |
|
|
685
|
+
| ---- | ---- | ----------- | ----- |
|
|
686
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
687
|
+
| **assignment_id** | **String** | Unique reward assignment ID. | |
|
|
688
|
+
|
|
689
|
+
### Return type
|
|
690
|
+
|
|
691
|
+
[**LoyaltiesRewardAssignmentsGetResponseBody**](LoyaltiesRewardAssignmentsGetResponseBody.md)
|
|
692
|
+
|
|
693
|
+
### Authorization
|
|
694
|
+
|
|
695
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
696
|
+
|
|
697
|
+
### HTTP request headers
|
|
698
|
+
|
|
699
|
+
- **Content-Type**: Not defined
|
|
700
|
+
- **Accept**: application/json
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
## get_reward_assignment2
|
|
704
|
+
|
|
705
|
+
> <LoyaltiesRewardsGetResponseBody> get_reward_assignment2(campaign_id, assignment_id)
|
|
706
|
+
|
|
707
|
+
Get Reward Assignment
|
|
708
|
+
|
|
709
|
+
Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this endpoint.
|
|
710
|
+
|
|
711
|
+
### Examples
|
|
712
|
+
|
|
713
|
+
```ruby
|
|
714
|
+
require 'time'
|
|
715
|
+
require 'VoucherifySdk'
|
|
716
|
+
# setup authorization
|
|
717
|
+
VoucherifySdk.configure do |config|
|
|
718
|
+
# Configure API key authorization: X-App-Id
|
|
719
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
720
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
721
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
722
|
+
|
|
723
|
+
# Configure API key authorization: X-App-Token
|
|
724
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
725
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
726
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
727
|
+
end
|
|
728
|
+
|
|
729
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
730
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
731
|
+
assignment_id = 'assignment_id_example' # String | A unique reward assignment ID.
|
|
732
|
+
|
|
733
|
+
begin
|
|
734
|
+
# Get Reward Assignment
|
|
735
|
+
result = api_instance.get_reward_assignment2(campaign_id, assignment_id)
|
|
736
|
+
p result
|
|
737
|
+
rescue VoucherifySdk::ApiError => e
|
|
738
|
+
puts "Error when calling LoyaltiesApi->get_reward_assignment2: #{e}"
|
|
739
|
+
end
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
### Parameters
|
|
743
|
+
|
|
744
|
+
| Name | Type | Description | Notes |
|
|
745
|
+
| ---- | ---- | ----------- | ----- |
|
|
746
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
747
|
+
| **assignment_id** | **String** | A unique reward assignment ID. | |
|
|
748
|
+
|
|
749
|
+
### Return type
|
|
750
|
+
|
|
751
|
+
[**LoyaltiesRewardsGetResponseBody**](LoyaltiesRewardsGetResponseBody.md)
|
|
752
|
+
|
|
753
|
+
### Authorization
|
|
754
|
+
|
|
755
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
756
|
+
|
|
757
|
+
### HTTP request headers
|
|
758
|
+
|
|
759
|
+
- **Content-Type**: Not defined
|
|
760
|
+
- **Accept**: application/json
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
## get_reward_details
|
|
764
|
+
|
|
765
|
+
> <LoyaltiesRewardAssignmentsRewardGetResponseBody> get_reward_details(campaign_id, assignment_id)
|
|
766
|
+
|
|
767
|
+
Get Reward Details
|
|
768
|
+
|
|
769
|
+
Get reward details in the context of a loyalty campaign and reward assignment ID.
|
|
770
|
+
|
|
771
|
+
### Examples
|
|
772
|
+
|
|
773
|
+
```ruby
|
|
774
|
+
require 'time'
|
|
775
|
+
require 'VoucherifySdk'
|
|
776
|
+
# setup authorization
|
|
777
|
+
VoucherifySdk.configure do |config|
|
|
778
|
+
# Configure API key authorization: X-App-Id
|
|
779
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
780
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
781
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
782
|
+
|
|
783
|
+
# Configure API key authorization: X-App-Token
|
|
784
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
785
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
786
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
787
|
+
end
|
|
788
|
+
|
|
789
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
790
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
791
|
+
assignment_id = 'assignment_id_example' # String | Unique reward assignment ID.
|
|
792
|
+
|
|
793
|
+
begin
|
|
794
|
+
# Get Reward Details
|
|
795
|
+
result = api_instance.get_reward_details(campaign_id, assignment_id)
|
|
796
|
+
p result
|
|
797
|
+
rescue VoucherifySdk::ApiError => e
|
|
798
|
+
puts "Error when calling LoyaltiesApi->get_reward_details: #{e}"
|
|
799
|
+
end
|
|
800
|
+
```
|
|
801
|
+
|
|
802
|
+
### Parameters
|
|
803
|
+
|
|
804
|
+
| Name | Type | Description | Notes |
|
|
805
|
+
| ---- | ---- | ----------- | ----- |
|
|
806
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
807
|
+
| **assignment_id** | **String** | Unique reward assignment ID. | |
|
|
808
|
+
|
|
809
|
+
### Return type
|
|
810
|
+
|
|
811
|
+
[**LoyaltiesRewardAssignmentsRewardGetResponseBody**](LoyaltiesRewardAssignmentsRewardGetResponseBody.md)
|
|
812
|
+
|
|
813
|
+
### Authorization
|
|
814
|
+
|
|
815
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
816
|
+
|
|
817
|
+
### HTTP request headers
|
|
818
|
+
|
|
819
|
+
- **Content-Type**: Not defined
|
|
820
|
+
- **Accept**: application/json
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
## list_loyalty_card_transactions
|
|
824
|
+
|
|
825
|
+
> <LoyaltiesMembersTransactionsListResponseBody> list_loyalty_card_transactions(member_id, opts)
|
|
826
|
+
|
|
827
|
+
List Loyalty Card Transactions
|
|
828
|
+
|
|
829
|
+
Retrieve transaction data related to point movements for a specific loyalty card.
|
|
830
|
+
|
|
831
|
+
### Examples
|
|
832
|
+
|
|
833
|
+
```ruby
|
|
834
|
+
require 'time'
|
|
835
|
+
require 'VoucherifySdk'
|
|
836
|
+
# setup authorization
|
|
837
|
+
VoucherifySdk.configure do |config|
|
|
838
|
+
# Configure API key authorization: X-App-Id
|
|
839
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
840
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
841
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
842
|
+
|
|
843
|
+
# Configure API key authorization: X-App-Token
|
|
844
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
845
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
846
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
847
|
+
end
|
|
848
|
+
|
|
849
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
850
|
+
member_id = 'member_id_example' # String | A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
|
|
851
|
+
opts = {
|
|
852
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
853
|
+
page: 56 # Integer | Which page of results to return.
|
|
854
|
+
}
|
|
855
|
+
|
|
856
|
+
begin
|
|
857
|
+
# List Loyalty Card Transactions
|
|
858
|
+
result = api_instance.list_loyalty_card_transactions(member_id, opts)
|
|
859
|
+
p result
|
|
860
|
+
rescue VoucherifySdk::ApiError => e
|
|
861
|
+
puts "Error when calling LoyaltiesApi->list_loyalty_card_transactions: #{e}"
|
|
862
|
+
end
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
### Parameters
|
|
866
|
+
|
|
867
|
+
| Name | Type | Description | Notes |
|
|
868
|
+
| ---- | ---- | ----------- | ----- |
|
|
869
|
+
| **member_id** | **String** | A unique code identifying the loyalty card that you are looking to retrieve transaction data for. | |
|
|
870
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
871
|
+
| **page** | **Integer** | Which page of results to return. | [optional] |
|
|
872
|
+
|
|
873
|
+
### Return type
|
|
874
|
+
|
|
875
|
+
[**LoyaltiesMembersTransactionsListResponseBody**](LoyaltiesMembersTransactionsListResponseBody.md)
|
|
876
|
+
|
|
877
|
+
### Authorization
|
|
878
|
+
|
|
879
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
880
|
+
|
|
881
|
+
### HTTP request headers
|
|
882
|
+
|
|
883
|
+
- **Content-Type**: Not defined
|
|
884
|
+
- **Accept**: application/json
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
## list_loyalty_card_transactions1
|
|
888
|
+
|
|
889
|
+
> <LoyaltiesMembersTransactionsListResponseBody> list_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
890
|
+
|
|
891
|
+
List Loyalty Card Transactions
|
|
892
|
+
|
|
893
|
+
Retrieve transaction data related to point movements for a specific loyalty card.
|
|
894
|
+
|
|
895
|
+
### Examples
|
|
896
|
+
|
|
897
|
+
```ruby
|
|
898
|
+
require 'time'
|
|
899
|
+
require 'VoucherifySdk'
|
|
900
|
+
# setup authorization
|
|
901
|
+
VoucherifySdk.configure do |config|
|
|
902
|
+
# Configure API key authorization: X-App-Id
|
|
903
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
904
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
905
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
906
|
+
|
|
907
|
+
# Configure API key authorization: X-App-Token
|
|
908
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
909
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
910
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
911
|
+
end
|
|
912
|
+
|
|
913
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
914
|
+
campaign_id = 'campaign_id_example' # String | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
|
|
915
|
+
member_id = 'member_id_example' # String | A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
|
|
916
|
+
opts = {
|
|
917
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
918
|
+
page: 56 # Integer | Which page of results to return.
|
|
919
|
+
}
|
|
920
|
+
|
|
921
|
+
begin
|
|
922
|
+
# List Loyalty Card Transactions
|
|
923
|
+
result = api_instance.list_loyalty_card_transactions1(campaign_id, member_id, opts)
|
|
924
|
+
p result
|
|
925
|
+
rescue VoucherifySdk::ApiError => e
|
|
926
|
+
puts "Error when calling LoyaltiesApi->list_loyalty_card_transactions1: #{e}"
|
|
927
|
+
end
|
|
928
|
+
```
|
|
929
|
+
|
|
930
|
+
### Parameters
|
|
931
|
+
|
|
932
|
+
| Name | Type | Description | Notes |
|
|
933
|
+
| ---- | ---- | ----------- | ----- |
|
|
934
|
+
| **campaign_id** | **String** | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. | |
|
|
935
|
+
| **member_id** | **String** | A unique code identifying the loyalty card that you are looking to retrieve transaction data for. | |
|
|
936
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
937
|
+
| **page** | **Integer** | Which page of results to return. | [optional] |
|
|
938
|
+
|
|
939
|
+
### Return type
|
|
940
|
+
|
|
941
|
+
[**LoyaltiesMembersTransactionsListResponseBody**](LoyaltiesMembersTransactionsListResponseBody.md)
|
|
942
|
+
|
|
943
|
+
### Authorization
|
|
944
|
+
|
|
945
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
946
|
+
|
|
947
|
+
### HTTP request headers
|
|
948
|
+
|
|
949
|
+
- **Content-Type**: Not defined
|
|
950
|
+
- **Accept**: application/json
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
## list_loyalty_tier_earning_rules
|
|
954
|
+
|
|
955
|
+
> <LoyaltiesTiersEarningRulesListResponseBody> list_loyalty_tier_earning_rules(campaign_id, loyalty_tier_id, opts)
|
|
956
|
+
|
|
957
|
+
List Loyalty Tier Earning Rules
|
|
958
|
+
|
|
959
|
+
Retrieve available earning rules for a given tier and the calculation method for earning points.
|
|
960
|
+
|
|
961
|
+
### Examples
|
|
962
|
+
|
|
963
|
+
```ruby
|
|
964
|
+
require 'time'
|
|
965
|
+
require 'VoucherifySdk'
|
|
966
|
+
# setup authorization
|
|
967
|
+
VoucherifySdk.configure do |config|
|
|
968
|
+
# Configure API key authorization: X-App-Id
|
|
969
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
970
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
971
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
972
|
+
|
|
973
|
+
# Configure API key authorization: X-App-Token
|
|
974
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
975
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
976
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
977
|
+
end
|
|
978
|
+
|
|
979
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
980
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
|
981
|
+
loyalty_tier_id = 'loyalty_tier_id_example' # String | Unique loyalty tier ID.
|
|
982
|
+
opts = {
|
|
983
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
984
|
+
page: 56 # Integer | Which page of results to return.
|
|
985
|
+
}
|
|
986
|
+
|
|
987
|
+
begin
|
|
988
|
+
# List Loyalty Tier Earning Rules
|
|
989
|
+
result = api_instance.list_loyalty_tier_earning_rules(campaign_id, loyalty_tier_id, opts)
|
|
990
|
+
p result
|
|
991
|
+
rescue VoucherifySdk::ApiError => e
|
|
992
|
+
puts "Error when calling LoyaltiesApi->list_loyalty_tier_earning_rules: #{e}"
|
|
993
|
+
end
|
|
994
|
+
```
|
|
995
|
+
|
|
996
|
+
### Parameters
|
|
997
|
+
|
|
998
|
+
| Name | Type | Description | Notes |
|
|
999
|
+
| ---- | ---- | ----------- | ----- |
|
|
1000
|
+
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
|
1001
|
+
| **loyalty_tier_id** | **String** | Unique loyalty tier ID. | |
|
|
1002
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
1003
|
+
| **page** | **Integer** | Which page of results to return. | [optional] |
|
|
1004
|
+
|
|
1005
|
+
### Return type
|
|
1006
|
+
|
|
1007
|
+
[**LoyaltiesTiersEarningRulesListResponseBody**](LoyaltiesTiersEarningRulesListResponseBody.md)
|
|
1008
|
+
|
|
1009
|
+
### Authorization
|
|
1010
|
+
|
|
1011
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1012
|
+
|
|
1013
|
+
### HTTP request headers
|
|
1014
|
+
|
|
1015
|
+
- **Content-Type**: Not defined
|
|
1016
|
+
- **Accept**: application/json
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
## list_loyalty_tier_rewards
|
|
1020
|
+
|
|
1021
|
+
> <LoyaltiesTiersRewardsListResponseBody> list_loyalty_tier_rewards(campaign_id, loyalty_tier_id)
|
|
1022
|
+
|
|
1023
|
+
List Loyalty Tier Rewards
|
|
1024
|
+
|
|
1025
|
+
Get available rewards for a given tier.
|
|
1026
|
+
|
|
1027
|
+
### Examples
|
|
1028
|
+
|
|
1029
|
+
```ruby
|
|
1030
|
+
require 'time'
|
|
1031
|
+
require 'VoucherifySdk'
|
|
1032
|
+
# setup authorization
|
|
1033
|
+
VoucherifySdk.configure do |config|
|
|
1034
|
+
# Configure API key authorization: X-App-Id
|
|
1035
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1036
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1037
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1038
|
+
|
|
1039
|
+
# Configure API key authorization: X-App-Token
|
|
1040
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1041
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1042
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1043
|
+
end
|
|
1044
|
+
|
|
1045
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1046
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
|
1047
|
+
loyalty_tier_id = 'loyalty_tier_id_example' # String | Unique loyalty tier ID.
|
|
1048
|
+
|
|
1049
|
+
begin
|
|
1050
|
+
# List Loyalty Tier Rewards
|
|
1051
|
+
result = api_instance.list_loyalty_tier_rewards(campaign_id, loyalty_tier_id)
|
|
1052
|
+
p result
|
|
1053
|
+
rescue VoucherifySdk::ApiError => e
|
|
1054
|
+
puts "Error when calling LoyaltiesApi->list_loyalty_tier_rewards: #{e}"
|
|
1055
|
+
end
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
### Parameters
|
|
1059
|
+
|
|
1060
|
+
| Name | Type | Description | Notes |
|
|
1061
|
+
| ---- | ---- | ----------- | ----- |
|
|
1062
|
+
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
|
1063
|
+
| **loyalty_tier_id** | **String** | Unique loyalty tier ID. | |
|
|
1064
|
+
|
|
1065
|
+
### Return type
|
|
1066
|
+
|
|
1067
|
+
[**LoyaltiesTiersRewardsListResponseBody**](LoyaltiesTiersRewardsListResponseBody.md)
|
|
1068
|
+
|
|
1069
|
+
### Authorization
|
|
1070
|
+
|
|
1071
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1072
|
+
|
|
1073
|
+
### HTTP request headers
|
|
1074
|
+
|
|
1075
|
+
- **Content-Type**: Not defined
|
|
1076
|
+
- **Accept**: application/json
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
## list_loyalty_tiers
|
|
1080
|
+
|
|
1081
|
+
> <LoyaltiesTiersListResponseBody> list_loyalty_tiers(campaign_id, opts)
|
|
1082
|
+
|
|
1083
|
+
List Loyalty Tiers
|
|
1084
|
+
|
|
1085
|
+
Retrieve a list of loyalty tiers which were added to the loyalty program.
|
|
1086
|
+
|
|
1087
|
+
### Examples
|
|
1088
|
+
|
|
1089
|
+
```ruby
|
|
1090
|
+
require 'time'
|
|
1091
|
+
require 'VoucherifySdk'
|
|
1092
|
+
# setup authorization
|
|
1093
|
+
VoucherifySdk.configure do |config|
|
|
1094
|
+
# Configure API key authorization: X-App-Id
|
|
1095
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1096
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1097
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1098
|
+
|
|
1099
|
+
# Configure API key authorization: X-App-Token
|
|
1100
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1102
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1103
|
+
end
|
|
1104
|
+
|
|
1105
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1106
|
+
campaign_id = 'campaign_id_example' # String | Unique loyalty campaign ID or name.
|
|
1107
|
+
opts = {
|
|
1108
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
1109
|
+
order: VoucherifySdk::ParameterOrderListLoyaltyTiers::CREATED_AT # ParameterOrderListLoyaltyTiers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
1110
|
+
}
|
|
1111
|
+
|
|
1112
|
+
begin
|
|
1113
|
+
# List Loyalty Tiers
|
|
1114
|
+
result = api_instance.list_loyalty_tiers(campaign_id, opts)
|
|
1115
|
+
p result
|
|
1116
|
+
rescue VoucherifySdk::ApiError => e
|
|
1117
|
+
puts "Error when calling LoyaltiesApi->list_loyalty_tiers: #{e}"
|
|
1118
|
+
end
|
|
1119
|
+
```
|
|
1120
|
+
|
|
1121
|
+
### Parameters
|
|
1122
|
+
|
|
1123
|
+
| Name | Type | Description | Notes |
|
|
1124
|
+
| ---- | ---- | ----------- | ----- |
|
|
1125
|
+
| **campaign_id** | **String** | Unique loyalty campaign ID or name. | |
|
|
1126
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
1127
|
+
| **order** | [**ParameterOrderListLoyaltyTiers**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
1128
|
+
|
|
1129
|
+
### Return type
|
|
1130
|
+
|
|
1131
|
+
[**LoyaltiesTiersListResponseBody**](LoyaltiesTiersListResponseBody.md)
|
|
1132
|
+
|
|
1133
|
+
### Authorization
|
|
1134
|
+
|
|
1135
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1136
|
+
|
|
1137
|
+
### HTTP request headers
|
|
1138
|
+
|
|
1139
|
+
- **Content-Type**: Not defined
|
|
1140
|
+
- **Accept**: application/json
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
## list_member_loyalty_tier
|
|
1144
|
+
|
|
1145
|
+
> <LoyaltiesMembersTiersListResponseBody> list_member_loyalty_tier(member_id)
|
|
1146
|
+
|
|
1147
|
+
List Member's Loyalty Tiers
|
|
1148
|
+
|
|
1149
|
+
Retrieve member tiers using the loyalty card ID.
|
|
1150
|
+
|
|
1151
|
+
### Examples
|
|
1152
|
+
|
|
1153
|
+
```ruby
|
|
1154
|
+
require 'time'
|
|
1155
|
+
require 'VoucherifySdk'
|
|
1156
|
+
# setup authorization
|
|
1157
|
+
VoucherifySdk.configure do |config|
|
|
1158
|
+
# Configure API key authorization: X-App-Id
|
|
1159
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1160
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1161
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1162
|
+
|
|
1163
|
+
# Configure API key authorization: X-App-Token
|
|
1164
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1165
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1166
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1167
|
+
end
|
|
1168
|
+
|
|
1169
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1170
|
+
member_id = 'member_id_example' # String | Unique loyalty card assigned to a particular customer.
|
|
1171
|
+
|
|
1172
|
+
begin
|
|
1173
|
+
# List Member's Loyalty Tiers
|
|
1174
|
+
result = api_instance.list_member_loyalty_tier(member_id)
|
|
1175
|
+
p result
|
|
1176
|
+
rescue VoucherifySdk::ApiError => e
|
|
1177
|
+
puts "Error when calling LoyaltiesApi->list_member_loyalty_tier: #{e}"
|
|
1178
|
+
end
|
|
1179
|
+
```
|
|
1180
|
+
|
|
1181
|
+
### Parameters
|
|
1182
|
+
|
|
1183
|
+
| Name | Type | Description | Notes |
|
|
1184
|
+
| ---- | ---- | ----------- | ----- |
|
|
1185
|
+
| **member_id** | **String** | Unique loyalty card assigned to a particular customer. | |
|
|
1186
|
+
|
|
1187
|
+
### Return type
|
|
1188
|
+
|
|
1189
|
+
[**LoyaltiesMembersTiersListResponseBody**](LoyaltiesMembersTiersListResponseBody.md)
|
|
1190
|
+
|
|
1191
|
+
### Authorization
|
|
1192
|
+
|
|
1193
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1194
|
+
|
|
1195
|
+
### HTTP request headers
|
|
1196
|
+
|
|
1197
|
+
- **Content-Type**: Not defined
|
|
1198
|
+
- **Accept**: application/json
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
## list_member_rewards
|
|
1202
|
+
|
|
1203
|
+
> <LoyaltiesMembersRewardsListResponseBody> list_member_rewards(member_id, opts)
|
|
1204
|
+
|
|
1205
|
+
List Member Rewards
|
|
1206
|
+
|
|
1207
|
+
Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
|
|
1208
|
+
|
|
1209
|
+
### Examples
|
|
1210
|
+
|
|
1211
|
+
```ruby
|
|
1212
|
+
require 'time'
|
|
1213
|
+
require 'VoucherifySdk'
|
|
1214
|
+
# setup authorization
|
|
1215
|
+
VoucherifySdk.configure do |config|
|
|
1216
|
+
# Configure API key authorization: X-App-Id
|
|
1217
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1218
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1219
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1220
|
+
|
|
1221
|
+
# Configure API key authorization: X-App-Token
|
|
1222
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1223
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1224
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1225
|
+
end
|
|
1226
|
+
|
|
1227
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1228
|
+
member_id = 'member_id_example' # String | Unique loyalty card assigned to a particular customer.
|
|
1229
|
+
opts = {
|
|
1230
|
+
affordable_only: true # Boolean | Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford.
|
|
1231
|
+
}
|
|
1232
|
+
|
|
1233
|
+
begin
|
|
1234
|
+
# List Member Rewards
|
|
1235
|
+
result = api_instance.list_member_rewards(member_id, opts)
|
|
1236
|
+
p result
|
|
1237
|
+
rescue VoucherifySdk::ApiError => e
|
|
1238
|
+
puts "Error when calling LoyaltiesApi->list_member_rewards: #{e}"
|
|
1239
|
+
end
|
|
1240
|
+
```
|
|
1241
|
+
|
|
1242
|
+
### Parameters
|
|
1243
|
+
|
|
1244
|
+
| Name | Type | Description | Notes |
|
|
1245
|
+
| ---- | ---- | ----------- | ----- |
|
|
1246
|
+
| **member_id** | **String** | Unique loyalty card assigned to a particular customer. | |
|
|
1247
|
+
| **affordable_only** | **Boolean** | Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford. | [optional] |
|
|
1248
|
+
|
|
1249
|
+
### Return type
|
|
1250
|
+
|
|
1251
|
+
[**LoyaltiesMembersRewardsListResponseBody**](LoyaltiesMembersRewardsListResponseBody.md)
|
|
1252
|
+
|
|
1253
|
+
### Authorization
|
|
1254
|
+
|
|
1255
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1256
|
+
|
|
1257
|
+
### HTTP request headers
|
|
1258
|
+
|
|
1259
|
+
- **Content-Type**: Not defined
|
|
1260
|
+
- **Accept**: application/json
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
## list_points_expiration
|
|
1264
|
+
|
|
1265
|
+
> <LoyaltiesMembersPointsExpirationListResponseBody> list_points_expiration(campaign_id, member_id, opts)
|
|
1266
|
+
|
|
1267
|
+
Get Points Expiration
|
|
1268
|
+
|
|
1269
|
+
Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
|
|
1270
|
+
|
|
1271
|
+
### Examples
|
|
1272
|
+
|
|
1273
|
+
```ruby
|
|
1274
|
+
require 'time'
|
|
1275
|
+
require 'VoucherifySdk'
|
|
1276
|
+
# setup authorization
|
|
1277
|
+
VoucherifySdk.configure do |config|
|
|
1278
|
+
# Configure API key authorization: X-App-Id
|
|
1279
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1280
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1281
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1282
|
+
|
|
1283
|
+
# Configure API key authorization: X-App-Token
|
|
1284
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1285
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1286
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1287
|
+
end
|
|
1288
|
+
|
|
1289
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1290
|
+
campaign_id = 'campaign_id_example' # String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
|
|
1291
|
+
member_id = 'member_id_example' # String | Loyalty card code.
|
|
1292
|
+
opts = {
|
|
1293
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
1294
|
+
page: 56 # Integer | Which page of results to return.
|
|
1295
|
+
}
|
|
1296
|
+
|
|
1297
|
+
begin
|
|
1298
|
+
# Get Points Expiration
|
|
1299
|
+
result = api_instance.list_points_expiration(campaign_id, member_id, opts)
|
|
1300
|
+
p result
|
|
1301
|
+
rescue VoucherifySdk::ApiError => e
|
|
1302
|
+
puts "Error when calling LoyaltiesApi->list_points_expiration: #{e}"
|
|
1303
|
+
end
|
|
1304
|
+
```
|
|
1305
|
+
|
|
1306
|
+
### Parameters
|
|
1307
|
+
|
|
1308
|
+
| Name | Type | Description | Notes |
|
|
1309
|
+
| ---- | ---- | ----------- | ----- |
|
|
1310
|
+
| **campaign_id** | **String** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | |
|
|
1311
|
+
| **member_id** | **String** | Loyalty card code. | |
|
|
1312
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
1313
|
+
| **page** | **Integer** | Which page of results to return. | [optional] |
|
|
1314
|
+
|
|
1315
|
+
### Return type
|
|
1316
|
+
|
|
1317
|
+
[**LoyaltiesMembersPointsExpirationListResponseBody**](LoyaltiesMembersPointsExpirationListResponseBody.md)
|
|
1318
|
+
|
|
1319
|
+
### Authorization
|
|
1320
|
+
|
|
1321
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1322
|
+
|
|
1323
|
+
### HTTP request headers
|
|
1324
|
+
|
|
1325
|
+
- **Content-Type**: Not defined
|
|
1326
|
+
- **Accept**: application/json
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
## redeem_reward
|
|
1330
|
+
|
|
1331
|
+
> <LoyaltiesMembersRedemptionRedeemResponseBody> redeem_reward(member_id, opts)
|
|
1332
|
+
|
|
1333
|
+
Redeem Reward
|
|
1334
|
+
|
|
1335
|
+
📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
|
|
1336
|
+
|
|
1337
|
+
### Examples
|
|
1338
|
+
|
|
1339
|
+
```ruby
|
|
1340
|
+
require 'time'
|
|
1341
|
+
require 'VoucherifySdk'
|
|
1342
|
+
# setup authorization
|
|
1343
|
+
VoucherifySdk.configure do |config|
|
|
1344
|
+
# Configure API key authorization: X-App-Id
|
|
1345
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1346
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1347
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1348
|
+
|
|
1349
|
+
# Configure API key authorization: X-App-Token
|
|
1350
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1351
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1352
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1353
|
+
end
|
|
1354
|
+
|
|
1355
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1356
|
+
member_id = 'member_id_example' # String | Unique loyalty card assigned to a particular customer.
|
|
1357
|
+
opts = {
|
|
1358
|
+
loyalties_members_redemption_redeem_request_body: VoucherifySdk::LoyaltiesMembersRedemptionRedeemRequestBody.new # LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.
|
|
1359
|
+
}
|
|
1360
|
+
|
|
1361
|
+
begin
|
|
1362
|
+
# Redeem Reward
|
|
1363
|
+
result = api_instance.redeem_reward(member_id, opts)
|
|
1364
|
+
p result
|
|
1365
|
+
rescue VoucherifySdk::ApiError => e
|
|
1366
|
+
puts "Error when calling LoyaltiesApi->redeem_reward: #{e}"
|
|
1367
|
+
end
|
|
1368
|
+
```
|
|
1369
|
+
|
|
1370
|
+
### Parameters
|
|
1371
|
+
|
|
1372
|
+
| Name | Type | Description | Notes |
|
|
1373
|
+
| ---- | ---- | ----------- | ----- |
|
|
1374
|
+
| **member_id** | **String** | Unique loyalty card assigned to a particular customer. | |
|
|
1375
|
+
| **loyalties_members_redemption_redeem_request_body** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md) | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. | [optional] |
|
|
1376
|
+
|
|
1377
|
+
### Return type
|
|
1378
|
+
|
|
1379
|
+
[**LoyaltiesMembersRedemptionRedeemResponseBody**](LoyaltiesMembersRedemptionRedeemResponseBody.md)
|
|
1380
|
+
|
|
1381
|
+
### Authorization
|
|
1382
|
+
|
|
1383
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1384
|
+
|
|
1385
|
+
### HTTP request headers
|
|
1386
|
+
|
|
1387
|
+
- **Content-Type**: application/json
|
|
1388
|
+
- **Accept**: application/json
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
## redeem_reward1
|
|
1392
|
+
|
|
1393
|
+
> <LoyaltiesMembersRedemptionRedeemResponseBody> redeem_reward1(campaign_id, member_id, opts)
|
|
1394
|
+
|
|
1395
|
+
Redeem Reward
|
|
1396
|
+
|
|
1397
|
+
Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
|
|
1398
|
+
|
|
1399
|
+
### Examples
|
|
1400
|
+
|
|
1401
|
+
```ruby
|
|
1402
|
+
require 'time'
|
|
1403
|
+
require 'VoucherifySdk'
|
|
1404
|
+
# setup authorization
|
|
1405
|
+
VoucherifySdk.configure do |config|
|
|
1406
|
+
# Configure API key authorization: X-App-Id
|
|
1407
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1408
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1409
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1410
|
+
|
|
1411
|
+
# Configure API key authorization: X-App-Token
|
|
1412
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1413
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1414
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1415
|
+
end
|
|
1416
|
+
|
|
1417
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1418
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID.
|
|
1419
|
+
member_id = 'member_id_example' # String | A code that identifies the loyalty card.
|
|
1420
|
+
opts = {
|
|
1421
|
+
loyalties_members_redemption_redeem_request_body: VoucherifySdk::LoyaltiesMembersRedemptionRedeemRequestBody.new # LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.
|
|
1422
|
+
}
|
|
1423
|
+
|
|
1424
|
+
begin
|
|
1425
|
+
# Redeem Reward
|
|
1426
|
+
result = api_instance.redeem_reward1(campaign_id, member_id, opts)
|
|
1427
|
+
p result
|
|
1428
|
+
rescue VoucherifySdk::ApiError => e
|
|
1429
|
+
puts "Error when calling LoyaltiesApi->redeem_reward1: #{e}"
|
|
1430
|
+
end
|
|
1431
|
+
```
|
|
1432
|
+
|
|
1433
|
+
### Parameters
|
|
1434
|
+
|
|
1435
|
+
| Name | Type | Description | Notes |
|
|
1436
|
+
| ---- | ---- | ----------- | ----- |
|
|
1437
|
+
| **campaign_id** | **String** | Unique campaign ID. | |
|
|
1438
|
+
| **member_id** | **String** | A code that identifies the loyalty card. | |
|
|
1439
|
+
| **loyalties_members_redemption_redeem_request_body** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md) | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. | [optional] |
|
|
1440
|
+
|
|
1441
|
+
### Return type
|
|
1442
|
+
|
|
1443
|
+
[**LoyaltiesMembersRedemptionRedeemResponseBody**](LoyaltiesMembersRedemptionRedeemResponseBody.md)
|
|
1444
|
+
|
|
1445
|
+
### Authorization
|
|
1446
|
+
|
|
1447
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1448
|
+
|
|
1449
|
+
### HTTP request headers
|
|
1450
|
+
|
|
1451
|
+
- **Content-Type**: application/json
|
|
1452
|
+
- **Accept**: application/json
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
## transfer_points
|
|
1456
|
+
|
|
1457
|
+
> <LoyaltiesMembersTransfersCreateResponseBody> transfer_points(campaign_id, member_id, opts)
|
|
1458
|
+
|
|
1459
|
+
Transfer Loyalty Points
|
|
1460
|
+
|
|
1461
|
+
Transfer points between different loyalty cards. You need to provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters in the URL. In the request body, you provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
|
|
1462
|
+
|
|
1463
|
+
### Examples
|
|
1464
|
+
|
|
1465
|
+
```ruby
|
|
1466
|
+
require 'time'
|
|
1467
|
+
require 'VoucherifySdk'
|
|
1468
|
+
# setup authorization
|
|
1469
|
+
VoucherifySdk.configure do |config|
|
|
1470
|
+
# Configure API key authorization: X-App-Id
|
|
1471
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1472
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1473
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1474
|
+
|
|
1475
|
+
# Configure API key authorization: X-App-Token
|
|
1476
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1477
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1478
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1479
|
+
end
|
|
1480
|
+
|
|
1481
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1482
|
+
campaign_id = 'campaign_id_example' # String | A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
|
|
1483
|
+
member_id = 'member_id_example' # String | A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
|
|
1484
|
+
opts = {
|
|
1485
|
+
loyalties_transfer_points: [VoucherifySdk::LoyaltiesTransferPoints.new({code: 'code_example', points: 37, source_id: 'source_id_example'})] # Array<LoyaltiesTransferPoints> | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
|
|
1486
|
+
}
|
|
1487
|
+
|
|
1488
|
+
begin
|
|
1489
|
+
# Transfer Loyalty Points
|
|
1490
|
+
result = api_instance.transfer_points(campaign_id, member_id, opts)
|
|
1491
|
+
p result
|
|
1492
|
+
rescue VoucherifySdk::ApiError => e
|
|
1493
|
+
puts "Error when calling LoyaltiesApi->transfer_points: #{e}"
|
|
1494
|
+
end
|
|
1495
|
+
```
|
|
1496
|
+
|
|
1497
|
+
### Parameters
|
|
1498
|
+
|
|
1499
|
+
| Name | Type | Description | Notes |
|
|
1500
|
+
| ---- | ---- | ----------- | ----- |
|
|
1501
|
+
| **campaign_id** | **String** | A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). | |
|
|
1502
|
+
| **member_id** | **String** | A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). | |
|
|
1503
|
+
| **loyalties_transfer_points** | [**Array<LoyaltiesTransferPoints>**](LoyaltiesTransferPoints.md) | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. | [optional] |
|
|
1504
|
+
|
|
1505
|
+
### Return type
|
|
1506
|
+
|
|
1507
|
+
[**LoyaltiesMembersTransfersCreateResponseBody**](LoyaltiesMembersTransfersCreateResponseBody.md)
|
|
1508
|
+
|
|
1509
|
+
### Authorization
|
|
1510
|
+
|
|
1511
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1512
|
+
|
|
1513
|
+
### HTTP request headers
|
|
1514
|
+
|
|
1515
|
+
- **Content-Type**: application/json
|
|
1516
|
+
- **Accept**: application/json
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
## update_loyalty_card_balance
|
|
1520
|
+
|
|
1521
|
+
> <LoyaltiesMembersBalanceUpdateResponseBody> update_loyalty_card_balance(member_id, opts)
|
|
1522
|
+
|
|
1523
|
+
Add or Remove Loyalty Card Balance
|
|
1524
|
+
|
|
1525
|
+
This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.
|
|
1526
|
+
|
|
1527
|
+
### Examples
|
|
1528
|
+
|
|
1529
|
+
```ruby
|
|
1530
|
+
require 'time'
|
|
1531
|
+
require 'VoucherifySdk'
|
|
1532
|
+
# setup authorization
|
|
1533
|
+
VoucherifySdk.configure do |config|
|
|
1534
|
+
# Configure API key authorization: X-App-Id
|
|
1535
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1536
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1537
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1538
|
+
|
|
1539
|
+
# Configure API key authorization: X-App-Token
|
|
1540
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1541
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1542
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1543
|
+
end
|
|
1544
|
+
|
|
1545
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1546
|
+
member_id = 'member_id_example' # String | Unique loyalty card assigned to a particular customer.
|
|
1547
|
+
opts = {
|
|
1548
|
+
loyalties_members_balance_update_request_body: VoucherifySdk::LoyaltiesMembersBalanceUpdateRequestBody.new({points: 37}) # LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism.
|
|
1549
|
+
}
|
|
1550
|
+
|
|
1551
|
+
begin
|
|
1552
|
+
# Add or Remove Loyalty Card Balance
|
|
1553
|
+
result = api_instance.update_loyalty_card_balance(member_id, opts)
|
|
1554
|
+
p result
|
|
1555
|
+
rescue VoucherifySdk::ApiError => e
|
|
1556
|
+
puts "Error when calling LoyaltiesApi->update_loyalty_card_balance: #{e}"
|
|
1557
|
+
end
|
|
1558
|
+
```
|
|
1559
|
+
|
|
1560
|
+
### Parameters
|
|
1561
|
+
|
|
1562
|
+
| Name | Type | Description | Notes |
|
|
1563
|
+
| ---- | ---- | ----------- | ----- |
|
|
1564
|
+
| **member_id** | **String** | Unique loyalty card assigned to a particular customer. | |
|
|
1565
|
+
| **loyalties_members_balance_update_request_body** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md) | Specify the point adjustment along with the expiration mechanism. | [optional] |
|
|
1566
|
+
|
|
1567
|
+
### Return type
|
|
1568
|
+
|
|
1569
|
+
[**LoyaltiesMembersBalanceUpdateResponseBody**](LoyaltiesMembersBalanceUpdateResponseBody.md)
|
|
1570
|
+
|
|
1571
|
+
### Authorization
|
|
1572
|
+
|
|
1573
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1574
|
+
|
|
1575
|
+
### HTTP request headers
|
|
1576
|
+
|
|
1577
|
+
- **Content-Type**: application/json
|
|
1578
|
+
- **Accept**: application/json
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
## update_loyalty_card_balance1
|
|
1582
|
+
|
|
1583
|
+
> <LoyaltiesMembersBalanceUpdateResponseBody> update_loyalty_card_balance1(campaign_id, member_id, opts)
|
|
1584
|
+
|
|
1585
|
+
Add or Remove Loyalty Card Balance
|
|
1586
|
+
|
|
1587
|
+
This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest.
|
|
1588
|
+
|
|
1589
|
+
### Examples
|
|
1590
|
+
|
|
1591
|
+
```ruby
|
|
1592
|
+
require 'time'
|
|
1593
|
+
require 'VoucherifySdk'
|
|
1594
|
+
# setup authorization
|
|
1595
|
+
VoucherifySdk.configure do |config|
|
|
1596
|
+
# Configure API key authorization: X-App-Id
|
|
1597
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
1598
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1599
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
1600
|
+
|
|
1601
|
+
# Configure API key authorization: X-App-Token
|
|
1602
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
1603
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1604
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
1605
|
+
end
|
|
1606
|
+
|
|
1607
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
|
1608
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID.
|
|
1609
|
+
member_id = 'member_id_example' # String | A code that identifies the loyalty card.
|
|
1610
|
+
opts = {
|
|
1611
|
+
loyalties_members_balance_update_request_body: VoucherifySdk::LoyaltiesMembersBalanceUpdateRequestBody.new({points: 37}) # LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism.
|
|
1612
|
+
}
|
|
1613
|
+
|
|
1614
|
+
begin
|
|
1615
|
+
# Add or Remove Loyalty Card Balance
|
|
1616
|
+
result = api_instance.update_loyalty_card_balance1(campaign_id, member_id, opts)
|
|
1617
|
+
p result
|
|
1618
|
+
rescue VoucherifySdk::ApiError => e
|
|
1619
|
+
puts "Error when calling LoyaltiesApi->update_loyalty_card_balance1: #{e}"
|
|
1620
|
+
end
|
|
1621
|
+
```
|
|
1622
|
+
|
|
1623
|
+
### Parameters
|
|
1624
|
+
|
|
1625
|
+
| Name | Type | Description | Notes |
|
|
1626
|
+
| ---- | ---- | ----------- | ----- |
|
|
1627
|
+
| **campaign_id** | **String** | Unique campaign ID. | |
|
|
1628
|
+
| **member_id** | **String** | A code that identifies the loyalty card. | |
|
|
1629
|
+
| **loyalties_members_balance_update_request_body** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md) | Specify the point adjustment along with the expiration mechanism. | [optional] |
|
|
1630
|
+
|
|
1631
|
+
### Return type
|
|
1632
|
+
|
|
1633
|
+
[**LoyaltiesMembersBalanceUpdateResponseBody**](LoyaltiesMembersBalanceUpdateResponseBody.md)
|
|
1634
|
+
|
|
1635
|
+
### Authorization
|
|
1636
|
+
|
|
1637
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
1638
|
+
|
|
1639
|
+
### HTTP request headers
|
|
1640
|
+
|
|
1641
|
+
- **Content-Type**: application/json
|
|
1642
|
+
- **Accept**: application/json
|
|
1643
|
+
|