voucherify 8.0.3 → 8.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +123 -111
- data/Gemfile.lock +19 -17
- data/README.md +223 -75
- data/VoucherifySdk.gemspec +1 -1
- data/__tests__/README.md +18 -0
- data/__tests__/lib/campaigns.rb +53 -1
- data/__tests__/lib/config.rb +21 -0
- data/__tests__/lib/loyalties.rb +2 -2
- data/__tests__/lib/utils.rb +27 -1
- data/__tests__/spec/02_campaigns_spec.rb +33 -2
- data/__tests__/spec/04_publications_spec.rb +16 -3
- data/__tests__/spec/07_vouchers_spec.rb +22 -3
- data/__tests__/spec/13_management_spec.rb +110 -0
- data/__tests__/spec/14_additional_properties_spec.rb +28 -0
- data/__tests__/spec/support/get_snapshot_without_uniq_keys.rb +1 -1
- data/docs/ApplicableTo.md +18 -2
- data/docs/ApplicableToOrderItemUnitsItem.md +2 -1
- data/docs/AsyncActionsApi.md +2 -2
- data/docs/AsyncActionsListResponseBody.md +1 -0
- data/docs/Bundle.md +11 -0
- data/docs/BundleIdentifiedItem.md +11 -0
- data/docs/BundleMissingItem.md +10 -0
- data/docs/Campaign.md +4 -4
- data/docs/CampaignBase.md +4 -4
- data/docs/CampaignLoyaltyCardExpirationRules.md +6 -4
- data/docs/CampaignsApi.md +211 -14
- data/docs/CampaignsCreateRequestBody.md +2 -2
- data/docs/CampaignsCreateResponseBody.md +4 -4
- data/docs/CampaignsGetResponseBody.md +4 -4
- data/docs/CampaignsImportVoucherItem.md +1 -1
- data/docs/CampaignsSummaryGetResponseBody.md +48 -0
- data/docs/CampaignsTransactionsExportCreateRequestBody.md +8 -0
- data/docs/CampaignsTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/CampaignsTransactionsExportCreateResponseBody.md +16 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParameters.md +10 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFilters.md +11 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md +8 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md +8 -0
- data/docs/CampaignsTransactionsExportCreateResponseBodyResult.md +8 -0
- data/docs/CampaignsTransactionsListResponseBody.md +12 -0
- data/docs/CampaignsUpdateRequestBody.md +1 -1
- data/docs/CampaignsUpdateResponseBody.md +4 -4
- data/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +5 -3
- data/docs/CampaignsVouchersCreateResponseBodyGift.md +3 -2
- data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +5 -3
- data/docs/CategoriesApi.md +1 -1
- data/docs/ClientQualificationsCheckEligibilityRequestBody.md +2 -1
- data/docs/ClientQualificationsCheckEligibilityRequestBodySession.md +8 -0
- data/docs/ClientRedemptionsRedeemRequestBodyOptions.md +1 -1
- data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ClientSideApi.md +2 -2
- data/docs/ClientValidationsValidateRequestBodyOptions.md +1 -1
- data/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ClientValidationsValidateResponseBody.md +1 -0
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
- data/docs/CustomerSummaryOrders.md +3 -3
- data/docs/CustomerSummaryRedemptionsGift.md +2 -2
- data/docs/CustomerWithSummaryLoyaltyReferralsAssets.md +2 -1
- data/docs/CustomersApi.md +14 -14
- data/docs/CustomersCreateResponseBodyAssets.md +2 -1
- data/docs/CustomersGetResponseBodyAssets.md +2 -1
- data/docs/CustomersUpdateResponseBodyAssets.md +2 -1
- data/docs/Discount.md +4 -4
- data/docs/DiscountUnitMultipleOneUnit.md +1 -1
- data/docs/EarningRule.md +1 -0
- data/docs/EarningRuleExpirationRules.md +13 -0
- data/docs/EarningRuleLoyalty.md +1 -0
- data/docs/EarningRuleLoyaltyCustomEventMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyCustomerMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyOrderAmount.md +1 -0
- data/docs/EarningRuleLoyaltyOrderItemsAmount.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/EarningRuleLoyaltyOrderMetadata.md +1 -0
- data/docs/EarningRuleLoyaltyOrderTotalAmount.md +1 -0
- data/docs/ErrorError.md +1 -1
- data/docs/ExportCampaignTransactionsFilters.md +10 -0
- data/docs/ExportParameters.md +3 -2
- data/docs/ExportsApi.md +7 -7
- data/docs/ExportsCreateRequestBodyParameters.md +3 -2
- data/docs/ExportsCreateResponseBodyParameters.md +3 -2
- data/docs/ExportsGetResponseBodyParameters.md +3 -2
- data/docs/Gift.md +3 -2
- data/docs/InapplicableTo.md +18 -2
- data/docs/InapplicableToOrderItemUnitsItem.md +2 -1
- data/docs/LoyaltiesApi.md +293 -96
- data/docs/LoyaltiesCreateCampaignRequestBody.md +2 -2
- data/docs/LoyaltiesCreateCampaignResponseBody.md +1 -1
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateRequestBodyItemPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBody.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateRequestBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
- data/docs/LoyaltiesGetCampaignResponseBody.md +1 -1
- data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +5 -3
- data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +5 -3
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +1 -1
- data/docs/LoyaltiesMembersPendingPointsBalanceRequestBody.md +8 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBody.md +12 -0
- data/docs/LoyaltiesMembersPendingPointsBalanceResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +1 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodySession.md +8 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherGift.md +3 -2
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +5 -3
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +5 -3
- data/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParameters.md +1 -1
- data/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +1 -1
- data/docs/LoyaltiesTransactionsExportCreateRequestBody.md +8 -0
- data/docs/LoyaltiesTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/LoyaltiesTransactionsListResponseBody.md +12 -0
- data/docs/LoyaltiesUpdateCampaignRequestBody.md +1 -1
- data/docs/LoyaltiesUpdateCampaignResponseBody.md +1 -1
- data/docs/LoyaltyCampaign.md +1 -1
- data/docs/LoyaltyCardTransaction.md +1 -1
- data/docs/LoyaltyCardTransactionDetailsBalance.md +1 -0
- data/docs/LoyaltyMemberLoyaltyCard.md +5 -3
- data/docs/LoyaltyPointsBucket.md +1 -1
- data/docs/LoyaltyTiersExpirationAll.md +1 -1
- data/docs/ManagementApi.md +26 -26
- data/docs/ManagementProjectsStackingRules.md +14 -8
- data/docs/ManagementProjectsStackingRulesCreateRequestBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesCreateResponseBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesGetResponseBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesUpdateRequestBody.md +14 -8
- data/docs/ManagementProjectsStackingRulesUpdateResponseBody.md +14 -8
- data/docs/ManagementProjectsUsersInviteCreateRequestBody.md +1 -1
- data/docs/ManagementProjectsUsersUpdateRoleRequestBody.md +1 -1
- data/docs/MetadataSchemasApi.md +5 -5
- data/docs/Order.md +1 -1
- data/docs/OrderCalculatedItem.md +1 -1
- data/docs/OrderItem.md +1 -1
- data/docs/OrdersApi.md +4 -4
- data/docs/OrdersCreateRequestBody.md +1 -1
- data/docs/OrdersImportCreateRequestBodyItem.md +2 -2
- data/docs/OrdersUpdateRequestBody.md +1 -1
- data/docs/ParametersFiltersListCampaignTransactions.md +10 -0
- data/docs/ProductCollectionsApi.md +1 -1
- data/docs/ProductCollectionsCreateRequestBody.md +1 -1
- data/docs/ProductsApi.md +23 -23
- data/docs/ProductsSkusCreateRequestBody.md +1 -1
- data/docs/ProductsSkusUpdateRequestBody.md +1 -1
- data/docs/PromotionTierCampaign.md +1 -1
- data/docs/PromotionsTiersCreateResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersDisableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersEnableResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersGetResponseBodyCampaign.md +1 -1
- data/docs/PromotionsTiersUpdateResponseBodyCampaign.md +1 -1
- data/docs/PublicationsApi.md +8 -8
- data/docs/QualificationsApi.md +1 -1
- data/docs/QualificationsCheckEligibilityRequestBody.md +2 -1
- data/docs/QualificationsCheckEligibilityRequestBodySession.md +8 -0
- data/docs/QualificationsOption.md +1 -1
- data/docs/QualificationsRedeemable.md +1 -1
- data/docs/QualificationsRedeemableBase.md +1 -1
- data/docs/RedeemableGift.md +3 -2
- data/docs/RedeemableLoyaltyCard.md +2 -2
- data/docs/RedeemableResult.md +1 -0
- data/docs/RedeemableVoucherGift.md +3 -2
- data/docs/RedeemableVoucherLoyaltyCard.md +5 -3
- data/docs/Redemption.md +1 -0
- data/docs/RedemptionEntry.md +1 -0
- data/docs/RedemptionEntryPromotionTierCampaign.md +1 -1
- data/docs/RedemptionEntryRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionEntrySession.md +8 -0
- data/docs/RedemptionEntryVoucherGift.md +3 -2
- data/docs/RedemptionEntryVoucherLoyaltyCard.md +5 -3
- data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionRewardResultParametersCampaign.md +1 -1
- data/docs/RedemptionRewardResultParametersCoin.md +1 -1
- data/docs/RedemptionRollback.md +1 -1
- data/docs/RedemptionSession.md +8 -0
- data/docs/RedemptionVoucherGift.md +3 -2
- data/docs/RedemptionVoucherLoyaltyCard.md +5 -3
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsGetResponseBody.md +1 -0
- data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionsGetResponseBodySession.md +8 -0
- data/docs/RedemptionsGetResponseBodyVoucherGift.md +3 -2
- data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +5 -3
- data/docs/RedemptionsListResponseBodyRedemptionsItem.md +1 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md +1 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemSession.md +8 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherGift.md +3 -2
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +5 -3
- data/docs/RedemptionsRedeemRequestBodyOptions.md +2 -1
- data/docs/RedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/RedemptionsRollbackCreateResponseBody.md +1 -1
- data/docs/ReferralsApi.md +13 -13
- data/docs/Reward.md +1 -1
- data/docs/RewardsCreateRequestBody.md +1 -1
- data/docs/RewardsCreateRequestBodyParametersCampaign.md +1 -1
- data/docs/RewardsCreateRequestBodyParametersCoin.md +1 -1
- data/docs/RewardsCreateResponseBody.md +1 -1
- data/docs/RewardsUpdateRequestBody.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCampaign.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCoin.md +1 -1
- data/docs/RewardsUpdateResponseBody.md +1 -1
- data/docs/SegmentsApi.md +2 -2
- data/docs/SegmentsCreateRequestBody.md +1 -1
- data/docs/SegmentsCreateResponseBody.md +4 -3
- data/docs/SegmentsGetResponseBody.md +4 -3
- data/docs/SimpleLoyaltyCard.md +5 -3
- data/docs/SimpleVoucherRedemption.md +1 -0
- data/docs/StackingRules.md +15 -11
- data/docs/TemplatesApi.md +7 -7
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +2 -2
- data/docs/TrashBinItem.md +1 -1
- data/docs/ValidationRule.md +1 -0
- data/docs/ValidationRulesApi.md +3 -3
- data/docs/ValidationRulesCreateRequestBody.md +1 -0
- data/docs/ValidationRulesCreateResponseBody.md +1 -0
- data/docs/ValidationRulesGetResponseBody.md +1 -0
- data/docs/ValidationRulesUpdateRequestBody.md +1 -0
- data/docs/ValidationRulesUpdateResponseBody.md +1 -0
- data/docs/ValidationsApi.md +1 -1
- data/docs/ValidationsRedeemableInapplicableResult.md +1 -0
- data/docs/ValidationsValidateRequestBodyOptions.md +2 -1
- data/docs/ValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
- data/docs/ValidationsValidateResponseBody.md +1 -0
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
- data/docs/ValidityHours.md +1 -1
- data/docs/VoucherBalance.md +1 -0
- data/docs/VoucherGift.md +3 -2
- data/docs/VoucherLoyaltyCard.md +5 -3
- data/docs/VoucherTransaction.md +1 -1
- data/docs/VoucherTransactionDetailsBalance.md +1 -0
- data/docs/VoucherTransactionsExportParameters.md +1 -1
- data/docs/VoucherTransactionsFilters.md +1 -1
- data/docs/VoucherWithCategoriesGift.md +3 -2
- data/docs/VoucherWithCategoriesLoyaltyCard.md +5 -3
- data/docs/VouchersApi.md +18 -16
- data/docs/VouchersBalanceUpdateRequestBody.md +1 -1
- data/docs/VouchersBalanceUpdateResponseBody.md +2 -2
- data/docs/VouchersCreateRequestBody.md +2 -2
- data/docs/VouchersCreateResponseBodyGift.md +3 -2
- data/docs/VouchersCreateResponseBodyLoyaltyCard.md +5 -3
- data/docs/VouchersCreateWithSpecificCodeRequestBody.md +2 -2
- data/docs/VouchersDisableResponseBodyGift.md +3 -2
- data/docs/VouchersDisableResponseBodyLoyaltyCard.md +5 -3
- data/docs/VouchersEnableResponseBodyGift.md +3 -2
- data/docs/VouchersEnableResponseBodyLoyaltyCard.md +5 -3
- data/docs/VouchersGetResponseBodyGift.md +3 -2
- data/docs/VouchersGetResponseBodyLoyaltyCard.md +5 -3
- data/docs/VouchersImportCreateItemRequestBody.md +1 -1
- data/docs/VouchersTransactionsExportCreateResponseBodyResult.md +1 -1
- data/docs/VouchersUpdateRequestBody.md +2 -2
- data/docs/VouchersUpdateResponseBodyGift.md +3 -2
- data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +5 -3
- data/lib/VoucherifySdk/api/async_actions_api.rb +4 -4
- data/lib/VoucherifySdk/api/campaigns_api.rb +224 -22
- data/lib/VoucherifySdk/api/categories_api.rb +2 -2
- data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
- data/lib/VoucherifySdk/api/customers_api.rb +22 -22
- data/lib/VoucherifySdk/api/exports_api.rb +10 -10
- data/lib/VoucherifySdk/api/loyalties_api.rb +335 -130
- data/lib/VoucherifySdk/api/management_api.rb +52 -52
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +6 -6
- data/lib/VoucherifySdk/api/orders_api.rb +8 -8
- data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
- data/lib/VoucherifySdk/api/products_api.rb +32 -32
- data/lib/VoucherifySdk/api/publications_api.rb +10 -10
- data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
- data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
- data/lib/VoucherifySdk/api/referrals_api.rb +14 -14
- data/lib/VoucherifySdk/api/segments_api.rb +4 -4
- data/lib/VoucherifySdk/api/templates_api.rb +14 -14
- data/lib/VoucherifySdk/api/validation_rules_api.rb +6 -6
- data/lib/VoucherifySdk/api/validations_api.rb +2 -2
- data/lib/VoucherifySdk/api/vouchers_api.rb +29 -26
- data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
- data/lib/VoucherifySdk/models/applicable_to.rb +192 -16
- data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +20 -5
- data/lib/VoucherifySdk/models/async_actions_list_response_body.rb +16 -5
- data/lib/VoucherifySdk/models/bundle.rb +267 -0
- data/lib/VoucherifySdk/models/bundle_identified_item.rb +296 -0
- data/lib/VoucherifySdk/models/bundle_missing_item.rb +274 -0
- data/lib/VoucherifySdk/models/campaign.rb +4 -4
- data/lib/VoucherifySdk/models/campaign_base.rb +4 -4
- data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +53 -10
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +4 -4
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +4 -4
- data/lib/VoucherifySdk/models/campaigns_import_voucher_item.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_summary_get_response_body.rb +673 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body.rb +334 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters.rb +257 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id.rb +209 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id_conditions.rb +221 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_result.rb +210 -0
- data/lib/VoucherifySdk/models/campaigns_transactions_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +4 -4
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb +12 -2
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body_session.rb +236 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_options.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result.rb +11 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +5 -2
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
- data/lib/VoucherifySdk/models/create_publication_campaign.rb +3 -3
- data/lib/VoucherifySdk/models/customer_summary_orders.rb +4 -3
- data/lib/VoucherifySdk/models/customer_summary_redemptions_gift.rb +2 -2
- data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_create_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_get_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/customers_update_response_body_assets.rb +18 -7
- data/lib/VoucherifySdk/models/discount.rb +5 -2
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -1
- data/lib/VoucherifySdk/models/earning_rule.rb +10 -1
- data/lib/VoucherifySdk/models/earning_rule_expiration_rules.rb +313 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/earning_rule_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/error_error.rb +2 -2
- data/lib/VoucherifySdk/models/export.rb +1 -1
- data/lib/VoucherifySdk/models/export_campaign_transactions_filters.rb +248 -0
- data/lib/VoucherifySdk/models/export_parameters.rb +19 -8
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +19 -8
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +19 -8
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -2
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +19 -8
- data/lib/VoucherifySdk/models/filter_conditions_date_time.rb +2 -2
- data/lib/VoucherifySdk/models/gift.rb +14 -3
- data/lib/VoucherifySdk/models/inapplicable_to.rb +192 -16
- data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +20 -5
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/loyalties_create_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item.rb +22 -3
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +10 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +10 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +10 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +10 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb +22 -3
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +10 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_custom_event_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_customer_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_metadata.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_total_amount.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
- data/lib/VoucherifySdk/models/loyalties_get_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_request_body.rb +210 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_session.rb +210 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/loyalties_points_expiration_export_create_request_body_parameters.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body_parameters.rb +256 -0
- data/lib/VoucherifySdk/models/loyalties_transactions_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_update_campaign_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +12 -1
- data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/loyalty_member_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb +1 -1
- data/lib/VoucherifySdk/models/management_projects_stacking_rules.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_request_body.rb +116 -13
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_request_body.rb +116 -13
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_response_body.rb +112 -9
- data/lib/VoucherifySdk/models/management_projects_users_invite_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/management_projects_users_update_role_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/order.rb +1 -1
- data/lib/VoucherifySdk/models/order_calculated_item.rb +1 -1
- data/lib/VoucherifySdk/models/order_item.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +15 -15
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status.rb +2 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status_conditions.rb +1 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_category_ids.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_is_referral_code.rb +1 -1
- data/lib/VoucherifySdk/models/parameters_filters_list_campaign_transactions.rb +247 -0
- data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +2 -4
- data/lib/VoucherifySdk/models/products_skus_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body.rb +12 -2
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body_session.rb +236 -0
- data/lib/VoucherifySdk/models/qualifications_option.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type_conditions.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +1 -1
- data/lib/VoucherifySdk/models/redeemable_gift.rb +18 -7
- data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +2 -2
- data/lib/VoucherifySdk/models/redeemable_result.rb +10 -1
- data/lib/VoucherifySdk/models/redeemable_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/redeemable_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redemption.rb +11 -1
- data/lib/VoucherifySdk/models/redemption_entry.rb +11 -1
- data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemption_entry_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemption_entry_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_rollback.rb +15 -15
- data/lib/VoucherifySdk/models/redemption_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemption_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemptions_get_response_body_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +11 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions.rb +0 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions_rollbacks_item.rb +38 -4
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_session.rb +210 -0
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +29 -7
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_rollback_create_response_body.rb +15 -15
- data/lib/VoucherifySdk/models/reward.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_campaign.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/segments_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/segments_create_response_body.rb +31 -20
- data/lib/VoucherifySdk/models/segments_get_response_body.rb +32 -21
- data/lib/VoucherifySdk/models/simple_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/simple_voucher_redemption.rb +16 -5
- data/lib/VoucherifySdk/models/stacking_rules.rb +72 -20
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/trash_bin_item.rb +1 -1
- data/lib/VoucherifySdk/models/validation_rule.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +11 -1
- data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable_result.rb +14 -5
- data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +29 -7
- data/lib/VoucherifySdk/models/validations_validate_request_body_redeemables_item_gift.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result.rb +11 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +5 -2
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
- data/lib/VoucherifySdk/models/validity_hours.rb +1 -1
- data/lib/VoucherifySdk/models/validity_hours_daily_item.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_balance.rb +12 -1
- data/lib/VoucherifySdk/models/voucher_gift.rb +14 -3
- data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/voucher_transaction.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +12 -1
- data/lib/VoucherifySdk/models/voucher_transactions_export_parameters.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transactions_filters.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_with_categories_gift.rb +14 -3
- data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/vouchers_balance_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_create_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/vouchers_create_with_specific_code_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/vouchers_get_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/models/vouchers_import_create_item_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_transactions_export_create_response_body_result.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_update_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/vouchers_update_response_body_gift.rb +14 -3
- data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +30 -8
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +55 -0
- metadata +142 -28
|
@@ -20,7 +20,7 @@ module VoucherifySdk
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Assign User
|
|
23
|
-
# Assigns a user to a given project. The user must be an existing user in Voucherify.
|
|
23
|
+
# Assigns a user to a given project. The user must be an existing user in Voucherify. <Warning> <Badge color yellow>Correct Use of Data</Badge> To avoid errors, use the role key with either id or login keys. </Warning>
|
|
24
24
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [ManagementProjectsUsersAssignRequestBody] :management_projects_users_assign_request_body Defines the user details.
|
|
@@ -31,7 +31,7 @@ module VoucherifySdk
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Assign User
|
|
34
|
-
# Assigns a user to a given project. The user must be an existing user in Voucherify.
|
|
34
|
+
# Assigns a user to a given project. The user must be an existing user in Voucherify. <Warning> <Badge color yellow>Correct Use of Data</Badge> To avoid errors, use the role key with either id or login keys. </Warning>
|
|
35
35
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
37
|
# @option opts [ManagementProjectsUsersAssignRequestBody] :management_projects_users_assign_request_body Defines the user details.
|
|
@@ -86,7 +86,7 @@ module VoucherifySdk
|
|
|
86
86
|
end
|
|
87
87
|
|
|
88
88
|
# Create Brand
|
|
89
|
-
# Creates a new brand configuration. You can have only one brand configured for a project.
|
|
89
|
+
# Creates a new brand configuration. You can have only one brand configured for a project. <Note> <Badge color blue>White Labelling</Badge> The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface. </Note>
|
|
90
90
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
91
91
|
# @param [Hash] opts the optional parameters
|
|
92
92
|
# @option opts [ManagementProjectsBrandingCreateRequestBody] :management_projects_branding_create_request_body Defines a brand configuration.
|
|
@@ -97,7 +97,7 @@ module VoucherifySdk
|
|
|
97
97
|
end
|
|
98
98
|
|
|
99
99
|
# Create Brand
|
|
100
|
-
# Creates a new brand configuration. You can have only one brand configured for a project.
|
|
100
|
+
# Creates a new brand configuration. You can have only one brand configured for a project. <Note> <Badge color blue>White Labelling</Badge> The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface. </Note>
|
|
101
101
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
102
102
|
# @param [Hash] opts the optional parameters
|
|
103
103
|
# @option opts [ManagementProjectsBrandingCreateRequestBody] :management_projects_branding_create_request_body Defines a brand configuration.
|
|
@@ -152,7 +152,7 @@ module VoucherifySdk
|
|
|
152
152
|
end
|
|
153
153
|
|
|
154
154
|
# Create Custom Event Schema
|
|
155
|
-
# Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata).
|
|
155
|
+
# Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata). <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
156
156
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
157
157
|
# @param [Hash] opts the optional parameters
|
|
158
158
|
# @option opts [ManagementProjectsCustomEventSchemasCreateRequestBody] :management_projects_custom_event_schemas_create_request_body Defines the custom event schema.
|
|
@@ -163,7 +163,7 @@ module VoucherifySdk
|
|
|
163
163
|
end
|
|
164
164
|
|
|
165
165
|
# Create Custom Event Schema
|
|
166
|
-
# Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata).
|
|
166
|
+
# Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata). <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
167
167
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
168
168
|
# @param [Hash] opts the optional parameters
|
|
169
169
|
# @option opts [ManagementProjectsCustomEventSchemasCreateRequestBody] :management_projects_custom_event_schemas_create_request_body Defines the custom event schema.
|
|
@@ -218,7 +218,7 @@ module VoucherifySdk
|
|
|
218
218
|
end
|
|
219
219
|
|
|
220
220
|
# Create Metadata Schema
|
|
221
|
-
# Creates a new metadata (custom attribute) schema. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object
|
|
221
|
+
# Creates a new metadata (custom attribute) schema for a given resource. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cant include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward Use this endpoint to define a metadata schema of a given resource for the first time. Once you configure a metadata schema for a given related_object, use the PUT [Update metadata schema](/api-reference/management/update-metadata-schema) endpoint to either update or add new metadata key-value pairs. For example, use this endpoint to define a metadata schema for related_object: campaign for the first time. If you want define a new metadata property for campaign, use the [PUT Update metadata schema](/api-reference/management/update-metadata-schema) endpoint. <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
222
222
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
223
223
|
# @param [Hash] opts the optional parameters
|
|
224
224
|
# @option opts [ManagementProjectsMetadataSchemasCreateRequestBody] :management_projects_metadata_schemas_create_request_body Defines the metadata schema.
|
|
@@ -229,7 +229,7 @@ module VoucherifySdk
|
|
|
229
229
|
end
|
|
230
230
|
|
|
231
231
|
# Create Metadata Schema
|
|
232
|
-
# Creates a new metadata (custom attribute) schema. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object
|
|
232
|
+
# Creates a new metadata (custom attribute) schema for a given resource. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cant include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward Use this endpoint to define a metadata schema of a given resource for the first time. Once you configure a metadata schema for a given related_object, use the PUT [Update metadata schema](/api-reference/management/update-metadata-schema) endpoint to either update or add new metadata key-value pairs. For example, use this endpoint to define a metadata schema for related_object: campaign for the first time. If you want define a new metadata property for campaign, use the [PUT Update metadata schema](/api-reference/management/update-metadata-schema) endpoint. <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
233
233
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
234
234
|
# @param [Hash] opts the optional parameters
|
|
235
235
|
# @option opts [ManagementProjectsMetadataSchemasCreateRequestBody] :management_projects_metadata_schemas_create_request_body Defines the metadata schema.
|
|
@@ -348,7 +348,7 @@ module VoucherifySdk
|
|
|
348
348
|
end
|
|
349
349
|
|
|
350
350
|
# Create Stacking Rules
|
|
351
|
-
# Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use Update
|
|
351
|
+
# Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use [Update stacking rules](/api-reference/management/update-stacking-rules) endpoint to change the rules. <Note> <Badge color blue>Stacking rules documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
352
352
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
353
353
|
# @param [Hash] opts the optional parameters
|
|
354
354
|
# @option opts [ManagementProjectsStackingRulesCreateRequestBody] :management_projects_stacking_rules_create_request_body Defines the stacking rule parameters.
|
|
@@ -359,7 +359,7 @@ module VoucherifySdk
|
|
|
359
359
|
end
|
|
360
360
|
|
|
361
361
|
# Create Stacking Rules
|
|
362
|
-
# Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use Update
|
|
362
|
+
# Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use [Update stacking rules](/api-reference/management/update-stacking-rules) endpoint to change the rules. <Note> <Badge color blue>Stacking rules documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
363
363
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
364
364
|
# @param [Hash] opts the optional parameters
|
|
365
365
|
# @option opts [ManagementProjectsStackingRulesCreateRequestBody] :management_projects_stacking_rules_create_request_body Defines the stacking rule parameters.
|
|
@@ -414,7 +414,7 @@ module VoucherifySdk
|
|
|
414
414
|
end
|
|
415
415
|
|
|
416
416
|
# Create Webhook
|
|
417
|
-
# Creates a new webhook configuration.
|
|
417
|
+
# Creates a new webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
418
418
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
419
419
|
# @param [Hash] opts the optional parameters
|
|
420
420
|
# @option opts [ManagementProjectsWebhooksCreateRequestBody] :management_projects_webhooks_create_request_body Defines a webhook configuration.
|
|
@@ -425,7 +425,7 @@ module VoucherifySdk
|
|
|
425
425
|
end
|
|
426
426
|
|
|
427
427
|
# Create Webhook
|
|
428
|
-
# Creates a new webhook configuration.
|
|
428
|
+
# Creates a new webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
429
429
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
430
430
|
# @param [Hash] opts the optional parameters
|
|
431
431
|
# @option opts [ManagementProjectsWebhooksCreateRequestBody] :management_projects_webhooks_create_request_body Defines a webhook configuration.
|
|
@@ -539,7 +539,7 @@ module VoucherifySdk
|
|
|
539
539
|
end
|
|
540
540
|
|
|
541
541
|
# Delete Custom Event Schema
|
|
542
|
-
# Deletes permanently the custom event schema with its custom properties (metadata).
|
|
542
|
+
# Deletes permanently the custom event schema with its custom properties (metadata). <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
543
543
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
544
544
|
# @param custom_event_schema_id [String] Provide the unique identifier of the custom event schema.
|
|
545
545
|
# @param [Hash] opts the optional parameters
|
|
@@ -550,7 +550,7 @@ module VoucherifySdk
|
|
|
550
550
|
end
|
|
551
551
|
|
|
552
552
|
# Delete Custom Event Schema
|
|
553
|
-
# Deletes permanently the custom event schema with its custom properties (metadata).
|
|
553
|
+
# Deletes permanently the custom event schema with its custom properties (metadata). <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
554
554
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
555
555
|
# @param custom_event_schema_id [String] Provide the unique identifier of the custom event schema.
|
|
556
556
|
# @param [Hash] opts the optional parameters
|
|
@@ -598,7 +598,7 @@ module VoucherifySdk
|
|
|
598
598
|
end
|
|
599
599
|
|
|
600
600
|
# Delete Metadata Schema
|
|
601
|
-
# Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the Update Metadata Schema endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the Create Metadata Schema endpoint.
|
|
601
|
+
# Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the [Create Metadata Schema](/api-reference/management/create-metadata-schema) endpoint. <Warning> <Badge color yellow>Metadata Purging</Badge> This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify. </Warning> <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
602
602
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
603
603
|
# @param metadata_schema_id [String] Provide the unique identifier of the metadata schema.
|
|
604
604
|
# @param [Hash] opts the optional parameters
|
|
@@ -609,7 +609,7 @@ module VoucherifySdk
|
|
|
609
609
|
end
|
|
610
610
|
|
|
611
611
|
# Delete Metadata Schema
|
|
612
|
-
# Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the Update Metadata Schema endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the Create Metadata Schema endpoint.
|
|
612
|
+
# Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the [Create Metadata Schema](/api-reference/management/create-metadata-schema) endpoint. <Warning> <Badge color yellow>Metadata Purging</Badge> This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify. </Warning> <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
613
613
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
614
614
|
# @param metadata_schema_id [String] Provide the unique identifier of the metadata schema.
|
|
615
615
|
# @param [Hash] opts the optional parameters
|
|
@@ -657,7 +657,7 @@ module VoucherifySdk
|
|
|
657
657
|
end
|
|
658
658
|
|
|
659
659
|
# Delete Project
|
|
660
|
-
# Deletes an existing project. The users currently using the deleted project will be automatically logged out.
|
|
660
|
+
# Deletes an existing project. The users currently using the deleted project will be automatically logged out. <Warning> <Badge color yellow>Sandbox Project</Badge> The sandbox project cannot be deleted. </Warning>
|
|
661
661
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
662
662
|
# @param [Hash] opts the optional parameters
|
|
663
663
|
# @return [nil]
|
|
@@ -667,7 +667,7 @@ module VoucherifySdk
|
|
|
667
667
|
end
|
|
668
668
|
|
|
669
669
|
# Delete Project
|
|
670
|
-
# Deletes an existing project. The users currently using the deleted project will be automatically logged out.
|
|
670
|
+
# Deletes an existing project. The users currently using the deleted project will be automatically logged out. <Warning> <Badge color yellow>Sandbox Project</Badge> The sandbox project cannot be deleted. </Warning>
|
|
671
671
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
672
672
|
# @param [Hash] opts the optional parameters
|
|
673
673
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -714,7 +714,7 @@ module VoucherifySdk
|
|
|
714
714
|
end
|
|
715
715
|
|
|
716
716
|
# Delete Stacking Rules
|
|
717
|
-
# Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values.
|
|
717
|
+
# Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
718
718
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
719
719
|
# @param stacking_rules_id [String] Provide the unique identifier of the stacking rules.
|
|
720
720
|
# @param [Hash] opts the optional parameters
|
|
@@ -725,7 +725,7 @@ module VoucherifySdk
|
|
|
725
725
|
end
|
|
726
726
|
|
|
727
727
|
# Delete Stacking Rules
|
|
728
|
-
# Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values.
|
|
728
|
+
# Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
729
729
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
730
730
|
# @param stacking_rules_id [String] Provide the unique identifier of the stacking rules.
|
|
731
731
|
# @param [Hash] opts the optional parameters
|
|
@@ -773,7 +773,7 @@ module VoucherifySdk
|
|
|
773
773
|
end
|
|
774
774
|
|
|
775
775
|
# Delete Webhook
|
|
776
|
-
# Deletes a webhook configuration.
|
|
776
|
+
# Deletes a webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
777
777
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
778
778
|
# @param webhook_id [String] Provide the unique identifier of the webhook configuration.
|
|
779
779
|
# @param [Hash] opts the optional parameters
|
|
@@ -784,7 +784,7 @@ module VoucherifySdk
|
|
|
784
784
|
end
|
|
785
785
|
|
|
786
786
|
# Delete Webhook
|
|
787
|
-
# Deletes a webhook configuration.
|
|
787
|
+
# Deletes a webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
788
788
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
789
789
|
# @param webhook_id [String] Provide the unique identifier of the webhook configuration.
|
|
790
790
|
# @param [Hash] opts the optional parameters
|
|
@@ -893,7 +893,7 @@ module VoucherifySdk
|
|
|
893
893
|
end
|
|
894
894
|
|
|
895
895
|
# Get Custom Event Schema
|
|
896
|
-
# Retrieves a custom event schema.
|
|
896
|
+
# Retrieves a custom event schema. <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
897
897
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
898
898
|
# @param custom_event_schema_id [String] Provide the unique identifier of the custom event schema.
|
|
899
899
|
# @param [Hash] opts the optional parameters
|
|
@@ -904,7 +904,7 @@ module VoucherifySdk
|
|
|
904
904
|
end
|
|
905
905
|
|
|
906
906
|
# Get Custom Event Schema
|
|
907
|
-
# Retrieves a custom event schema.
|
|
907
|
+
# Retrieves a custom event schema. <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
908
908
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
909
909
|
# @param custom_event_schema_id [String] Provide the unique identifier of the custom event schema.
|
|
910
910
|
# @param [Hash] opts the optional parameters
|
|
@@ -954,7 +954,7 @@ module VoucherifySdk
|
|
|
954
954
|
end
|
|
955
955
|
|
|
956
956
|
# Get Metadata Schema
|
|
957
|
-
# Retrieves a metadata schema.
|
|
957
|
+
# Retrieves a metadata schema. <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
958
958
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
959
959
|
# @param metadata_schema_id [String] Provide the unique identifier of the metadata schema.
|
|
960
960
|
# @param [Hash] opts the optional parameters
|
|
@@ -965,7 +965,7 @@ module VoucherifySdk
|
|
|
965
965
|
end
|
|
966
966
|
|
|
967
967
|
# Get Metadata Schema
|
|
968
|
-
# Retrieves a metadata schema.
|
|
968
|
+
# Retrieves a metadata schema. <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
969
969
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
970
970
|
# @param metadata_schema_id [String] Provide the unique identifier of the metadata schema.
|
|
971
971
|
# @param [Hash] opts the optional parameters
|
|
@@ -1074,7 +1074,7 @@ module VoucherifySdk
|
|
|
1074
1074
|
end
|
|
1075
1075
|
|
|
1076
1076
|
# Get Stacking Rules
|
|
1077
|
-
# Retrieves the stacking rules for the project.
|
|
1077
|
+
# Retrieves the stacking rules for the project. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
1078
1078
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1079
1079
|
# @param stacking_rules_id [String] Provide the unique identifier of the stacking rules.
|
|
1080
1080
|
# @param [Hash] opts the optional parameters
|
|
@@ -1085,7 +1085,7 @@ module VoucherifySdk
|
|
|
1085
1085
|
end
|
|
1086
1086
|
|
|
1087
1087
|
# Get Stacking Rules
|
|
1088
|
-
# Retrieves the stacking rules for the project.
|
|
1088
|
+
# Retrieves the stacking rules for the project. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
1089
1089
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1090
1090
|
# @param stacking_rules_id [String] Provide the unique identifier of the stacking rules.
|
|
1091
1091
|
# @param [Hash] opts the optional parameters
|
|
@@ -1196,7 +1196,7 @@ module VoucherifySdk
|
|
|
1196
1196
|
end
|
|
1197
1197
|
|
|
1198
1198
|
# Get Webhook
|
|
1199
|
-
# Retrieves a webhook configuration.
|
|
1199
|
+
# Retrieves a webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
1200
1200
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1201
1201
|
# @param webhook_id [String] Provide the unique identifier of the webhook configuration.
|
|
1202
1202
|
# @param [Hash] opts the optional parameters
|
|
@@ -1207,7 +1207,7 @@ module VoucherifySdk
|
|
|
1207
1207
|
end
|
|
1208
1208
|
|
|
1209
1209
|
# Get Webhook
|
|
1210
|
-
# Retrieves a webhook configuration.
|
|
1210
|
+
# Retrieves a webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
1211
1211
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1212
1212
|
# @param webhook_id [String] Provide the unique identifier of the webhook configuration.
|
|
1213
1213
|
# @param [Hash] opts the optional parameters
|
|
@@ -1378,7 +1378,7 @@ module VoucherifySdk
|
|
|
1378
1378
|
end
|
|
1379
1379
|
|
|
1380
1380
|
# List Custom Event Schemas
|
|
1381
|
-
# Lists all custom event schemas available in the project.
|
|
1381
|
+
# Lists all custom event schemas available in the project. <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
1382
1382
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1383
1383
|
# @param [Hash] opts the optional parameters
|
|
1384
1384
|
# @return [ManagementProjectsCustomEventSchemasListResponseBody]
|
|
@@ -1388,7 +1388,7 @@ module VoucherifySdk
|
|
|
1388
1388
|
end
|
|
1389
1389
|
|
|
1390
1390
|
# List Custom Event Schemas
|
|
1391
|
-
# Lists all custom event schemas available in the project.
|
|
1391
|
+
# Lists all custom event schemas available in the project. <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
1392
1392
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1393
1393
|
# @param [Hash] opts the optional parameters
|
|
1394
1394
|
# @return [Array<(ManagementProjectsCustomEventSchemasListResponseBody, Integer, Hash)>] ManagementProjectsCustomEventSchemasListResponseBody data, response status code and response headers
|
|
@@ -1437,7 +1437,7 @@ module VoucherifySdk
|
|
|
1437
1437
|
end
|
|
1438
1438
|
|
|
1439
1439
|
# List Metadata Schemas
|
|
1440
|
-
# Lists all metadata schemas available in the project.
|
|
1440
|
+
# Lists all metadata schemas available in the project. <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
1441
1441
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1442
1442
|
# @param [Hash] opts the optional parameters
|
|
1443
1443
|
# @return [ManagementProjectsMetadataSchemasListResponseBody]
|
|
@@ -1447,7 +1447,7 @@ module VoucherifySdk
|
|
|
1447
1447
|
end
|
|
1448
1448
|
|
|
1449
1449
|
# List Metadata Schemas
|
|
1450
|
-
# Lists all metadata schemas available in the project.
|
|
1450
|
+
# Lists all metadata schemas available in the project. <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
1451
1451
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1452
1452
|
# @param [Hash] opts the optional parameters
|
|
1453
1453
|
# @return [Array<(ManagementProjectsMetadataSchemasListResponseBody, Integer, Hash)>] ManagementProjectsMetadataSchemasListResponseBody data, response status code and response headers
|
|
@@ -1553,7 +1553,7 @@ module VoucherifySdk
|
|
|
1553
1553
|
end
|
|
1554
1554
|
|
|
1555
1555
|
# List Stacking Rules
|
|
1556
|
-
# Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the Get Stacking Rules or Update Stacking Rules endpoints.
|
|
1556
|
+
# Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the [Get Stacking Rules](/api-reference/management/get-stacking-rules) or [Update Stacking Rules](/api-reference/management/update-stacking-rules) endpoints. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
1557
1557
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1558
1558
|
# @param [Hash] opts the optional parameters
|
|
1559
1559
|
# @return [ManagementProjectsStackingRulesListResponseBody]
|
|
@@ -1563,7 +1563,7 @@ module VoucherifySdk
|
|
|
1563
1563
|
end
|
|
1564
1564
|
|
|
1565
1565
|
# List Stacking Rules
|
|
1566
|
-
# Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the Get Stacking Rules or Update Stacking Rules endpoints.
|
|
1566
|
+
# Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the [Get Stacking Rules](/api-reference/management/get-stacking-rules) or [Update Stacking Rules](/api-reference/management/update-stacking-rules) endpoints. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
1567
1567
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1568
1568
|
# @param [Hash] opts the optional parameters
|
|
1569
1569
|
# @return [Array<(ManagementProjectsStackingRulesListResponseBody, Integer, Hash)>] ManagementProjectsStackingRulesListResponseBody data, response status code and response headers
|
|
@@ -1671,7 +1671,7 @@ module VoucherifySdk
|
|
|
1671
1671
|
end
|
|
1672
1672
|
|
|
1673
1673
|
# List Webhooks
|
|
1674
|
-
# Lists all webhook configurations for the project.
|
|
1674
|
+
# Lists all webhook configurations for the project. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
1675
1675
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1676
1676
|
# @param [Hash] opts the optional parameters
|
|
1677
1677
|
# @return [ManagementProjectsWebhooksListResponseBody]
|
|
@@ -1681,7 +1681,7 @@ module VoucherifySdk
|
|
|
1681
1681
|
end
|
|
1682
1682
|
|
|
1683
1683
|
# List Webhooks
|
|
1684
|
-
# Lists all webhook configurations for the project.
|
|
1684
|
+
# Lists all webhook configurations for the project. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
1685
1685
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1686
1686
|
# @param [Hash] opts the optional parameters
|
|
1687
1687
|
# @return [Array<(ManagementProjectsWebhooksListResponseBody, Integer, Hash)>] ManagementProjectsWebhooksListResponseBody data, response status code and response headers
|
|
@@ -1730,7 +1730,7 @@ module VoucherifySdk
|
|
|
1730
1730
|
end
|
|
1731
1731
|
|
|
1732
1732
|
# Copy Campaign Template to a Project
|
|
1733
|
-
# Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project.
|
|
1733
|
+
# Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
1734
1734
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1735
1735
|
# @param campaign_template_id [String] Provide the unique identifier of the campaign template.
|
|
1736
1736
|
# @param [Hash] opts the optional parameters
|
|
@@ -1742,7 +1742,7 @@ module VoucherifySdk
|
|
|
1742
1742
|
end
|
|
1743
1743
|
|
|
1744
1744
|
# Copy Campaign Template to a Project
|
|
1745
|
-
# Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project.
|
|
1745
|
+
# Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
1746
1746
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1747
1747
|
# @param campaign_template_id [String] Provide the unique identifier of the campaign template.
|
|
1748
1748
|
# @param [Hash] opts the optional parameters
|
|
@@ -1798,7 +1798,7 @@ module VoucherifySdk
|
|
|
1798
1798
|
end
|
|
1799
1799
|
|
|
1800
1800
|
# List Campaign Templates
|
|
1801
|
-
# Lists all campaign templates available in the project.
|
|
1801
|
+
# Lists all campaign templates available in the project. <Tip> <Badge color green>List Campaign Templates</Badge> This endpoint works in the same way as the [List Campaign Templates endpoint](/api-reference/templates/list-campaign-templates). </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
1802
1802
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1803
1803
|
# @param [Hash] opts the optional parameters
|
|
1804
1804
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1813,7 +1813,7 @@ module VoucherifySdk
|
|
|
1813
1813
|
end
|
|
1814
1814
|
|
|
1815
1815
|
# List Campaign Templates
|
|
1816
|
-
# Lists all campaign templates available in the project.
|
|
1816
|
+
# Lists all campaign templates available in the project. <Tip> <Badge color green>List Campaign Templates</Badge> This endpoint works in the same way as the [List Campaign Templates endpoint](/api-reference/templates/list-campaign-templates). </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
|
|
1817
1817
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1818
1818
|
# @param [Hash] opts the optional parameters
|
|
1819
1819
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
@@ -1931,7 +1931,7 @@ module VoucherifySdk
|
|
|
1931
1931
|
end
|
|
1932
1932
|
|
|
1933
1933
|
# Update Brand
|
|
1934
|
-
# Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged.
|
|
1934
|
+
# Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged. <Note> <Badge color blue>White Labelling</Badge> The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface. </Note>
|
|
1935
1935
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1936
1936
|
# @param branding_id [String] Provide the unique identifier of the brand configuration.
|
|
1937
1937
|
# @param [Hash] opts the optional parameters
|
|
@@ -1943,7 +1943,7 @@ module VoucherifySdk
|
|
|
1943
1943
|
end
|
|
1944
1944
|
|
|
1945
1945
|
# Update Brand
|
|
1946
|
-
# Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged.
|
|
1946
|
+
# Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged. <Note> <Badge color blue>White Labelling</Badge> The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface. </Note>
|
|
1947
1947
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
1948
1948
|
# @param branding_id [String] Provide the unique identifier of the brand configuration.
|
|
1949
1949
|
# @param [Hash] opts the optional parameters
|
|
@@ -1999,7 +1999,7 @@ module VoucherifySdk
|
|
|
1999
1999
|
end
|
|
2000
2000
|
|
|
2001
2001
|
# Update Custom Event Schema
|
|
2002
|
-
# Updates a custom event schema. With this request, you can: - Add a
|
|
2002
|
+
# Updates a custom event schema. With this request, you can: - Add a nonexistent property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged. <Tip> <Badge color green>Additional Notes</Badge> - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint. </Tip> <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
2003
2003
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2004
2004
|
# @param custom_event_schema_id [String] Provide the unique identifier of the custom event schema.
|
|
2005
2005
|
# @param [Hash] opts the optional parameters
|
|
@@ -2011,7 +2011,7 @@ module VoucherifySdk
|
|
|
2011
2011
|
end
|
|
2012
2012
|
|
|
2013
2013
|
# Update Custom Event Schema
|
|
2014
|
-
# Updates a custom event schema. With this request, you can: - Add a
|
|
2014
|
+
# Updates a custom event schema. With this request, you can: - Add a nonexistent property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged. <Tip> <Badge color green>Additional Notes</Badge> - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint. </Tip> <Note> <Badge color blue>Custom Event Documentation</Badge> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object). </Note>
|
|
2015
2015
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2016
2016
|
# @param custom_event_schema_id [String] Provide the unique identifier of the custom event schema.
|
|
2017
2017
|
# @param [Hash] opts the optional parameters
|
|
@@ -2067,7 +2067,7 @@ module VoucherifySdk
|
|
|
2067
2067
|
end
|
|
2068
2068
|
|
|
2069
2069
|
# Update Metadata Schema
|
|
2070
|
-
# Updates a metadata schema. With this request, you can: - Add a
|
|
2070
|
+
# Updates a metadata schema. With this request, you can: - Add a nonexistent attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted. <Tip> <Badge color green>Additional Notes</Badge> - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint. </Tip> <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
2071
2071
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2072
2072
|
# @param metadata_schema_id [String] Provide the unique identifier of the metadata schema.
|
|
2073
2073
|
# @param [Hash] opts the optional parameters
|
|
@@ -2079,7 +2079,7 @@ module VoucherifySdk
|
|
|
2079
2079
|
end
|
|
2080
2080
|
|
|
2081
2081
|
# Update Metadata Schema
|
|
2082
|
-
# Updates a metadata schema. With this request, you can: - Add a
|
|
2082
|
+
# Updates a metadata schema. With this request, you can: - Add a nonexistent attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted. <Tip> <Badge color green>Additional Notes</Badge> - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint. </Tip> <Note> <Badge color blue>Metadata Documentation</Badge> Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify. </Note>
|
|
2083
2083
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2084
2084
|
# @param metadata_schema_id [String] Provide the unique identifier of the metadata schema.
|
|
2085
2085
|
# @param [Hash] opts the optional parameters
|
|
@@ -2201,7 +2201,7 @@ module VoucherifySdk
|
|
|
2201
2201
|
end
|
|
2202
2202
|
|
|
2203
2203
|
# Update Stacking Rules
|
|
2204
|
-
# Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request.
|
|
2204
|
+
# Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
2205
2205
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2206
2206
|
# @param stacking_rules_id [String] Provide the unique identifier of the stacking rules.
|
|
2207
2207
|
# @param [Hash] opts the optional parameters
|
|
@@ -2213,7 +2213,7 @@ module VoucherifySdk
|
|
|
2213
2213
|
end
|
|
2214
2214
|
|
|
2215
2215
|
# Update Stacking Rules
|
|
2216
|
-
# Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request.
|
|
2216
|
+
# Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request. <Note> <Badge color blue>Stacking Rules Documentation</Badge> Read [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work. </Note>
|
|
2217
2217
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2218
2218
|
# @param stacking_rules_id [String] Provide the unique identifier of the stacking rules.
|
|
2219
2219
|
# @param [Hash] opts the optional parameters
|
|
@@ -2337,7 +2337,7 @@ module VoucherifySdk
|
|
|
2337
2337
|
end
|
|
2338
2338
|
|
|
2339
2339
|
# Update Webhook
|
|
2340
|
-
# Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration.
|
|
2340
|
+
# Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
2341
2341
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2342
2342
|
# @param webhook_id [String] Provide the unique identifier of the webhook configuration.
|
|
2343
2343
|
# @param [Hash] opts the optional parameters
|
|
@@ -2349,7 +2349,7 @@ module VoucherifySdk
|
|
|
2349
2349
|
end
|
|
2350
2350
|
|
|
2351
2351
|
# Update Webhook
|
|
2352
|
-
# Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration.
|
|
2352
|
+
# Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration. <Note> <Badge color blue>Webhook Documentation</Badge> Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify. </Note>
|
|
2353
2353
|
# @param project_id [String] Provide the unique identifier of the project.
|
|
2354
2354
|
# @param webhook_id [String] Provide the unique identifier of the webhook configuration.
|
|
2355
2355
|
# @param [Hash] opts the optional parameters
|
|
@@ -20,7 +20,7 @@ module VoucherifySdk
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Get Metadata Schema
|
|
23
|
-
# Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](
|
|
23
|
+
# Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](/prepare/metadata#add-metadata), provide its name in the resource field to retrieve its details. <Note> <Badge color blue>Management API</Badge> If you have Management API enabled, you can also use the [Get Metadata Schemas](/api-reference/management/get-metadata-schema) endpoint to retrieve a metadata schema using its ID. </Note>
|
|
24
24
|
# @param resource [String] There is an infinite number of possibilities for retrieving metadata schemas by the resource type because you can define custom metadata schemas.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [MetadataSchemasGetResponseBody]
|
|
@@ -30,7 +30,7 @@ module VoucherifySdk
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Get Metadata Schema
|
|
33
|
-
# Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](
|
|
33
|
+
# Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](/prepare/metadata#add-metadata), provide its name in the resource field to retrieve its details. <Note> <Badge color blue>Management API</Badge> If you have Management API enabled, you can also use the [Get Metadata Schemas](/api-reference/management/get-metadata-schema) endpoint to retrieve a metadata schema using its ID. </Note>
|
|
34
34
|
# @param resource [String] There is an infinite number of possibilities for retrieving metadata schemas by the resource type because you can define custom metadata schemas.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(MetadataSchemasGetResponseBody, Integer, Hash)>] MetadataSchemasGetResponseBody data, response status code and response headers
|
|
@@ -78,8 +78,8 @@ module VoucherifySdk
|
|
|
78
78
|
return data, status_code, headers
|
|
79
79
|
end
|
|
80
80
|
|
|
81
|
-
# List Metadata
|
|
82
|
-
# Retrieve metadata schema definitions.
|
|
81
|
+
# List Metadata Schema Definitions
|
|
82
|
+
# Retrieve metadata schema definitions. <Note> <Badge color blue>Management API</Badge> If you have Management API enabled, you can also use the [List Metadata Schemas](/api-reference/management/list-metadata-schemas) endpoint to list all metadata schemas. </Note>
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
84
|
# @return [MetadataSchemasListResponseBody]
|
|
85
85
|
def list_metadata_schemas(opts = {})
|
|
@@ -87,8 +87,8 @@ module VoucherifySdk
|
|
|
87
87
|
data
|
|
88
88
|
end
|
|
89
89
|
|
|
90
|
-
# List Metadata
|
|
91
|
-
# Retrieve metadata schema definitions.
|
|
90
|
+
# List Metadata Schema Definitions
|
|
91
|
+
# Retrieve metadata schema definitions. <Note> <Badge color blue>Management API</Badge> If you have Management API enabled, you can also use the [List Metadata Schemas](/api-reference/management/list-metadata-schemas) endpoint to list all metadata schemas. </Note>
|
|
92
92
|
# @param [Hash] opts the optional parameters
|
|
93
93
|
# @return [Array<(MetadataSchemasListResponseBody, Integer, Hash)>] MetadataSchemasListResponseBody data, response status code and response headers
|
|
94
94
|
private def list_metadata_schemas_with_http_info(opts = {})
|