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
|
@@ -22,10 +22,10 @@
|
|
|
22
22
|
| **customer** | [**RedemptionsGetResponseBodyCustomer**](RedemptionsGetResponseBodyCustomer.md) | | [optional] |
|
|
23
23
|
| **related_object_type** | **String** | Defines the related object. | [optional] |
|
|
24
24
|
| **related_object_id** | **String** | | [optional] |
|
|
25
|
-
| **voucher** | [**RedemptionsGetResponseBodyVoucher**](RedemptionsGetResponseBodyVoucher.md) | | [optional] |
|
|
26
25
|
| **promotion_tier** | [**RedemptionsGetResponseBodyPromotionTier**](RedemptionsGetResponseBodyPromotionTier.md) | | [optional] |
|
|
27
26
|
| **reward** | [**RedemptionRewardResult**](RedemptionRewardResult.md) | | [optional] |
|
|
28
27
|
| **gift** | [**RedemptionsGetResponseBodyGift**](RedemptionsGetResponseBodyGift.md) | | [optional] |
|
|
29
28
|
| **loyalty_card** | [**RedemptionsGetResponseBodyLoyaltyCard**](RedemptionsGetResponseBodyLoyaltyCard.md) | | [optional] |
|
|
29
|
+
| **voucher** | [**RedemptionsGetResponseBodyVoucher**](RedemptionsGetResponseBodyVoucher.md) | | [optional] |
|
|
30
30
|
| **reason** | **String** | System generated cause for the redemption being invalid in the context of the provided parameters. | [optional] |
|
|
31
31
|
|
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **channel_id** | **String** | | [optional] |
|
|
8
|
-
| **channel_type** | **String** |
|
|
8
|
+
| **channel_type** | **String** | | [optional] |
|
|
9
9
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
| **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
|
|
17
17
|
| **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` | [optional] |
|
|
18
18
|
| **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
|
|
19
|
-
| **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. | [optional] |
|
|
19
|
+
| **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
|
|
20
20
|
| **metadata** | **Object** | | [optional] |
|
|
21
21
|
| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
|
|
22
22
|
| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [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
|
|
|
@@ -22,10 +22,10 @@
|
|
|
22
22
|
| **customer** | [**RedemptionsListResponseBodyRedemptionsItemCustomer**](RedemptionsListResponseBodyRedemptionsItemCustomer.md) | | [optional] |
|
|
23
23
|
| **related_object_type** | **String** | Defines the related object. | [optional] |
|
|
24
24
|
| **related_object_id** | **String** | | [optional] |
|
|
25
|
-
| **voucher** | [**RedemptionsListResponseBodyRedemptionsItemVoucher**](RedemptionsListResponseBodyRedemptionsItemVoucher.md) | | [optional] |
|
|
26
25
|
| **promotion_tier** | [**RedemptionsListResponseBodyRedemptionsItemPromotionTier**](RedemptionsListResponseBodyRedemptionsItemPromotionTier.md) | | [optional] |
|
|
27
26
|
| **reward** | [**RedemptionRewardResult**](RedemptionRewardResult.md) | | [optional] |
|
|
28
27
|
| **gift** | [**RedemptionsListResponseBodyRedemptionsItemGift**](RedemptionsListResponseBodyRedemptionsItemGift.md) | | [optional] |
|
|
29
28
|
| **loyalty_card** | [**RedemptionsListResponseBodyRedemptionsItemLoyaltyCard**](RedemptionsListResponseBodyRedemptionsItemLoyaltyCard.md) | | [optional] |
|
|
29
|
+
| **voucher** | [**RedemptionsListResponseBodyRedemptionsItemVoucher**](RedemptionsListResponseBodyRedemptionsItemVoucher.md) | | [optional] |
|
|
30
30
|
| **reason** | **String** | System generated cause for the redemption being invalid in the context of the provided parameters. | [optional] |
|
|
31
31
|
|
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **channel_id** | **String** | | [optional] |
|
|
8
|
-
| **channel_type** | **String** |
|
|
8
|
+
| **channel_type** | **String** | | [optional] |
|
|
9
9
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
| **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
|
|
17
17
|
| **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` | [optional] |
|
|
18
18
|
| **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
|
|
19
|
-
| **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. | [optional] |
|
|
19
|
+
| **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
|
|
20
20
|
| **metadata** | **Object** | | [optional] |
|
|
21
21
|
| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
|
|
22
22
|
| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [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
|
|
|
@@ -0,0 +1,397 @@
|
|
|
1
|
+
# VoucherifySdk::ReferralsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.voucherify.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**referrals_add_holders**](ReferralsApi.md#referrals_add_holders) | **POST** /v1/referrals/members/{memberId}/holders | Add Referral Code Holders |
|
|
8
|
+
| [**referrals_add_holders1**](ReferralsApi.md#referrals_add_holders1) | **POST** /v1/referrals/{campaignId}/members/{memberId}/holders | Add Referral Code Holders |
|
|
9
|
+
| [**referrals_code_holders**](ReferralsApi.md#referrals_code_holders) | **GET** /v1/referrals/{campaignId}/members/{memberId}/holders | List Referral Code Holders |
|
|
10
|
+
| [**referrals_code_holders1**](ReferralsApi.md#referrals_code_holders1) | **GET** /v1/referrals/members/{memberId}/holders | List Referral Code Holders |
|
|
11
|
+
| [**referrals_remove_holder**](ReferralsApi.md#referrals_remove_holder) | **DELETE** /v1/referrals/members/{memberId}/holders/{holderId} | Remove Referral Card Holder |
|
|
12
|
+
| [**referrals_remove_holder1**](ReferralsApi.md#referrals_remove_holder1) | **DELETE** /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} | Remove Referral Card Holder |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## referrals_add_holders
|
|
16
|
+
|
|
17
|
+
> <ReferralsMembersHoldersCreateInBulkResponseBody> referrals_add_holders(member_id, opts)
|
|
18
|
+
|
|
19
|
+
Add Referral Code Holders
|
|
20
|
+
|
|
21
|
+
Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) 👍 To add a holder as a referer, use the Create Publication endpoint. 📘 Alternative endpoint This endpoint is an alternative to the Add Referral Code Holders endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
|
|
22
|
+
|
|
23
|
+
### Examples
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'time'
|
|
27
|
+
require 'VoucherifySdk'
|
|
28
|
+
# setup authorization
|
|
29
|
+
VoucherifySdk.configure do |config|
|
|
30
|
+
# Configure API key authorization: X-App-Id
|
|
31
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
34
|
+
|
|
35
|
+
# Configure API key authorization: X-App-Token
|
|
36
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
37
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
38
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = VoucherifySdk::ReferralsApi.new
|
|
42
|
+
member_id = 'member_id_example' # String | Unique referral code or its identifier.
|
|
43
|
+
opts = {
|
|
44
|
+
referrals_members_holders_create_in_bulk_request_body: VoucherifySdk::ReferralsMembersHoldersCreateInBulkRequestBody.new # ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders.
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
begin
|
|
48
|
+
# Add Referral Code Holders
|
|
49
|
+
result = api_instance.referrals_add_holders(member_id, opts)
|
|
50
|
+
p result
|
|
51
|
+
rescue VoucherifySdk::ApiError => e
|
|
52
|
+
puts "Error when calling ReferralsApi->referrals_add_holders: #{e}"
|
|
53
|
+
end
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
| Name | Type | Description | Notes |
|
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
|
60
|
+
| **member_id** | **String** | Unique referral code or its identifier. | |
|
|
61
|
+
| **referrals_members_holders_create_in_bulk_request_body** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md) | Specify the customer data to be upserted as redeemable holders. | [optional] |
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
[**ReferralsMembersHoldersCreateInBulkResponseBody**](ReferralsMembersHoldersCreateInBulkResponseBody.md)
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: application/json
|
|
74
|
+
- **Accept**: application/json
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## referrals_add_holders1
|
|
78
|
+
|
|
79
|
+
> <ReferralsMembersHoldersCreateInBulkResponseBody> referrals_add_holders1(campaign_id, member_id, opts)
|
|
80
|
+
|
|
81
|
+
Add Referral Code Holders
|
|
82
|
+
|
|
83
|
+
Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) 👍 To add a holder as a referer, use the Create Publication endpoint.
|
|
84
|
+
|
|
85
|
+
### Examples
|
|
86
|
+
|
|
87
|
+
```ruby
|
|
88
|
+
require 'time'
|
|
89
|
+
require 'VoucherifySdk'
|
|
90
|
+
# setup authorization
|
|
91
|
+
VoucherifySdk.configure do |config|
|
|
92
|
+
# Configure API key authorization: X-App-Id
|
|
93
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
94
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
95
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
96
|
+
|
|
97
|
+
# Configure API key authorization: X-App-Token
|
|
98
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
99
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
100
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
api_instance = VoucherifySdk::ReferralsApi.new
|
|
104
|
+
campaign_id = 'campaign_id_example' # String | Unique identifier of a referral program campaign.
|
|
105
|
+
member_id = 'member_id_example' # String | Unique referral code or its identifier.
|
|
106
|
+
opts = {
|
|
107
|
+
referrals_members_holders_create_in_bulk_request_body: VoucherifySdk::ReferralsMembersHoldersCreateInBulkRequestBody.new # ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders.
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
begin
|
|
111
|
+
# Add Referral Code Holders
|
|
112
|
+
result = api_instance.referrals_add_holders1(campaign_id, member_id, opts)
|
|
113
|
+
p result
|
|
114
|
+
rescue VoucherifySdk::ApiError => e
|
|
115
|
+
puts "Error when calling ReferralsApi->referrals_add_holders1: #{e}"
|
|
116
|
+
end
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Parameters
|
|
120
|
+
|
|
121
|
+
| Name | Type | Description | Notes |
|
|
122
|
+
| ---- | ---- | ----------- | ----- |
|
|
123
|
+
| **campaign_id** | **String** | Unique identifier of a referral program campaign. | |
|
|
124
|
+
| **member_id** | **String** | Unique referral code or its identifier. | |
|
|
125
|
+
| **referrals_members_holders_create_in_bulk_request_body** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md) | Specify the customer data to be upserted as redeemable holders. | [optional] |
|
|
126
|
+
|
|
127
|
+
### Return type
|
|
128
|
+
|
|
129
|
+
[**ReferralsMembersHoldersCreateInBulkResponseBody**](ReferralsMembersHoldersCreateInBulkResponseBody.md)
|
|
130
|
+
|
|
131
|
+
### Authorization
|
|
132
|
+
|
|
133
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
134
|
+
|
|
135
|
+
### HTTP request headers
|
|
136
|
+
|
|
137
|
+
- **Content-Type**: application/json
|
|
138
|
+
- **Accept**: application/json
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
## referrals_code_holders
|
|
142
|
+
|
|
143
|
+
> <ReferralsMembersHoldersListResponseBody> referrals_code_holders(campaign_id, member_id, opts)
|
|
144
|
+
|
|
145
|
+
List Referral Code Holders
|
|
146
|
+
|
|
147
|
+
Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)
|
|
148
|
+
|
|
149
|
+
### Examples
|
|
150
|
+
|
|
151
|
+
```ruby
|
|
152
|
+
require 'time'
|
|
153
|
+
require 'VoucherifySdk'
|
|
154
|
+
# setup authorization
|
|
155
|
+
VoucherifySdk.configure do |config|
|
|
156
|
+
# Configure API key authorization: X-App-Id
|
|
157
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
158
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
159
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
160
|
+
|
|
161
|
+
# Configure API key authorization: X-App-Token
|
|
162
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
163
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
164
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
api_instance = VoucherifySdk::ReferralsApi.new
|
|
168
|
+
campaign_id = 'campaign_id_example' # String | Unique identifier of a referral program campaign.
|
|
169
|
+
member_id = 'member_id_example' # String | Unique referral code or its identifier.
|
|
170
|
+
opts = {
|
|
171
|
+
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.
|
|
172
|
+
order: VoucherifySdk::ParameterOrderListRedeemables::ID, # ParameterOrderListRedeemables | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
173
|
+
starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
|
|
174
|
+
filters: VoucherifySdk::ParameterFiltersListReferralsRedeemableHolders.new # ParameterFiltersListReferralsRedeemableHolders | Filters for listing customer redeemables.
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
begin
|
|
178
|
+
# List Referral Code Holders
|
|
179
|
+
result = api_instance.referrals_code_holders(campaign_id, member_id, opts)
|
|
180
|
+
p result
|
|
181
|
+
rescue VoucherifySdk::ApiError => e
|
|
182
|
+
puts "Error when calling ReferralsApi->referrals_code_holders: #{e}"
|
|
183
|
+
end
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
|
|
188
|
+
| Name | Type | Description | Notes |
|
|
189
|
+
| ---- | ---- | ----------- | ----- |
|
|
190
|
+
| **campaign_id** | **String** | Unique identifier of a referral program campaign. | |
|
|
191
|
+
| **member_id** | **String** | Unique referral code or its identifier. | |
|
|
192
|
+
| **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] |
|
|
193
|
+
| **order** | [**ParameterOrderListRedeemables**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
194
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] |
|
|
195
|
+
| **filters** | [**ParameterFiltersListReferralsRedeemableHolders**](.md) | Filters for listing customer redeemables. | [optional] |
|
|
196
|
+
|
|
197
|
+
### Return type
|
|
198
|
+
|
|
199
|
+
[**ReferralsMembersHoldersListResponseBody**](ReferralsMembersHoldersListResponseBody.md)
|
|
200
|
+
|
|
201
|
+
### Authorization
|
|
202
|
+
|
|
203
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
204
|
+
|
|
205
|
+
### HTTP request headers
|
|
206
|
+
|
|
207
|
+
- **Content-Type**: Not defined
|
|
208
|
+
- **Accept**: application/json
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
## referrals_code_holders1
|
|
212
|
+
|
|
213
|
+
> <ReferralsMembersHoldersListResponseBody> referrals_code_holders1(member_id, opts)
|
|
214
|
+
|
|
215
|
+
List Referral Code Holders
|
|
216
|
+
|
|
217
|
+
Retrieves the holders of the referral code from a referral campaign. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read) 📘 Alternative endpoint This endpoint is an alternative to the List Member Holders endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
|
|
218
|
+
|
|
219
|
+
### Examples
|
|
220
|
+
|
|
221
|
+
```ruby
|
|
222
|
+
require 'time'
|
|
223
|
+
require 'VoucherifySdk'
|
|
224
|
+
# setup authorization
|
|
225
|
+
VoucherifySdk.configure do |config|
|
|
226
|
+
# Configure API key authorization: X-App-Id
|
|
227
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
228
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
229
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
230
|
+
|
|
231
|
+
# Configure API key authorization: X-App-Token
|
|
232
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
233
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
234
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
api_instance = VoucherifySdk::ReferralsApi.new
|
|
238
|
+
member_id = 'member_id_example' # String | Unique referral code or its identifier.
|
|
239
|
+
opts = {
|
|
240
|
+
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.
|
|
241
|
+
order: VoucherifySdk::ParameterOrderListRedeemables::ID, # ParameterOrderListRedeemables | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
|
242
|
+
starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
|
|
243
|
+
filters: VoucherifySdk::ParameterFiltersListReferralsRedeemableHolders.new # ParameterFiltersListReferralsRedeemableHolders | Filters for listing customer redeemables.
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
begin
|
|
247
|
+
# List Referral Code Holders
|
|
248
|
+
result = api_instance.referrals_code_holders1(member_id, opts)
|
|
249
|
+
p result
|
|
250
|
+
rescue VoucherifySdk::ApiError => e
|
|
251
|
+
puts "Error when calling ReferralsApi->referrals_code_holders1: #{e}"
|
|
252
|
+
end
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
### Parameters
|
|
256
|
+
|
|
257
|
+
| Name | Type | Description | Notes |
|
|
258
|
+
| ---- | ---- | ----------- | ----- |
|
|
259
|
+
| **member_id** | **String** | Unique referral code or its identifier. | |
|
|
260
|
+
| **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] |
|
|
261
|
+
| **order** | [**ParameterOrderListRedeemables**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
|
262
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] |
|
|
263
|
+
| **filters** | [**ParameterFiltersListReferralsRedeemableHolders**](.md) | Filters for listing customer redeemables. | [optional] |
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
[**ReferralsMembersHoldersListResponseBody**](ReferralsMembersHoldersListResponseBody.md)
|
|
268
|
+
|
|
269
|
+
### Authorization
|
|
270
|
+
|
|
271
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
272
|
+
|
|
273
|
+
### HTTP request headers
|
|
274
|
+
|
|
275
|
+
- **Content-Type**: Not defined
|
|
276
|
+
- **Accept**: application/json
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
## referrals_remove_holder
|
|
280
|
+
|
|
281
|
+
> referrals_remove_holder(member_id, holder_id)
|
|
282
|
+
|
|
283
|
+
Remove Referral Card Holder
|
|
284
|
+
|
|
285
|
+
Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) 📘 Alternative endpoint This endpoint is an alternative to the Remove Referral Card Holder endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
|
|
286
|
+
|
|
287
|
+
### Examples
|
|
288
|
+
|
|
289
|
+
```ruby
|
|
290
|
+
require 'time'
|
|
291
|
+
require 'VoucherifySdk'
|
|
292
|
+
# setup authorization
|
|
293
|
+
VoucherifySdk.configure do |config|
|
|
294
|
+
# Configure API key authorization: X-App-Id
|
|
295
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
296
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
297
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
298
|
+
|
|
299
|
+
# Configure API key authorization: X-App-Token
|
|
300
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
301
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
302
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
api_instance = VoucherifySdk::ReferralsApi.new
|
|
306
|
+
member_id = 'member_id_example' # String | Unique referral code or its identifier.
|
|
307
|
+
holder_id = 'holder_id_example' # String | Unique identifier of a redeemable holder.
|
|
308
|
+
|
|
309
|
+
begin
|
|
310
|
+
# Remove Referral Card Holder
|
|
311
|
+
api_instance.referrals_remove_holder(member_id, holder_id)
|
|
312
|
+
rescue VoucherifySdk::ApiError => e
|
|
313
|
+
puts "Error when calling ReferralsApi->referrals_remove_holder: #{e}"
|
|
314
|
+
end
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
### Parameters
|
|
318
|
+
|
|
319
|
+
| Name | Type | Description | Notes |
|
|
320
|
+
| ---- | ---- | ----------- | ----- |
|
|
321
|
+
| **member_id** | **String** | Unique referral code or its identifier. | |
|
|
322
|
+
| **holder_id** | **String** | Unique identifier of a redeemable holder. | |
|
|
323
|
+
|
|
324
|
+
### Return type
|
|
325
|
+
|
|
326
|
+
nil (empty response body)
|
|
327
|
+
|
|
328
|
+
### Authorization
|
|
329
|
+
|
|
330
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
331
|
+
|
|
332
|
+
### HTTP request headers
|
|
333
|
+
|
|
334
|
+
- **Content-Type**: Not defined
|
|
335
|
+
- **Accept**: Not defined
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
## referrals_remove_holder1
|
|
339
|
+
|
|
340
|
+
> referrals_remove_holder1(campaign_id, member_id, holder_id)
|
|
341
|
+
|
|
342
|
+
Remove Referral Card Holder
|
|
343
|
+
|
|
344
|
+
Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)
|
|
345
|
+
|
|
346
|
+
### Examples
|
|
347
|
+
|
|
348
|
+
```ruby
|
|
349
|
+
require 'time'
|
|
350
|
+
require 'VoucherifySdk'
|
|
351
|
+
# setup authorization
|
|
352
|
+
VoucherifySdk.configure do |config|
|
|
353
|
+
# Configure API key authorization: X-App-Id
|
|
354
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
|
355
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
356
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
|
357
|
+
|
|
358
|
+
# Configure API key authorization: X-App-Token
|
|
359
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
|
360
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
361
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
|
362
|
+
end
|
|
363
|
+
|
|
364
|
+
api_instance = VoucherifySdk::ReferralsApi.new
|
|
365
|
+
campaign_id = 'campaign_id_example' # String | Unique identifier of a referral program campaign.
|
|
366
|
+
member_id = 'member_id_example' # String | Unique referral code or its identifier.
|
|
367
|
+
holder_id = 'holder_id_example' # String | Unique identifier of a redeemable holder.
|
|
368
|
+
|
|
369
|
+
begin
|
|
370
|
+
# Remove Referral Card Holder
|
|
371
|
+
api_instance.referrals_remove_holder1(campaign_id, member_id, holder_id)
|
|
372
|
+
rescue VoucherifySdk::ApiError => e
|
|
373
|
+
puts "Error when calling ReferralsApi->referrals_remove_holder1: #{e}"
|
|
374
|
+
end
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Parameters
|
|
378
|
+
|
|
379
|
+
| Name | Type | Description | Notes |
|
|
380
|
+
| ---- | ---- | ----------- | ----- |
|
|
381
|
+
| **campaign_id** | **String** | Unique identifier of a referral program campaign. | |
|
|
382
|
+
| **member_id** | **String** | Unique referral code or its identifier. | |
|
|
383
|
+
| **holder_id** | **String** | Unique identifier of a redeemable holder. | |
|
|
384
|
+
|
|
385
|
+
### Return type
|
|
386
|
+
|
|
387
|
+
nil (empty response body)
|
|
388
|
+
|
|
389
|
+
### Authorization
|
|
390
|
+
|
|
391
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
|
392
|
+
|
|
393
|
+
### HTTP request headers
|
|
394
|
+
|
|
395
|
+
- **Content-Type**: Not defined
|
|
396
|
+
- **Accept**: Not defined
|
|
397
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# VoucherifySdk::ReferralsMembersHoldersCreateInBulkRequestBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **holders** | [**Array<Customer>**](Customer.md) | Array of holders to be added to a referral card as referees. You have to send at least one object in the array up to a maximum of 100 objects. You can send either a `source_id` or `id`, or both; however, at least one of them is required. If both are sent, Voucherify checks `id` to upsert that customer's data. | [optional] |
|
|
8
|
+
| **metadata** | **Object** | A set of custom key/value pairs that you can attach to the redeemable holders sent in the array. The value can be a string, number, boolean, date, datetime, image URL, or object. The metadata must meet the metadata schema for publications. The metadata object stores all custom attributes assigned to the redeemable holder. | [optional] |
|
|
9
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# VoucherifySdk::ReferralsMembersHoldersCreateInBulkResponseBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **holders** | [**Array<RedeemableHolder>**](RedeemableHolder.md) | Contains an array of referral card holders who are the customers sent in the request. | [optional] |
|
|
8
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# VoucherifySdk::ReferralsMembersHoldersListResponseBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **object** | **String** | The type of the object represented by JSON. This object stores information about redeemables holders | [optional][default to 'list'] |
|
|
8
|
+
| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of holders. | [optional][default to 'data'] |
|
|
9
|
+
| **data** | [**Array<RedeemableHolder>**](RedeemableHolder.md) | A dictionary that contains an array of holders. | [optional] |
|
|
10
|
+
| **total** | **Integer** | Total number of holders assigned to the redeemable. | [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 with a `starting_after_id` query or a different limit to get more records returned in the results. | [optional] |
|
|
12
|
+
| **more_starting_after** | **String** | Returns an ID that can be used to return another page of results. Use the ID in the `starting_after_id` query parameter to display another page of the results occuring after the field with that ID. | [optional] |
|
|
13
|
+
|
|
@@ -5,4 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **points** | **Integer** | The number of points required to redeem the reward. | [optional] |
|
|
8
|
+
| **auto_redeem** | **Boolean** | Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`. | [optional] |
|
|
8
9
|
|
|
@@ -5,4 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **points** | **Integer** | Number of points that will be subtracted from the loyalty card points balance if the reward is redeemed. Must be positive integer. | [optional] |
|
|
8
|
+
| **auto_redeem** | **Boolean** | Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`. | [optional] |
|
|
8
9
|
|
|
@@ -5,4 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **points** | **Integer** | The number of points required to redeem the reward. | [optional] |
|
|
8
|
+
| **auto_redeem** | **Boolean** | Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`. | [optional] |
|
|
8
9
|
|
|
@@ -5,4 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **points** | **Integer** | The number of points required to redeem the reward. | [optional] |
|
|
8
|
+
| **auto_redeem** | **Boolean** | Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`. | [optional] |
|
|
8
9
|
|
|
@@ -5,4 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **points** | **Integer** | Defines how many points are required to obtain the reward. | [optional] |
|
|
8
|
+
| **auto_redeem** | **Boolean** | Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`. | [optional] |
|
|
8
9
|
|
|
@@ -5,4 +5,5 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **points** | **Integer** | The number of points required to redeem the reward. | [optional] |
|
|
8
|
+
| **auto_redeem** | **Boolean** | Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`. | [optional] |
|
|
8
9
|
|