voucherify 4.1.0 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Dockerfile +14 -0
- data/ENDPOINTS-COVERAGE.md +868 -0
- data/EXAMPLES.md +112 -0
- data/Gemfile +6 -1
- data/Gemfile.lock +72 -0
- data/LICENSE +2 -2
- data/README.md +881 -867
- data/Rakefile +9 -4
- data/VoucherifySdk.gemspec +37 -0
- data/__tests__/README.md +35 -0
- data/__tests__/lib/campaigns.rb +128 -0
- data/__tests__/lib/config.rb +70 -0
- data/__tests__/lib/customers.rb +34 -0
- data/__tests__/lib/events.rb +24 -0
- data/__tests__/lib/products.rb +116 -0
- data/__tests__/lib/stackables.rb +59 -0
- data/__tests__/lib/utils.rb +5 -0
- data/__tests__/lib/voucherify_data.rb +95 -0
- data/__tests__/spec/1_products_spec.rb +101 -0
- data/__tests__/spec/2_campaigns_spec.rb +95 -0
- data/__tests__/spec/3_customers_spec.rb +24 -0
- data/__tests__/spec/4_publications_spec.rb +23 -0
- data/__tests__/spec/5_qualifications_spec.rb +27 -0
- data/__tests__/spec/6_validations_spec.rb +126 -0
- data/__tests__/spec/7_vouchers_spec.rb +40 -0
- data/__tests__/spec/8_events_spec.rb +16 -0
- data/__tests__/spec/9_redemptions_spec.rb +14 -0
- data/docs/Any.md +53 -0
- data/docs/ApplicableTo.md +21 -0
- data/docs/ApplicableToEffect.md +7 -0
- data/docs/ApplicableToResultList.md +11 -0
- data/docs/ArrayInner.md +51 -0
- data/docs/AsyncActions.md +8 -0
- data/docs/BusValRuleAssignment.md +16 -0
- data/docs/Campaign.md +37 -0
- data/docs/CampaignBase.md +35 -0
- data/docs/CampaignBaseValidityTimeframe.md +9 -0
- data/docs/CampaignLoyaltyCard.md +9 -0
- data/docs/CampaignLoyaltyCardExpirationRules.md +11 -0
- data/docs/CampaignLoyaltyVoucher.md +11 -0
- data/docs/CampaignLoyaltyVoucherRedemption.md +8 -0
- data/docs/CampaignVoucher.md +17 -0
- data/docs/CampaignVoucherRedemption.md +8 -0
- data/docs/CampaignsApi.md +694 -0
- data/docs/CampaignsCreateBase.md +23 -0
- data/docs/CampaignsCreateDiscountCouponsCampaign.md +25 -0
- data/docs/CampaignsCreateGiftCampaign.md +25 -0
- data/docs/CampaignsCreateGiveawayCampaign.md +26 -0
- data/docs/CampaignsCreateLoyaltyCampaign.md +25 -0
- data/docs/CampaignsCreatePromotionCampaign.md +25 -0
- data/docs/CampaignsCreateReferralCampaign.md +26 -0
- data/docs/CampaignsCreateRequestBody.md +57 -0
- data/docs/CampaignsCreateResponseBody.md +37 -0
- data/docs/CampaignsDeleteResponseBody.md +8 -0
- data/docs/CampaignsDisableResponseBody.md +7 -0
- data/docs/CampaignsEnableResponseBody.md +7 -0
- data/docs/CampaignsGetResponseBody.md +37 -0
- data/docs/CampaignsImportCreateResponseBody.md +8 -0
- data/docs/CampaignsImportCsvCreateResponseBody.md +8 -0
- data/docs/CampaignsImportVoucherItem.md +20 -0
- data/docs/CampaignsImportVoucherItemRedemption.md +8 -0
- data/docs/CampaignsImportVoucherLoyaltyCard.md +8 -0
- data/docs/CampaignsListResponseBody.md +11 -0
- data/docs/CampaignsUpdateBase.md +16 -0
- data/docs/CampaignsUpdateCouponCampaignBase.md +20 -0
- data/docs/CampaignsUpdateDiscountCouponsCampaign.md +21 -0
- data/docs/CampaignsUpdateGiftCampaign.md +21 -0
- data/docs/CampaignsUpdateGiveawayCampaign.md +23 -0
- data/docs/CampaignsUpdateLoyaltyCampaign.md +22 -0
- data/docs/CampaignsUpdatePromotionCampaign.md +16 -0
- data/docs/CampaignsUpdateReferralCampaign.md +22 -0
- data/docs/CampaignsUpdateRequestBody.md +57 -0
- data/docs/CampaignsUpdateResponseBody.md +37 -0
- data/docs/CampaignsVouchersCreateBaseRequestBody.md +13 -0
- data/docs/CampaignsVouchersCreateInBulkRequestBody.md +15 -0
- data/docs/CampaignsVouchersCreateInBulkResponseBody.md +8 -0
- data/docs/CampaignsVouchersCreateRequestBody.md +13 -0
- data/docs/CampaignsVouchersCreateResponseBody.md +37 -0
- data/docs/CategoriesApi.md +304 -0
- data/docs/CategoriesCreateRequestBody.md +9 -0
- data/docs/CategoriesCreateResponseBody.md +12 -0
- data/docs/CategoriesGetResponseBody.md +14 -0
- data/docs/CategoriesListResponseBody.md +11 -0
- data/docs/CategoriesUpdateRequestBody.md +9 -0
- data/docs/CategoriesUpdateResponseBody.md +13 -0
- data/docs/Category.md +14 -0
- data/docs/ClientEventsCreateRequestBody.md +12 -0
- data/docs/ClientEventsCreateRequestBodyLoyalty.md +8 -0
- data/docs/ClientEventsCreateRequestBodyReferral.md +9 -0
- data/docs/ClientEventsCreateResponseBody.md +12 -0
- data/docs/ClientQualificationsCheckEligibilityRequestBody.md +14 -0
- data/docs/ClientQualificationsCheckEligibilityRequestBodyOptions.md +12 -0
- data/docs/ClientQualificationsCheckEligibilityRequestBodyOptionsFilters.md +14 -0
- data/docs/ClientQualificationsCheckEligibilityResponseBody.md +11 -0
- data/docs/ClientRedemptionsRedeemRequestBody.md +14 -0
- data/docs/ClientRedemptionsRedeemRequestBodyAllOfOptions.md +8 -0
- data/docs/ClientRedemptionsRedeemResponseBody.md +12 -0
- data/docs/ClientSideApi.md +319 -0
- data/docs/ClientValidationsValidateRequestBody.md +14 -0
- data/docs/ClientValidationsValidateRequestBodyAllOfOptions.md +8 -0
- data/docs/ClientValidationsValidateResponseBody.md +14 -0
- data/docs/CodeConfig.md +13 -0
- data/docs/CodeConfigRequiredLengthCharsetPattern.md +13 -0
- data/docs/CreatePublicationBase.md +10 -0
- data/docs/CreatePublicationCampaign.md +9 -0
- data/docs/CreatePublicationWithCampaign.md +11 -0
- data/docs/CreatePublicationWithSpecificVoucher.md +11 -0
- data/docs/CustomEvent.md +15 -0
- data/docs/CustomEventReferral.md +10 -0
- data/docs/Customer.md +17 -0
- data/docs/CustomerActivity.md +11 -0
- data/docs/CustomerActivityData.md +183 -0
- data/docs/CustomerBase.md +15 -0
- data/docs/CustomerBaseAddress.md +13 -0
- data/docs/CustomerId.md +9 -0
- data/docs/CustomerLoyalty.md +10 -0
- data/docs/CustomerLoyaltyCampaignsValue.md +10 -0
- data/docs/CustomerReferrals.md +9 -0
- data/docs/CustomerReferralsCampaignsItem.md +12 -0
- data/docs/CustomerResponseDataAssets.md +8 -0
- data/docs/CustomerSegmentsList.md +11 -0
- data/docs/CustomerSummary.md +9 -0
- data/docs/CustomerSummaryOrders.md +12 -0
- data/docs/CustomerSummaryRedemptions.md +15 -0
- data/docs/CustomerSummaryRedemptionsGift.md +9 -0
- data/docs/CustomerSummaryRedemptionsLoyaltyCard.md +9 -0
- data/docs/CustomerWithSummaryLoyaltyReferrals.md +25 -0
- data/docs/CustomersActivitiesListResponseBody.md +11 -0
- data/docs/CustomersApi.md +771 -0
- data/docs/CustomersCreateRequestBody.md +17 -0
- data/docs/CustomersCreateResponseBody.md +25 -0
- data/docs/CustomersGetResponseBody.md +25 -0
- data/docs/CustomersImportCsvCreateResponseBody.md +8 -0
- data/docs/CustomersListResponseBody.md +12 -0
- data/docs/CustomersMetadataUpdateInBulkRequestBody.md +9 -0
- data/docs/CustomersMetadataUpdateInBulkResponseBody.md +8 -0
- data/docs/CustomersPermanentDeletionCreateResponseBody.md +14 -0
- data/docs/CustomersPermanentDeletionCreateResponseBodyDataJson.md +14 -0
- data/docs/CustomersSegmentsListResponseBody.md +11 -0
- data/docs/CustomersUpdateInBulkRequestBody.md +16 -0
- data/docs/CustomersUpdateInBulkResponseBody.md +8 -0
- data/docs/CustomersUpdateRequestBody.md +15 -0
- data/docs/CustomersUpdateResponseBody.md +25 -0
- data/docs/Discount.md +55 -0
- data/docs/DiscountAmount.md +13 -0
- data/docs/DiscountAmountVouchersEffectTypes.md +7 -0
- data/docs/DiscountCouponsCampaignVoucher.md +11 -0
- data/docs/DiscountFixed.md +12 -0
- data/docs/DiscountFixedVouchersEffectTypes.md +7 -0
- data/docs/DiscountPercent.md +14 -0
- data/docs/DiscountPercentVouchersEffectTypes.md +7 -0
- data/docs/DiscountUnit.md +15 -0
- data/docs/DiscountUnitMultiple.md +10 -0
- data/docs/DiscountUnitMultipleOneUnit.md +13 -0
- data/docs/DiscountUnitVouchersEffectTypes.md +7 -0
- data/docs/EarningRule.md +24 -0
- data/docs/EarningRuleBase.md +21 -0
- data/docs/EarningRuleBaseCustomEvent.md +8 -0
- data/docs/EarningRuleBaseLoyalty.md +49 -0
- data/docs/EarningRuleBaseSegment.md +8 -0
- data/docs/EarningRuleBaseSource.md +10 -0
- data/docs/EarningRuleBaseValidityTimeframe.md +9 -0
- data/docs/EarningRuleEvent.md +7 -0
- data/docs/EarningRuleFixed.md +9 -0
- data/docs/EarningRuleProportional.md +53 -0
- data/docs/EarningRuleProportionalCustomEvent.md +10 -0
- data/docs/EarningRuleProportionalCustomEventCustomEvent.md +8 -0
- data/docs/EarningRuleProportionalCustomEventCustomEventMetadata.md +10 -0
- data/docs/EarningRuleProportionalCustomerMetadata.md +10 -0
- data/docs/EarningRuleProportionalCustomerMetadataCustomer.md +8 -0
- data/docs/EarningRuleProportionalCustomerMetadataCustomerMetadata.md +10 -0
- data/docs/EarningRuleProportionalOrder.md +51 -0
- data/docs/EarningRuleProportionalOrderAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderAmountOrder.md +8 -0
- data/docs/EarningRuleProportionalOrderAmountOrderAmount.md +9 -0
- data/docs/EarningRuleProportionalOrderItems.md +51 -0
- data/docs/EarningRuleProportionalOrderItemsAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderItemsAmountOrderItems.md +8 -0
- data/docs/EarningRuleProportionalOrderItemsAmountOrderItemsAmount.md +11 -0
- data/docs/EarningRuleProportionalOrderItemsQuantity.md +10 -0
- data/docs/EarningRuleProportionalOrderItemsQuantityOrderItems.md +8 -0
- data/docs/EarningRuleProportionalOrderItemsSubtotalAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderItemsSubtotalAmountOrderItems.md +8 -0
- data/docs/EarningRuleProportionalOrderMetadata.md +10 -0
- data/docs/EarningRuleProportionalOrderMetadataOrder.md +8 -0
- data/docs/EarningRuleProportionalOrderMetadataOrderMetadata.md +10 -0
- data/docs/EarningRuleProportionalOrderTotalAmount.md +10 -0
- data/docs/EarningRuleProportionalOrderTotalAmountOrder.md +8 -0
- data/docs/Error.md +14 -0
- data/docs/EventCustomerActiveCampaignFailed.md +10 -0
- data/docs/EventCustomerActiveCampaignRecovered.md +10 -0
- data/docs/EventCustomerActiveCampaignSent.md +10 -0
- data/docs/EventCustomerBatchFailed.md +10 -0
- data/docs/EventCustomerBatchRecovered.md +10 -0
- data/docs/EventCustomerBatchSent.md +10 -0
- data/docs/EventCustomerBrazeFailed.md +10 -0
- data/docs/EventCustomerBrazeRecovered.md +10 -0
- data/docs/EventCustomerBrazeSent.md +10 -0
- data/docs/EventCustomerConfirmed.md +9 -0
- data/docs/EventCustomerConfirmedUnconfirmedCustomer.md +8 -0
- data/docs/EventCustomerConsents.md +9 -0
- data/docs/EventCustomerConsentsGiven.md +9 -0
- data/docs/EventCustomerConsentsRevoked.md +9 -0
- data/docs/EventCustomerCreated.md +8 -0
- data/docs/EventCustomerCustomEvent.md +8 -0
- data/docs/EventCustomerDeleted.md +8 -0
- data/docs/EventCustomerEmailFailed.md +10 -0
- data/docs/EventCustomerEmailRecovered.md +10 -0
- data/docs/EventCustomerEmailSent.md +10 -0
- data/docs/EventCustomerFailed.md +10 -0
- data/docs/EventCustomerGiftVoucherBalanceAdded.md +12 -0
- data/docs/EventCustomerIntercomFailed.md +10 -0
- data/docs/EventCustomerIntercomRecovered.md +10 -0
- data/docs/EventCustomerIntercomSent.md +10 -0
- data/docs/EventCustomerKlaviyoFailed.md +10 -0
- data/docs/EventCustomerKlaviyoRecovered.md +10 -0
- data/docs/EventCustomerKlaviyoSent.md +10 -0
- data/docs/EventCustomerLoyaltyCardPointsAdded.md +12 -0
- data/docs/EventCustomerLoyaltyCardPointsTransferred.md +14 -0
- data/docs/EventCustomerLoyaltyTierBase.md +9 -0
- data/docs/EventCustomerLoyaltyTierDowngraded.md +12 -0
- data/docs/EventCustomerLoyaltyTierExpirationChanged.md +12 -0
- data/docs/EventCustomerLoyaltyTierJoined.md +11 -0
- data/docs/EventCustomerLoyaltyTierLeft.md +11 -0
- data/docs/EventCustomerLoyaltyTierProlonged.md +11 -0
- data/docs/EventCustomerLoyaltyTierUpgraded.md +12 -0
- data/docs/EventCustomerLoyaltyUpdated.md +11 -0
- data/docs/EventCustomerMailchimpFailed.md +10 -0
- data/docs/EventCustomerMailchimpRecovered.md +10 -0
- data/docs/EventCustomerMailchimpSent.md +10 -0
- data/docs/EventCustomerOrder.md +11 -0
- data/docs/EventCustomerOrderCanceled.md +11 -0
- data/docs/EventCustomerOrderCreated.md +11 -0
- data/docs/EventCustomerOrderFulfilled.md +11 -0
- data/docs/EventCustomerOrderPaid.md +11 -0
- data/docs/EventCustomerOrderProcessing.md +11 -0
- data/docs/EventCustomerOrderUpdated.md +11 -0
- data/docs/EventCustomerPublicationFailed.md +10 -0
- data/docs/EventCustomerPublicationSucceeded.md +10 -0
- data/docs/EventCustomerRecovered.md +10 -0
- data/docs/EventCustomerRedemption.md +14 -0
- data/docs/EventCustomerRedemptionFailed.md +14 -0
- data/docs/EventCustomerRedemptionRollbackFailed.md +15 -0
- data/docs/EventCustomerRedemptionRollbackSucceeded.md +15 -0
- data/docs/EventCustomerRedemptionSucceeded.md +14 -0
- data/docs/EventCustomerReferred.md +13 -0
- data/docs/EventCustomerRewardRedemptions.md +16 -0
- data/docs/EventCustomerRewardRedemptionsCompleted.md +16 -0
- data/docs/EventCustomerRewardRedemptionsCreated.md +16 -0
- data/docs/EventCustomerRewardRedemptionsPending.md +16 -0
- data/docs/EventCustomerRewardRedemptionsRolledBack.md +16 -0
- data/docs/EventCustomerRewarded.md +17 -0
- data/docs/EventCustomerRewardedLoyaltyPoints.md +16 -0
- data/docs/EventCustomerSegmentEntered.md +9 -0
- data/docs/EventCustomerSegmentLeft.md +9 -0
- data/docs/EventCustomerSent.md +10 -0
- data/docs/EventCustomerShopifyFailed.md +10 -0
- data/docs/EventCustomerShopifyRecovered.md +10 -0
- data/docs/EventCustomerShopifySent.md +10 -0
- data/docs/EventCustomerSmsFailed.md +10 -0
- data/docs/EventCustomerSmsRecovered.md +10 -0
- data/docs/EventCustomerSmsSent.md +10 -0
- data/docs/EventCustomerUpdated.md +8 -0
- data/docs/EventCustomerValidationFailed.md +9 -0
- data/docs/EventCustomerValidationSucceeded.md +9 -0
- data/docs/EventCustomerVoucherDeleted.md +10 -0
- data/docs/EventCustomerVouchersLoyaltyPointsExpired.md +13 -0
- data/docs/EventsApi.md +68 -0
- data/docs/EventsCreateRequestBody.md +12 -0
- data/docs/EventsCreateResponseBody.md +12 -0
- data/docs/Export.md +59 -0
- data/docs/ExportBase.md +14 -0
- data/docs/ExportBaseResult.md +8 -0
- data/docs/ExportCustomer.md +16 -0
- data/docs/ExportCustomerBase.md +9 -0
- data/docs/ExportCustomerBaseParameters.md +10 -0
- data/docs/ExportCustomerFields.md +7 -0
- data/docs/ExportCustomerFilters.md +38 -0
- data/docs/ExportCustomerOrder.md +7 -0
- data/docs/ExportCustomerScheduled.md +16 -0
- data/docs/ExportOrder.md +16 -0
- data/docs/ExportOrderBase.md +9 -0
- data/docs/ExportOrderFields.md +7 -0
- data/docs/ExportOrderFilters.md +21 -0
- data/docs/ExportOrderOrder.md +7 -0
- data/docs/ExportOrderScheduled.md +16 -0
- data/docs/ExportPointsExpiration.md +16 -0
- data/docs/ExportPointsExpirationBase.md +9 -0
- data/docs/ExportPointsExpirationBaseParameters.md +10 -0
- data/docs/ExportPointsExpirationFields.md +7 -0
- data/docs/ExportPointsExpirationFilters.md +10 -0
- data/docs/ExportPointsExpirationOrder.md +7 -0
- data/docs/ExportPointsExpirationScheduled.md +16 -0
- data/docs/ExportPublication.md +16 -0
- data/docs/ExportPublicationBase.md +9 -0
- data/docs/ExportPublicationBaseParameters.md +10 -0
- data/docs/ExportPublicationFields.md +7 -0
- data/docs/ExportPublicationFilters.md +16 -0
- data/docs/ExportPublicationOrder.md +7 -0
- data/docs/ExportPublicationScheduled.md +16 -0
- data/docs/ExportRedemption.md +16 -0
- data/docs/ExportRedemptionBase.md +9 -0
- data/docs/ExportRedemptionBaseParameters.md +10 -0
- data/docs/ExportRedemptionFields.md +7 -0
- data/docs/ExportRedemptionFilters.md +25 -0
- data/docs/ExportRedemptionOrder.md +7 -0
- data/docs/ExportRedemptionScheduled.md +16 -0
- data/docs/ExportScheduledBase.md +14 -0
- data/docs/ExportVoucher.md +16 -0
- data/docs/ExportVoucherBase.md +9 -0
- data/docs/ExportVoucherBaseParameters.md +10 -0
- data/docs/ExportVoucherFields.md +7 -0
- data/docs/ExportVoucherFilters.md +38 -0
- data/docs/ExportVoucherOrder.md +7 -0
- data/docs/ExportVoucherScheduled.md +16 -0
- data/docs/ExportVoucherTransactions.md +16 -0
- data/docs/ExportVoucherTransactionsBase.md +9 -0
- data/docs/ExportVoucherTransactionsFields.md +7 -0
- data/docs/ExportVoucherTransactionsFilters.md +11 -0
- data/docs/ExportVoucherTransactionsOrder.md +7 -0
- data/docs/ExportVoucherTransactionsScheduled.md +16 -0
- data/docs/ExportsApi.md +301 -0
- data/docs/ExportsCreateRequestBody.md +59 -0
- data/docs/ExportsCreateResponseBody.md +59 -0
- data/docs/ExportsGetResponseBody.md +16 -0
- data/docs/ExportsListResponseBody.md +11 -0
- data/docs/FieldConditions.md +8 -0
- data/docs/FilterConditionsString.md +15 -0
- data/docs/FiltersCondition.md +32 -0
- data/docs/Gift.md +10 -0
- data/docs/GiftCampaignVoucher.md +11 -0
- data/docs/GiveawayCampaignVoucher.md +12 -0
- data/docs/InapplicableTo.md +21 -0
- data/docs/InapplicableToResultList.md +11 -0
- data/docs/Junction.md +7 -0
- data/docs/ListPublicationsItemBase.md +17 -0
- data/docs/ListPublicationsItemInvalid.md +20 -0
- data/docs/ListPublicationsItemValidMultipleVouchers.md +19 -0
- data/docs/ListPublicationsItemValidSingleVoucher.md +19 -0
- data/docs/ListPublicationsItemVoucher.md +14 -0
- data/docs/LoyaltiesApi.md +1643 -0
- data/docs/LoyaltiesDeleteResponseBody.md +8 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBody.md +23 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBody.md +23 -0
- data/docs/LoyaltiesEarningRulesGetResponseBody.md +24 -0
- data/docs/LoyaltiesLoyaltyTierReward.md +10 -0
- data/docs/LoyaltiesMembersBalanceUpdateRequestBody.md +12 -0
- data/docs/LoyaltiesMembersBalanceUpdateResponseBody.md +14 -0
- data/docs/LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +16 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md +8 -0
- data/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +10 -0
- data/docs/LoyaltiesMembersRedemptionRedeemRequestBodyReward.md +9 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +30 -0
- data/docs/LoyaltiesMembersRewardsListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersRewardsListResponseBodyDataItem.md +10 -0
- data/docs/LoyaltiesMembersTiersListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersTransactionsExportCreateRequestBody.md +8 -0
- data/docs/LoyaltiesMembersTransactionsExportCreateRequestBodyParameters.md +10 -0
- data/docs/LoyaltiesMembersTransactionsExportCreateResponseBody.md +16 -0
- data/docs/LoyaltiesMembersTransactionsListResponseBody.md +11 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBody.md +30 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyAssets.md +9 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyAssetsBarcode.md +9 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyAssetsQr.md +9 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +11 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyPublish.md +11 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyRedemption.md +13 -0
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyValidityTimeframe.md +9 -0
- data/docs/LoyaltiesRewardAssignmentsGetResponseBody.md +15 -0
- data/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +18 -0
- data/docs/LoyaltiesRewardsGetResponseBody.md +15 -0
- data/docs/LoyaltiesTiersCreateInBulkRequestBodyItem.md +12 -0
- data/docs/LoyaltiesTiersEarningRulesListResponseBody.md +11 -0
- data/docs/LoyaltiesTiersGetResponseBody.md +19 -0
- data/docs/LoyaltiesTiersListResponseBody.md +11 -0
- data/docs/LoyaltiesTiersRewardsListResponseBody.md +11 -0
- data/docs/LoyaltiesTransferPoints.md +11 -0
- data/docs/LoyaltyCardTransaction.md +17 -0
- data/docs/LoyaltyCardTransactionsType.md +7 -0
- data/docs/LoyaltyTier.md +19 -0
- data/docs/LoyaltyTierAllOfConfig.md +8 -0
- data/docs/LoyaltyTierAllOfConfigPoints.md +9 -0
- data/docs/LoyaltyTierBase.md +11 -0
- data/docs/LoyaltyTierBasePoints.md +9 -0
- data/docs/LoyaltyTierExpiration.md +14 -0
- data/docs/LoyaltyTiersExpirationAll.md +11 -0
- data/docs/LoyaltyTiersExpirationAllExpirationDate.md +10 -0
- data/docs/LoyaltyTiersExpirationAllExpirationDateRounding.md +11 -0
- data/docs/LoyaltyTiersExpirationAllStartDate.md +8 -0
- data/docs/LuckyDraw.md +10 -0
- data/docs/MappingFixed.md +9 -0
- data/docs/MappingMultiply.md +9 -0
- data/docs/MappingPoints.md +49 -0
- data/docs/Order.md +19 -0
- data/docs/OrderBase.md +17 -0
- data/docs/OrderCalculated.md +29 -0
- data/docs/OrderCalculatedBase.md +27 -0
- data/docs/OrderCalculatedCustomer.md +49 -0
- data/docs/OrderCalculatedNoCustomerData.md +29 -0
- data/docs/OrderCalculatedReferrer.md +49 -0
- data/docs/OrderItem.md +21 -0
- data/docs/OrderItemCalculated.md +25 -0
- data/docs/OrderItemProduct.md +13 -0
- data/docs/OrderItemSku.md +12 -0
- data/docs/OrderRedemptions.md +15 -0
- data/docs/OrdersApi.md +377 -0
- data/docs/OrdersCreateRequestBody.md +19 -0
- data/docs/OrdersCreateResponseBody.md +29 -0
- data/docs/OrdersExportCreateRequestBody.md +8 -0
- data/docs/OrdersExportCreateRequestBodyParameters.md +10 -0
- data/docs/OrdersExportCreateResponseBody.md +16 -0
- data/docs/OrdersGetResponseBody.md +29 -0
- data/docs/OrdersImportCreateRequestBodyItem.md +18 -0
- data/docs/OrdersImportCreateResponseBody.md +8 -0
- data/docs/OrdersListResponseBody.md +11 -0
- data/docs/OrdersUpdateRequestBody.md +17 -0
- data/docs/OrdersUpdateResponseBody.md +29 -0
- data/docs/ParameterCampaignType.md +7 -0
- data/docs/ParameterCreatedBeforeAfter.md +9 -0
- data/docs/ParameterExpandListCampaigns.md +7 -0
- data/docs/ParameterFiltersListRedemptions.md +17 -0
- data/docs/ParameterFiltersListRedemptionsCampaignName.md +9 -0
- data/docs/ParameterFiltersListRedemptionsCustomerId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsFailureCode.md +9 -0
- data/docs/ParameterFiltersListRedemptionsObject.md +9 -0
- data/docs/ParameterFiltersListRedemptionsParentRedemptionId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsRelatedObjectId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsRelatedObjectParentId.md +9 -0
- data/docs/ParameterFiltersListRedemptionsResult.md +9 -0
- data/docs/ParameterFiltersListRedemptionsUserLogin.md +9 -0
- data/docs/ParameterFiltersListRedemptionsVoucherCode.md +9 -0
- data/docs/ParameterOrder.md +7 -0
- data/docs/ParameterOrderListAllPromotionStacks.md +7 -0
- data/docs/ParameterOrderListCampaigns.md +7 -0
- data/docs/ParameterOrderListCustomers.md +7 -0
- data/docs/ParameterOrderListExports.md +7 -0
- data/docs/ParameterOrderListLoyaltyTiers.md +7 -0
- data/docs/ParameterOrderListOrders.md +7 -0
- data/docs/ParameterOrderListPublications.md +7 -0
- data/docs/ParameterOrderListRedemptions.md +7 -0
- data/docs/ParameterOrderListValidationRuleAssignments.md +7 -0
- data/docs/ParameterOrderListValidationRules.md +7 -0
- data/docs/ParameterResultListPublications.md +7 -0
- data/docs/ParameterUpdatedBeforeAfter.md +9 -0
- data/docs/ParameterVoucherTypeListPublications.md +7 -0
- data/docs/PointsExpirationTypes.md +7 -0
- data/docs/Product.md +18 -0
- data/docs/ProductCollectionsApi.md +319 -0
- data/docs/ProductCollectionsCreateDynamicRequestBody.md +10 -0
- data/docs/ProductCollectionsCreateDynamicRequestBodyFilter.md +20 -0
- data/docs/ProductCollectionsCreateDynamicRequestBodyProductsItem.md +10 -0
- data/docs/ProductCollectionsCreateRequestBody.md +49 -0
- data/docs/ProductCollectionsCreateResponseBody.md +14 -0
- data/docs/ProductCollectionsCreateStaticRequestBody.md +10 -0
- data/docs/ProductCollectionsGetResponseBody.md +14 -0
- data/docs/ProductCollectionsItem.md +14 -0
- data/docs/ProductCollectionsItemProductsItem.md +10 -0
- data/docs/ProductCollectionsList.md +11 -0
- data/docs/ProductCollectionsListResponseBody.md +11 -0
- data/docs/ProductCollectionsProductsList.md +11 -0
- data/docs/ProductCollectionsProductsListProductsItem.md +49 -0
- data/docs/ProductCollectionsProductsListResponseBody.md +11 -0
- data/docs/ProductWithoutSkus.md +17 -0
- data/docs/ProductsApi.md +883 -0
- data/docs/ProductsCreateRequestBody.md +14 -0
- data/docs/ProductsCreateResponseBody.md +18 -0
- data/docs/ProductsGetResponseBody.md +18 -0
- data/docs/ProductsImportCsvCreateResponseBody.md +8 -0
- data/docs/ProductsListResponseBody.md +11 -0
- data/docs/ProductsMetadataUpdateInBulkRequestBody.md +9 -0
- data/docs/ProductsMetadataUpdateInBulkResponseBody.md +8 -0
- data/docs/ProductsSkusCreateRequestBody.md +15 -0
- data/docs/ProductsSkusCreateResponseBody.md +19 -0
- data/docs/ProductsSkusListResponseBody.md +11 -0
- data/docs/ProductsSkusUpdateRequestBody.md +13 -0
- data/docs/ProductsSkusUpdateResponseBody.md +19 -0
- data/docs/ProductsUpdateInBulkRequestBody.md +13 -0
- data/docs/ProductsUpdateInBulkResponseBody.md +8 -0
- data/docs/ProductsUpdateRequestBody.md +12 -0
- data/docs/ProductsUpdateResponseBody.md +18 -0
- data/docs/PromotionStack.md +16 -0
- data/docs/PromotionStackBase.md +9 -0
- data/docs/PromotionStackBaseTiers.md +9 -0
- data/docs/PromotionTier.md +28 -0
- data/docs/PromotionTierAction.md +8 -0
- data/docs/PromotionTierCampaign.md +15 -0
- data/docs/PromotionTierCampaignValidityTimeframe.md +9 -0
- data/docs/PromotionTierCreateParams.md +20 -0
- data/docs/PromotionTierSummary.md +9 -0
- data/docs/PromotionTierSummaryOrders.md +9 -0
- data/docs/PromotionTierSummaryRedemptions.md +8 -0
- data/docs/PromotionTierValidityTimeframe.md +9 -0
- data/docs/PromotionTiersList.md +12 -0
- data/docs/PromotionsApi.md +678 -0
- data/docs/PromotionsStacksCreateRequestBody.md +10 -0
- data/docs/PromotionsStacksCreateResponseBody.md +15 -0
- data/docs/PromotionsStacksGetResponseBody.md +16 -0
- data/docs/PromotionsStacksListResponseBody.md +11 -0
- data/docs/PromotionsStacksUpdateRequestBody.md +10 -0
- data/docs/PromotionsStacksUpdateRequestBodyTiers.md +9 -0
- data/docs/PromotionsStacksUpdateResponseBody.md +16 -0
- data/docs/PromotionsTiersDisableResponseBody.md +28 -0
- data/docs/PromotionsTiersEnableResponseBody.md +28 -0
- data/docs/PromotionsTiersGetResponseBody.md +28 -0
- data/docs/PromotionsTiersListResponseBody.md +12 -0
- data/docs/PropertiesForLoyaltyCampaignOptions.md +8 -0
- data/docs/PublicationsApi.md +222 -0
- data/docs/PublicationsCreateBaseResponseBody.md +18 -0
- data/docs/PublicationsCreateRequestBody.md +49 -0
- data/docs/PublicationsCreateResponseBody.md +49 -0
- data/docs/PublicationsCreateVoucherResponseBody.md +19 -0
- data/docs/PublicationsCreateVouchersResponseBody.md +19 -0
- data/docs/PublicationsListResponseBody.md +11 -0
- data/docs/PublicationsListResponseBodyPublicationsItem.md +51 -0
- data/docs/QualificationsApi.md +68 -0
- data/docs/QualificationsCheckEligibilityRequestBody.md +14 -0
- data/docs/QualificationsCheckEligibilityResponseBody.md +11 -0
- data/docs/QualificationsFieldConditions.md +8 -0
- data/docs/QualificationsFiltersCondition.md +13 -0
- data/docs/QualificationsOption.md +12 -0
- data/docs/QualificationsOptionFilters.md +14 -0
- data/docs/QualificationsOptionFiltersResourceType.md +8 -0
- data/docs/QualificationsOptionFiltersResourceTypeConditions.md +11 -0
- data/docs/QualificationsRedeemable.md +23 -0
- data/docs/QualificationsRedeemableBase.md +22 -0
- data/docs/QualificationsRedeemables.md +13 -0
- data/docs/QualificationsStackingRules.md +12 -0
- data/docs/RedeemGiftCard.md +10 -0
- data/docs/RedeemGiftCardAllOfGift.md +8 -0
- data/docs/RedeemLoyaltyCard.md +10 -0
- data/docs/RedeemLoyaltyCardAllOfReward.md +9 -0
- data/docs/RedeemPromotionStack.md +9 -0
- data/docs/RedeemPromotionTier.md +9 -0
- data/docs/RedeemVoucher.md +9 -0
- data/docs/RedeemableGift.md +9 -0
- data/docs/RedeemableLoyaltyCard.md +12 -0
- data/docs/RedeemableResult.md +11 -0
- data/docs/RedeemableResultGiftCard.md +8 -0
- data/docs/RedeemableResultGiftCardGift.md +8 -0
- data/docs/RedeemableResultLoyaltyCard.md +8 -0
- data/docs/RedeemableResultLoyaltyCardLoyaltyCard.md +8 -0
- data/docs/RedeemableResultPromotionStack.md +8 -0
- data/docs/RedeemableResultPromotionTier.md +8 -0
- data/docs/RedeemableResultPromotionTierDiscount.md +55 -0
- data/docs/RedeemableResultVoucherCode.md +8 -0
- data/docs/Redemption.md +30 -0
- data/docs/RedemptionChannel.md +9 -0
- data/docs/RedemptionGift.md +8 -0
- data/docs/RedemptionInternal.md +34 -0
- data/docs/RedemptionInternalRelatedRedemptions.md +9 -0
- data/docs/RedemptionInternalRelatedRedemptionsItem.md +9 -0
- data/docs/RedemptionInternalRelatedRedemptionsRollbacksItem.md +9 -0
- data/docs/RedemptionLoyaltyCard.md +8 -0
- data/docs/RedemptionRelatedRedemptions.md +9 -0
- data/docs/RedemptionRelatedRedemptionsItem.md +9 -0
- data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +9 -0
- data/docs/RedemptionRewardResult.md +20 -0
- data/docs/RedemptionRewardResultParameters.md +10 -0
- data/docs/RedemptionRewardResultParametersCampaign.md +10 -0
- data/docs/RedemptionRewardResultParametersCoin.md +9 -0
- data/docs/RedemptionRewardResultParametersProduct.md +9 -0
- data/docs/RedemptionRewardResultProduct.md +18 -0
- data/docs/RedemptionRewardResultSku.md +19 -0
- data/docs/RedemptionRewardResultVoucher.md +37 -0
- data/docs/RedemptionRollback.md +31 -0
- data/docs/RedemptionRollbackRelatedRedemptions.md +9 -0
- data/docs/RedemptionRollbackRelatedRedemptionsItem.md +9 -0
- data/docs/RedemptionRollbackRelatedRedemptionsRollbacksItem.md +9 -0
- data/docs/RedemptionsApi.md +395 -0
- data/docs/RedemptionsGetResponseBody.md +49 -0
- data/docs/RedemptionsListResponseBody.md +11 -0
- data/docs/RedemptionsListResponseBodyRedemptionsItem.md +49 -0
- data/docs/RedemptionsRedeemRequestBody.md +14 -0
- data/docs/RedemptionsRedeemResponseBody.md +12 -0
- data/docs/RedemptionsRollbackCreateRequestBody.md +12 -0
- data/docs/RedemptionsRollbackCreateResponseBody.md +31 -0
- data/docs/RedemptionsRollbacksCreateRequestBody.md +12 -0
- data/docs/RedemptionsRollbacksCreateResponseBody.md +10 -0
- data/docs/ReferralCampaignVoucher.md +12 -0
- data/docs/ReferralProgram.md +10 -0
- data/docs/ReferralProgramCustomEvent.md +9 -0
- data/docs/ReferralProgramRefereeReward.md +10 -0
- data/docs/ReferralProgramRefereeRewardRelatedObjectParent.md +10 -0
- data/docs/Referrer.md +17 -0
- data/docs/ReferrerId.md +9 -0
- data/docs/ReferrerWithSummaryLoyaltyReferrals.md +25 -0
- data/docs/ResourceTypes.md +7 -0
- data/docs/Reward.md +18 -0
- data/docs/RewardAssignment.md +15 -0
- data/docs/RewardAssignmentBase.md +14 -0
- data/docs/RewardAssignmentParameters.md +8 -0
- data/docs/RewardAssignmentParametersParameters.md +8 -0
- data/docs/RewardAssignmentParametersParametersLoyalty.md +8 -0
- data/docs/RewardAssignmentsCreateCoinRewardRequestBody.md +9 -0
- data/docs/RewardAssignmentsCreateDigitalOrMaterialRewardRequestBody.md +9 -0
- data/docs/RewardAssignmentsCreateDigitalOrMaterialRewardRequestBodyParameters.md +8 -0
- data/docs/RewardAssignmentsCreateDigitalOrMaterialRewardRequestBodyParametersLoyalty.md +8 -0
- data/docs/RewardAttributes.md +9 -0
- data/docs/RewardType.md +51 -0
- data/docs/RewardTypeCampaign.md +8 -0
- data/docs/RewardTypeCampaignCampaign.md +10 -0
- data/docs/RewardTypeCoin.md +8 -0
- data/docs/RewardTypeCoinCoin.md +9 -0
- data/docs/RewardTypeMaterial.md +8 -0
- data/docs/RewardTypeMaterialProduct.md +9 -0
- data/docs/RewardsApi.md +379 -0
- data/docs/RewardsAssignmentsCreateRequestBody.md +49 -0
- data/docs/RewardsAssignmentsCreateResponseBody.md +15 -0
- data/docs/RewardsAssignmentsGetResponseBody.md +15 -0
- data/docs/RewardsAssignmentsListResponseBody.md +11 -0
- data/docs/RewardsAssignmentsUpdateRequestBody.md +8 -0
- data/docs/RewardsAssignmentsUpdateRequestBodyParameters.md +8 -0
- data/docs/RewardsAssignmentsUpdateRequestBodyParametersLoyalty.md +8 -0
- data/docs/RewardsAssignmentsUpdateResponseBody.md +15 -0
- data/docs/SchemaThatContainsUniquePropertiesForPromotionCampaignPromotion.md +8 -0
- data/docs/SegmentsApi.md +65 -0
- data/docs/Session.md +11 -0
- data/docs/SimpleCampaign.md +20 -0
- data/docs/SimpleConsent.md +10 -0
- data/docs/SimpleCustomer.md +13 -0
- data/docs/SimpleCustomerRequiredObjectType.md +13 -0
- data/docs/SimpleOrder.md +23 -0
- data/docs/SimpleOrderItem.md +18 -0
- data/docs/SimpleProduct.md +10 -0
- data/docs/SimpleProductDiscountUnit.md +10 -0
- data/docs/SimplePromotionTier.md +11 -0
- data/docs/SimplePromotionTierCampaign.md +8 -0
- data/docs/SimpleRedemption.md +20 -0
- data/docs/SimpleRedemptionRewardResult.md +20 -0
- data/docs/SimpleReferralTier.md +11 -0
- data/docs/SimpleSegment.md +10 -0
- data/docs/SimpleSku.md +10 -0
- data/docs/SimpleSkuDiscountUnit.md +10 -0
- data/docs/SimpleVoucher.md +20 -0
- data/docs/Sku.md +19 -0
- data/docs/SkuWithProduct.md +20 -0
- data/docs/SkusGetResponseBody.md +19 -0
- data/docs/SkusImportCsvCreateResponseBody.md +8 -0
- data/docs/SkusList.md +11 -0
- data/docs/SkusListForProduct.md +11 -0
- data/docs/StackableDiscountsApi.md +412 -0
- data/docs/StackableValidateRedeemBase.md +13 -0
- data/docs/StackableValidateRedeemBaseRedeemablesItem.md +55 -0
- data/docs/StackingRules.md +15 -0
- data/docs/ValidationEntity.md +15 -0
- data/docs/ValidationRule.md +18 -0
- data/docs/ValidationRuleAssignment.md +13 -0
- data/docs/ValidationRuleAssignmentsList.md +11 -0
- data/docs/ValidationRuleBase.md +13 -0
- data/docs/ValidationRuleBaseApplicableTo.md +10 -0
- data/docs/ValidationRuleBaseError.md +8 -0
- data/docs/ValidationRulesApi.md +513 -0
- data/docs/ValidationRulesAssignmentsList.md +11 -0
- data/docs/ValidationRulesAssignmentsListResponseBody.md +11 -0
- data/docs/ValidationRulesCreateRequestBody.md +13 -0
- data/docs/ValidationRulesCreateResponseBody.md +18 -0
- data/docs/ValidationRulesGetResponseBody.md +18 -0
- data/docs/ValidationRulesListResponseBody.md +11 -0
- data/docs/ValidationRulesUpdateRequestBody.md +13 -0
- data/docs/ValidationRulesUpdateResponseBody.md +18 -0
- data/docs/ValidationsApi.md +68 -0
- data/docs/ValidationsRedeemableApplicable.md +16 -0
- data/docs/ValidationsRedeemableApplicableResult.md +55 -0
- data/docs/ValidationsRedeemableInapplicable.md +11 -0
- data/docs/ValidationsRedeemableInapplicableResult.md +8 -0
- data/docs/ValidationsRedeemableSkipped.md +11 -0
- data/docs/ValidationsValidateAllResponseBody.md +13 -0
- data/docs/ValidationsValidateAllResponseBodyRedeemablesItem.md +51 -0
- data/docs/ValidationsValidatePartialResponseBody.md +14 -0
- data/docs/ValidationsValidateRequestBody.md +14 -0
- data/docs/ValidationsValidateResponseBody.md +14 -0
- data/docs/Voucher.md +37 -0
- data/docs/VoucherAssets.md +9 -0
- data/docs/VoucherGift.md +10 -0
- data/docs/VoucherLoyaltyCard.md +11 -0
- data/docs/VoucherPublish.md +10 -0
- data/docs/VoucherRedemption.md +13 -0
- data/docs/VoucherTransaction.md +17 -0
- data/docs/VoucherTransactionDetails.md +20 -0
- data/docs/VoucherTransactionDetailsBalance.md +13 -0
- data/docs/VoucherTransactionDetailsBalanceRelatedObject.md +9 -0
- data/docs/VoucherTransactionDetailsCustomEvent.md +9 -0
- data/docs/VoucherTransactionDetailsEarningRule.md +9 -0
- data/docs/VoucherTransactionDetailsEarningRuleSource.md +8 -0
- data/docs/VoucherTransactionDetailsEvent.md +9 -0
- data/docs/VoucherTransactionDetailsEventSchema.md +9 -0
- data/docs/VoucherTransactionDetailsLoyaltyTier.md +9 -0
- data/docs/VoucherTransactionDetailsOrder.md +9 -0
- data/docs/VoucherTransactionDetailsRedemption.md +8 -0
- data/docs/VoucherTransactionDetailsReward.md +9 -0
- data/docs/VoucherTransactionDetailsRollback.md +8 -0
- data/docs/VoucherTransactionDetailsSegment.md +9 -0
- data/docs/VoucherTransactionsExport.md +16 -0
- data/docs/VoucherTransactionsExportFilterConditions.md +8 -0
- data/docs/VoucherTransactionsExportFilterConditionsVoucherId.md +8 -0
- data/docs/VoucherTransactionsExportFilterConditionsVoucherIdConditions.md +8 -0
- data/docs/VoucherTransactionsExportParameters.md +9 -0
- data/docs/VoucherTransactionsExportResult.md +8 -0
- data/docs/VoucherTransactionsFilters.md +10 -0
- data/docs/VoucherValidityTimeframe.md +9 -0
- data/docs/VouchersApi.md +554 -0
- data/docs/VouchersBalanceUpdateRequestBody.md +10 -0
- data/docs/VouchersBalanceUpdateResponseBody.md +14 -0
- data/docs/VouchersBalanceUpdateResponseBodyRelatedObject.md +9 -0
- data/docs/VouchersDisableResponseBody.md +37 -0
- data/docs/VouchersEnableResponseBody.md +37 -0
- data/docs/VouchersGetResponseBody.md +37 -0
- data/docs/VouchersImportCsvCreateResponseBody.md +8 -0
- data/docs/VouchersRedemptionGetResponseBody.md +14 -0
- data/docs/VouchersRedemptionGetResponseBodyRedemptionEntriesItem.md +49 -0
- data/docs/VouchersTransactionsExportCreateRequestBody.md +8 -0
- data/docs/VouchersTransactionsExportCreateResponseBody.md +16 -0
- data/docs/VouchersTransactionsListResponseBody.md +11 -0
- data/example.rb +25 -0
- data/lib/VoucherifySdk/api/campaigns_api.rb +789 -0
- data/lib/VoucherifySdk/api/categories_api.rb +337 -0
- data/lib/VoucherifySdk/api/client_side_api.rb +367 -0
- data/lib/VoucherifySdk/api/customers_api.rb +874 -0
- data/lib/VoucherifySdk/api/events_api.rb +86 -0
- data/lib/VoucherifySdk/api/exports_api.rb +354 -0
- data/lib/VoucherifySdk/api/loyalties_api.rb +1906 -0
- data/lib/VoucherifySdk/api/orders_api.rb +425 -0
- data/lib/VoucherifySdk/api/product_collections_api.rb +375 -0
- data/lib/VoucherifySdk/api/products_api.rb +1002 -0
- data/lib/VoucherifySdk/api/promotions_api.rb +764 -0
- data/lib/VoucherifySdk/api/publications_api.rb +270 -0
- data/lib/VoucherifySdk/api/qualifications_api.rb +86 -0
- data/lib/VoucherifySdk/api/redemptions_api.rb +457 -0
- data/lib/VoucherifySdk/api/rewards_api.rb +446 -0
- data/lib/VoucherifySdk/api/segments_api.rb +83 -0
- data/lib/VoucherifySdk/api/validation_rules_api.rb +599 -0
- data/lib/VoucherifySdk/api/validations_api.rb +86 -0
- data/lib/VoucherifySdk/api/vouchers_api.rb +636 -0
- data/lib/VoucherifySdk/api_client.rb +392 -0
- data/lib/VoucherifySdk/api_error.rb +58 -0
- data/lib/VoucherifySdk/configuration.rb +332 -0
- data/lib/VoucherifySdk/models/any.rb +107 -0
- data/lib/VoucherifySdk/models/applicable_to.rb +406 -0
- data/lib/VoucherifySdk/models/applicable_to_effect.rb +41 -0
- data/lib/VoucherifySdk/models/applicable_to_result_list.rb +340 -0
- data/lib/VoucherifySdk/models/array_inner.rb +106 -0
- data/lib/VoucherifySdk/models/async_actions.rb +223 -0
- data/lib/VoucherifySdk/models/bus_val_rule_assignment.rb +379 -0
- data/lib/VoucherifySdk/models/campaign.rb +674 -0
- data/lib/VoucherifySdk/models/campaign_base.rb +650 -0
- data/lib/VoucherifySdk/models/campaign_base_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_card.rb +232 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +273 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_voucher.rb +291 -0
- data/lib/VoucherifySdk/models/campaign_loyalty_voucher_redemption.rb +217 -0
- data/lib/VoucherifySdk/models/campaign_voucher.rb +328 -0
- data/lib/VoucherifySdk/models/campaign_voucher_redemption.rb +219 -0
- data/lib/VoucherifySdk/models/campaigns_create_base.rb +422 -0
- data/lib/VoucherifySdk/models/campaigns_create_discount_coupons_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_gift_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_giveaway_campaign.rb +470 -0
- data/lib/VoucherifySdk/models/campaigns_create_loyalty_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_promotion_campaign.rb +461 -0
- data/lib/VoucherifySdk/models/campaigns_create_referral_campaign.rb +470 -0
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +110 -0
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +675 -0
- data/lib/VoucherifySdk/models/campaigns_delete_response_body.rb +216 -0
- data/lib/VoucherifySdk/models/campaigns_disable_response_body.rb +206 -0
- data/lib/VoucherifySdk/models/campaigns_enable_response_body.rb +206 -0
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +675 -0
- data/lib/VoucherifySdk/models/campaigns_import_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/campaigns_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/campaigns_import_voucher_item.rb +374 -0
- data/lib/VoucherifySdk/models/campaigns_import_voucher_item_redemption.rb +216 -0
- data/lib/VoucherifySdk/models/campaigns_import_voucher_loyalty_card.rb +223 -0
- data/lib/VoucherifySdk/models/campaigns_list_response_body.rb +252 -0
- data/lib/VoucherifySdk/models/campaigns_update_base.rb +300 -0
- data/lib/VoucherifySdk/models/campaigns_update_coupon_campaign_base.rb +381 -0
- data/lib/VoucherifySdk/models/campaigns_update_discount_coupons_campaign.rb +389 -0
- data/lib/VoucherifySdk/models/campaigns_update_gift_campaign.rb +389 -0
- data/lib/VoucherifySdk/models/campaigns_update_giveaway_campaign.rb +420 -0
- data/lib/VoucherifySdk/models/campaigns_update_loyalty_campaign.rb +398 -0
- data/lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb +306 -0
- data/lib/VoucherifySdk/models/campaigns_update_referral_campaign.rb +398 -0
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +110 -0
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +675 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_base_request_body.rb +264 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_in_bulk_request_body.rb +291 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb +272 -0
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/categories_create_request_body.rb +240 -0
- data/lib/VoucherifySdk/models/categories_create_response_body.rb +324 -0
- data/lib/VoucherifySdk/models/categories_get_response_body.rb +364 -0
- data/lib/VoucherifySdk/models/categories_list_response_body.rb +321 -0
- data/lib/VoucherifySdk/models/categories_update_request_body.rb +240 -0
- data/lib/VoucherifySdk/models/categories_update_response_body.rb +341 -0
- data/lib/VoucherifySdk/models/category.rb +357 -0
- data/lib/VoucherifySdk/models/client_events_create_request_body.rb +295 -0
- data/lib/VoucherifySdk/models/client_events_create_request_body_loyalty.rb +223 -0
- data/lib/VoucherifySdk/models/client_events_create_request_body_referral.rb +233 -0
- data/lib/VoucherifySdk/models/client_events_create_response_body.rb +316 -0
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb +319 -0
- data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_response_body.rb +243 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_all_of_options.rb +240 -0
- data/lib/VoucherifySdk/models/client_redemptions_redeem_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/client_validations_validate_request_body_all_of_options.rb +240 -0
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +301 -0
- data/lib/VoucherifySdk/models/code_config.rb +266 -0
- data/lib/VoucherifySdk/models/code_config_required_length_charset_pattern.rb +293 -0
- data/lib/VoucherifySdk/models/create_publication_base.rb +242 -0
- data/lib/VoucherifySdk/models/create_publication_campaign.rb +261 -0
- data/lib/VoucherifySdk/models/create_publication_with_campaign.rb +265 -0
- data/lib/VoucherifySdk/models/create_publication_with_specific_voucher.rb +266 -0
- data/lib/VoucherifySdk/models/custom_event.rb +351 -0
- data/lib/VoucherifySdk/models/custom_event_referral.rb +236 -0
- data/lib/VoucherifySdk/models/customer.rb +312 -0
- data/lib/VoucherifySdk/models/customer_activity.rb +282 -0
- data/lib/VoucherifySdk/models/customer_activity_data.rb +173 -0
- data/lib/VoucherifySdk/models/customer_base.rb +285 -0
- data/lib/VoucherifySdk/models/customer_base_address.rb +266 -0
- data/lib/VoucherifySdk/models/customer_id.rb +273 -0
- data/lib/VoucherifySdk/models/customer_loyalty.rb +258 -0
- data/lib/VoucherifySdk/models/customer_loyalty_campaigns_value.rb +236 -0
- data/lib/VoucherifySdk/models/customer_referrals.rb +242 -0
- data/lib/VoucherifySdk/models/customer_referrals_campaigns_item.rb +291 -0
- data/lib/VoucherifySdk/models/customer_response_data_assets.rb +216 -0
- data/lib/VoucherifySdk/models/customer_segments_list.rb +276 -0
- data/lib/VoucherifySdk/models/customer_summary.rb +237 -0
- data/lib/VoucherifySdk/models/customer_summary_orders.rb +283 -0
- data/lib/VoucherifySdk/models/customer_summary_redemptions.rb +339 -0
- data/lib/VoucherifySdk/models/customer_summary_redemptions_gift.rb +240 -0
- data/lib/VoucherifySdk/models/customer_summary_redemptions_loyalty_card.rb +240 -0
- data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals.rb +438 -0
- data/lib/VoucherifySdk/models/customers_activities_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/customers_create_request_body.rb +313 -0
- data/lib/VoucherifySdk/models/customers_create_response_body.rb +439 -0
- data/lib/VoucherifySdk/models/customers_get_response_body.rb +439 -0
- data/lib/VoucherifySdk/models/customers_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/customers_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/customers_metadata_update_in_bulk_request_body.rb +242 -0
- data/lib/VoucherifySdk/models/customers_metadata_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/customers_permanent_deletion_create_response_body.rb +324 -0
- data/lib/VoucherifySdk/models/customers_permanent_deletion_create_response_body_data_json.rb +325 -0
- data/lib/VoucherifySdk/models/customers_segments_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/customers_update_in_bulk_request_body.rb +310 -0
- data/lib/VoucherifySdk/models/customers_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/customers_update_request_body.rb +293 -0
- data/lib/VoucherifySdk/models/customers_update_response_body.rb +439 -0
- data/lib/VoucherifySdk/models/discount.rb +109 -0
- data/lib/VoucherifySdk/models/discount_amount.rb +311 -0
- data/lib/VoucherifySdk/models/discount_amount_vouchers_effect_types.rb +43 -0
- data/lib/VoucherifySdk/models/discount_coupons_campaign_voucher.rb +290 -0
- data/lib/VoucherifySdk/models/discount_fixed.rb +301 -0
- data/lib/VoucherifySdk/models/discount_fixed_vouchers_effect_types.rb +40 -0
- data/lib/VoucherifySdk/models/discount_percent.rb +321 -0
- data/lib/VoucherifySdk/models/discount_percent_vouchers_effect_types.rb +40 -0
- data/lib/VoucherifySdk/models/discount_unit.rb +329 -0
- data/lib/VoucherifySdk/models/discount_unit_multiple.rb +298 -0
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +310 -0
- data/lib/VoucherifySdk/models/discount_unit_vouchers_effect_types.rb +41 -0
- data/lib/VoucherifySdk/models/earning_rule.rb +474 -0
- data/lib/VoucherifySdk/models/earning_rule_base.rb +424 -0
- data/lib/VoucherifySdk/models/earning_rule_base_custom_event.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_base_loyalty.rb +105 -0
- data/lib/VoucherifySdk/models/earning_rule_base_segment.rb +223 -0
- data/lib/VoucherifySdk/models/earning_rule_base_source.rb +284 -0
- data/lib/VoucherifySdk/models/earning_rule_base_validity_timeframe.rb +240 -0
- data/lib/VoucherifySdk/models/earning_rule_event.rb +46 -0
- data/lib/VoucherifySdk/models/earning_rule_fixed.rb +261 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional.rb +107 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_custom_event.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_custom_event_custom_event.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_custom_event_custom_event_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_customer_metadata.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_customer_metadata_customer.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_customer_metadata_customer_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order.rb +106 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_amount_order.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_amount_order_amount.rb +240 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items.rb +106 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_amount_order_items.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_amount_order_items_amount.rb +308 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_quantity.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_quantity_order_items.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_subtotal_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_items_subtotal_amount_order_items.rb +221 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_metadata.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_metadata_order.rb +222 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_metadata_order_metadata.rb +257 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_total_amount.rb +301 -0
- data/lib/VoucherifySdk/models/earning_rule_proportional_order_total_amount_order.rb +221 -0
- data/lib/VoucherifySdk/models/error.rb +311 -0
- data/lib/VoucherifySdk/models/event_customer_active_campaign_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_active_campaign_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_active_campaign_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_batch_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_batch_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_batch_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_braze_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_braze_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_braze_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_confirmed.rb +224 -0
- data/lib/VoucherifySdk/models/event_customer_confirmed_unconfirmed_customer.rb +214 -0
- data/lib/VoucherifySdk/models/event_customer_consents.rb +225 -0
- data/lib/VoucherifySdk/models/event_customer_consents_given.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_consents_revoked.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_created.rb +215 -0
- data/lib/VoucherifySdk/models/event_customer_custom_event.rb +222 -0
- data/lib/VoucherifySdk/models/event_customer_deleted.rb +215 -0
- data/lib/VoucherifySdk/models/event_customer_email_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_email_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_email_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_failed.rb +240 -0
- data/lib/VoucherifySdk/models/event_customer_gift_voucher_balance_added.rb +251 -0
- data/lib/VoucherifySdk/models/event_customer_intercom_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_intercom_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_intercom_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_klaviyo_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_klaviyo_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_klaviyo_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_card_points_added.rb +251 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_card_points_transferred.rb +269 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_base.rb +223 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_downgraded.rb +279 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_expiration_changed.rb +279 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_joined.rb +263 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_left.rb +263 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_prolonged.rb +263 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_tier_upgraded.rb +272 -0
- data/lib/VoucherifySdk/models/event_customer_loyalty_updated.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_mailchimp_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_mailchimp_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_mailchimp_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_order.rb +241 -0
- data/lib/VoucherifySdk/models/event_customer_order_canceled.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_created.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_fulfilled.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_paid.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_processing.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_order_updated.rb +249 -0
- data/lib/VoucherifySdk/models/event_customer_publication_failed.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_publication_succeeded.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_recovered.rb +240 -0
- data/lib/VoucherifySdk/models/event_customer_redemption.rb +268 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_failed.rb +276 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_rollback_failed.rb +285 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_rollback_succeeded.rb +285 -0
- data/lib/VoucherifySdk/models/event_customer_redemption_succeeded.rb +276 -0
- data/lib/VoucherifySdk/models/event_customer_referred.rb +288 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions.rb +286 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_completed.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_created.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_pending.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_reward_redemptions_rolled_back.rb +294 -0
- data/lib/VoucherifySdk/models/event_customer_rewarded.rb +296 -0
- data/lib/VoucherifySdk/models/event_customer_rewarded_loyalty_points.rb +287 -0
- data/lib/VoucherifySdk/models/event_customer_segment_entered.rb +238 -0
- data/lib/VoucherifySdk/models/event_customer_segment_left.rb +238 -0
- data/lib/VoucherifySdk/models/event_customer_sent.rb +240 -0
- data/lib/VoucherifySdk/models/event_customer_shopify_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_shopify_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_shopify_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_sms_failed.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_sms_recovered.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_sms_sent.rb +248 -0
- data/lib/VoucherifySdk/models/event_customer_updated.rb +215 -0
- data/lib/VoucherifySdk/models/event_customer_validation_failed.rb +224 -0
- data/lib/VoucherifySdk/models/event_customer_validation_succeeded.rb +224 -0
- data/lib/VoucherifySdk/models/event_customer_voucher_deleted.rb +233 -0
- data/lib/VoucherifySdk/models/event_customer_vouchers_loyalty_points_expired.rb +262 -0
- data/lib/VoucherifySdk/models/events_create_request_body.rb +295 -0
- data/lib/VoucherifySdk/models/events_create_response_body.rb +316 -0
- data/lib/VoucherifySdk/models/export.rb +110 -0
- data/lib/VoucherifySdk/models/export_base.rb +354 -0
- data/lib/VoucherifySdk/models/export_base_result.rb +223 -0
- data/lib/VoucherifySdk/models/export_customer.rb +400 -0
- data/lib/VoucherifySdk/models/export_customer_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_customer_base_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/export_customer_fields.rb +68 -0
- data/lib/VoucherifySdk/models/export_customer_order.rb +50 -0
- data/lib/VoucherifySdk/models/export_customer_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_order.rb +400 -0
- data/lib/VoucherifySdk/models/export_order_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_order_fields.rb +51 -0
- data/lib/VoucherifySdk/models/export_order_order.rb +44 -0
- data/lib/VoucherifySdk/models/export_order_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_points_expiration.rb +400 -0
- data/lib/VoucherifySdk/models/export_points_expiration_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_points_expiration_base_parameters.rb +258 -0
- data/lib/VoucherifySdk/models/export_points_expiration_fields.rb +44 -0
- data/lib/VoucherifySdk/models/export_points_expiration_filters.rb +254 -0
- data/lib/VoucherifySdk/models/export_points_expiration_order.rb +40 -0
- data/lib/VoucherifySdk/models/export_points_expiration_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_publication.rb +400 -0
- data/lib/VoucherifySdk/models/export_publication_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_publication_base_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/export_publication_fields.rb +46 -0
- data/lib/VoucherifySdk/models/export_publication_order.rb +50 -0
- data/lib/VoucherifySdk/models/export_publication_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_redemption.rb +400 -0
- data/lib/VoucherifySdk/models/export_redemption_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_redemption_base_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/export_redemption_fields.rb +55 -0
- data/lib/VoucherifySdk/models/export_redemption_order.rb +48 -0
- data/lib/VoucherifySdk/models/export_redemption_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_scheduled_base.rb +359 -0
- data/lib/VoucherifySdk/models/export_voucher.rb +400 -0
- data/lib/VoucherifySdk/models/export_voucher_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_voucher_base_parameters.rb +258 -0
- data/lib/VoucherifySdk/models/export_voucher_fields.rb +68 -0
- data/lib/VoucherifySdk/models/export_voucher_order.rb +44 -0
- data/lib/VoucherifySdk/models/export_voucher_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions.rb +400 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_base.rb +265 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_fields.rb +50 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_filters.rb +263 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_order.rb +40 -0
- data/lib/VoucherifySdk/models/export_voucher_transactions_scheduled.rb +405 -0
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +111 -0
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +111 -0
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +400 -0
- data/lib/VoucherifySdk/models/exports_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/field_conditions.rb +214 -0
- data/lib/VoucherifySdk/models/filter_conditions_string.rb +290 -0
- data/lib/VoucherifySdk/models/filters_condition.rb +430 -0
- data/lib/VoucherifySdk/models/gift.rb +284 -0
- data/lib/VoucherifySdk/models/gift_campaign_voucher.rb +291 -0
- data/lib/VoucherifySdk/models/giveaway_campaign_voucher.rb +300 -0
- data/lib/VoucherifySdk/models/inapplicable_to.rb +413 -0
- data/lib/VoucherifySdk/models/inapplicable_to_result_list.rb +340 -0
- data/lib/VoucherifySdk/models/junction.rb +40 -0
- data/lib/VoucherifySdk/models/list_publications_item_base.rb +399 -0
- data/lib/VoucherifySdk/models/list_publications_item_invalid.rb +455 -0
- data/lib/VoucherifySdk/models/list_publications_item_valid_multiple_vouchers.rb +454 -0
- data/lib/VoucherifySdk/models/list_publications_item_valid_single_voucher.rb +451 -0
- data/lib/VoucherifySdk/models/list_publications_item_voucher.rb +328 -0
- data/lib/VoucherifySdk/models/loyalties_delete_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +462 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +462 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +475 -0
- data/lib/VoucherifySdk/models/loyalties_loyalty_tier_reward.rb +289 -0
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_request_body.rb +284 -0
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body.rb +399 -0
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body_related_object.rb +274 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body.rb +334 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +390 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item_bucket.rb +223 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body.rb +234 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body_reward.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +585 -0
- data/lib/VoucherifySdk/models/loyalties_members_rewards_list_response_body.rb +341 -0
- data/lib/VoucherifySdk/models/loyalties_members_rewards_list_response_body_data_item.rb +269 -0
- data/lib/VoucherifySdk/models/loyalties_members_tiers_list_response_body.rb +321 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_export_create_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_export_create_request_body_parameters.rb +258 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_export_create_response_body.rb +405 -0
- data/lib/VoucherifySdk/models/loyalties_members_transactions_list_response_body.rb +334 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body.rb +544 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_assets.rb +224 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_assets_barcode.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_assets_qr.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +260 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_publish.rb +288 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb +306 -0
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_get_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb +418 -0
- data/lib/VoucherifySdk/models/loyalties_rewards_get_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_create_in_bulk_request_body_item.rb +279 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_earning_rules_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_get_response_body.rb +421 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/loyalties_tiers_rewards_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/loyalties_transfer_points.rb +266 -0
- data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +386 -0
- data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +47 -0
- data/lib/VoucherifySdk/models/loyalty_tier.rb +420 -0
- data/lib/VoucherifySdk/models/loyalty_tier_all_of_config.rb +222 -0
- data/lib/VoucherifySdk/models/loyalty_tier_all_of_config_points.rb +226 -0
- data/lib/VoucherifySdk/models/loyalty_tier_base.rb +262 -0
- data/lib/VoucherifySdk/models/loyalty_tier_base_points.rb +226 -0
- data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +304 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb +311 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all_expiration_date.rb +283 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all_expiration_date_rounding.rb +306 -0
- data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all_start_date.rb +257 -0
- data/lib/VoucherifySdk/models/lucky_draw.rb +246 -0
- data/lib/VoucherifySdk/models/mapping_fixed.rb +261 -0
- data/lib/VoucherifySdk/models/mapping_multiply.rb +261 -0
- data/lib/VoucherifySdk/models/mapping_points.rb +105 -0
- data/lib/VoucherifySdk/models/order.rb +366 -0
- data/lib/VoucherifySdk/models/order_base.rb +339 -0
- data/lib/VoucherifySdk/models/order_calculated.rb +496 -0
- data/lib/VoucherifySdk/models/order_calculated_base.rb +472 -0
- data/lib/VoucherifySdk/models/order_calculated_customer.rb +105 -0
- data/lib/VoucherifySdk/models/order_calculated_no_customer_data.rb +496 -0
- data/lib/VoucherifySdk/models/order_calculated_referrer.rb +105 -0
- data/lib/VoucherifySdk/models/order_item.rb +377 -0
- data/lib/VoucherifySdk/models/order_item_calculated.rb +436 -0
- data/lib/VoucherifySdk/models/order_item_product.rb +266 -0
- data/lib/VoucherifySdk/models/order_item_sku.rb +256 -0
- data/lib/VoucherifySdk/models/order_redemptions.rb +291 -0
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +367 -0
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +497 -0
- data/lib/VoucherifySdk/models/orders_export_create_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/orders_export_create_request_body_parameters.rb +259 -0
- data/lib/VoucherifySdk/models/orders_export_create_response_body.rb +406 -0
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +497 -0
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +356 -0
- data/lib/VoucherifySdk/models/orders_import_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/orders_list_response_body.rb +322 -0
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +347 -0
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +497 -0
- data/lib/VoucherifySdk/models/parameter_campaign_type.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_created_before_after.rb +225 -0
- data/lib/VoucherifySdk/models/parameter_expand_list_campaigns.rb +39 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions.rb +295 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_campaign_name.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_customer_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_failure_code.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_object.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_parent_redemption_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_related_object_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_related_object_parent_id.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_result.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_user_login.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_voucher_code.rb +246 -0
- data/lib/VoucherifySdk/models/parameter_order.rb +50 -0
- data/lib/VoucherifySdk/models/parameter_order_list_all_promotion_stacks.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_order_list_campaigns.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_customers.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_order_list_exports.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_loyalty_tiers.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_orders.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_publications.rb +50 -0
- data/lib/VoucherifySdk/models/parameter_order_list_redemptions.rb +48 -0
- data/lib/VoucherifySdk/models/parameter_order_list_validation_rule_assignments.rb +40 -0
- data/lib/VoucherifySdk/models/parameter_order_list_validation_rules.rb +44 -0
- data/lib/VoucherifySdk/models/parameter_result_list_publications.rb +40 -0
- data/lib/VoucherifySdk/models/parameter_updated_before_after.rb +225 -0
- data/lib/VoucherifySdk/models/parameter_voucher_type_list_publications.rb +41 -0
- data/lib/VoucherifySdk/models/points_expiration_types.rb +41 -0
- data/lib/VoucherifySdk/models/product.rb +397 -0
- data/lib/VoucherifySdk/models/product_collections_create_dynamic_request_body.rb +290 -0
- data/lib/VoucherifySdk/models/product_collections_create_dynamic_request_body_filter.rb +352 -0
- data/lib/VoucherifySdk/models/product_collections_create_dynamic_request_body_products_item.rb +283 -0
- data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +106 -0
- data/lib/VoucherifySdk/models/product_collections_create_response_body.rb +365 -0
- data/lib/VoucherifySdk/models/product_collections_create_static_request_body.rb +286 -0
- data/lib/VoucherifySdk/models/product_collections_get_response_body.rb +365 -0
- data/lib/VoucherifySdk/models/product_collections_item.rb +358 -0
- data/lib/VoucherifySdk/models/product_collections_item_products_item.rb +283 -0
- data/lib/VoucherifySdk/models/product_collections_list.rb +322 -0
- data/lib/VoucherifySdk/models/product_collections_list_response_body.rb +329 -0
- data/lib/VoucherifySdk/models/product_collections_products_list.rb +276 -0
- data/lib/VoucherifySdk/models/product_collections_products_list_products_item.rb +105 -0
- data/lib/VoucherifySdk/models/product_collections_products_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/product_without_skus.rb +380 -0
- data/lib/VoucherifySdk/models/products_create_request_body.rb +278 -0
- data/lib/VoucherifySdk/models/products_create_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/products_get_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/products_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/products_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/products_metadata_update_in_bulk_request_body.rb +242 -0
- data/lib/VoucherifySdk/models/products_metadata_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/products_skus_create_request_body.rb +286 -0
- data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/products_skus_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/products_skus_update_request_body.rb +266 -0
- data/lib/VoucherifySdk/models/products_skus_update_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/products_update_in_bulk_request_body.rb +275 -0
- data/lib/VoucherifySdk/models/products_update_in_bulk_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/products_update_request_body.rb +258 -0
- data/lib/VoucherifySdk/models/products_update_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/promotion_stack.rb +389 -0
- data/lib/VoucherifySdk/models/promotion_stack_base.rb +238 -0
- data/lib/VoucherifySdk/models/promotion_stack_base_tiers.rb +289 -0
- data/lib/VoucherifySdk/models/promotion_tier.rb +416 -0
- data/lib/VoucherifySdk/models/promotion_tier_action.rb +215 -0
- data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +289 -0
- data/lib/VoucherifySdk/models/promotion_tier_campaign_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/promotion_tier_create_params.rb +345 -0
- data/lib/VoucherifySdk/models/promotion_tier_summary.rb +224 -0
- data/lib/VoucherifySdk/models/promotion_tier_summary_orders.rb +226 -0
- data/lib/VoucherifySdk/models/promotion_tier_summary_redemptions.rb +216 -0
- data/lib/VoucherifySdk/models/promotion_tier_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/promotion_tiers_list.rb +262 -0
- data/lib/VoucherifySdk/models/promotions_stacks_create_request_body.rb +256 -0
- data/lib/VoucherifySdk/models/promotions_stacks_create_response_body.rb +380 -0
- data/lib/VoucherifySdk/models/promotions_stacks_get_response_body.rb +390 -0
- data/lib/VoucherifySdk/models/promotions_stacks_list_response_body.rb +341 -0
- data/lib/VoucherifySdk/models/promotions_stacks_update_request_body.rb +235 -0
- data/lib/VoucherifySdk/models/promotions_stacks_update_request_body_tiers.rb +264 -0
- data/lib/VoucherifySdk/models/promotions_stacks_update_response_body.rb +397 -0
- data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/promotions_tiers_get_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/promotions_tiers_list_response_body.rb +269 -0
- data/lib/VoucherifySdk/models/properties_for_loyalty_campaign_options.rb +215 -0
- data/lib/VoucherifySdk/models/publications_create_base_response_body.rb +440 -0
- data/lib/VoucherifySdk/models/publications_create_request_body.rb +106 -0
- data/lib/VoucherifySdk/models/publications_create_response_body.rb +106 -0
- data/lib/VoucherifySdk/models/publications_create_voucher_response_body.rb +464 -0
- data/lib/VoucherifySdk/models/publications_create_vouchers_response_body.rb +467 -0
- data/lib/VoucherifySdk/models/publications_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/publications_list_response_body_publications_item.rb +107 -0
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body.rb +319 -0
- data/lib/VoucherifySdk/models/qualifications_check_eligibility_response_body.rb +243 -0
- data/lib/VoucherifySdk/models/qualifications_field_conditions.rb +214 -0
- data/lib/VoucherifySdk/models/qualifications_filters_condition.rb +259 -0
- data/lib/VoucherifySdk/models/qualifications_option.rb +311 -0
- data/lib/VoucherifySdk/models/qualifications_option_filters.rb +291 -0
- data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type.rb +214 -0
- data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type_conditions.rb +270 -0
- data/lib/VoucherifySdk/models/qualifications_redeemable.rb +404 -0
- data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +387 -0
- data/lib/VoucherifySdk/models/qualifications_redeemables.rb +349 -0
- data/lib/VoucherifySdk/models/redeem_gift_card.rb +289 -0
- data/lib/VoucherifySdk/models/redeem_gift_card_all_of_gift.rb +216 -0
- data/lib/VoucherifySdk/models/redeem_loyalty_card.rb +289 -0
- data/lib/VoucherifySdk/models/redeem_loyalty_card_all_of_reward.rb +226 -0
- data/lib/VoucherifySdk/models/redeem_promotion_stack.rb +274 -0
- data/lib/VoucherifySdk/models/redeem_promotion_tier.rb +274 -0
- data/lib/VoucherifySdk/models/redeem_voucher.rb +274 -0
- data/lib/VoucherifySdk/models/redeemable_gift.rb +226 -0
- data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +257 -0
- data/lib/VoucherifySdk/models/redeemable_result.rb +242 -0
- data/lib/VoucherifySdk/models/redeemable_result_gift_card.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_gift_card_gift.rb +216 -0
- data/lib/VoucherifySdk/models/redeemable_result_loyalty_card.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_loyalty_card_loyalty_card.rb +216 -0
- data/lib/VoucherifySdk/models/redeemable_result_promotion_stack.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_promotion_tier.rb +215 -0
- data/lib/VoucherifySdk/models/redeemable_result_promotion_tier_discount.rb +109 -0
- data/lib/VoucherifySdk/models/redeemable_result_voucher_code.rb +215 -0
- data/lib/VoucherifySdk/models/redemption.rb +571 -0
- data/lib/VoucherifySdk/models/redemption_channel.rb +260 -0
- data/lib/VoucherifySdk/models/redemption_gift.rb +216 -0
- data/lib/VoucherifySdk/models/redemption_internal.rb +542 -0
- data/lib/VoucherifySdk/models/redemption_internal_related_redemptions.rb +227 -0
- data/lib/VoucherifySdk/models/redemption_internal_related_redemptions_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_internal_related_redemptions_rollbacks_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_loyalty_card.rb +216 -0
- data/lib/VoucherifySdk/models/redemption_related_redemptions.rb +227 -0
- data/lib/VoucherifySdk/models/redemption_related_redemptions_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_reward_result.rb +396 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters.rb +233 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb +236 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +226 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_product.rb +226 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_product.rb +397 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_sku.rb +425 -0
- data/lib/VoucherifySdk/models/redemption_reward_result_voucher.rb +547 -0
- data/lib/VoucherifySdk/models/redemption_rollback.rb +581 -0
- data/lib/VoucherifySdk/models/redemption_rollback_related_redemptions.rb +227 -0
- data/lib/VoucherifySdk/models/redemption_rollback_related_redemptions_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemption_rollback_related_redemptions_rollbacks_item.rb +225 -0
- data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +106 -0
- data/lib/VoucherifySdk/models/redemptions_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +105 -0
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/redemptions_redeem_response_body.rb +259 -0
- data/lib/VoucherifySdk/models/redemptions_rollback_create_request_body.rb +254 -0
- data/lib/VoucherifySdk/models/redemptions_rollback_create_response_body.rb +588 -0
- data/lib/VoucherifySdk/models/redemptions_rollbacks_create_request_body.rb +254 -0
- data/lib/VoucherifySdk/models/redemptions_rollbacks_create_response_body.rb +236 -0
- data/lib/VoucherifySdk/models/referral_campaign_voucher.rb +307 -0
- data/lib/VoucherifySdk/models/referral_program.rb +268 -0
- data/lib/VoucherifySdk/models/referral_program_custom_event.rb +226 -0
- data/lib/VoucherifySdk/models/referral_program_referee_reward.rb +269 -0
- data/lib/VoucherifySdk/models/referral_program_referee_reward_related_object_parent.rb +272 -0
- data/lib/VoucherifySdk/models/referrer.rb +312 -0
- data/lib/VoucherifySdk/models/referrer_id.rb +280 -0
- data/lib/VoucherifySdk/models/referrer_with_summary_loyalty_referrals.rb +438 -0
- data/lib/VoucherifySdk/models/resource_types.rb +41 -0
- data/lib/VoucherifySdk/models/reward.rb +410 -0
- data/lib/VoucherifySdk/models/reward_assignment.rb +383 -0
- data/lib/VoucherifySdk/models/reward_assignment_base.rb +366 -0
- data/lib/VoucherifySdk/models/reward_assignment_parameters.rb +214 -0
- data/lib/VoucherifySdk/models/reward_assignment_parameters_parameters.rb +222 -0
- data/lib/VoucherifySdk/models/reward_assignment_parameters_parameters_loyalty.rb +216 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_coin_reward_request_body.rb +234 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_digital_or_material_reward_request_body.rb +239 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_digital_or_material_reward_request_body_parameters.rb +222 -0
- data/lib/VoucherifySdk/models/reward_assignments_create_digital_or_material_reward_request_body_parameters_loyalty.rb +216 -0
- data/lib/VoucherifySdk/models/reward_attributes.rb +226 -0
- data/lib/VoucherifySdk/models/reward_type.rb +106 -0
- data/lib/VoucherifySdk/models/reward_type_campaign.rb +221 -0
- data/lib/VoucherifySdk/models/reward_type_campaign_campaign.rb +284 -0
- data/lib/VoucherifySdk/models/reward_type_coin.rb +221 -0
- data/lib/VoucherifySdk/models/reward_type_coin_coin.rb +233 -0
- data/lib/VoucherifySdk/models/reward_type_material.rb +221 -0
- data/lib/VoucherifySdk/models/reward_type_material_product.rb +236 -0
- data/lib/VoucherifySdk/models/rewards_assignments_create_request_body.rb +106 -0
- data/lib/VoucherifySdk/models/rewards_assignments_create_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/rewards_assignments_get_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/rewards_assignments_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_request_body_parameters.rb +215 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_request_body_parameters_loyalty.rb +216 -0
- data/lib/VoucherifySdk/models/rewards_assignments_update_response_body.rb +383 -0
- data/lib/VoucherifySdk/models/schema_that_contains_unique_properties_for_promotion_campaign_promotion.rb +217 -0
- data/lib/VoucherifySdk/models/session.rb +307 -0
- data/lib/VoucherifySdk/models/simple_campaign.rb +381 -0
- data/lib/VoucherifySdk/models/simple_consent.rb +273 -0
- data/lib/VoucherifySdk/models/simple_customer.rb +301 -0
- data/lib/VoucherifySdk/models/simple_customer_required_object_type.rb +273 -0
- data/lib/VoucherifySdk/models/simple_order.rb +423 -0
- data/lib/VoucherifySdk/models/simple_order_item.rb +363 -0
- data/lib/VoucherifySdk/models/simple_product.rb +235 -0
- data/lib/VoucherifySdk/models/simple_product_discount_unit.rb +249 -0
- data/lib/VoucherifySdk/models/simple_promotion_tier.rb +245 -0
- data/lib/VoucherifySdk/models/simple_promotion_tier_campaign.rb +216 -0
- data/lib/VoucherifySdk/models/simple_redemption.rb +368 -0
- data/lib/VoucherifySdk/models/simple_redemption_reward_result.rb +380 -0
- data/lib/VoucherifySdk/models/simple_referral_tier.rb +245 -0
- data/lib/VoucherifySdk/models/simple_segment.rb +290 -0
- data/lib/VoucherifySdk/models/simple_sku.rb +235 -0
- data/lib/VoucherifySdk/models/simple_sku_discount_unit.rb +249 -0
- data/lib/VoucherifySdk/models/simple_voucher.rb +390 -0
- data/lib/VoucherifySdk/models/sku.rb +418 -0
- data/lib/VoucherifySdk/models/sku_with_product.rb +433 -0
- data/lib/VoucherifySdk/models/skus_get_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/skus_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/skus_list.rb +276 -0
- data/lib/VoucherifySdk/models/skus_list_for_product.rb +276 -0
- data/lib/VoucherifySdk/models/stackable_validate_redeem_base.rb +299 -0
- data/lib/VoucherifySdk/models/stackable_validate_redeem_base_redeemables_item.rb +108 -0
- data/lib/VoucherifySdk/models/stacking_rules.rb +487 -0
- data/lib/VoucherifySdk/models/validation_entity.rb +325 -0
- data/lib/VoucherifySdk/models/validation_rule.rb +422 -0
- data/lib/VoucherifySdk/models/validation_rule_assignment.rb +354 -0
- data/lib/VoucherifySdk/models/validation_rule_assignments_list.rb +276 -0
- data/lib/VoucherifySdk/models/validation_rule_base.rb +314 -0
- data/lib/VoucherifySdk/models/validation_rule_base_applicable_to.rb +239 -0
- data/lib/VoucherifySdk/models/validation_rule_base_error.rb +216 -0
- data/lib/VoucherifySdk/models/validation_rules_assignments_list.rb +341 -0
- data/lib/VoucherifySdk/models/validation_rules_assignments_list_response_body.rb +283 -0
- data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +328 -0
- data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/validation_rules_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +321 -0
- data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +423 -0
- data/lib/VoucherifySdk/models/validations_redeemable_applicable.rb +340 -0
- data/lib/VoucherifySdk/models/validations_redeemable_applicable_result.rb +109 -0
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable.rb +292 -0
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable_result.rb +214 -0
- data/lib/VoucherifySdk/models/validations_redeemable_skipped.rb +292 -0
- data/lib/VoucherifySdk/models/validations_validate_all_response_body_redeemables_item.rb +106 -0
- data/lib/VoucherifySdk/models/validations_validate_request_body.rb +316 -0
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +294 -0
- data/lib/VoucherifySdk/models/voucher.rb +540 -0
- data/lib/VoucherifySdk/models/voucher_assets.rb +224 -0
- data/lib/VoucherifySdk/models/voucher_gift.rb +270 -0
- data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +246 -0
- data/lib/VoucherifySdk/models/voucher_publish.rb +238 -0
- data/lib/VoucherifySdk/models/voucher_redemption.rb +268 -0
- data/lib/VoucherifySdk/models/voucher_transaction.rb +379 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details.rb +323 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +365 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance_related_object.rb +280 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +239 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule_source.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_event.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +238 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_order.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_redemption.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_reward.rb +240 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +238 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export.rb +407 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_filter_conditions.rb +222 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_filter_conditions_voucher_id.rb +222 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_filter_conditions_voucher_id_conditions.rb +252 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_parameters.rb +262 -0
- data/lib/VoucherifySdk/models/voucher_transactions_export_result.rb +223 -0
- data/lib/VoucherifySdk/models/voucher_transactions_filters.rb +278 -0
- data/lib/VoucherifySdk/models/voucher_validity_timeframe.rb +226 -0
- data/lib/VoucherifySdk/models/vouchers_balance_update_request_body.rb +243 -0
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +381 -0
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body_related_object.rb +274 -0
- data/lib/VoucherifySdk/models/vouchers_disable_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/vouchers_enable_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/vouchers_get_response_body.rb +547 -0
- data/lib/VoucherifySdk/models/vouchers_import_csv_create_response_body.rb +230 -0
- data/lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb +323 -0
- data/lib/VoucherifySdk/models/vouchers_redemption_get_response_body_redemption_entries_item.rb +105 -0
- data/lib/VoucherifySdk/models/vouchers_transactions_export_create_request_body.rb +215 -0
- data/lib/VoucherifySdk/models/vouchers_transactions_export_create_response_body.rb +414 -0
- data/lib/VoucherifySdk/models/vouchers_transactions_list_response_body.rb +276 -0
- data/lib/VoucherifySdk/version.rb +15 -0
- data/lib/VoucherifySdk.rb +716 -0
- metadata +1430 -72
- data/.gitignore +0 -43
- data/.rspec +0 -2
- data/.travis.yml +0 -9
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/examples/customers.rb +0 -32
- data/examples/utils.rb +0 -71
- data/examples/vouchers.rb +0 -25
- data/lib/voucherify/client.rb +0 -154
- data/lib/voucherify/service/async_actions.rb +0 -22
- data/lib/voucherify/service/campaigns.rb +0 -39
- data/lib/voucherify/service/consents.rb +0 -17
- data/lib/voucherify/service/customers.rb +0 -37
- data/lib/voucherify/service/distributions.rb +0 -45
- data/lib/voucherify/service/events.rb +0 -24
- data/lib/voucherify/service/loyalties.rb +0 -133
- data/lib/voucherify/service/orders.rb +0 -29
- data/lib/voucherify/service/products.rb +0 -53
- data/lib/voucherify/service/promotions.rb +0 -58
- data/lib/voucherify/service/redemptions.rb +0 -42
- data/lib/voucherify/service/rewards.rb +0 -63
- data/lib/voucherify/service/segments.rb +0 -25
- data/lib/voucherify/service/validation_rules.rb +0 -69
- data/lib/voucherify/service/validations.rb +0 -26
- data/lib/voucherify/service/vouchers.rb +0 -54
- data/lib/voucherify/utils.rb +0 -101
- data/lib/voucherify/version.rb +0 -3
- data/lib/voucherify.rb +0 -23
- data/voucherify.gemspec +0 -28
data/docs/ProductsApi.md
ADDED
|
@@ -0,0 +1,883 @@
|
|
|
1
|
+
# VoucherifySdk::ProductsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.voucherify.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_product**](ProductsApi.md#create_product) | **POST** /v1/products | Create Product |
|
|
8
|
+
| [**create_sku**](ProductsApi.md#create_sku) | **POST** /v1/products/{productId}/skus | Create SKU |
|
|
9
|
+
| [**delete_product**](ProductsApi.md#delete_product) | **DELETE** /v1/products/{productId} | Delete Product |
|
|
10
|
+
| [**delete_sku**](ProductsApi.md#delete_sku) | **DELETE** /v1/products/{productId}/skus/{skuId} | Delete SKU |
|
|
11
|
+
| [**get_product**](ProductsApi.md#get_product) | **GET** /v1/products/{productId} | Get Product |
|
|
12
|
+
| [**get_sku**](ProductsApi.md#get_sku) | **GET** /v1/skus/{skuId} | Get SKU |
|
|
13
|
+
| [**import_products_using_csv**](ProductsApi.md#import_products_using_csv) | **POST** /v1/products/importCSV | Import Products using CSV |
|
|
14
|
+
| [**import_skus_using_csv**](ProductsApi.md#import_skus_using_csv) | **POST** /v1/skus/importCSV | Import SKUs using CSV |
|
|
15
|
+
| [**list_products**](ProductsApi.md#list_products) | **GET** /v1/products | List Products |
|
|
16
|
+
| [**list_skus_in_product**](ProductsApi.md#list_skus_in_product) | **GET** /v1/products/{productId}/skus | List SKUs in Product |
|
|
17
|
+
| [**update_product**](ProductsApi.md#update_product) | **PUT** /v1/products/{productId} | Update Product |
|
|
18
|
+
| [**update_products_in_bulk**](ProductsApi.md#update_products_in_bulk) | **POST** /v1/products/bulk/async | Update Products in bulk |
|
|
19
|
+
| [**update_products_metadata_in_bulk**](ProductsApi.md#update_products_metadata_in_bulk) | **POST** /v1/products/metadata/async | Update Products' Metadata in bulk |
|
|
20
|
+
| [**update_sku**](ProductsApi.md#update_sku) | **PUT** /v1/products/{productId}/skus/{skuId} | Update SKU |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## create_product
|
|
24
|
+
|
|
25
|
+
> <ProductsCreateResponseBody> create_product(opts)
|
|
26
|
+
|
|
27
|
+
Create Product
|
|
28
|
+
|
|
29
|
+
Creates a product object. 📘 Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields.
|
|
30
|
+
|
|
31
|
+
### Examples
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
require 'time'
|
|
35
|
+
require 'VoucherifySdk'
|
|
36
|
+
# setup authorization
|
|
37
|
+
VoucherifySdk.configure do |config|
|
|
38
|
+
# Configure API key authorization: X-App-Id
|
|
39
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
40
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
41
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
42
|
+
|
|
43
|
+
# Configure API key authorization: X-App-Token
|
|
44
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
45
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
46
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
50
|
+
opts = {
|
|
51
|
+
products_create_request_body: VoucherifySdk::ProductsCreateRequestBody.new # ProductsCreateRequestBody | Specify the product parameters.
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
begin
|
|
55
|
+
# Create Product
|
|
56
|
+
result = api_instance.create_product(opts)
|
|
57
|
+
p result
|
|
58
|
+
rescue VoucherifySdk::ApiError => e
|
|
59
|
+
puts "Error when calling ProductsApi->create_product: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **products_create_request_body** | [**ProductsCreateRequestBody**](ProductsCreateRequestBody.md) | Specify the product parameters. | [optional] |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**ProductsCreateResponseBody**](ProductsCreateResponseBody.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: application/json
|
|
80
|
+
- **Accept**: application/json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## create_sku
|
|
84
|
+
|
|
85
|
+
> <ProductsSkusCreateResponseBody> create_sku(product_id, opts)
|
|
86
|
+
|
|
87
|
+
Create SKU
|
|
88
|
+
|
|
89
|
+
This method adds product variants to a created product. 📘 Upsert Mode If you pass an id or a source_id that already exists in the sku database, Voucherify will return a related sku object with updated fields.
|
|
90
|
+
|
|
91
|
+
### Examples
|
|
92
|
+
|
|
93
|
+
```ruby
|
|
94
|
+
require 'time'
|
|
95
|
+
require 'VoucherifySdk'
|
|
96
|
+
# setup authorization
|
|
97
|
+
VoucherifySdk.configure do |config|
|
|
98
|
+
# Configure API key authorization: X-App-Id
|
|
99
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
100
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
101
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
102
|
+
|
|
103
|
+
# Configure API key authorization: X-App-Token
|
|
104
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
106
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
110
|
+
product_id = 'product_id_example' # String | A Voucherify product ID or product source ID.
|
|
111
|
+
opts = {
|
|
112
|
+
products_skus_create_request_body: VoucherifySdk::ProductsSkusCreateRequestBody.new # ProductsSkusCreateRequestBody | Specify the SKU parameters to be created.
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
begin
|
|
116
|
+
# Create SKU
|
|
117
|
+
result = api_instance.create_sku(product_id, opts)
|
|
118
|
+
p result
|
|
119
|
+
rescue VoucherifySdk::ApiError => e
|
|
120
|
+
puts "Error when calling ProductsApi->create_sku: #{e}"
|
|
121
|
+
end
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Parameters
|
|
125
|
+
|
|
126
|
+
| Name | Type | Description | Notes |
|
|
127
|
+
| ---- | ---- | ----------- | ----- |
|
|
128
|
+
| **product_id** | **String** | A Voucherify product ID or product source ID. | |
|
|
129
|
+
| **products_skus_create_request_body** | [**ProductsSkusCreateRequestBody**](ProductsSkusCreateRequestBody.md) | Specify the SKU parameters to be created. | [optional] |
|
|
130
|
+
|
|
131
|
+
### Return type
|
|
132
|
+
|
|
133
|
+
[**ProductsSkusCreateResponseBody**](ProductsSkusCreateResponseBody.md)
|
|
134
|
+
|
|
135
|
+
### Authorization
|
|
136
|
+
|
|
137
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
138
|
+
|
|
139
|
+
### HTTP request headers
|
|
140
|
+
|
|
141
|
+
- **Content-Type**: application/json
|
|
142
|
+
- **Accept**: application/json
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
## delete_product
|
|
146
|
+
|
|
147
|
+
> delete_product(product_id, opts)
|
|
148
|
+
|
|
149
|
+
Delete Product
|
|
150
|
+
|
|
151
|
+
This method deletes a product.
|
|
152
|
+
|
|
153
|
+
### Examples
|
|
154
|
+
|
|
155
|
+
```ruby
|
|
156
|
+
require 'time'
|
|
157
|
+
require 'VoucherifySdk'
|
|
158
|
+
# setup authorization
|
|
159
|
+
VoucherifySdk.configure do |config|
|
|
160
|
+
# Configure API key authorization: X-App-Id
|
|
161
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
162
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
163
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
164
|
+
|
|
165
|
+
# Configure API key authorization: X-App-Token
|
|
166
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
167
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
168
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
172
|
+
product_id = 'product_id_example' # String | A Voucherify product ID or source ID.
|
|
173
|
+
opts = {
|
|
174
|
+
force: true # Boolean | If this flag is set to true, the product will be removed permanently. Going forward, the user will be able to create another product with exactly the same source_id.
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
begin
|
|
178
|
+
# Delete Product
|
|
179
|
+
api_instance.delete_product(product_id, opts)
|
|
180
|
+
rescue VoucherifySdk::ApiError => e
|
|
181
|
+
puts "Error when calling ProductsApi->delete_product: #{e}"
|
|
182
|
+
end
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Parameters
|
|
186
|
+
|
|
187
|
+
| Name | Type | Description | Notes |
|
|
188
|
+
| ---- | ---- | ----------- | ----- |
|
|
189
|
+
| **product_id** | **String** | A Voucherify product ID or source ID. | |
|
|
190
|
+
| **force** | **Boolean** | If this flag is set to true, the product will be removed permanently. Going forward, the user will be able to create another product with exactly the same source_id. | [optional] |
|
|
191
|
+
|
|
192
|
+
### Return type
|
|
193
|
+
|
|
194
|
+
nil (empty response body)
|
|
195
|
+
|
|
196
|
+
### Authorization
|
|
197
|
+
|
|
198
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
199
|
+
|
|
200
|
+
### HTTP request headers
|
|
201
|
+
|
|
202
|
+
- **Content-Type**: Not defined
|
|
203
|
+
- **Accept**: Not defined
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
## delete_sku
|
|
207
|
+
|
|
208
|
+
> delete_sku(product_id, sku_id, opts)
|
|
209
|
+
|
|
210
|
+
Delete SKU
|
|
211
|
+
|
|
212
|
+
This method deletes a product SKU.
|
|
213
|
+
|
|
214
|
+
### Examples
|
|
215
|
+
|
|
216
|
+
```ruby
|
|
217
|
+
require 'time'
|
|
218
|
+
require 'VoucherifySdk'
|
|
219
|
+
# setup authorization
|
|
220
|
+
VoucherifySdk.configure do |config|
|
|
221
|
+
# Configure API key authorization: X-App-Id
|
|
222
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
223
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
224
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
225
|
+
|
|
226
|
+
# Configure API key authorization: X-App-Token
|
|
227
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
228
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
229
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
233
|
+
product_id = 'product_id_example' # String | A unique Voucherify product ID or product source ID.
|
|
234
|
+
sku_id = 'sku_id_example' # String | A Voucherify SKU ID or SKU source ID.
|
|
235
|
+
opts = {
|
|
236
|
+
force: true # Boolean | If this flag is set to true, the SKU will be removed permanently. Going forward, the user will be able to create another SKU with exactly the same source_id.
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
begin
|
|
240
|
+
# Delete SKU
|
|
241
|
+
api_instance.delete_sku(product_id, sku_id, opts)
|
|
242
|
+
rescue VoucherifySdk::ApiError => e
|
|
243
|
+
puts "Error when calling ProductsApi->delete_sku: #{e}"
|
|
244
|
+
end
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### Parameters
|
|
248
|
+
|
|
249
|
+
| Name | Type | Description | Notes |
|
|
250
|
+
| ---- | ---- | ----------- | ----- |
|
|
251
|
+
| **product_id** | **String** | A unique Voucherify product ID or product source ID. | |
|
|
252
|
+
| **sku_id** | **String** | A Voucherify SKU ID or SKU source ID. | |
|
|
253
|
+
| **force** | **Boolean** | If this flag is set to true, the SKU will be removed permanently. Going forward, the user will be able to create another SKU with exactly the same source_id. | [optional] |
|
|
254
|
+
|
|
255
|
+
### Return type
|
|
256
|
+
|
|
257
|
+
nil (empty response body)
|
|
258
|
+
|
|
259
|
+
### Authorization
|
|
260
|
+
|
|
261
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
262
|
+
|
|
263
|
+
### HTTP request headers
|
|
264
|
+
|
|
265
|
+
- **Content-Type**: Not defined
|
|
266
|
+
- **Accept**: Not defined
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
## get_product
|
|
270
|
+
|
|
271
|
+
> <ProductsGetResponseBody> get_product(product_id)
|
|
272
|
+
|
|
273
|
+
Get Product
|
|
274
|
+
|
|
275
|
+
Retrieve product details.
|
|
276
|
+
|
|
277
|
+
### Examples
|
|
278
|
+
|
|
279
|
+
```ruby
|
|
280
|
+
require 'time'
|
|
281
|
+
require 'VoucherifySdk'
|
|
282
|
+
# setup authorization
|
|
283
|
+
VoucherifySdk.configure do |config|
|
|
284
|
+
# Configure API key authorization: X-App-Id
|
|
285
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
286
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
287
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
288
|
+
|
|
289
|
+
# Configure API key authorization: X-App-Token
|
|
290
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
291
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
292
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
296
|
+
product_id = 'product_id_example' # String | A Voucherify product ID or source ID.
|
|
297
|
+
|
|
298
|
+
begin
|
|
299
|
+
# Get Product
|
|
300
|
+
result = api_instance.get_product(product_id)
|
|
301
|
+
p result
|
|
302
|
+
rescue VoucherifySdk::ApiError => e
|
|
303
|
+
puts "Error when calling ProductsApi->get_product: #{e}"
|
|
304
|
+
end
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
### Parameters
|
|
308
|
+
|
|
309
|
+
| Name | Type | Description | Notes |
|
|
310
|
+
| ---- | ---- | ----------- | ----- |
|
|
311
|
+
| **product_id** | **String** | A Voucherify product ID or source ID. | |
|
|
312
|
+
|
|
313
|
+
### Return type
|
|
314
|
+
|
|
315
|
+
[**ProductsGetResponseBody**](ProductsGetResponseBody.md)
|
|
316
|
+
|
|
317
|
+
### Authorization
|
|
318
|
+
|
|
319
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
320
|
+
|
|
321
|
+
### HTTP request headers
|
|
322
|
+
|
|
323
|
+
- **Content-Type**: Not defined
|
|
324
|
+
- **Accept**: application/json
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
## get_sku
|
|
328
|
+
|
|
329
|
+
> <SkusGetResponseBody> get_sku(sku_id)
|
|
330
|
+
|
|
331
|
+
Get SKU
|
|
332
|
+
|
|
333
|
+
Retrieve details of a SKU.
|
|
334
|
+
|
|
335
|
+
### Examples
|
|
336
|
+
|
|
337
|
+
```ruby
|
|
338
|
+
require 'time'
|
|
339
|
+
require 'VoucherifySdk'
|
|
340
|
+
# setup authorization
|
|
341
|
+
VoucherifySdk.configure do |config|
|
|
342
|
+
# Configure API key authorization: X-App-Id
|
|
343
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
344
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
345
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
346
|
+
|
|
347
|
+
# Configure API key authorization: X-App-Token
|
|
348
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
349
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
350
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
351
|
+
end
|
|
352
|
+
|
|
353
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
354
|
+
sku_id = 'sku_id_example' # String | A Voucherify SKU identifier or SKU source ID.
|
|
355
|
+
|
|
356
|
+
begin
|
|
357
|
+
# Get SKU
|
|
358
|
+
result = api_instance.get_sku(sku_id)
|
|
359
|
+
p result
|
|
360
|
+
rescue VoucherifySdk::ApiError => e
|
|
361
|
+
puts "Error when calling ProductsApi->get_sku: #{e}"
|
|
362
|
+
end
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
### Parameters
|
|
366
|
+
|
|
367
|
+
| Name | Type | Description | Notes |
|
|
368
|
+
| ---- | ---- | ----------- | ----- |
|
|
369
|
+
| **sku_id** | **String** | A Voucherify SKU identifier or SKU source ID. | |
|
|
370
|
+
|
|
371
|
+
### Return type
|
|
372
|
+
|
|
373
|
+
[**SkusGetResponseBody**](SkusGetResponseBody.md)
|
|
374
|
+
|
|
375
|
+
### Authorization
|
|
376
|
+
|
|
377
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
378
|
+
|
|
379
|
+
### HTTP request headers
|
|
380
|
+
|
|
381
|
+
- **Content-Type**: Not defined
|
|
382
|
+
- **Accept**: application/json
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
## import_products_using_csv
|
|
386
|
+
|
|
387
|
+
> <ProductsImportCsvCreateResponseBody> import_products_using_csv(file)
|
|
388
|
+
|
|
389
|
+
Import Products using CSV
|
|
390
|
+
|
|
391
|
+
Import products into the repository using a CSV file. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.
|
|
392
|
+
|
|
393
|
+
### Examples
|
|
394
|
+
|
|
395
|
+
```ruby
|
|
396
|
+
require 'time'
|
|
397
|
+
require 'VoucherifySdk'
|
|
398
|
+
# setup authorization
|
|
399
|
+
VoucherifySdk.configure do |config|
|
|
400
|
+
# Configure API key authorization: X-App-Id
|
|
401
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
402
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
403
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
404
|
+
|
|
405
|
+
# Configure API key authorization: X-App-Token
|
|
406
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
407
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
408
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
409
|
+
end
|
|
410
|
+
|
|
411
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
412
|
+
file = File.new('/path/to/some/file') # File | File path.
|
|
413
|
+
|
|
414
|
+
begin
|
|
415
|
+
# Import Products using CSV
|
|
416
|
+
result = api_instance.import_products_using_csv(file)
|
|
417
|
+
p result
|
|
418
|
+
rescue VoucherifySdk::ApiError => e
|
|
419
|
+
puts "Error when calling ProductsApi->import_products_using_csv: #{e}"
|
|
420
|
+
end
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
### Parameters
|
|
424
|
+
|
|
425
|
+
| Name | Type | Description | Notes |
|
|
426
|
+
| ---- | ---- | ----------- | ----- |
|
|
427
|
+
| **file** | **File** | File path. | |
|
|
428
|
+
|
|
429
|
+
### Return type
|
|
430
|
+
|
|
431
|
+
[**ProductsImportCsvCreateResponseBody**](ProductsImportCsvCreateResponseBody.md)
|
|
432
|
+
|
|
433
|
+
### Authorization
|
|
434
|
+
|
|
435
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
436
|
+
|
|
437
|
+
### HTTP request headers
|
|
438
|
+
|
|
439
|
+
- **Content-Type**: multipart/form-data
|
|
440
|
+
- **Accept**: application/json
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
## import_skus_using_csv
|
|
444
|
+
|
|
445
|
+
> <SkusImportCsvCreateResponseBody> import_skus_using_csv(file)
|
|
446
|
+
|
|
447
|
+
Import SKUs using CSV
|
|
448
|
+
|
|
449
|
+
Import SKUs into the repository using a CSV file. The CSV file has to include headers in the first line. All properties which cannot be mapped to standard SKU fields will be added to the metadata object. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b98d08c9b585083488a4c/Import_SKUS_template.csv). This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.
|
|
450
|
+
|
|
451
|
+
### Examples
|
|
452
|
+
|
|
453
|
+
```ruby
|
|
454
|
+
require 'time'
|
|
455
|
+
require 'VoucherifySdk'
|
|
456
|
+
# setup authorization
|
|
457
|
+
VoucherifySdk.configure do |config|
|
|
458
|
+
# Configure API key authorization: X-App-Id
|
|
459
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
460
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
461
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
462
|
+
|
|
463
|
+
# Configure API key authorization: X-App-Token
|
|
464
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
465
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
466
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
467
|
+
end
|
|
468
|
+
|
|
469
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
470
|
+
file = File.new('/path/to/some/file') # File | File path.
|
|
471
|
+
|
|
472
|
+
begin
|
|
473
|
+
# Import SKUs using CSV
|
|
474
|
+
result = api_instance.import_skus_using_csv(file)
|
|
475
|
+
p result
|
|
476
|
+
rescue VoucherifySdk::ApiError => e
|
|
477
|
+
puts "Error when calling ProductsApi->import_skus_using_csv: #{e}"
|
|
478
|
+
end
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Parameters
|
|
482
|
+
|
|
483
|
+
| Name | Type | Description | Notes |
|
|
484
|
+
| ---- | ---- | ----------- | ----- |
|
|
485
|
+
| **file** | **File** | File path. | |
|
|
486
|
+
|
|
487
|
+
### Return type
|
|
488
|
+
|
|
489
|
+
[**SkusImportCsvCreateResponseBody**](SkusImportCsvCreateResponseBody.md)
|
|
490
|
+
|
|
491
|
+
### Authorization
|
|
492
|
+
|
|
493
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
494
|
+
|
|
495
|
+
### HTTP request headers
|
|
496
|
+
|
|
497
|
+
- **Content-Type**: multipart/form-data
|
|
498
|
+
- **Accept**: application/json
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
## list_products
|
|
502
|
+
|
|
503
|
+
> <ProductsListResponseBody> list_products(opts)
|
|
504
|
+
|
|
505
|
+
List Products
|
|
506
|
+
|
|
507
|
+
Retrieve a list of products.
|
|
508
|
+
|
|
509
|
+
### Examples
|
|
510
|
+
|
|
511
|
+
```ruby
|
|
512
|
+
require 'time'
|
|
513
|
+
require 'VoucherifySdk'
|
|
514
|
+
# setup authorization
|
|
515
|
+
VoucherifySdk.configure do |config|
|
|
516
|
+
# Configure API key authorization: X-App-Id
|
|
517
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
518
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
519
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
520
|
+
|
|
521
|
+
# Configure API key authorization: X-App-Token
|
|
522
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
523
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
524
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
525
|
+
end
|
|
526
|
+
|
|
527
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
528
|
+
opts = {
|
|
529
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
530
|
+
page: 56, # Integer | Which page of results to return.
|
|
531
|
+
order: VoucherifySdk::ParameterOrder::CREATED_AT, # ParameterOrder | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
532
|
+
start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
|
|
533
|
+
end_date: Time.parse('2013-10-20T19:20:30+01:00') # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
begin
|
|
537
|
+
# List Products
|
|
538
|
+
result = api_instance.list_products(opts)
|
|
539
|
+
p result
|
|
540
|
+
rescue VoucherifySdk::ApiError => e
|
|
541
|
+
puts "Error when calling ProductsApi->list_products: #{e}"
|
|
542
|
+
end
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
### Parameters
|
|
546
|
+
|
|
547
|
+
| Name | Type | Description | Notes |
|
|
548
|
+
| ---- | ---- | ----------- | ----- |
|
|
549
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
550
|
+
| **page** | **Integer** | Which page of results to return. | [optional] |
|
|
551
|
+
| **order** | [**ParameterOrder**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
552
|
+
| **start_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
|
|
553
|
+
| **end_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
|
|
554
|
+
|
|
555
|
+
### Return type
|
|
556
|
+
|
|
557
|
+
[**ProductsListResponseBody**](ProductsListResponseBody.md)
|
|
558
|
+
|
|
559
|
+
### Authorization
|
|
560
|
+
|
|
561
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
562
|
+
|
|
563
|
+
### HTTP request headers
|
|
564
|
+
|
|
565
|
+
- **Content-Type**: Not defined
|
|
566
|
+
- **Accept**: application/json
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
## list_skus_in_product
|
|
570
|
+
|
|
571
|
+
> <ProductsSkusListResponseBody> list_skus_in_product(product_id, opts)
|
|
572
|
+
|
|
573
|
+
List SKUs in Product
|
|
574
|
+
|
|
575
|
+
Retrieve all SKUs for a given product.
|
|
576
|
+
|
|
577
|
+
### Examples
|
|
578
|
+
|
|
579
|
+
```ruby
|
|
580
|
+
require 'time'
|
|
581
|
+
require 'VoucherifySdk'
|
|
582
|
+
# setup authorization
|
|
583
|
+
VoucherifySdk.configure do |config|
|
|
584
|
+
# Configure API key authorization: X-App-Id
|
|
585
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
586
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
587
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
588
|
+
|
|
589
|
+
# Configure API key authorization: X-App-Token
|
|
590
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
591
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
592
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
593
|
+
end
|
|
594
|
+
|
|
595
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
596
|
+
product_id = 'product_id_example' # String | A Voucherify product ID or product source ID.
|
|
597
|
+
opts = {
|
|
598
|
+
limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
|
|
599
|
+
page: 56, # Integer | Which page of results to return.
|
|
600
|
+
order: VoucherifySdk::ParameterOrder::CREATED_AT, # ParameterOrder | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
601
|
+
start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
|
|
602
|
+
end_date: Time.parse('2013-10-20T19:20:30+01:00') # Time | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
begin
|
|
606
|
+
# List SKUs in Product
|
|
607
|
+
result = api_instance.list_skus_in_product(product_id, opts)
|
|
608
|
+
p result
|
|
609
|
+
rescue VoucherifySdk::ApiError => e
|
|
610
|
+
puts "Error when calling ProductsApi->list_skus_in_product: #{e}"
|
|
611
|
+
end
|
|
612
|
+
```
|
|
613
|
+
|
|
614
|
+
### Parameters
|
|
615
|
+
|
|
616
|
+
| Name | Type | Description | Notes |
|
|
617
|
+
| ---- | ---- | ----------- | ----- |
|
|
618
|
+
| **product_id** | **String** | A Voucherify product ID or product source ID. | |
|
|
619
|
+
| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
|
|
620
|
+
| **page** | **Integer** | Which page of results to return. | [optional] |
|
|
621
|
+
| **order** | [**ParameterOrder**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
622
|
+
| **start_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
|
|
623
|
+
| **end_date** | **Time** | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. | [optional] |
|
|
624
|
+
|
|
625
|
+
### Return type
|
|
626
|
+
|
|
627
|
+
[**ProductsSkusListResponseBody**](ProductsSkusListResponseBody.md)
|
|
628
|
+
|
|
629
|
+
### Authorization
|
|
630
|
+
|
|
631
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
632
|
+
|
|
633
|
+
### HTTP request headers
|
|
634
|
+
|
|
635
|
+
- **Content-Type**: Not defined
|
|
636
|
+
- **Accept**: application/json
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
## update_product
|
|
640
|
+
|
|
641
|
+
> <ProductsUpdateResponseBody> update_product(product_id, opts)
|
|
642
|
+
|
|
643
|
+
Update Product
|
|
644
|
+
|
|
645
|
+
Updates the specified product by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.
|
|
646
|
+
|
|
647
|
+
### Examples
|
|
648
|
+
|
|
649
|
+
```ruby
|
|
650
|
+
require 'time'
|
|
651
|
+
require 'VoucherifySdk'
|
|
652
|
+
# setup authorization
|
|
653
|
+
VoucherifySdk.configure do |config|
|
|
654
|
+
# Configure API key authorization: X-App-Id
|
|
655
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
656
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
657
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
658
|
+
|
|
659
|
+
# Configure API key authorization: X-App-Token
|
|
660
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
661
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
662
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
663
|
+
end
|
|
664
|
+
|
|
665
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
666
|
+
product_id = 'product_id_example' # String | A Voucherify product ID or source ID.
|
|
667
|
+
opts = {
|
|
668
|
+
products_update_request_body: VoucherifySdk::ProductsUpdateRequestBody.new # ProductsUpdateRequestBody | Specify the parameters of the product that are to be updated.
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
begin
|
|
672
|
+
# Update Product
|
|
673
|
+
result = api_instance.update_product(product_id, opts)
|
|
674
|
+
p result
|
|
675
|
+
rescue VoucherifySdk::ApiError => e
|
|
676
|
+
puts "Error when calling ProductsApi->update_product: #{e}"
|
|
677
|
+
end
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
### Parameters
|
|
681
|
+
|
|
682
|
+
| Name | Type | Description | Notes |
|
|
683
|
+
| ---- | ---- | ----------- | ----- |
|
|
684
|
+
| **product_id** | **String** | A Voucherify product ID or source ID. | |
|
|
685
|
+
| **products_update_request_body** | [**ProductsUpdateRequestBody**](ProductsUpdateRequestBody.md) | Specify the parameters of the product that are to be updated. | [optional] |
|
|
686
|
+
|
|
687
|
+
### Return type
|
|
688
|
+
|
|
689
|
+
[**ProductsUpdateResponseBody**](ProductsUpdateResponseBody.md)
|
|
690
|
+
|
|
691
|
+
### Authorization
|
|
692
|
+
|
|
693
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
694
|
+
|
|
695
|
+
### HTTP request headers
|
|
696
|
+
|
|
697
|
+
- **Content-Type**: application/json
|
|
698
|
+
- **Accept**: application/json
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
## update_products_in_bulk
|
|
702
|
+
|
|
703
|
+
> <ProductsUpdateInBulkResponseBody> update_products_in_bulk(opts)
|
|
704
|
+
|
|
705
|
+
Update Products in bulk
|
|
706
|
+
|
|
707
|
+
Update several products in one asynchronous operation. In one request, it is possible to update a maximum of **100** records. In the response body, you get a unique async action identifier. If a requested product object is not found, then an **upsert** occurs. This is reflected in the Get Async Action endpoint as follows: This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.
|
|
708
|
+
|
|
709
|
+
### Examples
|
|
710
|
+
|
|
711
|
+
```ruby
|
|
712
|
+
require 'time'
|
|
713
|
+
require 'VoucherifySdk'
|
|
714
|
+
# setup authorization
|
|
715
|
+
VoucherifySdk.configure do |config|
|
|
716
|
+
# Configure API key authorization: X-App-Id
|
|
717
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
718
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
719
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
720
|
+
|
|
721
|
+
# Configure API key authorization: X-App-Token
|
|
722
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
723
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
724
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
725
|
+
end
|
|
726
|
+
|
|
727
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
728
|
+
opts = {
|
|
729
|
+
products_update_in_bulk_request_body: [VoucherifySdk::ProductsUpdateInBulkRequestBody.new({source_id: 'test_prod_id_1'})] # Array<ProductsUpdateInBulkRequestBody> | Create an array of product objects, each with the parameters which you want to update.
|
|
730
|
+
}
|
|
731
|
+
|
|
732
|
+
begin
|
|
733
|
+
# Update Products in bulk
|
|
734
|
+
result = api_instance.update_products_in_bulk(opts)
|
|
735
|
+
p result
|
|
736
|
+
rescue VoucherifySdk::ApiError => e
|
|
737
|
+
puts "Error when calling ProductsApi->update_products_in_bulk: #{e}"
|
|
738
|
+
end
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### Parameters
|
|
742
|
+
|
|
743
|
+
| Name | Type | Description | Notes |
|
|
744
|
+
| ---- | ---- | ----------- | ----- |
|
|
745
|
+
| **products_update_in_bulk_request_body** | [**Array<ProductsUpdateInBulkRequestBody>**](ProductsUpdateInBulkRequestBody.md) | Create an array of product objects, each with the parameters which you want to update. | [optional] |
|
|
746
|
+
|
|
747
|
+
### Return type
|
|
748
|
+
|
|
749
|
+
[**ProductsUpdateInBulkResponseBody**](ProductsUpdateInBulkResponseBody.md)
|
|
750
|
+
|
|
751
|
+
### Authorization
|
|
752
|
+
|
|
753
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
754
|
+
|
|
755
|
+
### HTTP request headers
|
|
756
|
+
|
|
757
|
+
- **Content-Type**: application/json
|
|
758
|
+
- **Accept**: application/json
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
## update_products_metadata_in_bulk
|
|
762
|
+
|
|
763
|
+
> <ProductsMetadataUpdateInBulkResponseBody> update_products_metadata_in_bulk(opts)
|
|
764
|
+
|
|
765
|
+
Update Products' Metadata in bulk
|
|
766
|
+
|
|
767
|
+
Update several product metadata properties in one asynchronous operation. In one request, it is possible to update a maximum of **100** records. In the response body, you get a unique async action identifier. If a requested product object is not found, then an **upsert** occurs. This is reflected in the Get Async Action endpoint as follows: This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.
|
|
768
|
+
|
|
769
|
+
### Examples
|
|
770
|
+
|
|
771
|
+
```ruby
|
|
772
|
+
require 'time'
|
|
773
|
+
require 'VoucherifySdk'
|
|
774
|
+
# setup authorization
|
|
775
|
+
VoucherifySdk.configure do |config|
|
|
776
|
+
# Configure API key authorization: X-App-Id
|
|
777
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
778
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
779
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
780
|
+
|
|
781
|
+
# Configure API key authorization: X-App-Token
|
|
782
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
783
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
784
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
785
|
+
end
|
|
786
|
+
|
|
787
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
788
|
+
opts = {
|
|
789
|
+
products_metadata_update_in_bulk_request_body: VoucherifySdk::ProductsMetadataUpdateInBulkRequestBody.new({source_ids: ['source_ids_example'], metadata: 3.56}) # ProductsMetadataUpdateInBulkRequestBody | Specify the list of product source IDs and the metadata key value pairs to be udpated for these products.
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
begin
|
|
793
|
+
# Update Products' Metadata in bulk
|
|
794
|
+
result = api_instance.update_products_metadata_in_bulk(opts)
|
|
795
|
+
p result
|
|
796
|
+
rescue VoucherifySdk::ApiError => e
|
|
797
|
+
puts "Error when calling ProductsApi->update_products_metadata_in_bulk: #{e}"
|
|
798
|
+
end
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
### Parameters
|
|
802
|
+
|
|
803
|
+
| Name | Type | Description | Notes |
|
|
804
|
+
| ---- | ---- | ----------- | ----- |
|
|
805
|
+
| **products_metadata_update_in_bulk_request_body** | [**ProductsMetadataUpdateInBulkRequestBody**](ProductsMetadataUpdateInBulkRequestBody.md) | Specify the list of product source IDs and the metadata key value pairs to be udpated for these products. | [optional] |
|
|
806
|
+
|
|
807
|
+
### Return type
|
|
808
|
+
|
|
809
|
+
[**ProductsMetadataUpdateInBulkResponseBody**](ProductsMetadataUpdateInBulkResponseBody.md)
|
|
810
|
+
|
|
811
|
+
### Authorization
|
|
812
|
+
|
|
813
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
814
|
+
|
|
815
|
+
### HTTP request headers
|
|
816
|
+
|
|
817
|
+
- **Content-Type**: application/json
|
|
818
|
+
- **Accept**: application/json
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
## update_sku
|
|
822
|
+
|
|
823
|
+
> <ProductsSkusUpdateResponseBody> update_sku(product_id, sku_id, opts)
|
|
824
|
+
|
|
825
|
+
Update SKU
|
|
826
|
+
|
|
827
|
+
Updates the specified SKU by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body schema wont be modified. Even if provided, they will be silently skipped.
|
|
828
|
+
|
|
829
|
+
### Examples
|
|
830
|
+
|
|
831
|
+
```ruby
|
|
832
|
+
require 'time'
|
|
833
|
+
require 'VoucherifySdk'
|
|
834
|
+
# setup authorization
|
|
835
|
+
VoucherifySdk.configure do |config|
|
|
836
|
+
# Configure API key authorization: X-App-Id
|
|
837
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
838
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
839
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
840
|
+
|
|
841
|
+
# Configure API key authorization: X-App-Token
|
|
842
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
843
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
844
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
845
|
+
end
|
|
846
|
+
|
|
847
|
+
api_instance = VoucherifySdk::ProductsApi.new
|
|
848
|
+
product_id = 'product_id_example' # String | A unique Voucherify product ID or product source ID.
|
|
849
|
+
sku_id = 'sku_id_example' # String | A Voucherify SKU ID or SKU source ID.
|
|
850
|
+
opts = {
|
|
851
|
+
products_skus_update_request_body: VoucherifySdk::ProductsSkusUpdateRequestBody.new # ProductsSkusUpdateRequestBody | Specify the parameters to be updated.
|
|
852
|
+
}
|
|
853
|
+
|
|
854
|
+
begin
|
|
855
|
+
# Update SKU
|
|
856
|
+
result = api_instance.update_sku(product_id, sku_id, opts)
|
|
857
|
+
p result
|
|
858
|
+
rescue VoucherifySdk::ApiError => e
|
|
859
|
+
puts "Error when calling ProductsApi->update_sku: #{e}"
|
|
860
|
+
end
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
### Parameters
|
|
864
|
+
|
|
865
|
+
| Name | Type | Description | Notes |
|
|
866
|
+
| ---- | ---- | ----------- | ----- |
|
|
867
|
+
| **product_id** | **String** | A unique Voucherify product ID or product source ID. | |
|
|
868
|
+
| **sku_id** | **String** | A Voucherify SKU ID or SKU source ID. | |
|
|
869
|
+
| **products_skus_update_request_body** | [**ProductsSkusUpdateRequestBody**](ProductsSkusUpdateRequestBody.md) | Specify the parameters to be updated. | [optional] |
|
|
870
|
+
|
|
871
|
+
### Return type
|
|
872
|
+
|
|
873
|
+
[**ProductsSkusUpdateResponseBody**](ProductsSkusUpdateResponseBody.md)
|
|
874
|
+
|
|
875
|
+
### Authorization
|
|
876
|
+
|
|
877
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
878
|
+
|
|
879
|
+
### HTTP request headers
|
|
880
|
+
|
|
881
|
+
- **Content-Type**: application/json
|
|
882
|
+
- **Accept**: application/json
|
|
883
|
+
|