voucherify 4.1.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +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,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRelatedRedemptions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **rollbacks** | [**Array<RedemptionRelatedRedemptionsRollbacksItem>**](RedemptionRelatedRedemptionsRollbacksItem.md) | | [optional] |
|
|
8
|
+
| **redemptions** | [**Array<RedemptionRelatedRedemptionsItem>**](RedemptionRelatedRedemptionsItem.md) | | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRelatedRedemptionsItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique redemption ID. | [optional] |
|
|
8
|
+
| **date** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRelatedRedemptionsRollbacksItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique rollback redemption ID. | [optional] |
|
|
8
|
+
| **date** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer** | [**SimpleCustomer**](SimpleCustomer.md) | | |
|
|
8
|
+
| **assignment_id** | **String** | Unique reward assignment ID assigned by Voucherify. | |
|
|
9
|
+
| **voucher** | [**RedemptionRewardResultVoucher**](RedemptionRewardResultVoucher.md) | | |
|
|
10
|
+
| **product** | [**RedemptionRewardResultProduct**](RedemptionRewardResultProduct.md) | | |
|
|
11
|
+
| **sku** | [**RedemptionRewardResultSku**](RedemptionRewardResultSku.md) | | |
|
|
12
|
+
| **loyalty_tier_id** | **String** | Unique loyalty tier ID assigned by Voucherify. | |
|
|
13
|
+
| **id** | **String** | Unique reward ID. | [optional] |
|
|
14
|
+
| **name** | **String** | Name of the reward. | [optional] |
|
|
15
|
+
| **object** | **String** | The type of object represented by the JSON | [optional][default to 'reward'] |
|
|
16
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the redemption was created in ISO 8601 format. | [optional] |
|
|
17
|
+
| **updated_at** | **Time** | Timestamp in ISO 8601 format indicating when the reward was updated. | [optional] |
|
|
18
|
+
| **parameters** | [**RedemptionRewardResultParameters**](RedemptionRewardResultParameters.md) | | [optional] |
|
|
19
|
+
| **type** | **String** | Reward type. | [optional] |
|
|
20
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResultParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **campaign** | [**RedemptionRewardResultParametersCampaign**](RedemptionRewardResultParametersCampaign.md) | | [optional] |
|
|
8
|
+
| **product** | [**RedemptionRewardResultParametersProduct**](RedemptionRewardResultParametersProduct.md) | | [optional] |
|
|
9
|
+
| **coin** | [**RedemptionRewardResultParametersCoin**](RedemptionRewardResultParametersCoin.md) | | [optional] |
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResultParametersCampaign
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Campaign unique ID. | [optional] |
|
|
8
|
+
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
|
9
|
+
| **type** | **String** | Defines the type of the campaign. | [optional] |
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResultParametersCoin
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **exchange_ratio** | **Integer** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] |
|
|
8
|
+
| **points_ratio** | **Integer** | The number of loyalty points that will map to the predefined cash amount defined by the `exchange_ratio` property. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResultParametersProduct
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique product ID, assigned by Voucherify. | [optional] |
|
|
8
|
+
| **sku_id** | **String** | A unique SKU ID assigned by Voucherify. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResultProduct
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique product ID assigned by Voucherify. | |
|
|
8
|
+
| **source_id** | **String** | Unique product source ID. | |
|
|
9
|
+
| **name** | **String** | Unique user-defined product name. | |
|
|
10
|
+
| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | |
|
|
11
|
+
| **attributes** | **Array<String>** | A list of product attributes whose values you can customize for given SKUs: `[\"color\",\"size\",\"ranking\"]`. Each child SKU can have a unique value for a given attribute. | |
|
|
12
|
+
| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. | |
|
|
13
|
+
| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. | [optional] |
|
|
14
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the product was created in ISO 8601 format. | [optional] |
|
|
15
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the product was updated in ISO 8601 format. | [optional] |
|
|
16
|
+
| **object** | **String** | The type of object represented by JSON. This object stores information about the product. | [default to 'product'] |
|
|
17
|
+
| **skus** | [**SkusListForProduct**](SkusListForProduct.md) | | [optional] |
|
|
18
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResultSku
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | |
|
|
8
|
+
| **source_id** | **String** | A unique SKU identifier from your inventory system. | |
|
|
9
|
+
| **product_id** | **String** | The parent product's unique ID. | |
|
|
10
|
+
| **sku** | **String** | Unique user-defined SKU name. | |
|
|
11
|
+
| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | |
|
|
12
|
+
| **currency** | **String** | SKU price currency. | [optional] |
|
|
13
|
+
| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | |
|
|
14
|
+
| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | |
|
|
15
|
+
| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. | |
|
|
16
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created in ISO 8601 format. | |
|
|
17
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated in ISO 8601 format. | |
|
|
18
|
+
| **object** | **String** | The type of object represented by JSON. This object stores information about the `SKU`. | [default to 'sku'] |
|
|
19
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRewardResultVoucher
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Assigned by the Voucherify API, identifies the voucher. | [optional] |
|
|
8
|
+
| **code** | **String** | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. | [optional] |
|
|
9
|
+
| **campaign** | **String** | A unique campaign name, identifies the voucher's parent campaign. | [optional] |
|
|
10
|
+
| **campaign_id** | **String** | Assigned by the Voucherify API, identifies the voucher's parent campaign. | [optional] |
|
|
11
|
+
| **category** | **String** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. | [optional] |
|
|
12
|
+
| **category_id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
|
|
13
|
+
| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
|
|
14
|
+
| **type** | **String** | Defines the type of the voucher. | [optional] |
|
|
15
|
+
| **discount** | [**Discount**](Discount.md) | | [optional] |
|
|
16
|
+
| **gift** | [**VoucherGift**](VoucherGift.md) | | [optional] |
|
|
17
|
+
| **loyalty_card** | [**VoucherLoyaltyCard**](VoucherLoyaltyCard.md) | | [optional] |
|
|
18
|
+
| **start_date** | **Time** | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date. | [optional] |
|
|
19
|
+
| **expiration_date** | **Time** | Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is *inactive after* this date. | [optional] |
|
|
20
|
+
| **validity_timeframe** | [**VoucherValidityTimeframe**](VoucherValidityTimeframe.md) | | [optional] |
|
|
21
|
+
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
22
|
+
| **active** | **Boolean** | A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher | [optional] |
|
|
23
|
+
| **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
|
|
24
|
+
| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] |
|
|
25
|
+
| **assets** | [**VoucherAssets**](VoucherAssets.md) | | [optional] |
|
|
26
|
+
| **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
|
|
27
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the voucher was created in ISO 8601 format. | [optional] |
|
|
28
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] |
|
|
29
|
+
| **holder_id** | **String** | Unique customer ID of voucher owner. | [optional] |
|
|
30
|
+
| **holder** | [**SimpleCustomer**](SimpleCustomer.md) | | [optional] |
|
|
31
|
+
| **object** | **String** | The type of object represented by JSON. Default is `voucher`. | [optional][default to 'voucher'] |
|
|
32
|
+
| **distributions** | **Array<Object>** | | [optional] |
|
|
33
|
+
| **deleted** | **Boolean** | Flag indicating whether this voucher is deleted. | [optional] |
|
|
34
|
+
| **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] |
|
|
35
|
+
| **publish** | [**VoucherPublish**](VoucherPublish.md) | | [optional] |
|
|
36
|
+
| **redemption** | [**VoucherRedemption**](VoucherRedemption.md) | | [optional] |
|
|
37
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRollback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique redemption ID. | |
|
|
8
|
+
| **object** | **String** | The type of object represented by the JSON | [default to 'redemption_rollback'] |
|
|
9
|
+
| **date** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. | |
|
|
10
|
+
| **customer_id** | **String** | Unique customer ID of the redeeming customer. | |
|
|
11
|
+
| **tracking_id** | **String** | Hashed customer source ID. | |
|
|
12
|
+
| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the redemption. | |
|
|
13
|
+
| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
|
|
14
|
+
| **redemption** | **String** | Unique redemption ID of the parent redemption. | |
|
|
15
|
+
| **reason** | **String** | System generated cause for the redemption being invalid in the context of the provided parameters. | [optional] |
|
|
16
|
+
| **result** | **String** | Redemption result. | |
|
|
17
|
+
| **status** | **String** | Redemption status. | |
|
|
18
|
+
| **related_redemptions** | [**RedemptionRollbackRelatedRedemptions**](RedemptionRollbackRelatedRedemptions.md) | | [optional] |
|
|
19
|
+
| **failure_code** | **String** | If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. | [optional] |
|
|
20
|
+
| **failure_message** | **String** | If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. | [optional] |
|
|
21
|
+
| **order** | [**OrderCalculatedNoCustomerData**](OrderCalculatedNoCustomerData.md) | | |
|
|
22
|
+
| **channel** | [**RedemptionChannel**](RedemptionChannel.md) | | |
|
|
23
|
+
| **customer** | [**SimpleCustomer**](SimpleCustomer.md) | | |
|
|
24
|
+
| **related_object_type** | **String** | Defines the related object. | |
|
|
25
|
+
| **related_object_id** | **String** | Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher. | |
|
|
26
|
+
| **voucher** | [**Voucher**](Voucher.md) | | [optional] |
|
|
27
|
+
| **promotion_tier** | [**PromotionTier**](PromotionTier.md) | | [optional] |
|
|
28
|
+
| **reward** | [**RedemptionRewardResult**](RedemptionRewardResult.md) | | [optional] |
|
|
29
|
+
| **gift** | [**RedemptionGift**](RedemptionGift.md) | | [optional] |
|
|
30
|
+
| **loyalty_card** | [**RedemptionLoyaltyCard**](RedemptionLoyaltyCard.md) | | [optional] |
|
|
31
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRollbackRelatedRedemptions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **rollbacks** | [**Array<RedemptionRollbackRelatedRedemptionsRollbacksItem>**](RedemptionRollbackRelatedRedemptionsRollbacksItem.md) | | [optional] |
|
|
8
|
+
| **redemptions** | [**Array<RedemptionRollbackRelatedRedemptionsItem>**](RedemptionRollbackRelatedRedemptionsItem.md) | | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRollbackRelatedRedemptionsItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique redemption ID. | [optional] |
|
|
8
|
+
| **date** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionRollbackRelatedRedemptionsRollbacksItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique rollback redemption ID. | [optional] |
|
|
8
|
+
| **date** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
# VoucherifySdk::RedemptionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.voucherify.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_redemption**](RedemptionsApi.md#get_redemption) | **GET** /v1/redemptions/{redemptionId} | Get Redemption |
|
|
8
|
+
| [**get_voucher_redemptions**](RedemptionsApi.md#get_voucher_redemptions) | **GET** /v1/vouchers/{code}/redemption | Get Voucher's Redemptions |
|
|
9
|
+
| [**list_redemptions**](RedemptionsApi.md#list_redemptions) | **GET** /v1/redemptions | List Redemptions |
|
|
10
|
+
| [**redeem_stacked_discounts**](RedemptionsApi.md#redeem_stacked_discounts) | **POST** /v1/redemptions | Redeem Stackable Discounts |
|
|
11
|
+
| [**rollback_redemption**](RedemptionsApi.md#rollback_redemption) | **POST** /v1/redemptions/{redemptionId}/rollback | Rollback Redemption |
|
|
12
|
+
| [**rollback_stacked_redemptions**](RedemptionsApi.md#rollback_stacked_redemptions) | **POST** /v1/redemptions/{parentRedemptionId}/rollbacks | Rollback Stackable Redemptions |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## get_redemption
|
|
16
|
+
|
|
17
|
+
> <RedemptionsGetResponseBody> get_redemption(redemption_id)
|
|
18
|
+
|
|
19
|
+
Get Redemption
|
|
20
|
+
|
|
21
|
+
Return a redemption or redemption rollback object. This object can either be a successfull or failed redemption or redemption rollback.
|
|
22
|
+
|
|
23
|
+
### Examples
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'time'
|
|
27
|
+
require 'VoucherifySdk'
|
|
28
|
+
# setup authorization
|
|
29
|
+
VoucherifySdk.configure do |config|
|
|
30
|
+
# Configure API key authorization: X-App-Id
|
|
31
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
34
|
+
|
|
35
|
+
# Configure API key authorization: X-App-Token
|
|
36
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
37
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
38
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = VoucherifySdk::RedemptionsApi.new
|
|
42
|
+
redemption_id = 'redemption_id_example' # String | ID of previously created redemption.
|
|
43
|
+
|
|
44
|
+
begin
|
|
45
|
+
# Get Redemption
|
|
46
|
+
result = api_instance.get_redemption(redemption_id)
|
|
47
|
+
p result
|
|
48
|
+
rescue VoucherifySdk::ApiError => e
|
|
49
|
+
puts "Error when calling RedemptionsApi->get_redemption: #{e}"
|
|
50
|
+
end
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
| Name | Type | Description | Notes |
|
|
56
|
+
| ---- | ---- | ----------- | ----- |
|
|
57
|
+
| **redemption_id** | **String** | ID of previously created redemption. | |
|
|
58
|
+
|
|
59
|
+
### Return type
|
|
60
|
+
|
|
61
|
+
[**RedemptionsGetResponseBody**](RedemptionsGetResponseBody.md)
|
|
62
|
+
|
|
63
|
+
### Authorization
|
|
64
|
+
|
|
65
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
66
|
+
|
|
67
|
+
### HTTP request headers
|
|
68
|
+
|
|
69
|
+
- **Content-Type**: Not defined
|
|
70
|
+
- **Accept**: application/json
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
## get_voucher_redemptions
|
|
74
|
+
|
|
75
|
+
> <VouchersRedemptionGetResponseBody> get_voucher_redemptions(code)
|
|
76
|
+
|
|
77
|
+
Get Voucher's Redemptions
|
|
78
|
+
|
|
79
|
+
Retrieve the number of times a voucher was redeemed and each of the redemption details.
|
|
80
|
+
|
|
81
|
+
### Examples
|
|
82
|
+
|
|
83
|
+
```ruby
|
|
84
|
+
require 'time'
|
|
85
|
+
require 'VoucherifySdk'
|
|
86
|
+
# setup authorization
|
|
87
|
+
VoucherifySdk.configure do |config|
|
|
88
|
+
# Configure API key authorization: X-App-Id
|
|
89
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
90
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
91
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
92
|
+
|
|
93
|
+
# Configure API key authorization: X-App-Token
|
|
94
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
95
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
96
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
api_instance = VoucherifySdk::RedemptionsApi.new
|
|
100
|
+
code = 'code_example' # String | A **code** that identifies the voucher.
|
|
101
|
+
|
|
102
|
+
begin
|
|
103
|
+
# Get Voucher's Redemptions
|
|
104
|
+
result = api_instance.get_voucher_redemptions(code)
|
|
105
|
+
p result
|
|
106
|
+
rescue VoucherifySdk::ApiError => e
|
|
107
|
+
puts "Error when calling RedemptionsApi->get_voucher_redemptions: #{e}"
|
|
108
|
+
end
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Parameters
|
|
112
|
+
|
|
113
|
+
| Name | Type | Description | Notes |
|
|
114
|
+
| ---- | ---- | ----------- | ----- |
|
|
115
|
+
| **code** | **String** | A **code** that identifies the voucher. | |
|
|
116
|
+
|
|
117
|
+
### Return type
|
|
118
|
+
|
|
119
|
+
[**VouchersRedemptionGetResponseBody**](VouchersRedemptionGetResponseBody.md)
|
|
120
|
+
|
|
121
|
+
### Authorization
|
|
122
|
+
|
|
123
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
124
|
+
|
|
125
|
+
### HTTP request headers
|
|
126
|
+
|
|
127
|
+
- **Content-Type**: Not defined
|
|
128
|
+
- **Accept**: application/json
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
## list_redemptions
|
|
132
|
+
|
|
133
|
+
> <RedemptionsListResponseBody> list_redemptions(opts)
|
|
134
|
+
|
|
135
|
+
List Redemptions
|
|
136
|
+
|
|
137
|
+
Returns a list of redemptions previously created. The redemptions are returned in a sorted order, with the most recent redemptions appearing first. The response returns a list of redemptions of all vouchers. # Filtering results The result can be narrowed according to specified (or default) filters, for example, you can sort redemptions by date: https://api.voucherify.io/v1/redemptions?limit 3&[created_at][before] 2017-09-08T13:52:18.227Z. A filter based on the object created_at field narrows down the results and lists redemptions done before or after a particular date time. You can use the following options: [created_at][after], [created_at][before]. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z. # Failed Redemptions A redemption may fail for various reasons. You can figure out an exact reason from the failure_code: - resource_not_found - voucher with given code does not exist - voucher_not_active - voucher is not active yet (before start date) - voucher_expired - voucher has already expired (after expiration date) - voucher_disabled - voucher has been disabled (active: false) - quantity_exceeded - vouchers redemptions limit has been exceeded - gift_amount_exceeded - gift amount has been exceeded - customer_rules_violated - customer did not match the segment - order_rules_violated - order did not match validation rules - invalid_order - order was specified incorrectly - invalid_amount - order amount was specified incorrectly - missing_amount - order amount was not specified - missing_order_items - order items were not specified - missing_customer - customer was not specified
|
|
138
|
+
|
|
139
|
+
### Examples
|
|
140
|
+
|
|
141
|
+
```ruby
|
|
142
|
+
require 'time'
|
|
143
|
+
require 'VoucherifySdk'
|
|
144
|
+
# setup authorization
|
|
145
|
+
VoucherifySdk.configure do |config|
|
|
146
|
+
# Configure API key authorization: X-App-Id
|
|
147
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
148
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
149
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
150
|
+
|
|
151
|
+
# Configure API key authorization: X-App-Token
|
|
152
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
153
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
154
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
api_instance = VoucherifySdk::RedemptionsApi.new
|
|
158
|
+
opts = {
|
|
159
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
160
|
+
page: 56, # Integer | Which page of results to return.
|
|
161
|
+
result: 'result_example', # String | A filter on the list based on the redemption result. Available options are: SUCCESS, FAILURE. You can provide multiple values by repeating the param.
|
|
162
|
+
campaign: 'campaign_example', # String | A filter by the campaign **name** that the redemption resources originate from.
|
|
163
|
+
customer: 'customer_example', # String | Return redemptions performed by the customer with given id or source_id.
|
|
164
|
+
order: VoucherifySdk::ParameterOrderListRedemptions::CREATED_AT, # ParameterOrderListRedemptions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
165
|
+
created_at: VoucherifySdk::ParameterCreatedBeforeAfter.new, # ParameterCreatedBeforeAfter | A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z
|
|
166
|
+
filters: VoucherifySdk::ParameterFiltersListRedemptions.new # ParameterFiltersListRedemptions | Filters for listing responses.
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
begin
|
|
170
|
+
# List Redemptions
|
|
171
|
+
result = api_instance.list_redemptions(opts)
|
|
172
|
+
p result
|
|
173
|
+
rescue VoucherifySdk::ApiError => e
|
|
174
|
+
puts "Error when calling RedemptionsApi->list_redemptions: #{e}"
|
|
175
|
+
end
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Parameters
|
|
179
|
+
|
|
180
|
+
| Name | Type | Description | Notes |
|
|
181
|
+
| ---- | ---- | ----------- | ----- |
|
|
182
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
183
|
+
| **page** | **Integer** | Which page of results to return. | [optional] |
|
|
184
|
+
| **result** | **String** | A filter on the list based on the redemption result. Available options are: SUCCESS, FAILURE. You can provide multiple values by repeating the param. | [optional] |
|
|
185
|
+
| **campaign** | **String** | A filter by the campaign **name** that the redemption resources originate from. | [optional] |
|
|
186
|
+
| **customer** | **String** | Return redemptions performed by the customer with given id or source_id. | [optional] |
|
|
187
|
+
| **order** | [**ParameterOrderListRedemptions**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
188
|
+
| **created_at** | [**ParameterCreatedBeforeAfter**](.md) | A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z | [optional] |
|
|
189
|
+
| **filters** | [**ParameterFiltersListRedemptions**](.md) | Filters for listing responses. | [optional] |
|
|
190
|
+
|
|
191
|
+
### Return type
|
|
192
|
+
|
|
193
|
+
[**RedemptionsListResponseBody**](RedemptionsListResponseBody.md)
|
|
194
|
+
|
|
195
|
+
### Authorization
|
|
196
|
+
|
|
197
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
198
|
+
|
|
199
|
+
### HTTP request headers
|
|
200
|
+
|
|
201
|
+
- **Content-Type**: Not defined
|
|
202
|
+
- **Accept**: application/json
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
## redeem_stacked_discounts
|
|
206
|
+
|
|
207
|
+
> <RedemptionsRedeemResponseBody> redeem_stacked_discounts(opts)
|
|
208
|
+
|
|
209
|
+
Redeem Stackable Discounts
|
|
210
|
+
|
|
211
|
+
# How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: 📘 Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your rollback request. 📘 Also available on client-side This method is also accessible through public keys which you can use in client-side apps: mobile and web browser apps. Go to the dedicated endpoint to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain.
|
|
212
|
+
|
|
213
|
+
### Examples
|
|
214
|
+
|
|
215
|
+
```ruby
|
|
216
|
+
require 'time'
|
|
217
|
+
require 'VoucherifySdk'
|
|
218
|
+
# setup authorization
|
|
219
|
+
VoucherifySdk.configure do |config|
|
|
220
|
+
# Configure API key authorization: X-App-Id
|
|
221
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
222
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
223
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
224
|
+
|
|
225
|
+
# Configure API key authorization: X-App-Token
|
|
226
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
227
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
228
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
api_instance = VoucherifySdk::RedemptionsApi.new
|
|
232
|
+
opts = {
|
|
233
|
+
redemptions_redeem_request_body: VoucherifySdk::RedemptionsRedeemRequestBody.new({redeemables: [VoucherifySdk::RedeemGiftCard.new({object: 'voucher', id: 'id_example'})]}) # RedemptionsRedeemRequestBody |
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
begin
|
|
237
|
+
# Redeem Stackable Discounts
|
|
238
|
+
result = api_instance.redeem_stacked_discounts(opts)
|
|
239
|
+
p result
|
|
240
|
+
rescue VoucherifySdk::ApiError => e
|
|
241
|
+
puts "Error when calling RedemptionsApi->redeem_stacked_discounts: #{e}"
|
|
242
|
+
end
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Parameters
|
|
246
|
+
|
|
247
|
+
| Name | Type | Description | Notes |
|
|
248
|
+
| ---- | ---- | ----------- | ----- |
|
|
249
|
+
| **redemptions_redeem_request_body** | [**RedemptionsRedeemRequestBody**](RedemptionsRedeemRequestBody.md) | | [optional] |
|
|
250
|
+
|
|
251
|
+
### Return type
|
|
252
|
+
|
|
253
|
+
[**RedemptionsRedeemResponseBody**](RedemptionsRedeemResponseBody.md)
|
|
254
|
+
|
|
255
|
+
### Authorization
|
|
256
|
+
|
|
257
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
258
|
+
|
|
259
|
+
### HTTP request headers
|
|
260
|
+
|
|
261
|
+
- **Content-Type**: application/json
|
|
262
|
+
- **Accept**: application/json
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
## rollback_redemption
|
|
266
|
+
|
|
267
|
+
> <RedemptionsRollbackCreateResponseBody> rollback_redemption(redemption_id, opts)
|
|
268
|
+
|
|
269
|
+
Rollback Redemption
|
|
270
|
+
|
|
271
|
+
Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption.
|
|
272
|
+
|
|
273
|
+
### Examples
|
|
274
|
+
|
|
275
|
+
```ruby
|
|
276
|
+
require 'time'
|
|
277
|
+
require 'VoucherifySdk'
|
|
278
|
+
# setup authorization
|
|
279
|
+
VoucherifySdk.configure do |config|
|
|
280
|
+
# Configure API key authorization: X-App-Id
|
|
281
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
282
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
283
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
284
|
+
|
|
285
|
+
# Configure API key authorization: X-App-Token
|
|
286
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
287
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
288
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
api_instance = VoucherifySdk::RedemptionsApi.new
|
|
292
|
+
redemption_id = 'redemption_id_example' # String | The original redemption ID to be rolled back (undone).
|
|
293
|
+
opts = {
|
|
294
|
+
reason: 'reason_example', # String | Reason for the rollback.
|
|
295
|
+
tracking_id: 'tracking_id_example', # String | Customers source_id.
|
|
296
|
+
redemptions_rollback_create_request_body: VoucherifySdk::RedemptionsRollbackCreateRequestBody.new # RedemptionsRollbackCreateRequestBody | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body.
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
begin
|
|
300
|
+
# Rollback Redemption
|
|
301
|
+
result = api_instance.rollback_redemption(redemption_id, opts)
|
|
302
|
+
p result
|
|
303
|
+
rescue VoucherifySdk::ApiError => e
|
|
304
|
+
puts "Error when calling RedemptionsApi->rollback_redemption: #{e}"
|
|
305
|
+
end
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
### Parameters
|
|
309
|
+
|
|
310
|
+
| Name | Type | Description | Notes |
|
|
311
|
+
| ---- | ---- | ----------- | ----- |
|
|
312
|
+
| **redemption_id** | **String** | The original redemption ID to be rolled back (undone). | |
|
|
313
|
+
| **reason** | **String** | Reason for the rollback. | [optional] |
|
|
314
|
+
| **tracking_id** | **String** | Customers source_id. | [optional] |
|
|
315
|
+
| **redemptions_rollback_create_request_body** | [**RedemptionsRollbackCreateRequestBody**](RedemptionsRollbackCreateRequestBody.md) | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. | [optional] |
|
|
316
|
+
|
|
317
|
+
### Return type
|
|
318
|
+
|
|
319
|
+
[**RedemptionsRollbackCreateResponseBody**](RedemptionsRollbackCreateResponseBody.md)
|
|
320
|
+
|
|
321
|
+
### Authorization
|
|
322
|
+
|
|
323
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
324
|
+
|
|
325
|
+
### HTTP request headers
|
|
326
|
+
|
|
327
|
+
- **Content-Type**: application/json
|
|
328
|
+
- **Accept**: application/json
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
## rollback_stacked_redemptions
|
|
332
|
+
|
|
333
|
+
> <RedemptionsRollbacksCreateResponseBody> rollback_stacked_redemptions(parent_redemption_id, opts)
|
|
334
|
+
|
|
335
|
+
Rollback Stackable Redemptions
|
|
336
|
+
|
|
337
|
+
Rollback a stackable redemption. When you rollback a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter.
|
|
338
|
+
|
|
339
|
+
### Examples
|
|
340
|
+
|
|
341
|
+
```ruby
|
|
342
|
+
require 'time'
|
|
343
|
+
require 'VoucherifySdk'
|
|
344
|
+
# setup authorization
|
|
345
|
+
VoucherifySdk.configure do |config|
|
|
346
|
+
# Configure API key authorization: X-App-Id
|
|
347
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
348
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
349
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
350
|
+
|
|
351
|
+
# Configure API key authorization: X-App-Token
|
|
352
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
353
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
354
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
355
|
+
end
|
|
356
|
+
|
|
357
|
+
api_instance = VoucherifySdk::RedemptionsApi.new
|
|
358
|
+
parent_redemption_id = 'parent_redemption_id_example' # String | Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm.
|
|
359
|
+
opts = {
|
|
360
|
+
reason: 'reason_example', # String | Reason for the rollback.
|
|
361
|
+
tracking_id: 'tracking_id_example', # String | Customers source_id.
|
|
362
|
+
redemptions_rollbacks_create_request_body: VoucherifySdk::RedemptionsRollbacksCreateRequestBody.new # RedemptionsRollbacksCreateRequestBody | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body.
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
begin
|
|
366
|
+
# Rollback Stackable Redemptions
|
|
367
|
+
result = api_instance.rollback_stacked_redemptions(parent_redemption_id, opts)
|
|
368
|
+
p result
|
|
369
|
+
rescue VoucherifySdk::ApiError => e
|
|
370
|
+
puts "Error when calling RedemptionsApi->rollback_stacked_redemptions: #{e}"
|
|
371
|
+
end
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Parameters
|
|
375
|
+
|
|
376
|
+
| Name | Type | Description | Notes |
|
|
377
|
+
| ---- | ---- | ----------- | ----- |
|
|
378
|
+
| **parent_redemption_id** | **String** | Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. | |
|
|
379
|
+
| **reason** | **String** | Reason for the rollback. | [optional] |
|
|
380
|
+
| **tracking_id** | **String** | Customers source_id. | [optional] |
|
|
381
|
+
| **redemptions_rollbacks_create_request_body** | [**RedemptionsRollbacksCreateRequestBody**](RedemptionsRollbacksCreateRequestBody.md) | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. | [optional] |
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
[**RedemptionsRollbacksCreateResponseBody**](RedemptionsRollbacksCreateResponseBody.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**: application/json
|
|
394
|
+
- **Accept**: application/json
|
|
395
|
+
|