voucherify 6.0.0 → 7.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 +1 -1
- data/ENDPOINTS-COVERAGE.md +94 -95
- data/EXAMPLES.md +3 -3
- data/Gemfile.lock +4 -4
- data/README.md +345 -9
- data/__tests__/lib/stackables.rb +18 -0
- data/__tests__/spec/09_redemptions_spec.rb +5 -0
- data/docs/ApplicableTo.md +7 -7
- data/docs/BinApi.md +132 -0
- data/docs/Campaign.md +40 -0
- data/docs/CampaignBase.md +1 -0
- data/docs/CampaignTemplate.md +14 -0
- data/docs/CampaignsApi.md +3 -1
- data/docs/CampaignsCreateRequestBody.md +1 -2
- data/docs/CampaignsCreateResponseBody.md +1 -0
- data/docs/CampaignsGetResponseBody.md +1 -0
- data/docs/CampaignsUpdateRequestBody.md +1 -4
- data/docs/CampaignsUpdateResponseBody.md +1 -0
- data/docs/CampaignsVouchersCreateCombinedResponseBodyPublish.md +1 -1
- data/docs/CampaignsVouchersCreateCombinedResponseBodyRedemption.md +1 -1
- data/docs/CampaignsVouchersCreateResponseBodyPublish.md +1 -1
- data/docs/CampaignsVouchersCreateResponseBodyRedemption.md +1 -1
- data/docs/CategoriesCreateRequestBody.md +1 -1
- data/docs/CategoriesCreateResponseBody.md +1 -1
- data/docs/CategoriesGetResponseBody.md +1 -2
- data/docs/CategoriesUpdateRequestBody.md +1 -1
- data/docs/CategoriesUpdateResponseBody.md +1 -1
- data/docs/Category.md +1 -2
- data/docs/CategoryWithStackingRulesType.md +14 -0
- data/docs/ClientPromotionsTiersListResponseBody.md +1 -1
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md +1 -1
- data/docs/CustomersActivityListResponseBody.md +1 -1
- data/docs/CustomersApi.md +2 -64
- data/docs/Error.md +1 -1
- data/docs/ExportsApi.md +13 -1
- data/docs/{ParameterFiltersListCustomerRedeemablesCreatedAtConditions.md → FilterConditionsDateTime.md} +1 -1
- data/docs/InapplicableTo.md +7 -7
- data/docs/Location.md +13 -0
- data/docs/LocationShape.md +11 -0
- data/docs/LocationShapeDistance.md +9 -0
- data/docs/LocationShapeGeojson.md +9 -0
- data/docs/LocationsApi.md +133 -0
- data/docs/LocationsGetResponseBody.md +13 -0
- data/docs/LocationsGetResponseBodyShape.md +11 -0
- data/docs/LocationsGetResponseBodyShapeDistance.md +9 -0
- data/docs/LocationsGetResponseBodyShapeGeojson.md +9 -0
- data/docs/LocationsListResponseBody.md +12 -0
- data/docs/LoyaltiesApi.md +9 -3
- data/docs/LoyaltiesCreateCampaignRequestBody.md +1 -1
- data/docs/LoyaltiesCreateCampaignResponseBody.md +1 -0
- data/docs/LoyaltiesGetCampaignResponseBody.md +1 -0
- data/docs/LoyaltiesMemberActivityListResponseBody.md +1 -1
- data/docs/LoyaltiesMembersCreateResponseBodyPublish.md +1 -1
- data/docs/LoyaltiesMembersCreateResponseBodyRedemption.md +1 -1
- data/docs/LoyaltiesMembersGetResponseBodyPublish.md +1 -1
- data/docs/LoyaltiesMembersGetResponseBodyRedemption.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyChannel.md +2 -2
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucher.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherPublish.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherRedemption.md +1 -1
- data/docs/LoyaltiesMembersTransactionsListResponseBody.md +2 -1
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyPublish.md +1 -1
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyRedemption.md +1 -1
- data/docs/LoyaltiesRewardAssignmentsGetResponseBodyParametersLoyalty.md +1 -0
- data/docs/LoyaltiesRewardsCreateAssignmentResponseBodyParametersLoyalty.md +1 -0
- data/docs/LoyaltiesRewardsGetResponseBodyParametersLoyalty.md +1 -0
- data/docs/LoyaltiesRewardsUpdateAssignmentRequestBodyParametersLoyalty.md +1 -0
- data/docs/LoyaltiesRewardsUpdateAssignmentResponseBodyParametersLoyalty.md +1 -0
- data/docs/LoyaltiesUpdateCampaignResponseBody.md +1 -0
- data/docs/LoyaltyCampaign.md +1 -0
- data/docs/LoyaltyMemberPublish.md +1 -1
- data/docs/LoyaltyMemberRedemption.md +1 -1
- data/docs/ManagementApi.md +2348 -0
- data/docs/ManagementProject.md +30 -0
- data/docs/ManagementProjectApiUsageNotifications.md +13 -0
- data/docs/ManagementProjectDefaultCodeConfig.md +8 -0
- data/docs/ManagementProjectLimits.md +9 -0
- data/docs/ManagementProjectLimitsApiCallsItem.md +9 -0
- data/docs/ManagementProjectLimitsBulkApiCallsItem.md +9 -0
- data/docs/ManagementProjectWebhooksCalloutNotifications.md +9 -0
- data/docs/ManagementProjectWebhooksCalloutNotificationsDistributions.md +10 -0
- data/docs/ManagementProjectWebhooksCalloutNotificationsWebhooks.md +10 -0
- data/docs/ManagementProjectsBranding.md +12 -0
- data/docs/ManagementProjectsBrandingAddress.md +12 -0
- data/docs/ManagementProjectsBrandingBrand.md +12 -0
- data/docs/ManagementProjectsBrandingCockpits.md +15 -0
- data/docs/ManagementProjectsBrandingContact.md +9 -0
- data/docs/ManagementProjectsBrandingCreateRequestBody.md +11 -0
- data/docs/ManagementProjectsBrandingCreateRequestBodyAddress.md +12 -0
- data/docs/ManagementProjectsBrandingCreateRequestBodyBrand.md +12 -0
- data/docs/ManagementProjectsBrandingCreateRequestBodyCockpits.md +15 -0
- data/docs/ManagementProjectsBrandingCreateRequestBodyContact.md +9 -0
- data/docs/ManagementProjectsBrandingCreateResponseBody.md +12 -0
- data/docs/ManagementProjectsBrandingCreateResponseBodyAddress.md +12 -0
- data/docs/ManagementProjectsBrandingCreateResponseBodyBrand.md +12 -0
- data/docs/ManagementProjectsBrandingCreateResponseBodyCockpits.md +15 -0
- data/docs/ManagementProjectsBrandingCreateResponseBodyContact.md +9 -0
- data/docs/ManagementProjectsBrandingGetResponseBody.md +12 -0
- data/docs/ManagementProjectsBrandingGetResponseBodyAddress.md +12 -0
- data/docs/ManagementProjectsBrandingGetResponseBodyBrand.md +12 -0
- data/docs/ManagementProjectsBrandingGetResponseBodyCockpits.md +15 -0
- data/docs/ManagementProjectsBrandingGetResponseBodyContact.md +9 -0
- data/docs/ManagementProjectsBrandingListResponseBody.md +11 -0
- data/docs/ManagementProjectsBrandingUpdateRequestBody.md +11 -0
- data/docs/ManagementProjectsBrandingUpdateRequestBodyAddress.md +12 -0
- data/docs/ManagementProjectsBrandingUpdateRequestBodyBrand.md +12 -0
- data/docs/ManagementProjectsBrandingUpdateRequestBodyCockpits.md +15 -0
- data/docs/ManagementProjectsBrandingUpdateRequestBodyContact.md +9 -0
- data/docs/ManagementProjectsBrandingUpdateResponseBody.md +12 -0
- data/docs/ManagementProjectsBrandingUpdateResponseBodyAddress.md +12 -0
- data/docs/ManagementProjectsBrandingUpdateResponseBodyBrand.md +12 -0
- data/docs/ManagementProjectsBrandingUpdateResponseBodyCockpits.md +15 -0
- data/docs/ManagementProjectsBrandingUpdateResponseBodyContact.md +9 -0
- data/docs/ManagementProjectsCreateRequestBody.md +26 -0
- data/docs/ManagementProjectsCreateRequestBodyApiUsageNotifications.md +12 -0
- data/docs/ManagementProjectsCreateRequestBodyUsersItem.md +10 -0
- data/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications.md +9 -0
- data/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsDistributions.md +10 -0
- data/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsWebhooks.md +10 -0
- data/docs/ManagementProjectsCreateResponseBody.md +30 -0
- data/docs/ManagementProjectsCreateResponseBodyApiUsageNotifications.md +13 -0
- data/docs/ManagementProjectsCreateResponseBodyClientSideKey.md +9 -0
- data/docs/ManagementProjectsCreateResponseBodyServerSideKey.md +9 -0
- data/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotifications.md +9 -0
- data/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsDistributions.md +10 -0
- data/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsWebhooks.md +10 -0
- data/docs/ManagementProjectsCustomEventSchema.md +13 -0
- data/docs/ManagementProjectsCustomEventSchemaSchema.md +8 -0
- data/docs/ManagementProjectsCustomEventSchemasCreateRequestBody.md +9 -0
- data/docs/ManagementProjectsCustomEventSchemasCreateRequestBodySchema.md +8 -0
- data/docs/ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntry.md +10 -0
- data/docs/ManagementProjectsCustomEventSchemasCreateResponseBody.md +13 -0
- data/docs/ManagementProjectsCustomEventSchemasCreateResponseBodySchema.md +8 -0
- data/docs/ManagementProjectsCustomEventSchemasGetResponseBody.md +13 -0
- data/docs/ManagementProjectsCustomEventSchemasGetResponseBodySchema.md +8 -0
- data/docs/ManagementProjectsCustomEventSchemasListResponseBody.md +11 -0
- data/docs/ManagementProjectsCustomEventSchemasUpdateRequestBody.md +8 -0
- data/docs/ManagementProjectsCustomEventSchemasUpdateRequestBodySchema.md +8 -0
- data/docs/ManagementProjectsCustomEventSchemasUpdateResponseBody.md +13 -0
- data/docs/ManagementProjectsCustomEventSchemasUpdateResponseBodySchema.md +8 -0
- data/docs/ManagementProjectsGetResponseBody.md +30 -0
- data/docs/ManagementProjectsGetResponseBodyApiUsageNotifications.md +13 -0
- data/docs/ManagementProjectsGetResponseBodyDefaultCodeConfig.md +8 -0
- data/docs/ManagementProjectsGetResponseBodyLimits.md +9 -0
- data/docs/ManagementProjectsGetResponseBodyLimitsApiCallsItem.md +9 -0
- data/docs/ManagementProjectsGetResponseBodyLimitsBulkApiCallsItem.md +9 -0
- data/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotifications.md +9 -0
- data/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsDistributions.md +10 -0
- data/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsWebhooks.md +10 -0
- data/docs/ManagementProjectsListResponseBody.md +11 -0
- data/docs/ManagementProjectsMetadataSchema.md +14 -0
- data/docs/ManagementProjectsMetadataSchemaDefinition.md +21 -0
- data/docs/ManagementProjectsMetadataSchemasCreateRequestBody.md +10 -0
- data/docs/ManagementProjectsMetadataSchemasCreateResponseBody.md +14 -0
- data/docs/ManagementProjectsMetadataSchemasGetResponseBody.md +14 -0
- data/docs/ManagementProjectsMetadataSchemasListResponseBody.md +11 -0
- data/docs/ManagementProjectsMetadataSchemasUpdateRequestBody.md +9 -0
- data/docs/ManagementProjectsMetadataSchemasUpdateResponseBody.md +14 -0
- data/docs/ManagementProjectsStackingRules.md +22 -0
- data/docs/ManagementProjectsStackingRulesCreateRequestBody.md +19 -0
- data/docs/ManagementProjectsStackingRulesCreateResponseBody.md +22 -0
- data/docs/ManagementProjectsStackingRulesGetResponseBody.md +22 -0
- data/docs/ManagementProjectsStackingRulesListResponseBody.md +11 -0
- data/docs/ManagementProjectsStackingRulesUpdateRequestBody.md +19 -0
- data/docs/ManagementProjectsStackingRulesUpdateResponseBody.md +22 -0
- data/docs/ManagementProjectsTemplatesCampaignsCopyCreateRequestBody.md +10 -0
- data/docs/ManagementProjectsTemplatesCampaignsCopyCreateResponseBody.md +13 -0
- data/docs/ManagementProjectsTemplatesCampaignsListResponseBody.md +13 -0
- data/docs/ManagementProjectsUpdateRequestBody.md +23 -0
- data/docs/ManagementProjectsUpdateRequestBodyApiUsageNotifications.md +12 -0
- data/docs/ManagementProjectsUpdateRequestBodyDefaultCodeConfig.md +8 -0
- data/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotifications.md +9 -0
- data/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsDistributions.md +10 -0
- data/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsWebhooks.md +10 -0
- data/docs/ManagementProjectsUpdateResponseBody.md +30 -0
- data/docs/ManagementProjectsUpdateResponseBodyApiUsageNotifications.md +13 -0
- data/docs/ManagementProjectsUpdateResponseBodyDefaultCodeConfig.md +8 -0
- data/docs/ManagementProjectsUpdateResponseBodyLimits.md +9 -0
- data/docs/ManagementProjectsUpdateResponseBodyLimitsApiCallsItem.md +9 -0
- data/docs/ManagementProjectsUpdateResponseBodyLimitsBulkApiCallsItem.md +9 -0
- data/docs/ManagementProjectsUpdateResponseBodyWebhooksCalloutNotifications.md +9 -0
- data/docs/ManagementProjectsUpdateResponseBodyWebhooksCalloutNotificationsDistributions.md +10 -0
- data/docs/ManagementProjectsUpdateResponseBodyWebhooksCalloutNotificationsWebhooks.md +10 -0
- data/docs/ManagementProjectsUsersAssignRequestBody.md +10 -0
- data/docs/ManagementProjectsUsersAssignResponseBody.md +14 -0
- data/docs/ManagementProjectsUsersGetUserResponseBody.md +14 -0
- data/docs/ManagementProjectsUsersInviteCreateRequestBody.md +11 -0
- data/docs/ManagementProjectsUsersListResponseBody.md +11 -0
- data/docs/ManagementProjectsUsersUpdateRoleRequestBody.md +8 -0
- data/docs/ManagementProjectsUsersUpdateRoleResponseBody.md +14 -0
- data/docs/ManagementProjectsWebhook.md +13 -0
- data/docs/ManagementProjectsWebhooksCreateRequestBody.md +10 -0
- data/docs/ManagementProjectsWebhooksCreateResponseBody.md +13 -0
- data/docs/ManagementProjectsWebhooksGetResponseBody.md +13 -0
- data/docs/ManagementProjectsWebhooksListResponseBody.md +11 -0
- data/docs/ManagementProjectsWebhooksUpdateRequestBody.md +10 -0
- data/docs/ManagementProjectsWebhooksUpdateResponseBody.md +13 -0
- data/docs/MetadataSchemaDefinitionDeprecated.md +21 -0
- data/docs/MetadataSchemaDeprecated.md +14 -0
- data/docs/MetadataSchemasApi.md +122 -0
- data/docs/MetadataSchemasGetResponseBody.md +14 -0
- data/docs/MetadataSchemasListResponseBody.md +11 -0
- data/docs/Order.md +1 -1
- data/docs/OrderCalculated.md +1 -1
- data/docs/OrderItemProduct.md +1 -1
- data/docs/OrdersCreateRequestBody.md +1 -1
- data/docs/OrdersCreateResponseBody.md +1 -1
- data/docs/OrdersGetResponseBody.md +1 -1
- data/docs/OrdersImportCreateRequestBodyItem.md +1 -1
- data/docs/OrdersUpdateRequestBody.md +1 -1
- data/docs/OrdersUpdateResponseBody.md +1 -1
- data/docs/ParameterFiltersListBin.md +12 -0
- data/docs/ParameterFiltersListBinId.md +8 -0
- data/docs/ParameterFiltersListBinResourceId.md +8 -0
- data/docs/ParameterFiltersListBinResourceName.md +8 -0
- data/docs/ParameterFiltersListBinResourceType.md +8 -0
- data/docs/ParameterFiltersListBinResourceTypeConditions.md +15 -0
- data/docs/ParameterFiltersListCampaigns.md +14 -0
- data/docs/ParameterFiltersListCampaignsCampaignStatus.md +8 -0
- data/docs/ParameterFiltersListCampaignsCampaignStatusConditions.md +15 -0
- data/docs/ParameterFiltersListCampaignsCategories.md +8 -0
- data/docs/ParameterFiltersListCampaignsCategoryIds.md +8 -0
- data/docs/ParameterFiltersListCampaignsIsReferralCode.md +9 -0
- data/docs/ParameterFiltersListCampaignsValidityTimeframe.md +8 -0
- data/docs/ParameterFiltersListCampaignsVoucherType.md +8 -0
- data/docs/ParameterFiltersListCustomerRedeemables.md +1 -0
- data/docs/ParameterFiltersListCustomerRedeemablesCampaignId.md +0 -1
- data/docs/ParameterFiltersListCustomerRedeemablesCampaignType.md +0 -1
- data/docs/ParameterFiltersListCustomerRedeemablesCreatedAt.md +1 -2
- data/docs/ParameterFiltersListCustomerRedeemablesHolderRole.md +0 -1
- data/docs/ParameterFiltersListCustomerRedeemablesId.md +0 -1
- data/docs/ParameterFiltersListCustomerRedeemablesRedeemableId.md +0 -1
- data/docs/ParameterFiltersListCustomerRedeemablesRedeemableObject.md +0 -1
- data/docs/ParameterFiltersListCustomerRedeemablesVoucherType.md +0 -1
- data/docs/ParameterFiltersListLocations.md +10 -0
- data/docs/ParameterFiltersListLocationsCreatedAt.md +8 -0
- data/docs/ParameterFiltersListLocationsName.md +8 -0
- data/docs/ParameterFiltersListLocationsUpdatedAt.md +8 -0
- data/docs/ParameterFiltersListPublications.md +17 -0
- data/docs/ParameterFiltersListPublicationsCampaignName.md +8 -0
- data/docs/ParameterFiltersListPublicationsCustomerId.md +8 -0
- data/docs/ParameterFiltersListPublicationsFailureCode.md +8 -0
- data/docs/ParameterFiltersListPublicationsIsReferralCode.md +8 -0
- data/docs/ParameterFiltersListPublicationsParentObjectId.md +8 -0
- data/docs/ParameterFiltersListPublicationsRelatedObjectId.md +8 -0
- data/docs/ParameterFiltersListPublicationsResult.md +8 -0
- data/docs/ParameterFiltersListPublicationsSourceId.md +8 -0
- data/docs/ParameterFiltersListPublicationsVoucherType.md +8 -0
- data/docs/ParameterFiltersListRedemptions.md +1 -0
- data/docs/ParameterFiltersListRedemptionsCampaignName.md +0 -1
- data/docs/ParameterFiltersListRedemptionsCustomerId.md +0 -1
- data/docs/ParameterFiltersListRedemptionsFailureCode.md +0 -1
- data/docs/ParameterFiltersListRedemptionsObject.md +0 -1
- data/docs/ParameterFiltersListRedemptionsParentRedemptionId.md +0 -1
- data/docs/ParameterFiltersListRedemptionsRelatedObjectId.md +0 -1
- data/docs/ParameterFiltersListRedemptionsRelatedObjectParentId.md +0 -1
- data/docs/ParameterFiltersListRedemptionsResult.md +0 -1
- data/docs/ParameterFiltersListRedemptionsUserLogin.md +0 -1
- data/docs/ParameterFiltersListRedemptionsVoucherCode.md +0 -1
- data/docs/ParameterFiltersListReferralsRedeemableHolders.md +12 -0
- data/docs/ParameterFiltersListReferralsRedeemableHoldersCreatedAt.md +8 -0
- data/docs/ParameterFiltersListReferralsRedeemableHoldersCustomerId.md +8 -0
- data/docs/ParameterFiltersListReferralsRedeemableHoldersHolderRole.md +8 -0
- data/docs/ParameterFiltersListReferralsRedeemableHoldersHolderRoleConditions.md +15 -0
- data/docs/ParameterFiltersListReferralsRedeemableHoldersId.md +8 -0
- data/docs/ParameterFiltersListTemplates.md +11 -0
- data/docs/ParameterFiltersListTemplatesCampaignType.md +8 -0
- data/docs/ParameterFiltersListTemplatesCampaignTypeConditions.md +15 -0
- data/docs/ParameterFiltersListTemplatesId.md +8 -0
- data/docs/ParameterFiltersListTemplatesName.md +8 -0
- data/docs/ParameterOrderListBin.md +7 -0
- data/docs/ParameterOrderListLocations.md +7 -0
- data/docs/ParameterOrderListTransactions.md +7 -0
- data/docs/ParameterTemplatesList.md +7 -0
- data/docs/ProductCollectionsCreateRequestBody.md +1 -1
- data/docs/ProductCollectionsCreateResponseBody.md +1 -1
- data/docs/ProductCollectionsGetResponseBody.md +1 -1
- data/docs/ProductCollectionsItem.md +1 -1
- data/docs/ProductsApi.md +2 -2
- data/docs/PromotionTiersList.md +1 -1
- data/docs/PromotionsStacksUpdateRequestBodyTiers.md +1 -1
- data/docs/PromotionsTiersCreateRequestBody.md +2 -2
- data/docs/PromotionsTiersListResponseBody.md +1 -1
- data/docs/PublicationsApi.md +2 -2
- data/docs/PublicationsCreateRequestBody.md +1 -1
- data/docs/QualificationsOption.md +1 -1
- data/docs/QualificationsRedeemable.md +1 -1
- data/docs/QualificationsRedeemableBase.md +1 -1
- data/docs/RedeemableHolder.md +18 -0
- data/docs/RedeemableVoucherPublish.md +1 -1
- data/docs/RedeemableVoucherRedemption.md +1 -1
- data/docs/Redemption.md +1 -1
- data/docs/RedemptionChannel.md +2 -2
- data/docs/RedemptionEntry.md +1 -1
- data/docs/RedemptionEntryChannel.md +1 -1
- data/docs/RedemptionEntryOrder.md +1 -1
- data/docs/RedemptionEntryVoucherPublish.md +1 -1
- data/docs/RedemptionEntryVoucherRedemption.md +1 -1
- data/docs/RedemptionVoucher.md +1 -1
- data/docs/RedemptionVoucherPublish.md +1 -1
- data/docs/RedemptionVoucherRedemption.md +1 -1
- data/docs/RedemptionsGetResponseBody.md +1 -1
- data/docs/RedemptionsGetResponseBodyChannel.md +1 -1
- data/docs/RedemptionsGetResponseBodyOrder.md +1 -1
- data/docs/RedemptionsGetResponseBodyVoucherPublish.md +1 -1
- data/docs/RedemptionsGetResponseBodyVoucherRedemption.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItem.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemChannel.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherPublish.md +1 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherRedemption.md +1 -1
- data/docs/ReferralsApi.md +397 -0
- data/docs/ReferralsMembersHoldersCreateInBulkRequestBody.md +9 -0
- data/docs/ReferralsMembersHoldersCreateInBulkResponseBody.md +8 -0
- data/docs/ReferralsMembersHoldersListResponseBody.md +13 -0
- data/docs/RewardAssignmentParametersLoyalty.md +1 -0
- data/docs/RewardsAssignmentsCreateRequestBodyParametersLoyalty.md +1 -0
- data/docs/RewardsAssignmentsCreateResponseBodyParametersLoyalty.md +1 -0
- data/docs/RewardsAssignmentsGetResponseBodyParametersLoyalty.md +1 -0
- data/docs/RewardsAssignmentsUpdateRequestBodyParametersLoyalty.md +1 -0
- data/docs/RewardsAssignmentsUpdateResponseBodyParametersLoyalty.md +1 -0
- data/docs/TemplatesApi.md +443 -0
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +24 -0
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher.md +9 -0
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption.md +8 -0
- data/docs/TemplatesCampaignsCampaignSetupCreateResponseBody.md +10 -0
- data/docs/TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem.md +9 -0
- data/docs/TemplatesCampaignsCreateRequestBody.md +11 -0
- data/docs/TemplatesCampaignsCreateTemplateResponseBody.md +13 -0
- data/docs/TemplatesCampaignsGetResponseBody.md +14 -0
- data/docs/TemplatesCampaignsListResponseBody.md +13 -0
- data/docs/TemplatesCampaignsTierSetupCreateRequestBody.md +20 -0
- data/docs/TemplatesCampaignsTierSetupCreateResponseBody.md +10 -0
- data/docs/TemplatesCampaignsTierSetupCreateResponseBodyCreatedResourcesItem.md +9 -0
- data/docs/TemplatesCampaignsUpdateRequestBody.md +9 -0
- data/docs/TemplatesCampaignsUpdateResponseBody.md +14 -0
- data/docs/TrashBinItem.md +15 -0
- data/docs/TrashBinListResponseBody.md +13 -0
- data/docs/UsageNotifications.md +11 -0
- data/docs/User.md +14 -0
- data/docs/ValidationRule.md +1 -1
- data/docs/ValidationRulesCreateRequestBody.md +1 -1
- data/docs/ValidationRulesCreateResponseBody.md +1 -1
- data/docs/ValidationRulesGetResponseBody.md +1 -1
- data/docs/ValidationRulesUpdateRequestBody.md +1 -1
- data/docs/ValidationRulesUpdateResponseBody.md +1 -1
- data/docs/ValidationsRedeemableInapplicable.md +1 -1
- data/docs/ValidationsRedeemableSkipped.md +1 -1
- data/docs/ValidationsValidateResponseBodyRedeemablesItem.md +1 -1
- data/docs/VoucherPublish.md +1 -1
- data/docs/VoucherRedemption.md +1 -1
- data/docs/VoucherWithCategoriesPublish.md +1 -1
- data/docs/VoucherWithCategoriesRedemption.md +1 -1
- data/docs/VouchersApi.md +4 -2
- data/docs/VouchersCreateResponseBodyPublish.md +1 -1
- data/docs/VouchersCreateResponseBodyRedemption.md +1 -1
- data/docs/VouchersDisableResponseBodyPublish.md +1 -1
- data/docs/VouchersDisableResponseBodyRedemption.md +1 -1
- data/docs/VouchersEnableResponseBodyPublish.md +1 -1
- data/docs/VouchersEnableResponseBodyRedemption.md +1 -1
- data/docs/VouchersGetResponseBodyPublish.md +1 -1
- data/docs/VouchersGetResponseBodyRedemption.md +1 -1
- data/docs/VouchersTransactionsListResponseBody.md +2 -1
- data/docs/VouchersUpdateResponseBodyPublish.md +1 -1
- data/docs/VouchersUpdateResponseBodyRedemption.md +1 -1
- data/lib/VoucherifySdk/api/bin_api.rb +148 -0
- data/lib/VoucherifySdk/api/campaigns_api.rb +3 -0
- data/lib/VoucherifySdk/api/customers_api.rb +4 -68
- data/lib/VoucherifySdk/api/exports_api.rb +1 -1
- data/lib/VoucherifySdk/api/locations_api.rb +150 -0
- data/lib/VoucherifySdk/api/loyalties_api.rb +12 -3
- data/lib/VoucherifySdk/api/management_api.rb +2407 -0
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +138 -0
- data/lib/VoucherifySdk/api/products_api.rb +4 -4
- data/lib/VoucherifySdk/api/publications_api.rb +2 -2
- data/lib/VoucherifySdk/api/referrals_api.rb +420 -0
- data/lib/VoucherifySdk/api/templates_api.rb +472 -0
- data/lib/VoucherifySdk/api/vouchers_api.rb +6 -3
- data/lib/VoucherifySdk/api_client.rb +22 -1
- data/lib/VoucherifySdk/configuration.rb +14 -0
- data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
- data/lib/VoucherifySdk/models/applicable_to.rb +7 -3
- data/lib/VoucherifySdk/models/applicable_to_effect.rb +6 -4
- data/lib/VoucherifySdk/models/campaign.rb +580 -0
- data/lib/VoucherifySdk/models/campaign_base.rb +13 -2
- data/lib/VoucherifySdk/models/{product_collections_item_filter.rb → campaign_template.rb} +47 -89
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +19 -28
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +13 -2
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +13 -2
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +6 -40
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +13 -2
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/categories_create_request_body.rb +6 -1
- data/lib/VoucherifySdk/models/categories_create_response_body.rb +6 -1
- data/lib/VoucherifySdk/models/categories_get_response_body.rb +11 -19
- data/lib/VoucherifySdk/models/categories_update_request_body.rb +6 -1
- data/lib/VoucherifySdk/models/categories_update_response_body.rb +6 -1
- data/lib/VoucherifySdk/models/category.rb +11 -19
- data/lib/VoucherifySdk/models/category_with_stacking_rules_type.rb +309 -0
- data/lib/VoucherifySdk/models/client_promotions_tiers_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item.rb +1 -1
- data/lib/VoucherifySdk/models/customer_redeemable.rb +2 -2
- data/lib/VoucherifySdk/models/customers_activity_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/error.rb +1 -1
- data/lib/VoucherifySdk/models/{parameter_filters_list_customer_redeemables_created_at_conditions.rb → filter_conditions_date_time.rb} +1 -1
- data/lib/VoucherifySdk/models/inapplicable_to.rb +7 -3
- data/lib/VoucherifySdk/models/{product_collections_create_response_body_filter.rb → location.rb} +34 -89
- data/lib/VoucherifySdk/models/location_shape.rb +264 -0
- data/lib/VoucherifySdk/models/location_shape_distance.rb +221 -0
- data/lib/VoucherifySdk/models/{lucky_draw.rb → location_shape_geojson.rb} +42 -30
- data/lib/VoucherifySdk/models/locations_get_response_body.rb +290 -0
- data/lib/VoucherifySdk/models/locations_get_response_body_shape.rb +264 -0
- data/lib/VoucherifySdk/models/locations_get_response_body_shape_distance.rb +221 -0
- data/lib/VoucherifySdk/models/locations_get_response_body_shape_geojson.rb +244 -0
- data/lib/VoucherifySdk/models/locations_list_response_body.rb +260 -0
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +14 -14
- data/lib/VoucherifySdk/models/loyalties_create_campaign_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_get_campaign_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/loyalties_member_activity_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +15 -15
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_channel.rb +3 -3
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher.rb +2 -2
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_transactions_list_response_body.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/loyalties_reward_assignments_get_response_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_rewards_create_assignment_response_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_rewards_get_response_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_rewards_update_assignment_request_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_rewards_update_assignment_response_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/loyalties_update_campaign_response_body.rb +12 -1
- data/lib/VoucherifySdk/models/loyalty_campaign.rb +12 -1
- data/lib/VoucherifySdk/models/loyalty_member_publish.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_member_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/management_project.rb +479 -0
- data/lib/VoucherifySdk/models/management_project_api_usage_notifications.rb +253 -0
- data/lib/VoucherifySdk/models/management_project_default_code_config.rb +210 -0
- data/lib/VoucherifySdk/models/management_project_limits.rb +223 -0
- data/lib/VoucherifySdk/models/management_project_limits_api_calls_item.rb +219 -0
- data/lib/VoucherifySdk/models/management_project_limits_bulk_api_calls_item.rb +219 -0
- data/lib/VoucherifySdk/models/management_project_webhooks_callout_notifications.rb +219 -0
- data/lib/VoucherifySdk/models/management_project_webhooks_callout_notifications_distributions.rb +234 -0
- data/lib/VoucherifySdk/models/management_project_webhooks_callout_notifications_webhooks.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_branding.rb +250 -0
- data/lib/VoucherifySdk/models/{publications_create_request_body_customer_address.rb → management_projects_branding_address.rb} +32 -42
- data/lib/VoucherifySdk/models/management_projects_branding_brand.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_cockpits.rb +311 -0
- data/lib/VoucherifySdk/models/management_projects_branding_contact.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_request_body.rb +239 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_request_body_address.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_request_body_brand.rb +256 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb +325 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_request_body_contact.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_response_body.rb +250 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_response_body_address.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_response_body_brand.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_response_body_cockpits.rb +311 -0
- data/lib/VoucherifySdk/models/management_projects_branding_create_response_body_contact.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_branding_get_response_body.rb +250 -0
- data/lib/VoucherifySdk/models/management_projects_branding_get_response_body_address.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_get_response_body_brand.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_get_response_body_cockpits.rb +311 -0
- data/lib/VoucherifySdk/models/management_projects_branding_get_response_body_contact.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_branding_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_request_body.rb +238 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_request_body_address.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_request_body_brand.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_request_body_cockpits.rb +311 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_request_body_contact.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_response_body.rb +250 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_response_body_address.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_response_body_brand.rb +254 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_response_body_cockpits.rb +311 -0
- data/lib/VoucherifySdk/models/management_projects_branding_update_response_body_contact.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_create_request_body.rb +440 -0
- data/lib/VoucherifySdk/models/management_projects_create_request_body_api_usage_notifications.rb +244 -0
- data/lib/VoucherifySdk/models/management_projects_create_request_body_users_item.rb +236 -0
- data/lib/VoucherifySdk/models/management_projects_create_request_body_webhooks_callout_notifications.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_create_request_body_webhooks_callout_notifications_distributions.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_create_request_body_webhooks_callout_notifications_webhooks.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_create_response_body.rb +480 -0
- data/lib/VoucherifySdk/models/management_projects_create_response_body_api_usage_notifications.rb +253 -0
- data/lib/VoucherifySdk/models/management_projects_create_response_body_client_side_key.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_create_response_body_server_side_key.rb +221 -0
- data/lib/VoucherifySdk/models/management_projects_create_response_body_webhooks_callout_notifications.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_create_response_body_webhooks_callout_notifications_distributions.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_create_response_body_webhooks_callout_notifications_webhooks.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schema.rb +290 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schema_schema.rb +212 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_create_request_body.rb +220 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_create_request_body_schema.rb +212 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_create_request_body_schema_properties_entry.rb +267 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_create_response_body.rb +290 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_create_response_body_schema.rb +212 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_get_response_body.rb +290 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_get_response_body_schema.rb +212 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_update_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_update_request_body_schema.rb +212 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_update_response_body.rb +290 -0
- data/lib/VoucherifySdk/models/management_projects_custom_event_schemas_update_response_body_schema.rb +212 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body.rb +479 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_api_usage_notifications.rb +253 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_default_code_config.rb +210 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_limits.rb +223 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_limits_api_calls_item.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_limits_bulk_api_calls_item.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_webhooks_callout_notifications.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_webhooks_callout_notifications_distributions.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_get_response_body_webhooks_callout_notifications_webhooks.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schema.rb +280 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schema_definition.rb +380 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schemas_create_request_body.rb +236 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schemas_create_response_body.rb +280 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schemas_get_response_body.rb +280 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schemas_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schemas_update_request_body.rb +223 -0
- data/lib/VoucherifySdk/models/management_projects_metadata_schemas_update_response_body.rb +280 -0
- data/lib/VoucherifySdk/models/management_projects_stacking_rules.rb +425 -0
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_request_body.rb +392 -0
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_request_body.rb +392 -0
- data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_response_body.rb +425 -0
- data/lib/VoucherifySdk/models/management_projects_templates_campaigns_copy_create_request_body.rb +232 -0
- data/lib/VoucherifySdk/models/management_projects_templates_campaigns_copy_create_response_body.rb +293 -0
- data/lib/VoucherifySdk/models/management_projects_templates_campaigns_list_response_body.rb +297 -0
- data/lib/VoucherifySdk/models/management_projects_update_request_body.rb +400 -0
- data/lib/VoucherifySdk/models/management_projects_update_request_body_api_usage_notifications.rb +244 -0
- data/lib/VoucherifySdk/models/management_projects_update_request_body_default_code_config.rb +210 -0
- data/lib/VoucherifySdk/models/management_projects_update_request_body_webhooks_callout_notifications.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_update_request_body_webhooks_callout_notifications_distributions.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_update_request_body_webhooks_callout_notifications_webhooks.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body.rb +479 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_api_usage_notifications.rb +253 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_default_code_config.rb +210 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_limits.rb +223 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_limits_api_calls_item.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_limits_bulk_api_calls_item.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_webhooks_callout_notifications.rb +219 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_webhooks_callout_notifications_distributions.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_update_response_body_webhooks_callout_notifications_webhooks.rb +234 -0
- data/lib/VoucherifySdk/models/management_projects_users_assign_request_body.rb +231 -0
- data/lib/VoucherifySdk/models/management_projects_users_assign_response_body.rb +278 -0
- data/lib/VoucherifySdk/models/management_projects_users_get_user_response_body.rb +278 -0
- data/lib/VoucherifySdk/models/management_projects_users_invite_create_request_body.rb +245 -0
- data/lib/VoucherifySdk/models/management_projects_users_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/management_projects_users_update_role_request_body.rb +209 -0
- data/lib/VoucherifySdk/models/management_projects_users_update_role_response_body.rb +278 -0
- data/lib/VoucherifySdk/models/management_projects_webhook.rb +295 -0
- data/lib/VoucherifySdk/models/management_projects_webhooks_create_request_body.rb +258 -0
- data/lib/VoucherifySdk/models/management_projects_webhooks_create_response_body.rb +295 -0
- data/lib/VoucherifySdk/models/management_projects_webhooks_get_response_body.rb +295 -0
- data/lib/VoucherifySdk/models/management_projects_webhooks_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/management_projects_webhooks_update_request_body.rb +258 -0
- data/lib/VoucherifySdk/models/management_projects_webhooks_update_response_body.rb +295 -0
- data/lib/VoucherifySdk/models/metadata_schema_definition_deprecated.rb +380 -0
- data/lib/VoucherifySdk/models/metadata_schema_deprecated.rb +280 -0
- data/lib/VoucherifySdk/models/metadata_schemas_get_response_body.rb +280 -0
- data/lib/VoucherifySdk/models/metadata_schemas_list_response_body.rb +275 -0
- data/lib/VoucherifySdk/models/order.rb +1 -1
- data/lib/VoucherifySdk/models/order_calculated.rb +1 -1
- data/lib/VoucherifySdk/models/order_item_product.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +1 -1
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/parameter_campaign_type.rb +1 -2
- data/lib/VoucherifySdk/models/parameter_filters_list_bin.rb +269 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_bin_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_bin_resource_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_bin_resource_name.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_bin_resource_type.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_bin_resource_type_conditions.rb +316 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns.rb +289 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status_conditions.rb +316 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_categories.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_category_ids.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_is_referral_code.rb +247 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_validity_timeframe.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_voucher_type.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables.rb +36 -5
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_campaign_id.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_campaign_type.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_created_at.rb +4 -36
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_holder_role.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_id.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_redeemable_id.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_redeemable_object.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_customer_redeemables_voucher_type.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_locations.rb +228 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_locations_created_at.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_locations_name.rb +207 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_locations_updated_at.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications.rb +319 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_campaign_name.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_customer_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_failure_code.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_is_referral_code.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_parent_object_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_related_object_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_result.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_source_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_publications_voucher_type.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions.rb +36 -5
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_campaign_name.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_customer_id.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_failure_code.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_object.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_parent_redemption_id.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_related_object_id.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_related_object_parent_id.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_result.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_user_login.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_redemptions_voucher_code.rb +4 -35
- data/lib/VoucherifySdk/models/parameter_filters_list_referrals_redeemable_holders.rb +269 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_referrals_redeemable_holders_created_at.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_referrals_redeemable_holders_customer_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_referrals_redeemable_holders_holder_role.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_referrals_redeemable_holders_holder_role_conditions.rb +316 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_referrals_redeemable_holders_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_templates.rb +259 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_templates_campaign_type.rb +209 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_templates_campaign_type_conditions.rb +317 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_templates_id.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_filters_list_templates_name.rb +208 -0
- data/lib/VoucherifySdk/models/parameter_order_list_bin.rb +40 -0
- data/lib/VoucherifySdk/models/parameter_order_list_locations.rb +42 -0
- data/lib/VoucherifySdk/models/parameter_order_list_transactions.rb +40 -0
- data/lib/VoucherifySdk/models/parameter_templates_list.rb +40 -0
- data/lib/VoucherifySdk/models/parameter_voucher_type_list_publications.rb +1 -2
- data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +2 -1
- data/lib/VoucherifySdk/models/product_collections_create_response_body.rb +2 -1
- data/lib/VoucherifySdk/models/product_collections_get_response_body.rb +2 -1
- data/lib/VoucherifySdk/models/product_collections_item.rb +2 -1
- data/lib/VoucherifySdk/models/promotion_tiers_list.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_stacks_update_request_body_tiers.rb +1 -1
- data/lib/VoucherifySdk/models/promotions_tiers_create_request_body.rb +24 -24
- data/lib/VoucherifySdk/models/promotions_tiers_list_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/publications_create_request_body.rb +1 -2
- data/lib/VoucherifySdk/models/qualifications_option.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +1 -1
- data/lib/VoucherifySdk/models/redeemable_holder.rb +354 -0
- data/lib/VoucherifySdk/models/redeemable_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redeemable_voucher_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/redemption.rb +16 -16
- data/lib/VoucherifySdk/models/redemption_channel.rb +3 -3
- data/lib/VoucherifySdk/models/redemption_entry.rb +11 -11
- data/lib/VoucherifySdk/models/redemption_entry_channel.rb +1 -2
- data/lib/VoucherifySdk/models/redemption_entry_order.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_entry_voucher_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_voucher.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redemption_voucher_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +11 -11
- data/lib/VoucherifySdk/models/redemptions_get_response_body_channel.rb +1 -2
- data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +10 -10
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_channel.rb +1 -3
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_rollbacks_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/referral_program_referee_reward.rb +1 -1
- data/lib/VoucherifySdk/models/referrals_members_holders_create_in_bulk_request_body.rb +223 -0
- data/lib/VoucherifySdk/models/referrals_members_holders_create_in_bulk_response_body.rb +212 -0
- data/lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb +271 -0
- data/lib/VoucherifySdk/models/reward_assignment_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/rewards_assignments_create_request_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/rewards_assignments_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_assignments_create_response_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/rewards_assignments_get_response_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/rewards_assignments_update_request_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/rewards_assignments_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_assignments_update_response_body_parameters_loyalty.rb +16 -5
- data/lib/VoucherifySdk/models/stacking_rules.rb +1 -1
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +406 -0
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body_voucher.rb +218 -0
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body_voucher_redemption.rb +210 -0
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_response_body.rb +265 -0
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_response_body_created_resources_item.rb +242 -0
- data/lib/VoucherifySdk/models/templates_campaigns_create_request_body.rb +243 -0
- data/lib/VoucherifySdk/models/{publications_create_request_body_customer.rb → templates_campaigns_create_template_response_body.rb} +55 -68
- data/lib/VoucherifySdk/models/{product_collections_get_response_body_filter.rb → templates_campaigns_get_response_body.rb} +48 -89
- data/lib/VoucherifySdk/models/templates_campaigns_list_response_body.rb +297 -0
- data/lib/VoucherifySdk/models/templates_campaigns_tier_setup_create_request_body.rb +361 -0
- data/lib/VoucherifySdk/models/templates_campaigns_tier_setup_create_response_body.rb +258 -0
- data/lib/VoucherifySdk/models/templates_campaigns_tier_setup_create_response_body_created_resources_item.rb +242 -0
- data/lib/VoucherifySdk/models/templates_campaigns_update_request_body.rb +221 -0
- data/lib/VoucherifySdk/models/{product_collections_create_request_body_filter.rb → templates_campaigns_update_response_body.rb} +48 -89
- data/lib/VoucherifySdk/models/trash_bin_item.rb +313 -0
- data/lib/VoucherifySdk/models/trash_bin_list_response_body.rb +297 -0
- data/lib/VoucherifySdk/models/usage_notifications.rb +254 -0
- data/lib/VoucherifySdk/models/user.rb +278 -0
- data/lib/VoucherifySdk/models/validation_rule.rb +2 -2
- data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +2 -2
- data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +2 -2
- data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +2 -2
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable.rb +1 -1
- data/lib/VoucherifySdk/models/validations_redeemable_skipped.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_publish.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_with_categories_publish.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_with_categories_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_create_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_create_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_get_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_get_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_transactions_list_response_body.rb +43 -6
- data/lib/VoucherifySdk/models/vouchers_update_response_body_publish.rb +1 -1
- data/lib/VoucherifySdk/models/vouchers_update_response_body_redemption.rb +1 -1
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +212 -8
- metadata +456 -48
- data/docs/LuckyDraw.md +0 -10
- data/docs/ProductCollectionsCreateRequestBodyFilter.md +0 -20
- data/docs/ProductCollectionsCreateResponseBodyFilter.md +0 -20
- data/docs/ProductCollectionsGetResponseBodyFilter.md +0 -20
- data/docs/ProductCollectionsItemFilter.md +0 -20
- data/docs/PublicationsCreateRequestBodyCustomer.md +0 -17
- data/docs/PublicationsCreateRequestBodyCustomerAddress.md +0 -13
data/docs/ApplicableTo.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **object** | **String** | This object stores information about the
|
|
8
|
-
| **id** | **String** | Unique product collection
|
|
9
|
-
| **source_id** | **String** | The source
|
|
7
|
+
| **object** | **String** | This object stores information about the resource to which the discount is applicable. | [optional] |
|
|
8
|
+
| **id** | **String** | Unique product collection, product, or SKU identifier assigned by Voucherify. | [optional] |
|
|
9
|
+
| **source_id** | **String** | The source identifier from your inventory system. | [optional] |
|
|
10
10
|
| **product_id** | **String** | Parent product's unique ID assigned by Voucherify. | [optional] |
|
|
11
11
|
| **product_source_id** | **String** | Parent product's source ID from your inventory system. | [optional] |
|
|
12
12
|
| **strict** | **Boolean** | | [optional] |
|
|
@@ -17,8 +17,8 @@
|
|
|
17
17
|
| **aggregated_quantity_limit** | **Integer** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] |
|
|
18
18
|
| **amount_limit** | **Integer** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] |
|
|
19
19
|
| **aggregated_amount_limit** | **Integer** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional] |
|
|
20
|
-
| **order_item_indices** | **Array<Integer>** |
|
|
21
|
-
| **repeat** | **Integer** |
|
|
22
|
-
| **skip_initially** | **Integer** |
|
|
23
|
-
| **target** | **String** |
|
|
20
|
+
| **order_item_indices** | **Array<Integer>** | Determines the order in which the discount is applied to the products or SKUs sent in the `order` object in the request. The counting begins from `0`. | [optional] |
|
|
21
|
+
| **repeat** | **Integer** | Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item. | [optional] |
|
|
22
|
+
| **skip_initially** | **Integer** | Determines how many items are skipped before the discount is applied. | [optional] |
|
|
23
|
+
| **target** | **String** | Determines to which kinds of objects the discount is applicable. `\"ITEM\"` includes products and SKUs. | [optional] |
|
|
24
24
|
|
data/docs/BinApi.md
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# VoucherifySdk::BinApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.voucherify.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**delete_bin_entry**](BinApi.md#delete_bin_entry) | **DELETE** /v1/trash-bin/{binEntryId} | Delete Bin Entry |
|
|
8
|
+
| [**list_bin_entries**](BinApi.md#list_bin_entries) | **GET** /v1/trash-bin | List Bin Entries |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## delete_bin_entry
|
|
12
|
+
|
|
13
|
+
> delete_bin_entry(bin_entry_id)
|
|
14
|
+
|
|
15
|
+
Delete Bin Entry
|
|
16
|
+
|
|
17
|
+
Deletes permanently a bin entry with a given ID.The following resources can be moved to the bin and permanently deleted: - campaigns - vouchers - products - SKUs To use this endpoint and delete a given resource type, you must have the following permissions: - vouchers.delete to delete a voucher, - campaigns.delete to delete a campaign, - products.delete to delete a product or SKU.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'VoucherifySdk'
|
|
24
|
+
# setup authorization
|
|
25
|
+
VoucherifySdk.configure do |config|
|
|
26
|
+
# Configure API key authorization: X-App-Id
|
|
27
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
30
|
+
|
|
31
|
+
# Configure API key authorization: X-App-Token
|
|
32
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
34
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
api_instance = VoucherifySdk::BinApi.new
|
|
38
|
+
bin_entry_id = 'bin_entry_id_example' # String | Provide the unique identifier of the bin entry.
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# Delete Bin Entry
|
|
42
|
+
api_instance.delete_bin_entry(bin_entry_id)
|
|
43
|
+
rescue VoucherifySdk::ApiError => e
|
|
44
|
+
puts "Error when calling BinApi->delete_bin_entry: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
| Name | Type | Description | Notes |
|
|
51
|
+
| ---- | ---- | ----------- | ----- |
|
|
52
|
+
| **bin_entry_id** | **String** | Provide the unique identifier of the bin entry. | |
|
|
53
|
+
|
|
54
|
+
### Return type
|
|
55
|
+
|
|
56
|
+
nil (empty response body)
|
|
57
|
+
|
|
58
|
+
### Authorization
|
|
59
|
+
|
|
60
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
61
|
+
|
|
62
|
+
### HTTP request headers
|
|
63
|
+
|
|
64
|
+
- **Content-Type**: Not defined
|
|
65
|
+
- **Accept**: Not defined
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
## list_bin_entries
|
|
69
|
+
|
|
70
|
+
> <TrashBinListResponseBody> list_bin_entries(opts)
|
|
71
|
+
|
|
72
|
+
List Bin Entries
|
|
73
|
+
|
|
74
|
+
Retrieves a list of resources moved to the bin. The following resources can be moved to the bin: - campaigns - vouchers - products - SKUs To use this endpoint, you must have the following permissions: - vouchers.read - campaigns.read - products.read
|
|
75
|
+
|
|
76
|
+
### Examples
|
|
77
|
+
|
|
78
|
+
```ruby
|
|
79
|
+
require 'time'
|
|
80
|
+
require 'VoucherifySdk'
|
|
81
|
+
# setup authorization
|
|
82
|
+
VoucherifySdk.configure do |config|
|
|
83
|
+
# Configure API key authorization: X-App-Id
|
|
84
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
85
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
86
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
87
|
+
|
|
88
|
+
# Configure API key authorization: X-App-Token
|
|
89
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
90
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
91
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
api_instance = VoucherifySdk::BinApi.new
|
|
95
|
+
opts = {
|
|
96
|
+
limit: 56, # Integer | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
|
97
|
+
order: VoucherifySdk::ParameterOrderListBin::ID, # ParameterOrderListBin | Orders the bin entries according the date and time when they were moved to the bin or according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
|
98
|
+
starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
|
|
99
|
+
filters: VoucherifySdk::ParameterFiltersListBin.new # ParameterFiltersListBin | Filters for listing bin entries.
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
begin
|
|
103
|
+
# List Bin Entries
|
|
104
|
+
result = api_instance.list_bin_entries(opts)
|
|
105
|
+
p result
|
|
106
|
+
rescue VoucherifySdk::ApiError => e
|
|
107
|
+
puts "Error when calling BinApi->list_bin_entries: #{e}"
|
|
108
|
+
end
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Parameters
|
|
112
|
+
|
|
113
|
+
| Name | Type | Description | Notes |
|
|
114
|
+
| ---- | ---- | ----------- | ----- |
|
|
115
|
+
| **limit** | **Integer** | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] |
|
|
116
|
+
| **order** | [**ParameterOrderListBin**](.md) | Orders the bin entries according the date and time when they were moved to the bin or according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
117
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] |
|
|
118
|
+
| **filters** | [**ParameterFiltersListBin**](.md) | Filters for listing bin entries. | [optional] |
|
|
119
|
+
|
|
120
|
+
### Return type
|
|
121
|
+
|
|
122
|
+
[**TrashBinListResponseBody**](TrashBinListResponseBody.md)
|
|
123
|
+
|
|
124
|
+
### Authorization
|
|
125
|
+
|
|
126
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
127
|
+
|
|
128
|
+
### HTTP request headers
|
|
129
|
+
|
|
130
|
+
- **Content-Type**: Not defined
|
|
131
|
+
- **Accept**: application/json
|
|
132
|
+
|
data/docs/Campaign.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# VoucherifySdk::Campaign
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique campaign ID, assigned by Voucherify. | [optional] |
|
|
8
|
+
| **name** | **String** | Campaign name. | [optional] |
|
|
9
|
+
| **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|
|
10
|
+
| **campaign_type** | **String** | Type of campaign. | [optional] |
|
|
11
|
+
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published | [optional] |
|
|
12
|
+
| **voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|
|
13
|
+
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
14
|
+
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
15
|
+
| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
|
|
16
|
+
| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) | | [optional] |
|
|
17
|
+
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
18
|
+
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
19
|
+
| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
|
|
20
|
+
| **vouchers_count** | **Integer** | Total number of unique vouchers in campaign. | [optional] |
|
|
21
|
+
| **start_date** | **Time** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date. | [optional] |
|
|
22
|
+
| **expiration_date** | **Time** | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date. | [optional] |
|
|
23
|
+
| **active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|
|
24
|
+
| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
|
|
25
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
26
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] |
|
|
27
|
+
| **category** | **String** | Unique category name. | [optional] |
|
|
28
|
+
| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
|
|
29
|
+
| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
|
|
30
|
+
| **readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. | [optional] |
|
|
31
|
+
| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
|
|
32
|
+
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
33
|
+
| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
|
|
34
|
+
| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
|
35
|
+
| **referral_program** | [**ReferralProgram**](ReferralProgram.md) | | [optional] |
|
|
36
|
+
| **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] |
|
|
37
|
+
| **promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] |
|
|
38
|
+
| **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] |
|
|
39
|
+
| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] |
|
|
40
|
+
|
data/docs/CampaignBase.md
CHANGED
|
@@ -27,6 +27,7 @@
|
|
|
27
27
|
| **category** | **String** | Unique category name. | [optional] |
|
|
28
28
|
| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
|
|
29
29
|
| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
|
|
30
|
+
| **readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. | [optional] |
|
|
30
31
|
| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
|
|
31
32
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
32
33
|
| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# VoucherifySdk::CampaignTemplate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier of the campaign template. It is assigned by Voucherify. | [optional] |
|
|
8
|
+
| **name** | **String** | User-defined name of the campaign template. | [optional] |
|
|
9
|
+
| **description** | **String** | User-defined description of the campaign template. | [optional] |
|
|
10
|
+
| **campaign_type** | **String** | Type of the campaign used to create the campaign template. Templates created from a promotion tier are converted to `DISCOUNT_COUPONS`. | [optional] |
|
|
11
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the campaign template was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
12
|
+
| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'campaign_template'] |
|
|
13
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the campaign template was last updated. The value is shown in the ISO 8601 format. | [optional] |
|
|
14
|
+
|
data/docs/CampaignsApi.md
CHANGED
|
@@ -597,7 +597,8 @@ opts = {
|
|
|
597
597
|
page: 56, # Integer | Which page of results to return. The lowest value is 1.
|
|
598
598
|
campaign_type: VoucherifySdk::ParameterCampaignType::PROMOTION, # ParameterCampaignType | This attribute allows filtering by campaign type.
|
|
599
599
|
expand: VoucherifySdk::ParameterExpandListCampaigns::CATEGORY, # ParameterExpandListCampaigns | Include an expanded categories object in the response.
|
|
600
|
-
order: VoucherifySdk::ParameterOrderListCampaigns::CREATED_AT # ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
600
|
+
order: VoucherifySdk::ParameterOrderListCampaigns::CREATED_AT, # ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
601
|
+
filters: VoucherifySdk::ParameterFiltersListCampaigns.new # ParameterFiltersListCampaigns | Filters the results by campaign status or whether the campaign is a referral campaign.
|
|
601
602
|
}
|
|
602
603
|
|
|
603
604
|
begin
|
|
@@ -618,6 +619,7 @@ end
|
|
|
618
619
|
| **campaign_type** | [**ParameterCampaignType**](.md) | This attribute allows filtering by campaign type. | [optional] |
|
|
619
620
|
| **expand** | [**ParameterExpandListCampaigns**](.md) | Include an expanded categories object in the response. | [optional][default to 'category'] |
|
|
620
621
|
| **order** | [**ParameterOrderListCampaigns**](.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
|
+
| **filters** | [**ParameterFiltersListCampaigns**](.md) | Filters the results by campaign status or whether the campaign is a referral campaign. | [optional] |
|
|
621
623
|
|
|
622
624
|
### Return type
|
|
623
625
|
|
|
@@ -17,13 +17,12 @@
|
|
|
17
17
|
| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|
|
18
18
|
| **validity_hours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|
|
19
19
|
| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
|
|
20
|
-
| **validation_rules** | **Array<String>** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
|
|
21
20
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
|
|
22
21
|
| **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] |
|
|
23
22
|
| **metadata** | **Object** | | [optional] |
|
|
23
|
+
| **validation_rules** | **Array<String>** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
|
|
24
24
|
| **campaign_type** | **String** | | [optional] |
|
|
25
25
|
| **voucher** | [**CampaignsCreateRequestBodyVoucher**](CampaignsCreateRequestBodyVoucher.md) | | [optional] |
|
|
26
26
|
| **referral_program** | [**ReferralProgram**](ReferralProgram.md) | | [optional] |
|
|
27
27
|
| **promotion** | [**CampaignsCreateRequestBodyPromotion**](CampaignsCreateRequestBodyPromotion.md) | | [optional] |
|
|
28
|
-
| **lucky_draw** | [**LuckyDraw**](LuckyDraw.md) | | [optional] |
|
|
29
28
|
|
|
@@ -27,6 +27,7 @@
|
|
|
27
27
|
| **category** | **String** | Unique category name. | [optional] |
|
|
28
28
|
| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
|
|
29
29
|
| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
|
|
30
|
+
| **readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. | [optional] |
|
|
30
31
|
| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
|
|
31
32
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
32
33
|
| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
|
|
@@ -27,6 +27,7 @@
|
|
|
27
27
|
| **category** | **String** | Unique category name. | [optional] |
|
|
28
28
|
| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
|
|
29
29
|
| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
|
|
30
|
+
| **readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. | [optional] |
|
|
30
31
|
| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
|
|
31
32
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
32
33
|
| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
|
|
@@ -18,12 +18,9 @@
|
|
|
18
18
|
| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
|
|
19
19
|
| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
|
|
20
20
|
| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. | [optional] |
|
|
21
|
-
| **discount** | **
|
|
21
|
+
| **discount** | [**Discount**](Discount.md) | | [optional] |
|
|
22
22
|
| **referral_program** | [**ReferralProgram**](ReferralProgram.md) | | [optional] |
|
|
23
23
|
| **gift** | [**Gift**](Gift.md) | | [optional] |
|
|
24
24
|
| **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] |
|
|
25
25
|
| **options** | [**CampaignsUpdateRequestBodyOptions**](CampaignsUpdateRequestBodyOptions.md) | | [optional] |
|
|
26
|
-
| **winners_count** | **String** | It represents the total number of winners in a lucky draw. | [optional] |
|
|
27
|
-
| **unique_winners_per_draw** | **String** | It indicates whether each winner in a draw is unique or not. | [optional] |
|
|
28
|
-
| **unique_winners** | **String** | Specifies whether each participant can win only once across multiple draws. | [optional] |
|
|
29
26
|
|
|
@@ -27,6 +27,7 @@
|
|
|
27
27
|
| **category** | **String** | Unique category name. | [optional] |
|
|
28
28
|
| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
|
|
29
29
|
| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
|
|
30
|
+
| **readonly** | **Boolean** | Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. | [optional] |
|
|
30
31
|
| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
|
|
31
32
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|
|
32
33
|
| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
|
|
@@ -6,5 +6,5 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute. | [optional][default to 'list'] |
|
|
8
8
|
| **count** | **Integer** | Publication events counter. | [optional] |
|
|
9
|
-
| **url** | **String** | The endpoint where this list of publications can be accessed using a GET method. `/v1/vouchers/{voucher_code}/publications` | [optional] |
|
|
9
|
+
| **url** | **String** | The endpoint where this list of publications can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/publications` | [optional] |
|
|
10
10
|
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
| **redeemed_quantity** | **Integer** | How many times a voucher has already been redeemed. | [optional] |
|
|
9
9
|
| **redeemed_points** | **Integer** | Total loyalty points redeemed. | [optional] |
|
|
10
10
|
| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute. | [optional][default to 'list'] |
|
|
11
|
-
| **url** | **String** | The endpoint where this list of redemptions can be accessed using a GET method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] |
|
|
11
|
+
| **url** | **String** | The endpoint where this list of redemptions can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] |
|
|
12
12
|
|
|
@@ -6,5 +6,5 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute. | [optional][default to 'list'] |
|
|
8
8
|
| **count** | **Integer** | Publication events counter. | [optional] |
|
|
9
|
-
| **url** | **String** | The endpoint where this list of publications can be accessed using a GET method. `/v1/vouchers/{voucher_code}/publications` | [optional] |
|
|
9
|
+
| **url** | **String** | The endpoint where this list of publications can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/publications` | [optional] |
|
|
10
10
|
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
| **redeemed_quantity** | **Integer** | How many times a voucher has already been redeemed. | [optional] |
|
|
9
9
|
| **redeemed_points** | **Integer** | Total loyalty points redeemed. | [optional] |
|
|
10
10
|
| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute. | [optional][default to 'list'] |
|
|
11
|
-
| **url** | **String** | The endpoint where this list of redemptions can be accessed using a GET method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] |
|
|
11
|
+
| **url** | **String** | The endpoint where this list of redemptions can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] |
|
|
12
12
|
|
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Category name. | [optional] |
|
|
8
|
-
| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
|
|
8
|
+
| **hierarchy** | **Integer** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] |
|
|
9
9
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
|
|
8
8
|
| **name** | **String** | Category name. | [optional] |
|
|
9
|
-
| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
|
|
9
|
+
| **hierarchy** | **Integer** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] |
|
|
10
10
|
| **object** | **String** | | [optional][default to 'category'] |
|
|
11
11
|
| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
12
12
|
|
|
@@ -6,9 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
|
|
8
8
|
| **name** | **String** | Category name. | [optional] |
|
|
9
|
-
| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
|
|
9
|
+
| **hierarchy** | **Integer** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] |
|
|
10
10
|
| **object** | **String** | The type of the object represented by the JSON. This object stores information about the category. | [optional][default to 'category'] |
|
|
11
11
|
| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
12
12
|
| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. | [optional] |
|
|
13
|
-
| **stacking_rules_type** | **String** | The type of the stacking rule eligibility. | [optional] |
|
|
14
13
|
|
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Category name. | [optional] |
|
|
8
|
-
| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
|
|
8
|
+
| **hierarchy** | **Integer** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] |
|
|
9
9
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
|
|
8
8
|
| **name** | **String** | Category name. | [optional] |
|
|
9
|
-
| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
|
|
9
|
+
| **hierarchy** | **Integer** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] |
|
|
10
10
|
| **object** | **String** | | [optional][default to 'category'] |
|
|
11
11
|
| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
12
12
|
| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. | [optional] |
|
data/docs/Category.md
CHANGED
|
@@ -6,9 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
|
|
8
8
|
| **name** | **String** | Category name. | [optional] |
|
|
9
|
-
| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
|
|
9
|
+
| **hierarchy** | **Integer** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] |
|
|
10
10
|
| **object** | **String** | The type of the object represented by the JSON. This object stores information about the category. | [optional][default to 'category'] |
|
|
11
11
|
| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
12
12
|
| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. | [optional] |
|
|
13
|
-
| **stacking_rules_type** | **String** | The type of the stacking rule eligibility. | [optional] |
|
|
14
13
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# VoucherifySdk::CategoryWithStackingRulesType
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
|
|
8
|
+
| **name** | **String** | Category name. | [optional] |
|
|
9
|
+
| **hierarchy** | **Integer** | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. | [optional] |
|
|
10
|
+
| **object** | **String** | The type of the object represented by the JSON. This object stores information about the category. | [optional][default to 'category'] |
|
|
11
|
+
| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
|
|
12
|
+
| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. | [optional] |
|
|
13
|
+
| **stacking_rules_type** | **String** | The type of the stacking rule eligibility. | [optional] |
|
|
14
|
+
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
| **data_ref** | **String** | Identifies the name of the attribute that contains the array of promotion tier objects. | [optional][default to 'tiers'] |
|
|
9
9
|
| **tiers** | [**Array<PromotionTier>**](PromotionTier.md) | Contains array of promotion tier objects. | [optional] |
|
|
10
10
|
| **total** | **Integer** | Total number of promotion tiers. | [optional] |
|
|
11
|
-
| **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request
|
|
11
|
+
| **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results. | [optional] |
|
|
12
12
|
|
|
@@ -12,5 +12,5 @@
|
|
|
12
12
|
| **inapplicable_to** | [**InapplicableToResultList**](InapplicableToResultList.md) | | [optional] |
|
|
13
13
|
| **result** | [**ClientValidationsValidateResponseBodyRedeemablesItemResult**](ClientValidationsValidateResponseBodyRedeemablesItemResult.md) | | [optional] |
|
|
14
14
|
| **metadata** | **Object** | | [optional] |
|
|
15
|
-
| **categories** | [**Array<
|
|
15
|
+
| **categories** | [**Array<CategoryWithStackingRulesType>**](CategoryWithStackingRulesType.md) | | [optional] |
|
|
16
16
|
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
| **data_ref** | **String** | Identifies the name of the attribute that contains the array of customer activity objects. | [optional][default to 'data'] |
|
|
9
9
|
| **data** | [**Array<CustomerActivity>**](CustomerActivity.md) | Array of customer activity objects. | [optional] |
|
|
10
10
|
| **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a `starting_after_id` query or a different limit to get more records returned in the results. | [optional] |
|
|
11
|
-
| **more_starting_after** | **String** | Returns an ID that can be used to return another page of results. Use the event
|
|
11
|
+
| **more_starting_after** | **String** | Returns an ID that can be used to return another page of results. Use the event ID in the `starting_after_id` query parameter to display another page of the results starting after the event with that ID. | [optional] |
|
|
12
12
|
|
data/docs/CustomersApi.md
CHANGED
|
@@ -15,7 +15,6 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
15
15
|
| [**list_customer_segments**](CustomersApi.md#list_customer_segments) | **GET** /v1/customers/{customerId}/segments | List Customer's Segments |
|
|
16
16
|
| [**list_customers**](CustomersApi.md#list_customers) | **GET** /v1/customers | List Customers |
|
|
17
17
|
| [**update_customer**](CustomersApi.md#update_customer) | **PUT** /v1/customers/{customerId} | Update Customer |
|
|
18
|
-
| [**update_customers_consents**](CustomersApi.md#update_customers_consents) | **PUT** /v1/customers/{customerId}/consents | Update Customer's consents [Deprecated] |
|
|
19
18
|
| [**update_customers_in_bulk**](CustomersApi.md#update_customers_in_bulk) | **POST** /v1/customers/bulk/async | Update Customers in Bulk |
|
|
20
19
|
| [**update_customers_metadata_in_bulk**](CustomersApi.md#update_customers_metadata_in_bulk) | **POST** /v1/customers/metadata/async | Update Customers' Metadata in Bulk |
|
|
21
20
|
|
|
@@ -739,74 +738,13 @@ end
|
|
|
739
738
|
- **Accept**: application/json
|
|
740
739
|
|
|
741
740
|
|
|
742
|
-
## update_customers_consents
|
|
743
|
-
|
|
744
|
-
> update_customers_consents(customer_id, opts)
|
|
745
|
-
|
|
746
|
-
Update Customer's consents [Deprecated]
|
|
747
|
-
|
|
748
|
-
Update marketing permissions for the specified customer. ❗️ Deprecated This endpoint is deprecated. The feature of managing consents will be soon removed from Voucherify, including this endpoint.
|
|
749
|
-
|
|
750
|
-
### Examples
|
|
751
|
-
|
|
752
|
-
```ruby
|
|
753
|
-
require 'time'
|
|
754
|
-
require 'VoucherifySdk'
|
|
755
|
-
# setup authorization
|
|
756
|
-
VoucherifySdk.configure do |config|
|
|
757
|
-
# Configure API key authorization: X-App-Id
|
|
758
|
-
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
759
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
760
|
-
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
761
|
-
|
|
762
|
-
# Configure API key authorization: X-App-Token
|
|
763
|
-
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
764
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
765
|
-
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
766
|
-
end
|
|
767
|
-
|
|
768
|
-
api_instance = VoucherifySdk::CustomersApi.new
|
|
769
|
-
customer_id = 'customer_id_example' # String | A Voucherify unique customer identifier or source ID.
|
|
770
|
-
opts = {
|
|
771
|
-
body: { ... } # Object | Key-value pairs where the key is the consent identifier and value is a boolean that identifies if a customer has given the consent or not. To deny all consents use unsubscribed as a consent identifier and true as its value. ## Examples Opt-out from all communication:
|
|
772
|
-
}
|
|
773
|
-
|
|
774
|
-
begin
|
|
775
|
-
# Update Customer's consents [Deprecated]
|
|
776
|
-
api_instance.update_customers_consents(customer_id, opts)
|
|
777
|
-
rescue VoucherifySdk::ApiError => e
|
|
778
|
-
puts "Error when calling CustomersApi->update_customers_consents: #{e}"
|
|
779
|
-
end
|
|
780
|
-
```
|
|
781
|
-
|
|
782
|
-
### Parameters
|
|
783
|
-
|
|
784
|
-
| Name | Type | Description | Notes |
|
|
785
|
-
| ---- | ---- | ----------- | ----- |
|
|
786
|
-
| **customer_id** | **String** | A Voucherify unique customer identifier or source ID. | |
|
|
787
|
-
| **body** | **Object** | Key-value pairs where the key is the consent identifier and value is a boolean that identifies if a customer has given the consent or not. To deny all consents use unsubscribed as a consent identifier and true as its value. ## Examples Opt-out from all communication: | [optional] |
|
|
788
|
-
|
|
789
|
-
### Return type
|
|
790
|
-
|
|
791
|
-
nil (empty response body)
|
|
792
|
-
|
|
793
|
-
### Authorization
|
|
794
|
-
|
|
795
|
-
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
796
|
-
|
|
797
|
-
### HTTP request headers
|
|
798
|
-
|
|
799
|
-
- **Content-Type**: application/json
|
|
800
|
-
- **Accept**: Not defined
|
|
801
|
-
|
|
802
|
-
|
|
803
741
|
## update_customers_in_bulk
|
|
804
742
|
|
|
805
743
|
> <CustomersUpdateInBulkResponseBody> update_customers_in_bulk(opts)
|
|
806
744
|
|
|
807
745
|
Update Customers in Bulk
|
|
808
746
|
|
|
809
|
-
Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the GET Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
747
|
+
Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
810
748
|
|
|
811
749
|
### Examples
|
|
812
750
|
|
|
@@ -866,7 +804,7 @@ end
|
|
|
866
804
|
|
|
867
805
|
Update Customers' Metadata in Bulk
|
|
868
806
|
|
|
869
|
-
Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the GET Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
807
|
+
Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
|
|
870
808
|
|
|
871
809
|
### Examples
|
|
872
810
|
|
data/docs/Error.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **code** | **Integer** | Error's HTTP status code. | [optional] |
|
|
8
8
|
| **key** | **String** | Short string describing the kind of error which occurred. | [optional] |
|
|
9
|
-
| **message** | **String** | A human-readable message providing a short description
|
|
9
|
+
| **message** | **String** | A human-readable message providing a short description of the error. | [optional] |
|
|
10
10
|
| **details** | **String** | A human-readable message providing more details about the error. | [optional] |
|
|
11
11
|
| **request_id** | **String** | This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team. | [optional] |
|
|
12
12
|
| **resource_id** | **String** | Unique resource ID that can be used in another endpoint to get more details. | [optional] |
|
data/docs/ExportsApi.md
CHANGED
|
@@ -141,6 +141,18 @@ Download the contents of the exported CSV file. 📘 Important notes **Base U
|
|
|
141
141
|
```ruby
|
|
142
142
|
require 'time'
|
|
143
143
|
require 'VoucherifySdk'
|
|
144
|
+
# setup authorization
|
|
145
|
+
VoucherifySdk.configure do |config|
|
|
146
|
+
# Configure API key authorization: X-App-Id
|
|
147
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
148
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
149
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
150
|
+
|
|
151
|
+
# Configure API key authorization: X-App-Token
|
|
152
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
153
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
154
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
155
|
+
end
|
|
144
156
|
|
|
145
157
|
api_instance = VoucherifySdk::ExportsApi.new
|
|
146
158
|
export_id = 'exp_ex6zq0x0EEa9S0N68QcqhxcQ' # String | Unique export object ID.
|
|
@@ -170,7 +182,7 @@ end
|
|
|
170
182
|
|
|
171
183
|
### Authorization
|
|
172
184
|
|
|
173
|
-
|
|
185
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
174
186
|
|
|
175
187
|
### HTTP request headers
|
|
176
188
|
|