@voucherify/sdk 2.9.4 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1460) hide show
  1. package/README.md +1789 -1750
  2. package/dist/index.esm.js +205013 -0
  3. package/dist/index.js +206402 -0
  4. package/docs/AccessSettings.md +10 -0
  5. package/docs/AccessSettingsAssign.md +11 -0
  6. package/docs/AccessSettingsCampaignAssignmentsList.md +30 -0
  7. package/docs/AccessSettingsUnassign.md +11 -0
  8. package/docs/ApplicableTo.md +49 -0
  9. package/docs/ApplicableToEffect.md +16 -0
  10. package/docs/ApplicableToOrderItemUnitsItem.md +11 -0
  11. package/docs/ApplicableToResultList.md +30 -0
  12. package/docs/ApplicationDetailsItem.md +15 -0
  13. package/docs/AreaStoreCampaignAssignment.md +23 -0
  14. package/docs/AsyncActionBase.md +55 -0
  15. package/docs/AsyncActionGetResponseBody.md +56 -0
  16. package/docs/AsyncActionsApi.md +132 -0
  17. package/docs/AsyncActionsListResponseBody.md +30 -0
  18. package/docs/BinApi.md +136 -0
  19. package/docs/Bundle.md +12 -0
  20. package/docs/BundleIdentifiedItem.md +23 -0
  21. package/docs/BundleMissingItem.md +24 -0
  22. package/docs/BusValRuleAssignment.md +39 -0
  23. package/docs/Campaign.md +126 -0
  24. package/docs/CampaignBase.md +124 -0
  25. package/docs/CampaignLoyaltyCard.md +10 -0
  26. package/docs/CampaignLoyaltyCardExpirationRules.md +42 -0
  27. package/docs/CampaignLoyaltyVoucher.md +21 -0
  28. package/docs/CampaignLoyaltyVoucherRedemption.md +9 -0
  29. package/docs/CampaignTemplate.md +35 -0
  30. package/docs/CampaignVoucher.md +41 -0
  31. package/docs/CampaignVoucherRedemption.md +9 -0
  32. package/docs/CampaignsApi.md +906 -0
  33. package/docs/CampaignsCreateRequestBody.md +79 -0
  34. package/docs/CampaignsCreateRequestBodyPromotion.md +9 -0
  35. package/docs/CampaignsCreateRequestBodyVoucher.md +28 -0
  36. package/docs/CampaignsCreateRequestBodyVoucherRedemption.md +9 -0
  37. package/docs/CampaignsCreateResponseBody.md +126 -0
  38. package/docs/CampaignsDeleteResponseBody.md +9 -0
  39. package/docs/CampaignsGetResponseBody.md +126 -0
  40. package/docs/CampaignsImportCreateResponseBody.md +9 -0
  41. package/docs/CampaignsImportCsvCreateResponseBody.md +9 -0
  42. package/docs/CampaignsImportVoucherItem.md +56 -0
  43. package/docs/CampaignsImportVoucherItemRedemption.md +9 -0
  44. package/docs/CampaignsListResponseBody.md +12 -0
  45. package/docs/CampaignsSummaryGetResponseBody.md +58 -0
  46. package/docs/CampaignsTransactionsExportCreateRequestBody.md +9 -0
  47. package/docs/CampaignsTransactionsExportCreateRequestBodyParameters.md +51 -0
  48. package/docs/CampaignsTransactionsExportCreateResponseBody.md +53 -0
  49. package/docs/CampaignsTransactionsExportCreateResponseBodyParameters.md +51 -0
  50. package/docs/CampaignsTransactionsExportCreateResponseBodyParametersFilters.md +12 -0
  51. package/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md +9 -0
  52. package/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md +9 -0
  53. package/docs/CampaignsTransactionsExportCreateResponseBodyResult.md +9 -0
  54. package/docs/CampaignsTransactionsListResponseBody.md +31 -0
  55. package/docs/CampaignsUpdateRequestBody.md +60 -0
  56. package/docs/CampaignsUpdateRequestBodyOptions.md +9 -0
  57. package/docs/CampaignsUpdateResponseBody.md +126 -0
  58. package/docs/CampaignsVouchersCreateCombinedResponseBody.md +72 -0
  59. package/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md +23 -0
  60. package/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +15 -0
  61. package/docs/CampaignsVouchersCreateCombinedResponseBodyPublish.md +11 -0
  62. package/docs/CampaignsVouchersCreateCombinedResponseBodyRedemption.md +13 -0
  63. package/docs/CampaignsVouchersCreateInBulkRequestBody.md +16 -0
  64. package/docs/CampaignsVouchersCreateInBulkRequestBodyRedemption.md +9 -0
  65. package/docs/CampaignsVouchersCreateRequestBody.md +14 -0
  66. package/docs/CampaignsVouchersCreateRequestBodyRedemption.md +9 -0
  67. package/docs/CampaignsVouchersCreateResponseBody.md +71 -0
  68. package/docs/CampaignsVouchersCreateResponseBodyGift.md +23 -0
  69. package/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +15 -0
  70. package/docs/CampaignsVouchersCreateResponseBodyPublish.md +11 -0
  71. package/docs/CampaignsVouchersCreateResponseBodyRedemption.md +13 -0
  72. package/docs/CategoriesApi.md +306 -0
  73. package/docs/CategoriesCreateRequestBody.md +10 -0
  74. package/docs/CategoriesCreateResponseBody.md +22 -0
  75. package/docs/CategoriesGetResponseBody.md +23 -0
  76. package/docs/CategoriesListResponseBody.md +30 -0
  77. package/docs/CategoriesUpdateRequestBody.md +10 -0
  78. package/docs/CategoriesUpdateResponseBody.md +23 -0
  79. package/docs/Category.md +23 -0
  80. package/docs/CategoryWithStackingRulesType.md +35 -0
  81. package/docs/ClientEventsCreateRequestBody.md +13 -0
  82. package/docs/ClientEventsCreateRequestBodyLoyalty.md +9 -0
  83. package/docs/ClientEventsCreateRequestBodyReferral.md +10 -0
  84. package/docs/ClientEventsCreateResponseBody.md +23 -0
  85. package/docs/ClientPromotionsTiersListResponseBody.md +13 -0
  86. package/docs/ClientQualificationsCheckEligibilityRequestBody.md +38 -0
  87. package/docs/ClientQualificationsCheckEligibilityRequestBodySession.md +18 -0
  88. package/docs/ClientQualificationsCheckEligibilityResponseBody.md +12 -0
  89. package/docs/ClientQualificationsCheckEligibilityResponseBodyOrder.md +54 -0
  90. package/docs/ClientQualificationsCheckEligibilityResponseBodyOrderItemsItem.md +50 -0
  91. package/docs/ClientRedemptionsRedeemRequestBody.md +15 -0
  92. package/docs/ClientRedemptionsRedeemRequestBodyOptions.md +24 -0
  93. package/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItem.md +25 -0
  94. package/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md +9 -0
  95. package/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemReward.md +10 -0
  96. package/docs/ClientRedemptionsRedeemResponseBody.md +13 -0
  97. package/docs/ClientRedemptionsRedeemResponseBodyOrder.md +54 -0
  98. package/docs/ClientRedemptionsRedeemResponseBodyOrderItemsItem.md +50 -0
  99. package/docs/ClientSideApi.md +324 -0
  100. package/docs/ClientValidationsValidateRequestBody.md +15 -0
  101. package/docs/ClientValidationsValidateRequestBodyOptions.md +24 -0
  102. package/docs/ClientValidationsValidateRequestBodyRedeemablesItem.md +25 -0
  103. package/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md +9 -0
  104. package/docs/ClientValidationsValidateRequestBodyRedeemablesItemReward.md +10 -0
  105. package/docs/ClientValidationsValidateResponseBody.md +17 -0
  106. package/docs/ClientValidationsValidateResponseBodyOrder.md +54 -0
  107. package/docs/ClientValidationsValidateResponseBodyOrderItemsItem.md +50 -0
  108. package/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md +44 -0
  109. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemOrder.md +54 -0
  110. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemOrderCustomer.md +19 -0
  111. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemOrderReferrer.md +19 -0
  112. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemResult.md +14 -0
  113. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md +10 -0
  114. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +63 -0
  115. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md +11 -0
  116. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md +10 -0
  117. package/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md +9 -0
  118. package/docs/CodeConfig.md +14 -0
  119. package/docs/CreatePublicationCampaign.md +10 -0
  120. package/docs/CustomEvent.md +25 -0
  121. package/docs/CustomEventLoyalty.md +9 -0
  122. package/docs/CustomEventReferral.md +11 -0
  123. package/docs/Customer.md +18 -0
  124. package/docs/CustomerActivity.md +168 -0
  125. package/docs/CustomerAddress.md +14 -0
  126. package/docs/CustomerId.md +19 -0
  127. package/docs/CustomerLoyalty.md +11 -0
  128. package/docs/CustomerLoyaltyCampaignsEntryValue.md +11 -0
  129. package/docs/CustomerRedeemable.md +61 -0
  130. package/docs/CustomerRedeemableRedeemable.md +30 -0
  131. package/docs/CustomerReferrals.md +10 -0
  132. package/docs/CustomerReferralsCampaignsItem.md +13 -0
  133. package/docs/CustomerSummary.md +10 -0
  134. package/docs/CustomerSummaryOrders.md +13 -0
  135. package/docs/CustomerSummaryRedemptions.md +16 -0
  136. package/docs/CustomerSummaryRedemptionsGift.md +10 -0
  137. package/docs/CustomerSummaryRedemptionsLoyaltyCard.md +10 -0
  138. package/docs/CustomerWithSummaryLoyaltyReferrals.md +35 -0
  139. package/docs/CustomerWithSummaryLoyaltyReferralsAddress.md +14 -0
  140. package/docs/CustomerWithSummaryLoyaltyReferralsAssets.md +9 -0
  141. package/docs/CustomersActivityListResponseBody.md +22 -0
  142. package/docs/CustomersApi.md +786 -0
  143. package/docs/CustomersCreateRequestBody.md +18 -0
  144. package/docs/CustomersCreateRequestBodyAddress.md +14 -0
  145. package/docs/CustomersCreateResponseBody.md +35 -0
  146. package/docs/CustomersCreateResponseBodyAddress.md +14 -0
  147. package/docs/CustomersCreateResponseBodyAssets.md +9 -0
  148. package/docs/CustomersGetResponseBody.md +35 -0
  149. package/docs/CustomersGetResponseBodyAddress.md +14 -0
  150. package/docs/CustomersGetResponseBodyAssets.md +9 -0
  151. package/docs/CustomersImportCsvCreateResponseBody.md +9 -0
  152. package/docs/CustomersListResponseBody.md +13 -0
  153. package/docs/CustomersMetadataUpdateInBulkRequestBody.md +10 -0
  154. package/docs/CustomersMetadataUpdateInBulkResponseBody.md +9 -0
  155. package/docs/CustomersPermanentDeletionCreateResponseBody.md +15 -0
  156. package/docs/CustomersPermanentDeletionCreateResponseBodyDataJson.md +15 -0
  157. package/docs/CustomersRedeemablesListResponseBody.md +14 -0
  158. package/docs/CustomersSegmentsListResponseBody.md +12 -0
  159. package/docs/CustomersUpdateInBulkRequestBody.md +17 -0
  160. package/docs/CustomersUpdateInBulkRequestBodyAddress.md +14 -0
  161. package/docs/CustomersUpdateInBulkResponseBody.md +9 -0
  162. package/docs/CustomersUpdateRequestBody.md +16 -0
  163. package/docs/CustomersUpdateRequestBodyAddress.md +14 -0
  164. package/docs/CustomersUpdateResponseBody.md +35 -0
  165. package/docs/CustomersUpdateResponseBodyAddress.md +14 -0
  166. package/docs/CustomersUpdateResponseBodyAssets.md +9 -0
  167. package/docs/Discount.md +63 -0
  168. package/docs/DiscountProduct.md +11 -0
  169. package/docs/DiscountUnitMultipleOneUnit.md +25 -0
  170. package/docs/EarningRule.md +59 -0
  171. package/docs/EarningRuleCustomEvent.md +9 -0
  172. package/docs/EarningRuleExpirationRules.md +42 -0
  173. package/docs/EarningRuleLoyalty.md +50 -0
  174. package/docs/EarningRuleLoyaltyCustomEvent.md +9 -0
  175. package/docs/EarningRuleLoyaltyCustomEventMetadata.md +12 -0
  176. package/docs/EarningRuleLoyaltyCustomer.md +9 -0
  177. package/docs/EarningRuleLoyaltyCustomerMetadata.md +12 -0
  178. package/docs/EarningRuleLoyaltyOrder.md +11 -0
  179. package/docs/EarningRuleLoyaltyOrderAmount.md +11 -0
  180. package/docs/EarningRuleLoyaltyOrderItems.md +11 -0
  181. package/docs/EarningRuleLoyaltyOrderItemsAmount.md +27 -0
  182. package/docs/EarningRuleLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  183. package/docs/EarningRuleLoyaltyOrderItemsQuantity.md +27 -0
  184. package/docs/EarningRuleLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  185. package/docs/EarningRuleLoyaltyOrderItemsSubtotalAmount.md +27 -0
  186. package/docs/EarningRuleLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  187. package/docs/EarningRuleLoyaltyOrderMetadata.md +12 -0
  188. package/docs/EarningRuleLoyaltyOrderTotalAmount.md +11 -0
  189. package/docs/EarningRuleLoyaltyTier.md +9 -0
  190. package/docs/EarningRulePendingPoints.md +19 -0
  191. package/docs/EarningRuleSegment.md +9 -0
  192. package/docs/EarningRuleSource.md +20 -0
  193. package/docs/Error.md +16 -0
  194. package/docs/ErrorError.md +9 -0
  195. package/docs/EventSource.md +26 -0
  196. package/docs/EventSourceApiKey.md +10 -0
  197. package/docs/EventSourceUser.md +9 -0
  198. package/docs/EventsApi.md +68 -0
  199. package/docs/EventsCreateRequestBody.md +13 -0
  200. package/docs/EventsCreateRequestBodyLoyalty.md +9 -0
  201. package/docs/EventsCreateRequestBodyReferral.md +10 -0
  202. package/docs/EventsCreateResponseBody.md +23 -0
  203. package/docs/Export.md +62 -0
  204. package/docs/ExportCampaignTransactionsFilters.md +11 -0
  205. package/docs/ExportOrderFields.md +32 -0
  206. package/docs/ExportOrderOrder.md +18 -0
  207. package/docs/ExportParameters.md +256 -0
  208. package/docs/ExportResult.md +9 -0
  209. package/docs/ExportVoucherTransactionsFields.md +30 -0
  210. package/docs/ExportVoucherTransactionsFilters.md +12 -0
  211. package/docs/ExportVoucherTransactionsOrder.md +10 -0
  212. package/docs/ExportsApi.md +318 -0
  213. package/docs/ExportsCreateRequestBody.md +31 -0
  214. package/docs/ExportsCreateRequestBodyParameters.md +256 -0
  215. package/docs/ExportsCreateResponseBody.md +56 -0
  216. package/docs/ExportsCreateResponseBodyParameters.md +256 -0
  217. package/docs/ExportsGetResponseBody.md +62 -0
  218. package/docs/ExportsGetResponseBodyParameters.md +256 -0
  219. package/docs/ExportsGetResponseBodyResult.md +9 -0
  220. package/docs/ExportsListResponseBody.md +30 -0
  221. package/docs/FieldConditions.md +9 -0
  222. package/docs/FilterConditionsDateTime.md +14 -0
  223. package/docs/FilterConditionsString.md +18 -0
  224. package/docs/FiltersCondition.md +33 -0
  225. package/docs/Gift.md +23 -0
  226. package/docs/InapplicableTo.md +49 -0
  227. package/docs/InapplicableToOrderItemUnitsItem.md +11 -0
  228. package/docs/InapplicableToResultList.md +30 -0
  229. package/docs/Junction.md +10 -0
  230. package/docs/ListPublicationsItemValidSingleVoucher.md +39 -0
  231. package/docs/ListPublicationsItemValidSingleVoucherMetadata.md +11 -0
  232. package/docs/ListPublicationsItemVoucher.md +24 -0
  233. package/docs/Location.md +23 -0
  234. package/docs/LocationShape.md +34 -0
  235. package/docs/LocationShapeDistance.md +10 -0
  236. package/docs/LocationShapeGeojson.md +21 -0
  237. package/docs/LocationsApi.md +136 -0
  238. package/docs/LocationsGetResponseBody.md +23 -0
  239. package/docs/LocationsGetResponseBodyShape.md +34 -0
  240. package/docs/LocationsGetResponseBodyShapeDistance.md +10 -0
  241. package/docs/LocationsGetResponseBodyShapeGeojson.md +21 -0
  242. package/docs/LocationsListResponseBody.md +13 -0
  243. package/docs/LoyaltiesApi.md +3358 -0
  244. package/docs/LoyaltiesCreateCampaignRequestBody.md +68 -0
  245. package/docs/LoyaltiesCreateCampaignResponseBody.md +114 -0
  246. package/docs/LoyaltiesDeleteResponseBody.md +9 -0
  247. package/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md +45 -0
  248. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent.md +9 -0
  249. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md +50 -0
  250. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent.md +9 -0
  251. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md +12 -0
  252. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer.md +9 -0
  253. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md +12 -0
  254. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrder.md +11 -0
  255. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderAmount.md +11 -0
  256. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems.md +11 -0
  257. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmount.md +27 -0
  258. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  259. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantity.md +27 -0
  260. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  261. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmount.md +27 -0
  262. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  263. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderMetadata.md +12 -0
  264. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderTotalAmount.md +11 -0
  265. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier.md +9 -0
  266. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemPendingPoints.md +19 -0
  267. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemSegment.md +9 -0
  268. package/docs/LoyaltiesEarningRulesCreateRequestBodyItemSource.md +9 -0
  269. package/docs/LoyaltiesEarningRulesCreateResponseBody.md +59 -0
  270. package/docs/LoyaltiesEarningRulesCreateResponseBodyCustomEvent.md +9 -0
  271. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md +50 -0
  272. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent.md +9 -0
  273. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md +12 -0
  274. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer.md +9 -0
  275. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md +12 -0
  276. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder.md +11 -0
  277. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md +11 -0
  278. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems.md +11 -0
  279. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md +27 -0
  280. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  281. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md +27 -0
  282. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  283. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +27 -0
  284. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  285. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md +12 -0
  286. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md +11 -0
  287. package/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier.md +9 -0
  288. package/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +19 -0
  289. package/docs/LoyaltiesEarningRulesCreateResponseBodySegment.md +9 -0
  290. package/docs/LoyaltiesEarningRulesCreateResponseBodySource.md +20 -0
  291. package/docs/LoyaltiesEarningRulesDisableResponseBody.md +58 -0
  292. package/docs/LoyaltiesEarningRulesDisableResponseBodyCustomEvent.md +9 -0
  293. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md +50 -0
  294. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent.md +9 -0
  295. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md +12 -0
  296. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer.md +9 -0
  297. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md +12 -0
  298. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder.md +11 -0
  299. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md +11 -0
  300. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItems.md +11 -0
  301. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmount.md +27 -0
  302. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  303. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantity.md +27 -0
  304. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  305. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +27 -0
  306. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  307. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md +12 -0
  308. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md +11 -0
  309. package/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier.md +9 -0
  310. package/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +19 -0
  311. package/docs/LoyaltiesEarningRulesDisableResponseBodySegment.md +9 -0
  312. package/docs/LoyaltiesEarningRulesDisableResponseBodySource.md +20 -0
  313. package/docs/LoyaltiesEarningRulesEnableResponseBody.md +58 -0
  314. package/docs/LoyaltiesEarningRulesEnableResponseBodyCustomEvent.md +9 -0
  315. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyalty.md +50 -0
  316. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEvent.md +9 -0
  317. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md +12 -0
  318. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomer.md +9 -0
  319. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md +12 -0
  320. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrder.md +11 -0
  321. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderAmount.md +11 -0
  322. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItems.md +11 -0
  323. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmount.md +27 -0
  324. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  325. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantity.md +27 -0
  326. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  327. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +27 -0
  328. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  329. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderMetadata.md +12 -0
  330. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderTotalAmount.md +11 -0
  331. package/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyTier.md +9 -0
  332. package/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +19 -0
  333. package/docs/LoyaltiesEarningRulesEnableResponseBodySegment.md +9 -0
  334. package/docs/LoyaltiesEarningRulesEnableResponseBodySource.md +20 -0
  335. package/docs/LoyaltiesEarningRulesGetResponseBody.md +59 -0
  336. package/docs/LoyaltiesEarningRulesGetResponseBodyCustomEvent.md +9 -0
  337. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyalty.md +50 -0
  338. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEvent.md +9 -0
  339. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md +12 -0
  340. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomer.md +9 -0
  341. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md +12 -0
  342. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrder.md +11 -0
  343. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderAmount.md +11 -0
  344. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItems.md +11 -0
  345. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmount.md +27 -0
  346. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  347. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantity.md +27 -0
  348. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  349. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmount.md +27 -0
  350. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  351. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderMetadata.md +12 -0
  352. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderTotalAmount.md +11 -0
  353. package/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyTier.md +9 -0
  354. package/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +19 -0
  355. package/docs/LoyaltiesEarningRulesGetResponseBodySegment.md +9 -0
  356. package/docs/LoyaltiesEarningRulesGetResponseBodySource.md +20 -0
  357. package/docs/LoyaltiesEarningRulesListResponseBody.md +21 -0
  358. package/docs/LoyaltiesEarningRulesUpdateRequestBody.md +41 -0
  359. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md +50 -0
  360. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEvent.md +9 -0
  361. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md +12 -0
  362. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomer.md +9 -0
  363. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md +12 -0
  364. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrder.md +11 -0
  365. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderAmount.md +11 -0
  366. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItems.md +11 -0
  367. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmount.md +27 -0
  368. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  369. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantity.md +27 -0
  370. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  371. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmount.md +27 -0
  372. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  373. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderMetadata.md +12 -0
  374. package/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderTotalAmount.md +11 -0
  375. package/docs/LoyaltiesEarningRulesUpdateRequestBodyPendingPoints.md +19 -0
  376. package/docs/LoyaltiesEarningRulesUpdateRequestBodySource.md +9 -0
  377. package/docs/LoyaltiesEarningRulesUpdateResponseBody.md +59 -0
  378. package/docs/LoyaltiesEarningRulesUpdateResponseBodyCustomEvent.md +9 -0
  379. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md +50 -0
  380. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEvent.md +9 -0
  381. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md +12 -0
  382. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomer.md +9 -0
  383. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md +12 -0
  384. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrder.md +11 -0
  385. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderAmount.md +11 -0
  386. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItems.md +11 -0
  387. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmount.md +27 -0
  388. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +23 -0
  389. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md +27 -0
  390. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +23 -0
  391. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +27 -0
  392. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +23 -0
  393. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md +12 -0
  394. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md +11 -0
  395. package/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier.md +9 -0
  396. package/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +19 -0
  397. package/docs/LoyaltiesEarningRulesUpdateResponseBodySegment.md +9 -0
  398. package/docs/LoyaltiesEarningRulesUpdateResponseBodySource.md +20 -0
  399. package/docs/LoyaltiesGetCampaignResponseBody.md +114 -0
  400. package/docs/LoyaltiesListCampaignsResponseBody.md +21 -0
  401. package/docs/LoyaltiesListMembersResponseBody.md +21 -0
  402. package/docs/LoyaltiesLoyaltyTierReward.md +20 -0
  403. package/docs/LoyaltiesMemberActivityListResponseBody.md +22 -0
  404. package/docs/LoyaltiesMembersBalanceUpdateRequestBody.md +13 -0
  405. package/docs/LoyaltiesMembersBalanceUpdateResponseBody.md +46 -0
  406. package/docs/LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md +19 -0
  407. package/docs/LoyaltiesMembersCreateRequestBody.md +13 -0
  408. package/docs/LoyaltiesMembersCreateResponseBody.md +64 -0
  409. package/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +15 -0
  410. package/docs/LoyaltiesMembersCreateResponseBodyPublish.md +11 -0
  411. package/docs/LoyaltiesMembersCreateResponseBodyRedemption.md +13 -0
  412. package/docs/LoyaltiesMembersGetResponseBody.md +64 -0
  413. package/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +15 -0
  414. package/docs/LoyaltiesMembersGetResponseBodyPublish.md +11 -0
  415. package/docs/LoyaltiesMembersGetResponseBodyRedemption.md +13 -0
  416. package/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +42 -0
  417. package/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +19 -0
  418. package/docs/LoyaltiesMembersPendingPointsBalanceRequestBody.md +9 -0
  419. package/docs/LoyaltiesMembersPendingPointsBalanceResponseBody.md +31 -0
  420. package/docs/LoyaltiesMembersPendingPointsBalanceResponseBodyRelatedObject.md +19 -0
  421. package/docs/LoyaltiesMembersPendingPointsListResponseBody.md +31 -0
  422. package/docs/LoyaltiesMembersPointsExpirationListResponseBody.md +30 -0
  423. package/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +11 -0
  424. package/docs/LoyaltiesMembersRedemptionRedeemRequestBodyReward.md +10 -0
  425. package/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +78 -0
  426. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyChannel.md +23 -0
  427. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyGift.md +9 -0
  428. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyLoyaltyCard.md +9 -0
  429. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyOrder.md +54 -0
  430. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyOrderCustomer.md +19 -0
  431. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyOrderItemsItem.md +50 -0
  432. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyOrderReferrer.md +19 -0
  433. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptions.md +10 -0
  434. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRedemptionsItem.md +10 -0
  435. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.md +22 -0
  436. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodySession.md +9 -0
  437. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucher.md +72 -0
  438. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherGift.md +23 -0
  439. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +15 -0
  440. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherPublish.md +11 -0
  441. package/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherRedemption.md +13 -0
  442. package/docs/LoyaltiesMembersRewardsListResponseBody.md +30 -0
  443. package/docs/LoyaltiesMembersRewardsListResponseBodyDataItem.md +20 -0
  444. package/docs/LoyaltiesMembersTiersListResponseBody.md +30 -0
  445. package/docs/LoyaltiesMembersTransactionsExportCreateRequestBody.md +9 -0
  446. package/docs/LoyaltiesMembersTransactionsExportCreateRequestBodyParameters.md +11 -0
  447. package/docs/LoyaltiesMembersTransactionsExportCreateResponseBody.md +44 -0
  448. package/docs/LoyaltiesMembersTransactionsExportCreateResponseBodyParameters.md +11 -0
  449. package/docs/LoyaltiesMembersTransactionsListResponseBody.md +31 -0
  450. package/docs/LoyaltiesMembersTransfersCreateResponseBody.md +62 -0
  451. package/docs/LoyaltiesMembersTransfersCreateResponseBodyAssets.md +10 -0
  452. package/docs/LoyaltiesMembersTransfersCreateResponseBodyAssetsBarcode.md +10 -0
  453. package/docs/LoyaltiesMembersTransfersCreateResponseBodyAssetsQr.md +10 -0
  454. package/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +15 -0
  455. package/docs/LoyaltiesMembersTransfersCreateResponseBodyPublish.md +21 -0
  456. package/docs/LoyaltiesMembersTransfersCreateResponseBodyRedemption.md +22 -0
  457. package/docs/LoyaltiesPendingPointsListResponseBody.md +31 -0
  458. package/docs/LoyaltiesPointsExpirationExportCreateRequestBody.md +9 -0
  459. package/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParameters.md +41 -0
  460. package/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParametersFilters.md +11 -0
  461. package/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersCampaignId.md +9 -0
  462. package/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersCampaignIdConditions.md +12 -0
  463. package/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersVoucherId.md +9 -0
  464. package/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersVoucherIdConditions.md +12 -0
  465. package/docs/LoyaltiesPointsExpirationExportCreateResponseBody.md +55 -0
  466. package/docs/LoyaltiesPointsExpirationExportCreateResponseBodyParameters.md +41 -0
  467. package/docs/LoyaltiesPointsExpirationExportCreateResponseBodyParametersFilters.md +11 -0
  468. package/docs/LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersCampaignId.md +9 -0
  469. package/docs/LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersCampaignIdConditions.md +12 -0
  470. package/docs/LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersVoucherId.md +9 -0
  471. package/docs/LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersVoucherIdConditions.md +12 -0
  472. package/docs/LoyaltiesRewardAssignmentsGetResponseBody.md +34 -0
  473. package/docs/LoyaltiesRewardAssignmentsGetResponseBodyParameters.md +9 -0
  474. package/docs/LoyaltiesRewardAssignmentsGetResponseBodyParametersLoyalty.md +10 -0
  475. package/docs/LoyaltiesRewardAssignmentsListResponseBody.md +21 -0
  476. package/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +41 -0
  477. package/docs/LoyaltiesRewardAssignmentsRewardGetResponseBodyAttributes.md +10 -0
  478. package/docs/LoyaltiesRewardsCreateAssignmentItemRequestBody.md +11 -0
  479. package/docs/LoyaltiesRewardsCreateAssignmentItemRequestBodyParameters.md +9 -0
  480. package/docs/LoyaltiesRewardsCreateAssignmentItemRequestBodyParametersLoyalty.md +9 -0
  481. package/docs/LoyaltiesRewardsCreateAssignmentResponseBody.md +34 -0
  482. package/docs/LoyaltiesRewardsCreateAssignmentResponseBodyParameters.md +9 -0
  483. package/docs/LoyaltiesRewardsCreateAssignmentResponseBodyParametersLoyalty.md +10 -0
  484. package/docs/LoyaltiesRewardsGetResponseBody.md +34 -0
  485. package/docs/LoyaltiesRewardsGetResponseBodyParameters.md +9 -0
  486. package/docs/LoyaltiesRewardsGetResponseBodyParametersLoyalty.md +10 -0
  487. package/docs/LoyaltiesRewardsListAssignmentsResponseBody.md +21 -0
  488. package/docs/LoyaltiesRewardsUpdateAssignmentRequestBody.md +9 -0
  489. package/docs/LoyaltiesRewardsUpdateAssignmentRequestBodyParameters.md +9 -0
  490. package/docs/LoyaltiesRewardsUpdateAssignmentRequestBodyParametersLoyalty.md +10 -0
  491. package/docs/LoyaltiesRewardsUpdateAssignmentResponseBody.md +34 -0
  492. package/docs/LoyaltiesRewardsUpdateAssignmentResponseBodyParameters.md +9 -0
  493. package/docs/LoyaltiesRewardsUpdateAssignmentResponseBodyParametersLoyalty.md +10 -0
  494. package/docs/LoyaltiesTiersCreateInBulkRequestBodyItem.md +13 -0
  495. package/docs/LoyaltiesTiersEarningRulesListResponseBody.md +30 -0
  496. package/docs/LoyaltiesTiersGetResponseBody.md +29 -0
  497. package/docs/LoyaltiesTiersGetResponseBodyConfig.md +9 -0
  498. package/docs/LoyaltiesTiersGetResponseBodyConfigPoints.md +10 -0
  499. package/docs/LoyaltiesTiersGetResponseBodyPoints.md +10 -0
  500. package/docs/LoyaltiesTiersListResponseBody.md +30 -0
  501. package/docs/LoyaltiesTiersRewardsListResponseBody.md +12 -0
  502. package/docs/LoyaltiesTransactionsExportCreateRequestBody.md +9 -0
  503. package/docs/LoyaltiesTransactionsExportCreateRequestBodyParameters.md +51 -0
  504. package/docs/LoyaltiesTransactionsListResponseBody.md +31 -0
  505. package/docs/LoyaltiesTransferPoints.md +12 -0
  506. package/docs/LoyaltiesUpdateCampaignRequestBody.md +57 -0
  507. package/docs/LoyaltiesUpdateCampaignRequestBodyOptions.md +9 -0
  508. package/docs/LoyaltiesUpdateCampaignResponseBody.md +114 -0
  509. package/docs/LoyaltyCampaign.md +114 -0
  510. package/docs/LoyaltyCampaignVoucher.md +48 -0
  511. package/docs/LoyaltyCampaignVoucherRedemption.md +9 -0
  512. package/docs/LoyaltyCardTransaction.md +18 -0
  513. package/docs/LoyaltyCardTransactionDetails.md +23 -0
  514. package/docs/LoyaltyCardTransactionDetailsCustomEvent.md +10 -0
  515. package/docs/LoyaltyCardTransactionDetailsEarningRule.md +10 -0
  516. package/docs/LoyaltyCardTransactionDetailsEarningRuleSource.md +9 -0
  517. package/docs/LoyaltyCardTransactionDetailsEvent.md +10 -0
  518. package/docs/LoyaltyCardTransactionDetailsEventSchema.md +10 -0
  519. package/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +10 -0
  520. package/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +10 -0
  521. package/docs/LoyaltyCardTransactionDetailsOrder.md +10 -0
  522. package/docs/LoyaltyCardTransactionDetailsRedemption.md +9 -0
  523. package/docs/LoyaltyCardTransactionDetailsReward.md +10 -0
  524. package/docs/LoyaltyCardTransactionDetailsRollback.md +9 -0
  525. package/docs/LoyaltyCardTransactionDetailsSegment.md +10 -0
  526. package/docs/LoyaltyCardTransactionsType.md +24 -0
  527. package/docs/LoyaltyMember.md +64 -0
  528. package/docs/LoyaltyMemberLoyaltyCard.md +15 -0
  529. package/docs/LoyaltyMemberPublish.md +11 -0
  530. package/docs/LoyaltyMemberRedemption.md +13 -0
  531. package/docs/LoyaltyPendingPoints.md +18 -0
  532. package/docs/LoyaltyPendingPointsDetails.md +13 -0
  533. package/docs/LoyaltyPendingPointsDetailsEarningRule.md +10 -0
  534. package/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +9 -0
  535. package/docs/LoyaltyPendingPointsDetailsEvent.md +35 -0
  536. package/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +10 -0
  537. package/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +10 -0
  538. package/docs/LoyaltyPendingPointsDetailsOrder.md +10 -0
  539. package/docs/LoyaltyPointsBucket.md +26 -0
  540. package/docs/LoyaltyPointsBucketBucket.md +9 -0
  541. package/docs/LoyaltyTier.md +29 -0
  542. package/docs/LoyaltyTierBase.md +12 -0
  543. package/docs/LoyaltyTierBasePoints.md +10 -0
  544. package/docs/LoyaltyTierConfig.md +9 -0
  545. package/docs/LoyaltyTierConfigPoints.md +10 -0
  546. package/docs/LoyaltyTierExpiration.md +15 -0
  547. package/docs/LoyaltyTierPoints.md +10 -0
  548. package/docs/LoyaltyTiersExpirationAll.md +38 -0
  549. package/docs/LoyaltyTiersExpirationAllExpirationDate.md +26 -0
  550. package/docs/LoyaltyTiersExpirationAllExpirationDateRounding.md +49 -0
  551. package/docs/LoyaltyTiersExpirationAllStartDate.md +20 -0
  552. package/docs/ManagementApi.md +2248 -0
  553. package/docs/ManagementProject.md +49 -0
  554. package/docs/ManagementProjectApiUsageNotifications.md +14 -0
  555. package/docs/ManagementProjectDefaultCodeConfig.md +9 -0
  556. package/docs/ManagementProjectLimits.md +10 -0
  557. package/docs/ManagementProjectLimitsApiCallsItem.md +10 -0
  558. package/docs/ManagementProjectLimitsBulkApiCallsItem.md +10 -0
  559. package/docs/ManagementProjectWebhooksCalloutNotifications.md +10 -0
  560. package/docs/ManagementProjectWebhooksCalloutNotificationsDistributions.md +11 -0
  561. package/docs/ManagementProjectWebhooksCalloutNotificationsWebhooks.md +11 -0
  562. package/docs/ManagementProjectsBranding.md +13 -0
  563. package/docs/ManagementProjectsBrandingAddress.md +13 -0
  564. package/docs/ManagementProjectsBrandingBrand.md +13 -0
  565. package/docs/ManagementProjectsBrandingCockpits.md +39 -0
  566. package/docs/ManagementProjectsBrandingContact.md +10 -0
  567. package/docs/ManagementProjectsBrandingCreateRequestBody.md +12 -0
  568. package/docs/ManagementProjectsBrandingCreateRequestBodyAddress.md +13 -0
  569. package/docs/ManagementProjectsBrandingCreateRequestBodyBrand.md +13 -0
  570. package/docs/ManagementProjectsBrandingCreateRequestBodyCockpits.md +39 -0
  571. package/docs/ManagementProjectsBrandingCreateRequestBodyContact.md +10 -0
  572. package/docs/ManagementProjectsBrandingCreateResponseBody.md +13 -0
  573. package/docs/ManagementProjectsBrandingCreateResponseBodyAddress.md +13 -0
  574. package/docs/ManagementProjectsBrandingCreateResponseBodyBrand.md +13 -0
  575. package/docs/ManagementProjectsBrandingCreateResponseBodyCockpits.md +39 -0
  576. package/docs/ManagementProjectsBrandingCreateResponseBodyContact.md +10 -0
  577. package/docs/ManagementProjectsBrandingGetResponseBody.md +13 -0
  578. package/docs/ManagementProjectsBrandingGetResponseBodyAddress.md +13 -0
  579. package/docs/ManagementProjectsBrandingGetResponseBodyBrand.md +13 -0
  580. package/docs/ManagementProjectsBrandingGetResponseBodyCockpits.md +39 -0
  581. package/docs/ManagementProjectsBrandingGetResponseBodyContact.md +10 -0
  582. package/docs/ManagementProjectsBrandingListResponseBody.md +30 -0
  583. package/docs/ManagementProjectsBrandingUpdateRequestBody.md +12 -0
  584. package/docs/ManagementProjectsBrandingUpdateRequestBodyAddress.md +13 -0
  585. package/docs/ManagementProjectsBrandingUpdateRequestBodyBrand.md +13 -0
  586. package/docs/ManagementProjectsBrandingUpdateRequestBodyCockpits.md +37 -0
  587. package/docs/ManagementProjectsBrandingUpdateRequestBodyContact.md +10 -0
  588. package/docs/ManagementProjectsBrandingUpdateResponseBody.md +13 -0
  589. package/docs/ManagementProjectsBrandingUpdateResponseBodyAddress.md +13 -0
  590. package/docs/ManagementProjectsBrandingUpdateResponseBodyBrand.md +13 -0
  591. package/docs/ManagementProjectsBrandingUpdateResponseBodyCockpits.md +39 -0
  592. package/docs/ManagementProjectsBrandingUpdateResponseBodyContact.md +10 -0
  593. package/docs/ManagementProjectsCreateRequestBody.md +45 -0
  594. package/docs/ManagementProjectsCreateRequestBodyApiUsageNotifications.md +13 -0
  595. package/docs/ManagementProjectsCreateRequestBodyUsersItem.md +11 -0
  596. package/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications.md +10 -0
  597. package/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsDistributions.md +11 -0
  598. package/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsWebhooks.md +11 -0
  599. package/docs/ManagementProjectsCreateResponseBody.md +49 -0
  600. package/docs/ManagementProjectsCreateResponseBodyApiUsageNotifications.md +14 -0
  601. package/docs/ManagementProjectsCreateResponseBodyClientSideKey.md +10 -0
  602. package/docs/ManagementProjectsCreateResponseBodyServerSideKey.md +10 -0
  603. package/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotifications.md +10 -0
  604. package/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsDistributions.md +11 -0
  605. package/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsWebhooks.md +11 -0
  606. package/docs/ManagementProjectsCustomEventSchema.md +23 -0
  607. package/docs/ManagementProjectsCustomEventSchemaSchema.md +9 -0
  608. package/docs/ManagementProjectsCustomEventSchemasCreateRequestBody.md +10 -0
  609. package/docs/ManagementProjectsCustomEventSchemasCreateRequestBodySchema.md +9 -0
  610. package/docs/ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md +28 -0
  611. package/docs/ManagementProjectsCustomEventSchemasCreateResponseBody.md +23 -0
  612. package/docs/ManagementProjectsCustomEventSchemasCreateResponseBodySchema.md +9 -0
  613. package/docs/ManagementProjectsCustomEventSchemasGetResponseBody.md +23 -0
  614. package/docs/ManagementProjectsCustomEventSchemasGetResponseBodySchema.md +9 -0
  615. package/docs/ManagementProjectsCustomEventSchemasListResponseBody.md +30 -0
  616. package/docs/ManagementProjectsCustomEventSchemasUpdateRequestBody.md +9 -0
  617. package/docs/ManagementProjectsCustomEventSchemasUpdateRequestBodySchema.md +9 -0
  618. package/docs/ManagementProjectsCustomEventSchemasUpdateResponseBody.md +23 -0
  619. package/docs/ManagementProjectsCustomEventSchemasUpdateResponseBodySchema.md +9 -0
  620. package/docs/ManagementProjectsGetResponseBody.md +49 -0
  621. package/docs/ManagementProjectsGetResponseBodyApiUsageNotifications.md +14 -0
  622. package/docs/ManagementProjectsGetResponseBodyDefaultCodeConfig.md +9 -0
  623. package/docs/ManagementProjectsGetResponseBodyLimits.md +10 -0
  624. package/docs/ManagementProjectsGetResponseBodyLimitsApiCallsItem.md +10 -0
  625. package/docs/ManagementProjectsGetResponseBodyLimitsBulkApiCallsItem.md +10 -0
  626. package/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotifications.md +10 -0
  627. package/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsDistributions.md +11 -0
  628. package/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsWebhooks.md +11 -0
  629. package/docs/ManagementProjectsListResponseBody.md +30 -0
  630. package/docs/ManagementProjectsMetadataSchema.md +15 -0
  631. package/docs/ManagementProjectsMetadataSchemaDefinition.md +45 -0
  632. package/docs/ManagementProjectsMetadataSchemasCreateRequestBody.md +11 -0
  633. package/docs/ManagementProjectsMetadataSchemasCreateResponseBody.md +15 -0
  634. package/docs/ManagementProjectsMetadataSchemasGetResponseBody.md +15 -0
  635. package/docs/ManagementProjectsMetadataSchemasListResponseBody.md +30 -0
  636. package/docs/ManagementProjectsMetadataSchemasUpdateRequestBody.md +10 -0
  637. package/docs/ManagementProjectsMetadataSchemasUpdateResponseBody.md +15 -0
  638. package/docs/ManagementProjectsStackingRules.md +95 -0
  639. package/docs/ManagementProjectsStackingRulesCreateRequestBody.md +92 -0
  640. package/docs/ManagementProjectsStackingRulesCreateResponseBody.md +95 -0
  641. package/docs/ManagementProjectsStackingRulesGetResponseBody.md +95 -0
  642. package/docs/ManagementProjectsStackingRulesListResponseBody.md +30 -0
  643. package/docs/ManagementProjectsStackingRulesUpdateRequestBody.md +92 -0
  644. package/docs/ManagementProjectsStackingRulesUpdateResponseBody.md +95 -0
  645. package/docs/ManagementProjectsTemplatesCampaignsCopyCreateRequestBody.md +11 -0
  646. package/docs/ManagementProjectsTemplatesCampaignsCopyCreateResponseBody.md +34 -0
  647. package/docs/ManagementProjectsTemplatesCampaignsListResponseBody.md +32 -0
  648. package/docs/ManagementProjectsUpdateRequestBody.md +33 -0
  649. package/docs/ManagementProjectsUpdateRequestBodyApiUsageNotifications.md +13 -0
  650. package/docs/ManagementProjectsUpdateRequestBodyDefaultCodeConfig.md +9 -0
  651. package/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotifications.md +10 -0
  652. package/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsDistributions.md +11 -0
  653. package/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsWebhooks.md +11 -0
  654. package/docs/ManagementProjectsUpdateResponseBody.md +49 -0
  655. package/docs/ManagementProjectsUpdateResponseBodyApiUsageNotifications.md +14 -0
  656. package/docs/ManagementProjectsUpdateResponseBodyDefaultCodeConfig.md +9 -0
  657. package/docs/ManagementProjectsUpdateResponseBodyLimits.md +10 -0
  658. package/docs/ManagementProjectsUpdateResponseBodyLimitsApiCallsItem.md +10 -0
  659. package/docs/ManagementProjectsUpdateResponseBodyLimitsBulkApiCallsItem.md +10 -0
  660. package/docs/ManagementProjectsUpdateResponseBodyWebhooksCalloutNotifications.md +10 -0
  661. package/docs/ManagementProjectsUpdateResponseBodyWebhooksCalloutNotificationsDistributions.md +11 -0
  662. package/docs/ManagementProjectsUpdateResponseBodyWebhooksCalloutNotificationsWebhooks.md +11 -0
  663. package/docs/ManagementProjectsUsersAssignRequestBody.md +11 -0
  664. package/docs/ManagementProjectsUsersAssignResponseBody.md +15 -0
  665. package/docs/ManagementProjectsUsersGetUserResponseBody.md +15 -0
  666. package/docs/ManagementProjectsUsersInviteCreateRequestBody.md +12 -0
  667. package/docs/ManagementProjectsUsersListResponseBody.md +30 -0
  668. package/docs/ManagementProjectsUsersUpdateRoleRequestBody.md +9 -0
  669. package/docs/ManagementProjectsUsersUpdateRoleResponseBody.md +15 -0
  670. package/docs/ManagementProjectsWebhook.md +150 -0
  671. package/docs/ManagementProjectsWebhooksCreateRequestBody.md +138 -0
  672. package/docs/ManagementProjectsWebhooksCreateResponseBody.md +150 -0
  673. package/docs/ManagementProjectsWebhooksGetResponseBody.md +150 -0
  674. package/docs/ManagementProjectsWebhooksListResponseBody.md +30 -0
  675. package/docs/ManagementProjectsWebhooksUpdateRequestBody.md +138 -0
  676. package/docs/ManagementProjectsWebhooksUpdateResponseBody.md +150 -0
  677. package/docs/MappingPoints.md +22 -0
  678. package/docs/MemberActivity.md +72 -0
  679. package/docs/MemberActivityData.md +40 -0
  680. package/docs/MemberActivityData1.md +10 -0
  681. package/docs/MemberActivityDataBalance.md +47 -0
  682. package/docs/MemberActivityDataBalanceRelatedObject.md +19 -0
  683. package/docs/MemberActivityDataCustomerEvent.md +10 -0
  684. package/docs/MemberActivityDataOrder.md +54 -0
  685. package/docs/MemberActivityDataOrderCustomer.md +19 -0
  686. package/docs/MemberActivityDataOrderItemsItem.md +49 -0
  687. package/docs/MemberActivityDataOrderItemsItemProduct.md +14 -0
  688. package/docs/MemberActivityDataOrderItemsItemSku.md +14 -0
  689. package/docs/MemberActivityDataOrderReferrer.md +19 -0
  690. package/docs/MemberActivityDataRedemption.md +83 -0
  691. package/docs/MemberActivityDataRedemptionChannel.md +23 -0
  692. package/docs/MemberActivityDataRedemptionOrder.md +54 -0
  693. package/docs/MemberActivityDataRedemptionOrderCustomer.md +19 -0
  694. package/docs/MemberActivityDataRedemptionOrderItemsItem.md +49 -0
  695. package/docs/MemberActivityDataRedemptionOrderItemsItemProduct.md +14 -0
  696. package/docs/MemberActivityDataRedemptionOrderItemsItemSku.md +14 -0
  697. package/docs/MemberActivityDataRedemptionOrderReferrer.md +19 -0
  698. package/docs/MemberActivityDataRedemptionPreviousOrder.md +54 -0
  699. package/docs/MemberActivityDataRedemptionPreviousOrderCustomer.md +19 -0
  700. package/docs/MemberActivityDataRedemptionPreviousOrderReferrer.md +19 -0
  701. package/docs/MemberActivityDataRedemptionPromotionTier.md +51 -0
  702. package/docs/MemberActivityDataRedemptionPromotionTierAction.md +9 -0
  703. package/docs/MemberActivityDataRedemptionPromotionTierCampaign.md +38 -0
  704. package/docs/MemberActivityDataRedemptionPromotionTierSummary.md +10 -0
  705. package/docs/MemberActivityDataRedemptionPromotionTierSummaryOrders.md +10 -0
  706. package/docs/MemberActivityDataRedemptionPromotionTierSummaryRedemptions.md +9 -0
  707. package/docs/MemberActivityDataRedemptionRelatedRedemptions.md +10 -0
  708. package/docs/MemberActivityDataRedemptionRelatedRedemptionsRedemptionsItem.md +10 -0
  709. package/docs/MemberActivityDataRedemptionRelatedRedemptionsRollbacksItem.md +10 -0
  710. package/docs/MemberActivityDataRedemptionReward.md +44 -0
  711. package/docs/MemberActivityDataRedemptionRewardCustomer.md +23 -0
  712. package/docs/MemberActivityDataRedemptionRewardParameters.md +11 -0
  713. package/docs/MemberActivityDataRedemptionRewardParametersCampaign.md +11 -0
  714. package/docs/MemberActivityDataRedemptionRewardParametersCoin.md +10 -0
  715. package/docs/MemberActivityDataRedemptionRewardParametersProduct.md +10 -0
  716. package/docs/MemberActivityDataRedemptionRewardProduct.md +28 -0
  717. package/docs/MemberActivityDataRedemptionRewardSku.md +29 -0
  718. package/docs/MemberActivityDataRedemptionRewardVoucher.md +71 -0
  719. package/docs/MemberActivityDataRedemptionRewardVoucherGift.md +23 -0
  720. package/docs/MemberActivityDataRedemptionRewardVoucherLoyaltyCard.md +15 -0
  721. package/docs/MemberActivityDataRedemptionRewardVoucherPublish.md +11 -0
  722. package/docs/MemberActivityDataRedemptionRewardVoucherRedemption.md +13 -0
  723. package/docs/MemberActivityDataRedemptionVoucher.md +72 -0
  724. package/docs/MemberActivityDataRedemptionVoucherGift.md +23 -0
  725. package/docs/MemberActivityDataRedemptionVoucherLoyaltyCard.md +15 -0
  726. package/docs/MemberActivityDataRedemptionVoucherPublish.md +11 -0
  727. package/docs/MemberActivityDataRedemptionVoucherRedemption.md +13 -0
  728. package/docs/MemberActivityDataTransaction.md +51 -0
  729. package/docs/MemberActivityDataTransactionDetails.md +23 -0
  730. package/docs/MemberActivityDataTransactionDetailsCustomEvent.md +10 -0
  731. package/docs/MemberActivityDataTransactionDetailsDestinationVoucher.md +51 -0
  732. package/docs/MemberActivityDataTransactionDetailsDestinationVoucherGift.md +23 -0
  733. package/docs/MemberActivityDataTransactionDetailsDestinationVoucherLoyaltyCard.md +15 -0
  734. package/docs/MemberActivityDataTransactionDetailsDestinationVoucherRedemption.md +11 -0
  735. package/docs/MemberActivityDataTransactionDetailsEarningRule.md +10 -0
  736. package/docs/MemberActivityDataTransactionDetailsEarningRuleSource.md +9 -0
  737. package/docs/MemberActivityDataTransactionDetailsEvent.md +10 -0
  738. package/docs/MemberActivityDataTransactionDetailsEventSchema.md +10 -0
  739. package/docs/MemberActivityDataTransactionDetailsHolderLoyaltyTier.md +10 -0
  740. package/docs/MemberActivityDataTransactionDetailsLoyaltyTier.md +10 -0
  741. package/docs/MemberActivityDataTransactionDetailsOrder.md +10 -0
  742. package/docs/MemberActivityDataTransactionDetailsRedemption.md +9 -0
  743. package/docs/MemberActivityDataTransactionDetailsReward.md +10 -0
  744. package/docs/MemberActivityDataTransactionDetailsRollback.md +9 -0
  745. package/docs/MemberActivityDataTransactionDetailsSegment.md +10 -0
  746. package/docs/MemberActivityDataTransactionDetailsSourceVoucher.md +51 -0
  747. package/docs/MemberActivityDataTransactionDetailsSourceVoucherGift.md +23 -0
  748. package/docs/MemberActivityDataTransactionDetailsSourceVoucherLoyaltyCard.md +15 -0
  749. package/docs/MemberActivityDataTransactionDetailsSourceVoucherRedemption.md +11 -0
  750. package/docs/MetadataSchemaDefinitionDeprecated.md +45 -0
  751. package/docs/MetadataSchemaDeprecated.md +15 -0
  752. package/docs/MetadataSchemasApi.md +124 -0
  753. package/docs/MetadataSchemasGetResponseBody.md +15 -0
  754. package/docs/MetadataSchemasListResponseBody.md +30 -0
  755. package/docs/OAuthApi.md +187 -0
  756. package/docs/OAuthTokenGenerateResponseBody.md +23 -0
  757. package/docs/OAuthTokenIntrospectResponseBody.md +24 -0
  758. package/docs/Order.md +31 -0
  759. package/docs/OrderCalculated.md +53 -0
  760. package/docs/OrderCalculatedItem.md +49 -0
  761. package/docs/OrderCalculatedItemProduct.md +14 -0
  762. package/docs/OrderCalculatedItemSku.md +14 -0
  763. package/docs/OrderItem.md +33 -0
  764. package/docs/OrderItemProduct.md +14 -0
  765. package/docs/OrderItemSku.md +14 -0
  766. package/docs/OrderRedemptionsEntry.md +16 -0
  767. package/docs/OrdersApi.md +376 -0
  768. package/docs/OrdersCreateRequestBody.md +35 -0
  769. package/docs/OrdersCreateResponseBody.md +54 -0
  770. package/docs/OrdersExportCreateRequestBody.md +9 -0
  771. package/docs/OrdersExportCreateRequestBodyParameters.md +11 -0
  772. package/docs/OrdersExportCreateResponseBody.md +44 -0
  773. package/docs/OrdersExportCreateResponseBodyParameters.md +11 -0
  774. package/docs/OrdersGetResponseBody.md +54 -0
  775. package/docs/OrdersImportCreateRequestBodyItem.md +35 -0
  776. package/docs/OrdersImportCreateResponseBody.md +9 -0
  777. package/docs/OrdersListResponseBody.md +30 -0
  778. package/docs/OrdersListResponseBodyOrdersItem.md +54 -0
  779. package/docs/OrdersUpdateRequestBody.md +34 -0
  780. package/docs/OrdersUpdateResponseBody.md +54 -0
  781. package/docs/ParameterActivityCategory.md +10 -0
  782. package/docs/ParameterCampaignStatusListCampaigns.md +16 -0
  783. package/docs/ParameterCampaignType.md +16 -0
  784. package/docs/ParameterCampaignsAccessSetttings.md +9 -0
  785. package/docs/ParameterCampaignsAccessSetttingsFilter.md +11 -0
  786. package/docs/ParameterCreatedBeforeAfter.md +10 -0
  787. package/docs/ParameterCustomerEvent.md +140 -0
  788. package/docs/ParameterExpandListCampaigns.md +10 -0
  789. package/docs/ParameterFiltersListBin.md +13 -0
  790. package/docs/ParameterFiltersListBinId.md +9 -0
  791. package/docs/ParameterFiltersListBinResourceId.md +9 -0
  792. package/docs/ParameterFiltersListBinResourceName.md +9 -0
  793. package/docs/ParameterFiltersListBinResourceType.md +9 -0
  794. package/docs/ParameterFiltersListBinResourceTypeConditions.md +76 -0
  795. package/docs/ParameterFiltersListCampaigns.md +25 -0
  796. package/docs/ParameterFiltersListCampaignsActive.md +12 -0
  797. package/docs/ParameterFiltersListCampaignsCampaignStatus.md +9 -0
  798. package/docs/ParameterFiltersListCampaignsCampaignStatusConditions.md +84 -0
  799. package/docs/ParameterFiltersListCampaignsCampaigns.md +9 -0
  800. package/docs/ParameterFiltersListCampaignsCampaignsId.md +9 -0
  801. package/docs/ParameterFiltersListCampaignsCategories.md +9 -0
  802. package/docs/ParameterFiltersListCampaignsCategoryIds.md +9 -0
  803. package/docs/ParameterFiltersListCampaignsCreatedDate.md +9 -0
  804. package/docs/ParameterFiltersListCampaignsExpirationDate.md +9 -0
  805. package/docs/ParameterFiltersListCampaignsIsReferralCode.md +9 -0
  806. package/docs/ParameterFiltersListCampaignsIsReferralCodeConditions.md +32 -0
  807. package/docs/ParameterFiltersListCampaignsStartDate.md +9 -0
  808. package/docs/ParameterFiltersListCampaignsStatus.md +9 -0
  809. package/docs/ParameterFiltersListCampaignsStatusConditions.md +13 -0
  810. package/docs/ParameterFiltersListCampaignsType.md +9 -0
  811. package/docs/ParameterFiltersListCampaignsTypeConditions.md +40 -0
  812. package/docs/ParameterFiltersListCampaignsUpdatedAt.md +9 -0
  813. package/docs/ParameterFiltersListCampaignsValidityDayOfWeek.md +9 -0
  814. package/docs/ParameterFiltersListCampaignsValidityDayOfWeekConditions.md +30 -0
  815. package/docs/ParameterFiltersListCampaignsValidityTimeframe.md +9 -0
  816. package/docs/ParameterFiltersListCampaignsVoucherType.md +9 -0
  817. package/docs/ParameterFiltersListCampaignsVoucherTypeConditions.md +68 -0
  818. package/docs/ParameterFiltersListCustomerRedeemables.md +17 -0
  819. package/docs/ParameterFiltersListCustomerRedeemablesCampaignId.md +9 -0
  820. package/docs/ParameterFiltersListCustomerRedeemablesCampaignType.md +9 -0
  821. package/docs/ParameterFiltersListCustomerRedeemablesCampaignTypeConditions.md +76 -0
  822. package/docs/ParameterFiltersListCustomerRedeemablesCreatedAt.md +9 -0
  823. package/docs/ParameterFiltersListCustomerRedeemablesHolderRole.md +9 -0
  824. package/docs/ParameterFiltersListCustomerRedeemablesHolderRoleConditions.md +68 -0
  825. package/docs/ParameterFiltersListCustomerRedeemablesId.md +9 -0
  826. package/docs/ParameterFiltersListCustomerRedeemablesRedeemableId.md +9 -0
  827. package/docs/ParameterFiltersListCustomerRedeemablesRedeemableObject.md +9 -0
  828. package/docs/ParameterFiltersListCustomerRedeemablesRedeemableObjectConditions.md +52 -0
  829. package/docs/ParameterFiltersListCustomerRedeemablesVoucherType.md +9 -0
  830. package/docs/ParameterFiltersListLocations.md +11 -0
  831. package/docs/ParameterFiltersListLocationsCreatedAt.md +9 -0
  832. package/docs/ParameterFiltersListLocationsName.md +9 -0
  833. package/docs/ParameterFiltersListLocationsUpdatedAt.md +9 -0
  834. package/docs/ParameterFiltersListMemberTransactions.md +10 -0
  835. package/docs/ParameterFiltersListPublications.md +18 -0
  836. package/docs/ParameterFiltersListPublicationsCampaignName.md +9 -0
  837. package/docs/ParameterFiltersListPublicationsCustomerId.md +9 -0
  838. package/docs/ParameterFiltersListPublicationsFailureCode.md +9 -0
  839. package/docs/ParameterFiltersListPublicationsIsReferralCode.md +9 -0
  840. package/docs/ParameterFiltersListPublicationsParentObjectId.md +9 -0
  841. package/docs/ParameterFiltersListPublicationsRelatedObjectId.md +9 -0
  842. package/docs/ParameterFiltersListPublicationsResult.md +9 -0
  843. package/docs/ParameterFiltersListPublicationsSourceId.md +9 -0
  844. package/docs/ParameterFiltersListPublicationsVoucherType.md +9 -0
  845. package/docs/ParameterFiltersListRedemptions.md +19 -0
  846. package/docs/ParameterFiltersListRedemptionsCampaignName.md +9 -0
  847. package/docs/ParameterFiltersListRedemptionsCustomerId.md +9 -0
  848. package/docs/ParameterFiltersListRedemptionsFailureCode.md +9 -0
  849. package/docs/ParameterFiltersListRedemptionsObject.md +9 -0
  850. package/docs/ParameterFiltersListRedemptionsParentRedemptionId.md +9 -0
  851. package/docs/ParameterFiltersListRedemptionsRelatedObjectId.md +9 -0
  852. package/docs/ParameterFiltersListRedemptionsRelatedObjectParentId.md +9 -0
  853. package/docs/ParameterFiltersListRedemptionsResult.md +9 -0
  854. package/docs/ParameterFiltersListRedemptionsUserLogin.md +9 -0
  855. package/docs/ParameterFiltersListRedemptionsVoucherCode.md +9 -0
  856. package/docs/ParameterFiltersListReferralsRedeemableHolders.md +13 -0
  857. package/docs/ParameterFiltersListReferralsRedeemableHoldersCreatedAt.md +9 -0
  858. package/docs/ParameterFiltersListReferralsRedeemableHoldersCustomerId.md +9 -0
  859. package/docs/ParameterFiltersListReferralsRedeemableHoldersHolderRole.md +9 -0
  860. package/docs/ParameterFiltersListReferralsRedeemableHoldersHolderRoleConditions.md +60 -0
  861. package/docs/ParameterFiltersListReferralsRedeemableHoldersId.md +9 -0
  862. package/docs/ParameterFiltersListTemplates.md +12 -0
  863. package/docs/ParameterFiltersListTemplatesCampaignType.md +9 -0
  864. package/docs/ParameterFiltersListTemplatesCampaignTypeConditions.md +60 -0
  865. package/docs/ParameterFiltersListTemplatesId.md +9 -0
  866. package/docs/ParameterFiltersListTemplatesName.md +9 -0
  867. package/docs/ParameterOrder.md +30 -0
  868. package/docs/ParameterOrderCreatedAt.md +10 -0
  869. package/docs/ParameterOrderListAllPromotionStacks.md +18 -0
  870. package/docs/ParameterOrderListBin.md +10 -0
  871. package/docs/ParameterOrderListCampaigns.md +14 -0
  872. package/docs/ParameterOrderListCustomers.md +18 -0
  873. package/docs/ParameterOrderListEarningRules.md +14 -0
  874. package/docs/ParameterOrderListExports.md +14 -0
  875. package/docs/ParameterOrderListLocations.md +14 -0
  876. package/docs/ParameterOrderListLoyaltyTiers.md +14 -0
  877. package/docs/ParameterOrderListOrders.md +14 -0
  878. package/docs/ParameterOrderListPendingPoints.md +10 -0
  879. package/docs/ParameterOrderListPromotionTiers.md +14 -0
  880. package/docs/ParameterOrderListPromotionTiersClientSide.md +14 -0
  881. package/docs/ParameterOrderListPublications.md +30 -0
  882. package/docs/ParameterOrderListRedeemables.md +10 -0
  883. package/docs/ParameterOrderListRedemptions.md +26 -0
  884. package/docs/ParameterOrderListTransactions.md +10 -0
  885. package/docs/ParameterOrderListValidationRuleAssignments.md +10 -0
  886. package/docs/ParameterOrderListValidationRules.md +18 -0
  887. package/docs/ParameterOrderVouchers.md +18 -0
  888. package/docs/ParameterResultListPublications.md +10 -0
  889. package/docs/ParameterTemplatesList.md +10 -0
  890. package/docs/ParameterUpdatedBeforeAfter.md +10 -0
  891. package/docs/ParameterVoucherTypeListPublications.md +10 -0
  892. package/docs/ParametersFiltersListCampaignTransactions.md +11 -0
  893. package/docs/PointsExpirationTypes.md +12 -0
  894. package/docs/Product.md +28 -0
  895. package/docs/ProductCollectionsApi.md +324 -0
  896. package/docs/ProductCollectionsCreateRequestBody.md +21 -0
  897. package/docs/ProductCollectionsCreateRequestBodyProductsItem.md +22 -0
  898. package/docs/ProductCollectionsCreateResponseBody.md +35 -0
  899. package/docs/ProductCollectionsCreateResponseBodyProductsItem.md +22 -0
  900. package/docs/ProductCollectionsGetResponseBody.md +35 -0
  901. package/docs/ProductCollectionsGetResponseBodyProductsItem.md +22 -0
  902. package/docs/ProductCollectionsItem.md +35 -0
  903. package/docs/ProductCollectionsItemProductsItem.md +22 -0
  904. package/docs/ProductCollectionsListResponseBody.md +30 -0
  905. package/docs/ProductCollectionsProductsListResponseBody.md +12 -0
  906. package/docs/ProductCollectionsProductsListResponseBodyDataItem.md +33 -0
  907. package/docs/ProductWithoutSkus.md +27 -0
  908. package/docs/ProductsApi.md +892 -0
  909. package/docs/ProductsCreateRequestBody.md +15 -0
  910. package/docs/ProductsCreateResponseBody.md +28 -0
  911. package/docs/ProductsGetResponseBody.md +28 -0
  912. package/docs/ProductsImportCsvCreateResponseBody.md +9 -0
  913. package/docs/ProductsListResponseBody.md +12 -0
  914. package/docs/ProductsMetadataUpdateInBulkRequestBody.md +10 -0
  915. package/docs/ProductsMetadataUpdateInBulkResponseBody.md +9 -0
  916. package/docs/ProductsSkusCreateRequestBody.md +16 -0
  917. package/docs/ProductsSkusCreateResponseBody.md +29 -0
  918. package/docs/ProductsSkusListResponseBody.md +12 -0
  919. package/docs/ProductsSkusUpdateRequestBody.md +14 -0
  920. package/docs/ProductsSkusUpdateResponseBody.md +29 -0
  921. package/docs/ProductsUpdateInBulkRequestBody.md +14 -0
  922. package/docs/ProductsUpdateInBulkResponseBody.md +9 -0
  923. package/docs/ProductsUpdateRequestBody.md +13 -0
  924. package/docs/ProductsUpdateResponseBody.md +28 -0
  925. package/docs/PromotionStack.md +26 -0
  926. package/docs/PromotionStackBase.md +10 -0
  927. package/docs/PromotionStackBaseTiers.md +19 -0
  928. package/docs/PromotionStackTiers.md +19 -0
  929. package/docs/PromotionTier.md +51 -0
  930. package/docs/PromotionTierAction.md +9 -0
  931. package/docs/PromotionTierCampaign.md +38 -0
  932. package/docs/PromotionTierCreateParams.md +43 -0
  933. package/docs/PromotionTierCreateParamsAction.md +9 -0
  934. package/docs/PromotionTierSummary.md +10 -0
  935. package/docs/PromotionTierSummaryOrders.md +10 -0
  936. package/docs/PromotionTierSummaryRedemptions.md +9 -0
  937. package/docs/PromotionTiersList.md +13 -0
  938. package/docs/PromotionsApi.md +880 -0
  939. package/docs/PromotionsStacksCreateRequestBody.md +11 -0
  940. package/docs/PromotionsStacksCreateRequestBodyTiers.md +19 -0
  941. package/docs/PromotionsStacksCreateResponseBody.md +25 -0
  942. package/docs/PromotionsStacksCreateResponseBodyTiers.md +19 -0
  943. package/docs/PromotionsStacksGetResponseBody.md +26 -0
  944. package/docs/PromotionsStacksGetResponseBodyTiers.md +19 -0
  945. package/docs/PromotionsStacksListResponseBody.md +30 -0
  946. package/docs/PromotionsStacksUpdateRequestBody.md +11 -0
  947. package/docs/PromotionsStacksUpdateRequestBodyTiers.md +19 -0
  948. package/docs/PromotionsStacksUpdateResponseBody.md +26 -0
  949. package/docs/PromotionsStacksUpdateResponseBodyTiers.md +19 -0
  950. package/docs/PromotionsTiersCreateRequestBody.md +43 -0
  951. package/docs/PromotionsTiersCreateRequestBodyAction.md +9 -0
  952. package/docs/PromotionsTiersCreateResponseBody.md +51 -0
  953. package/docs/PromotionsTiersCreateResponseBodyAction.md +9 -0
  954. package/docs/PromotionsTiersCreateResponseBodyCampaign.md +38 -0
  955. package/docs/PromotionsTiersCreateResponseBodySummary.md +10 -0
  956. package/docs/PromotionsTiersCreateResponseBodySummaryOrders.md +10 -0
  957. package/docs/PromotionsTiersCreateResponseBodySummaryRedemptions.md +9 -0
  958. package/docs/PromotionsTiersDisableResponseBody.md +51 -0
  959. package/docs/PromotionsTiersDisableResponseBodyAction.md +9 -0
  960. package/docs/PromotionsTiersDisableResponseBodyCampaign.md +38 -0
  961. package/docs/PromotionsTiersDisableResponseBodySummary.md +10 -0
  962. package/docs/PromotionsTiersDisableResponseBodySummaryOrders.md +10 -0
  963. package/docs/PromotionsTiersDisableResponseBodySummaryRedemptions.md +9 -0
  964. package/docs/PromotionsTiersEnableResponseBody.md +51 -0
  965. package/docs/PromotionsTiersEnableResponseBodyAction.md +9 -0
  966. package/docs/PromotionsTiersEnableResponseBodyCampaign.md +38 -0
  967. package/docs/PromotionsTiersEnableResponseBodySummary.md +10 -0
  968. package/docs/PromotionsTiersEnableResponseBodySummaryOrders.md +10 -0
  969. package/docs/PromotionsTiersEnableResponseBodySummaryRedemptions.md +9 -0
  970. package/docs/PromotionsTiersGetResponseBody.md +51 -0
  971. package/docs/PromotionsTiersGetResponseBodyAction.md +9 -0
  972. package/docs/PromotionsTiersGetResponseBodyCampaign.md +38 -0
  973. package/docs/PromotionsTiersGetResponseBodySummary.md +10 -0
  974. package/docs/PromotionsTiersGetResponseBodySummaryOrders.md +10 -0
  975. package/docs/PromotionsTiersGetResponseBodySummaryRedemptions.md +9 -0
  976. package/docs/PromotionsTiersListResponseBody.md +13 -0
  977. package/docs/PromotionsTiersUpdateRequestBody.md +42 -0
  978. package/docs/PromotionsTiersUpdateRequestBodyAction.md +9 -0
  979. package/docs/PromotionsTiersUpdateResponseBody.md +51 -0
  980. package/docs/PromotionsTiersUpdateResponseBodyAction.md +9 -0
  981. package/docs/PromotionsTiersUpdateResponseBodyCampaign.md +38 -0
  982. package/docs/PromotionsTiersUpdateResponseBodySummary.md +10 -0
  983. package/docs/PromotionsTiersUpdateResponseBodySummaryOrders.md +10 -0
  984. package/docs/PromotionsTiersUpdateResponseBodySummaryRedemptions.md +9 -0
  985. package/docs/PublicationsApi.md +226 -0
  986. package/docs/PublicationsCreateRequestBody.md +14 -0
  987. package/docs/PublicationsCreateResponseBody.md +48 -0
  988. package/docs/PublicationsListResponseBody.md +12 -0
  989. package/docs/PublicationsListResponseBodyPublicationsItem.md +43 -0
  990. package/docs/PublicationsListResponseBodyPublicationsItemMetadata.md +11 -0
  991. package/docs/QualificationsApi.md +68 -0
  992. package/docs/QualificationsCheckEligibilityRequestBody.md +38 -0
  993. package/docs/QualificationsCheckEligibilityRequestBodySession.md +18 -0
  994. package/docs/QualificationsCheckEligibilityResponseBody.md +12 -0
  995. package/docs/QualificationsCheckEligibilityResponseBodyOrder.md +54 -0
  996. package/docs/QualificationsFieldConditions.md +9 -0
  997. package/docs/QualificationsFiltersCondition.md +14 -0
  998. package/docs/QualificationsOption.md +39 -0
  999. package/docs/QualificationsOptionFilters.md +17 -0
  1000. package/docs/QualificationsOptionFiltersCampaignType.md +9 -0
  1001. package/docs/QualificationsOptionFiltersCampaignTypeConditions.md +12 -0
  1002. package/docs/QualificationsOptionFiltersHolderRole.md +9 -0
  1003. package/docs/QualificationsOptionFiltersHolderRoleConditions.md +64 -0
  1004. package/docs/QualificationsOptionFiltersResourceType.md +9 -0
  1005. package/docs/QualificationsOptionFiltersResourceTypeConditions.md +12 -0
  1006. package/docs/QualificationsRedeemable.md +39 -0
  1007. package/docs/QualificationsRedeemableBase.md +38 -0
  1008. package/docs/QualificationsRedeemableBaseOrder.md +54 -0
  1009. package/docs/QualificationsRedeemableBaseOrderItemsItem.md +50 -0
  1010. package/docs/QualificationsRedeemableOrder.md +54 -0
  1011. package/docs/QualificationsRedeemableOrderItemsItem.md +50 -0
  1012. package/docs/QualificationsRedeemables.md +32 -0
  1013. package/docs/RedeemableGift.md +11 -0
  1014. package/docs/RedeemableHolder.md +63 -0
  1015. package/docs/RedeemableLoyaltyCard.md +13 -0
  1016. package/docs/RedeemableResult.md +13 -0
  1017. package/docs/RedeemableVoucher.md +70 -0
  1018. package/docs/RedeemableVoucherGift.md +23 -0
  1019. package/docs/RedeemableVoucherLoyaltyCard.md +15 -0
  1020. package/docs/RedeemableVoucherPublish.md +11 -0
  1021. package/docs/RedeemableVoucherRedemption.md +13 -0
  1022. package/docs/Redemption.md +78 -0
  1023. package/docs/RedemptionChannel.md +23 -0
  1024. package/docs/RedemptionEntry.md +81 -0
  1025. package/docs/RedemptionEntryChannel.md +23 -0
  1026. package/docs/RedemptionEntryCustomer.md +23 -0
  1027. package/docs/RedemptionEntryGift.md +9 -0
  1028. package/docs/RedemptionEntryLoyaltyCard.md +9 -0
  1029. package/docs/RedemptionEntryOrder.md +54 -0
  1030. package/docs/RedemptionEntryOrderCustomer.md +19 -0
  1031. package/docs/RedemptionEntryOrderItemsItem.md +50 -0
  1032. package/docs/RedemptionEntryOrderItemsItemProduct.md +14 -0
  1033. package/docs/RedemptionEntryOrderItemsItemSku.md +14 -0
  1034. package/docs/RedemptionEntryOrderReferrer.md +19 -0
  1035. package/docs/RedemptionEntryPromotionTier.md +51 -0
  1036. package/docs/RedemptionEntryPromotionTierAction.md +9 -0
  1037. package/docs/RedemptionEntryPromotionTierCampaign.md +38 -0
  1038. package/docs/RedemptionEntryPromotionTierSummary.md +10 -0
  1039. package/docs/RedemptionEntryPromotionTierSummaryOrders.md +10 -0
  1040. package/docs/RedemptionEntryPromotionTierSummaryRedemptions.md +9 -0
  1041. package/docs/RedemptionEntryRelatedRedemptions.md +10 -0
  1042. package/docs/RedemptionEntryRelatedRedemptionsRedemptionsItem.md +10 -0
  1043. package/docs/RedemptionEntryRelatedRedemptionsRollbacksItem.md +22 -0
  1044. package/docs/RedemptionEntrySession.md +9 -0
  1045. package/docs/RedemptionEntryVoucher.md +72 -0
  1046. package/docs/RedemptionEntryVoucherGift.md +23 -0
  1047. package/docs/RedemptionEntryVoucherLoyaltyCard.md +15 -0
  1048. package/docs/RedemptionEntryVoucherPublish.md +11 -0
  1049. package/docs/RedemptionEntryVoucherRedemption.md +13 -0
  1050. package/docs/RedemptionGift.md +9 -0
  1051. package/docs/RedemptionLoyaltyCard.md +9 -0
  1052. package/docs/RedemptionOrder.md +54 -0
  1053. package/docs/RedemptionOrderCustomer.md +19 -0
  1054. package/docs/RedemptionOrderItemsItem.md +50 -0
  1055. package/docs/RedemptionOrderReferrer.md +19 -0
  1056. package/docs/RedemptionRelatedRedemptions.md +10 -0
  1057. package/docs/RedemptionRelatedRedemptionsRedemptionsItem.md +10 -0
  1058. package/docs/RedemptionRelatedRedemptionsRollbacksItem.md +22 -0
  1059. package/docs/RedemptionRewardResult.md +44 -0
  1060. package/docs/RedemptionRewardResultParameters.md +11 -0
  1061. package/docs/RedemptionRewardResultParametersCampaign.md +11 -0
  1062. package/docs/RedemptionRewardResultParametersCoin.md +10 -0
  1063. package/docs/RedemptionRewardResultParametersProduct.md +10 -0
  1064. package/docs/RedemptionRollback.md +75 -0
  1065. package/docs/RedemptionRollbackChannel.md +21 -0
  1066. package/docs/RedemptionRollbackGift.md +9 -0
  1067. package/docs/RedemptionRollbackLoyaltyCard.md +9 -0
  1068. package/docs/RedemptionRollbackOrder.md +54 -0
  1069. package/docs/RedemptionSession.md +9 -0
  1070. package/docs/RedemptionVoucher.md +72 -0
  1071. package/docs/RedemptionVoucherGift.md +23 -0
  1072. package/docs/RedemptionVoucherLoyaltyCard.md +15 -0
  1073. package/docs/RedemptionVoucherPublish.md +11 -0
  1074. package/docs/RedemptionVoucherRedemption.md +13 -0
  1075. package/docs/RedemptionsApi.md +400 -0
  1076. package/docs/RedemptionsGetResponseBody.md +81 -0
  1077. package/docs/RedemptionsGetResponseBodyChannel.md +23 -0
  1078. package/docs/RedemptionsGetResponseBodyCustomer.md +23 -0
  1079. package/docs/RedemptionsGetResponseBodyGift.md +9 -0
  1080. package/docs/RedemptionsGetResponseBodyLoyaltyCard.md +9 -0
  1081. package/docs/RedemptionsGetResponseBodyOrder.md +54 -0
  1082. package/docs/RedemptionsGetResponseBodyOrderCustomer.md +19 -0
  1083. package/docs/RedemptionsGetResponseBodyOrderItemsItem.md +50 -0
  1084. package/docs/RedemptionsGetResponseBodyOrderItemsItemProduct.md +14 -0
  1085. package/docs/RedemptionsGetResponseBodyOrderItemsItemSku.md +14 -0
  1086. package/docs/RedemptionsGetResponseBodyOrderReferrer.md +19 -0
  1087. package/docs/RedemptionsGetResponseBodyPromotionTier.md +51 -0
  1088. package/docs/RedemptionsGetResponseBodyPromotionTierAction.md +9 -0
  1089. package/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +38 -0
  1090. package/docs/RedemptionsGetResponseBodyPromotionTierSummary.md +10 -0
  1091. package/docs/RedemptionsGetResponseBodyPromotionTierSummaryOrders.md +10 -0
  1092. package/docs/RedemptionsGetResponseBodyPromotionTierSummaryRedemptions.md +9 -0
  1093. package/docs/RedemptionsGetResponseBodyRelatedRedemptions.md +10 -0
  1094. package/docs/RedemptionsGetResponseBodyRelatedRedemptionsRedemptionsItem.md +10 -0
  1095. package/docs/RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md +22 -0
  1096. package/docs/RedemptionsGetResponseBodySession.md +9 -0
  1097. package/docs/RedemptionsGetResponseBodyVoucher.md +72 -0
  1098. package/docs/RedemptionsGetResponseBodyVoucherGift.md +23 -0
  1099. package/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +15 -0
  1100. package/docs/RedemptionsGetResponseBodyVoucherPublish.md +11 -0
  1101. package/docs/RedemptionsGetResponseBodyVoucherRedemption.md +13 -0
  1102. package/docs/RedemptionsListResponseBody.md +12 -0
  1103. package/docs/RedemptionsListResponseBodyRedemptionsItem.md +81 -0
  1104. package/docs/RedemptionsListResponseBodyRedemptionsItemChannel.md +23 -0
  1105. package/docs/RedemptionsListResponseBodyRedemptionsItemCustomer.md +23 -0
  1106. package/docs/RedemptionsListResponseBodyRedemptionsItemGift.md +9 -0
  1107. package/docs/RedemptionsListResponseBodyRedemptionsItemLoyaltyCard.md +9 -0
  1108. package/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +54 -0
  1109. package/docs/RedemptionsListResponseBodyRedemptionsItemOrderCustomer.md +19 -0
  1110. package/docs/RedemptionsListResponseBodyRedemptionsItemOrderItemsItem.md +50 -0
  1111. package/docs/RedemptionsListResponseBodyRedemptionsItemOrderItemsItemProduct.md +14 -0
  1112. package/docs/RedemptionsListResponseBodyRedemptionsItemOrderItemsItemSku.md +14 -0
  1113. package/docs/RedemptionsListResponseBodyRedemptionsItemOrderReferrer.md +19 -0
  1114. package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTier.md +51 -0
  1115. package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierAction.md +9 -0
  1116. package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +38 -0
  1117. package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary.md +10 -0
  1118. package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders.md +10 -0
  1119. package/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions.md +9 -0
  1120. package/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptions.md +10 -0
  1121. package/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem.md +10 -0
  1122. package/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md +22 -0
  1123. package/docs/RedemptionsListResponseBodyRedemptionsItemSession.md +9 -0
  1124. package/docs/RedemptionsListResponseBodyRedemptionsItemVoucher.md +72 -0
  1125. package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherGift.md +23 -0
  1126. package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +15 -0
  1127. package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherPublish.md +11 -0
  1128. package/docs/RedemptionsListResponseBodyRedemptionsItemVoucherRedemption.md +13 -0
  1129. package/docs/RedemptionsRedeemRequestBody.md +15 -0
  1130. package/docs/RedemptionsRedeemRequestBodyOptions.md +24 -0
  1131. package/docs/RedemptionsRedeemRequestBodyRedeemablesItem.md +25 -0
  1132. package/docs/RedemptionsRedeemRequestBodyRedeemablesItemGift.md +9 -0
  1133. package/docs/RedemptionsRedeemRequestBodyRedeemablesItemReward.md +10 -0
  1134. package/docs/RedemptionsRedeemResponseBody.md +13 -0
  1135. package/docs/RedemptionsRedeemResponseBodyOrder.md +54 -0
  1136. package/docs/RedemptionsRedeemResponseBodyOrderItemsItem.md +50 -0
  1137. package/docs/RedemptionsRollbackCreateRequestBody.md +13 -0
  1138. package/docs/RedemptionsRollbackCreateResponseBody.md +75 -0
  1139. package/docs/RedemptionsRollbackCreateResponseBodyChannel.md +21 -0
  1140. package/docs/RedemptionsRollbackCreateResponseBodyGift.md +9 -0
  1141. package/docs/RedemptionsRollbackCreateResponseBodyLoyaltyCard.md +9 -0
  1142. package/docs/RedemptionsRollbackCreateResponseBodyOrder.md +54 -0
  1143. package/docs/RedemptionsRollbacksCreateRequestBody.md +13 -0
  1144. package/docs/RedemptionsRollbacksCreateResponseBody.md +11 -0
  1145. package/docs/RedemptionsRollbacksCreateResponseBodyOrder.md +54 -0
  1146. package/docs/ReferralProgram.md +22 -0
  1147. package/docs/ReferralProgramCustomEvent.md +10 -0
  1148. package/docs/ReferralProgramRefereeReward.md +22 -0
  1149. package/docs/ReferralProgramRefereeRewardRelatedObjectParent.md +20 -0
  1150. package/docs/ReferralsApi.md +402 -0
  1151. package/docs/ReferralsMembersHoldersCreateInBulkRequestBody.md +10 -0
  1152. package/docs/ReferralsMembersHoldersCreateInBulkResponseBody.md +9 -0
  1153. package/docs/ReferralsMembersHoldersListResponseBody.md +14 -0
  1154. package/docs/Referrer.md +18 -0
  1155. package/docs/ReferrerAddress.md +14 -0
  1156. package/docs/ReferrerId.md +19 -0
  1157. package/docs/ResourceTypes.md +12 -0
  1158. package/docs/Reward.md +41 -0
  1159. package/docs/RewardAssignment.md +34 -0
  1160. package/docs/RewardAssignmentParameters.md +9 -0
  1161. package/docs/RewardAssignmentParametersLoyalty.md +10 -0
  1162. package/docs/RewardAttributes.md +10 -0
  1163. package/docs/RewardType.md +11 -0
  1164. package/docs/RewardTypeCampaign.md +24 -0
  1165. package/docs/RewardTypeCoin.md +10 -0
  1166. package/docs/RewardTypeProduct.md +10 -0
  1167. package/docs/RewardsApi.md +632 -0
  1168. package/docs/RewardsAssignmentsCreateRequestBody.md +11 -0
  1169. package/docs/RewardsAssignmentsCreateRequestBodyParameters.md +9 -0
  1170. package/docs/RewardsAssignmentsCreateRequestBodyParametersLoyalty.md +10 -0
  1171. package/docs/RewardsAssignmentsCreateResponseBody.md +34 -0
  1172. package/docs/RewardsAssignmentsCreateResponseBodyParameters.md +9 -0
  1173. package/docs/RewardsAssignmentsCreateResponseBodyParametersLoyalty.md +10 -0
  1174. package/docs/RewardsAssignmentsGetResponseBody.md +34 -0
  1175. package/docs/RewardsAssignmentsGetResponseBodyParameters.md +9 -0
  1176. package/docs/RewardsAssignmentsGetResponseBodyParametersLoyalty.md +10 -0
  1177. package/docs/RewardsAssignmentsListResponseBody.md +12 -0
  1178. package/docs/RewardsAssignmentsUpdateRequestBody.md +9 -0
  1179. package/docs/RewardsAssignmentsUpdateRequestBodyParameters.md +9 -0
  1180. package/docs/RewardsAssignmentsUpdateRequestBodyParametersLoyalty.md +10 -0
  1181. package/docs/RewardsAssignmentsUpdateResponseBody.md +34 -0
  1182. package/docs/RewardsAssignmentsUpdateResponseBodyParameters.md +9 -0
  1183. package/docs/RewardsAssignmentsUpdateResponseBodyParametersLoyalty.md +10 -0
  1184. package/docs/RewardsCreateRequestBody.md +13 -0
  1185. package/docs/RewardsCreateRequestBodyAttributes.md +10 -0
  1186. package/docs/RewardsCreateRequestBodyParameters.md +11 -0
  1187. package/docs/RewardsCreateRequestBodyParametersCampaign.md +10 -0
  1188. package/docs/RewardsCreateRequestBodyParametersCoin.md +10 -0
  1189. package/docs/RewardsCreateRequestBodyParametersProduct.md +10 -0
  1190. package/docs/RewardsCreateResponseBody.md +41 -0
  1191. package/docs/RewardsCreateResponseBodyAttributes.md +10 -0
  1192. package/docs/RewardsListResponseBody.md +12 -0
  1193. package/docs/RewardsUpdateRequestBody.md +13 -0
  1194. package/docs/RewardsUpdateRequestBodyAttributes.md +10 -0
  1195. package/docs/RewardsUpdateRequestBodyParameters.md +11 -0
  1196. package/docs/RewardsUpdateRequestBodyParametersCampaign.md +10 -0
  1197. package/docs/RewardsUpdateRequestBodyParametersCoin.md +10 -0
  1198. package/docs/RewardsUpdateRequestBodyParametersProduct.md +10 -0
  1199. package/docs/RewardsUpdateResponseBody.md +41 -0
  1200. package/docs/RewardsUpdateResponseBodyAttributes.md +10 -0
  1201. package/docs/SegmentsApi.md +188 -0
  1202. package/docs/SegmentsCreateRequestBody.md +25 -0
  1203. package/docs/SegmentsCreateResponseBody.md +48 -0
  1204. package/docs/SegmentsGetResponseBody.md +48 -0
  1205. package/docs/Session.md +42 -0
  1206. package/docs/SimpleCampaign.md +50 -0
  1207. package/docs/SimpleCampaignVoucher.md +27 -0
  1208. package/docs/SimpleCampaignVoucherRedemption.md +10 -0
  1209. package/docs/SimpleCustomer.md +23 -0
  1210. package/docs/SimpleCustomerRequiredObjectType.md +14 -0
  1211. package/docs/SimpleEvent.md +25 -0
  1212. package/docs/SimpleLoyaltyCard.md +15 -0
  1213. package/docs/SimpleOrder.md +48 -0
  1214. package/docs/SimpleOrderItem.md +44 -0
  1215. package/docs/SimpleProduct.md +11 -0
  1216. package/docs/SimpleProductDiscountUnit.md +11 -0
  1217. package/docs/SimplePromotionStack.md +13 -0
  1218. package/docs/SimplePromotionStackCampaign.md +9 -0
  1219. package/docs/SimplePromotionStackTiers.md +19 -0
  1220. package/docs/SimplePromotionTier.md +13 -0
  1221. package/docs/SimplePromotionTierCampaign.md +9 -0
  1222. package/docs/SimpleRedemption.md +51 -0
  1223. package/docs/SimpleRedemptionChannel.md +23 -0
  1224. package/docs/SimpleRedemptionRewardResult.md +44 -0
  1225. package/docs/SimpleReferralTier.md +12 -0
  1226. package/docs/SimpleSegment.md +20 -0
  1227. package/docs/SimpleSku.md +11 -0
  1228. package/docs/SimpleSkuDiscountUnit.md +11 -0
  1229. package/docs/SimpleVoucher.md +51 -0
  1230. package/docs/SimpleVoucherRedemption.md +11 -0
  1231. package/docs/Sku.md +29 -0
  1232. package/docs/SkusGetResponseBody.md +29 -0
  1233. package/docs/SkusImportCsvCreateResponseBody.md +9 -0
  1234. package/docs/SkusListForProduct.md +12 -0
  1235. package/docs/StackingRules.md +78 -0
  1236. package/docs/TemplatesApi.md +444 -0
  1237. package/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +58 -0
  1238. package/docs/TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher.md +10 -0
  1239. package/docs/TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption.md +9 -0
  1240. package/docs/TemplatesCampaignsCampaignSetupCreateResponseBody.md +20 -0
  1241. package/docs/TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem.md +29 -0
  1242. package/docs/TemplatesCampaignsCreateRequestBody.md +12 -0
  1243. package/docs/TemplatesCampaignsCreateTemplateResponseBody.md +34 -0
  1244. package/docs/TemplatesCampaignsGetResponseBody.md +35 -0
  1245. package/docs/TemplatesCampaignsListResponseBody.md +32 -0
  1246. package/docs/TemplatesCampaignsTierSetupCreateRequestBody.md +42 -0
  1247. package/docs/TemplatesCampaignsTierSetupCreateResponseBody.md +20 -0
  1248. package/docs/TemplatesCampaignsTierSetupCreateResponseBodyCreatedResourcesItem.md +29 -0
  1249. package/docs/TemplatesCampaignsUpdateRequestBody.md +10 -0
  1250. package/docs/TemplatesCampaignsUpdateResponseBody.md +35 -0
  1251. package/docs/TrashBinItem.md +46 -0
  1252. package/docs/TrashBinListResponseBody.md +32 -0
  1253. package/docs/UsageNotifications.md +12 -0
  1254. package/docs/User.md +15 -0
  1255. package/docs/ValidationRule.md +152 -0
  1256. package/docs/ValidationRuleApplicableTo.md +11 -0
  1257. package/docs/ValidationRuleAssignment.md +42 -0
  1258. package/docs/ValidationRuleAssignmentsList.md +12 -0
  1259. package/docs/ValidationRuleError.md +9 -0
  1260. package/docs/ValidationRulesApi.md +586 -0
  1261. package/docs/ValidationRulesAssignmentsCreateRequestBody.md +29 -0
  1262. package/docs/ValidationRulesAssignmentsCreateResponseBody.md +42 -0
  1263. package/docs/ValidationRulesAssignmentsList.md +30 -0
  1264. package/docs/ValidationRulesAssignmentsListResponseBody.md +12 -0
  1265. package/docs/ValidationRulesCreateRequestBody.md +147 -0
  1266. package/docs/ValidationRulesCreateRequestBodyApplicableTo.md +11 -0
  1267. package/docs/ValidationRulesCreateRequestBodyError.md +9 -0
  1268. package/docs/ValidationRulesCreateResponseBody.md +152 -0
  1269. package/docs/ValidationRulesCreateResponseBodyApplicableTo.md +11 -0
  1270. package/docs/ValidationRulesCreateResponseBodyError.md +9 -0
  1271. package/docs/ValidationRulesGetResponseBody.md +152 -0
  1272. package/docs/ValidationRulesGetResponseBodyApplicableTo.md +11 -0
  1273. package/docs/ValidationRulesGetResponseBodyError.md +9 -0
  1274. package/docs/ValidationRulesListResponseBody.md +12 -0
  1275. package/docs/ValidationRulesUpdateRequestBody.md +147 -0
  1276. package/docs/ValidationRulesUpdateRequestBodyApplicableTo.md +11 -0
  1277. package/docs/ValidationRulesUpdateRequestBodyError.md +9 -0
  1278. package/docs/ValidationRulesUpdateResponseBody.md +152 -0
  1279. package/docs/ValidationRulesUpdateResponseBodyApplicableTo.md +11 -0
  1280. package/docs/ValidationRulesUpdateResponseBodyError.md +9 -0
  1281. package/docs/ValidationsApi.md +68 -0
  1282. package/docs/ValidationsRedeemableInapplicable.md +37 -0
  1283. package/docs/ValidationsRedeemableInapplicableResult.md +11 -0
  1284. package/docs/ValidationsRedeemableInapplicableResultDetails.md +10 -0
  1285. package/docs/ValidationsRedeemableSkipped.md +37 -0
  1286. package/docs/ValidationsRedeemableSkippedResult.md +9 -0
  1287. package/docs/ValidationsRedeemableSkippedResultDetails.md +29 -0
  1288. package/docs/ValidationsValidateRequestBody.md +15 -0
  1289. package/docs/ValidationsValidateRequestBodyOptions.md +24 -0
  1290. package/docs/ValidationsValidateRequestBodyRedeemablesItem.md +25 -0
  1291. package/docs/ValidationsValidateRequestBodyRedeemablesItemGift.md +9 -0
  1292. package/docs/ValidationsValidateRequestBodyRedeemablesItemReward.md +10 -0
  1293. package/docs/ValidationsValidateResponseBody.md +17 -0
  1294. package/docs/ValidationsValidateResponseBodyOrder.md +54 -0
  1295. package/docs/ValidationsValidateResponseBodyOrderItemsItem.md +50 -0
  1296. package/docs/ValidationsValidateResponseBodyRedeemablesItem.md +44 -0
  1297. package/docs/ValidationsValidateResponseBodyRedeemablesItemOrder.md +54 -0
  1298. package/docs/ValidationsValidateResponseBodyRedeemablesItemOrderCustomer.md +19 -0
  1299. package/docs/ValidationsValidateResponseBodyRedeemablesItemOrderReferrer.md +19 -0
  1300. package/docs/ValidationsValidateResponseBodyRedeemablesItemResult.md +14 -0
  1301. package/docs/ValidationsValidateResponseBodyRedeemablesItemResultDetails.md +10 -0
  1302. package/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +63 -0
  1303. package/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md +11 -0
  1304. package/docs/ValidationsValidateResponseBodyRedeemablesItemResultGift.md +10 -0
  1305. package/docs/ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md +9 -0
  1306. package/docs/ValidityHours.md +9 -0
  1307. package/docs/ValidityHoursDailyItem.md +32 -0
  1308. package/docs/ValidityTimeframe.md +10 -0
  1309. package/docs/Voucher.md +71 -0
  1310. package/docs/VoucherAssets.md +10 -0
  1311. package/docs/VoucherAssetsBarcode.md +10 -0
  1312. package/docs/VoucherAssetsQr.md +10 -0
  1313. package/docs/VoucherBalance.md +47 -0
  1314. package/docs/VoucherBalanceRelatedObject.md +19 -0
  1315. package/docs/VoucherGift.md +23 -0
  1316. package/docs/VoucherLoyaltyCard.md +15 -0
  1317. package/docs/VoucherPublish.md +11 -0
  1318. package/docs/VoucherRedemption.md +13 -0
  1319. package/docs/VoucherTransaction.md +51 -0
  1320. package/docs/VoucherTransactionDetails.md +23 -0
  1321. package/docs/VoucherTransactionDetailsCustomEvent.md +10 -0
  1322. package/docs/VoucherTransactionDetailsEarningRule.md +10 -0
  1323. package/docs/VoucherTransactionDetailsEarningRuleSource.md +9 -0
  1324. package/docs/VoucherTransactionDetailsEvent.md +10 -0
  1325. package/docs/VoucherTransactionDetailsEventSchema.md +10 -0
  1326. package/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +10 -0
  1327. package/docs/VoucherTransactionDetailsLoyaltyTier.md +10 -0
  1328. package/docs/VoucherTransactionDetailsOrder.md +10 -0
  1329. package/docs/VoucherTransactionDetailsRedemption.md +9 -0
  1330. package/docs/VoucherTransactionDetailsReward.md +10 -0
  1331. package/docs/VoucherTransactionDetailsRollback.md +9 -0
  1332. package/docs/VoucherTransactionDetailsSegment.md +10 -0
  1333. package/docs/VoucherTransactionsExportFilterConditions.md +9 -0
  1334. package/docs/VoucherTransactionsExportFilterConditionsVoucherId.md +9 -0
  1335. package/docs/VoucherTransactionsExportFilterConditionsVoucherIdConditions.md +9 -0
  1336. package/docs/VoucherTransactionsExportParameters.md +52 -0
  1337. package/docs/VoucherTransactionsFilters.md +53 -0
  1338. package/docs/VoucherWithCategories.md +70 -0
  1339. package/docs/VoucherWithCategoriesGift.md +23 -0
  1340. package/docs/VoucherWithCategoriesLoyaltyCard.md +15 -0
  1341. package/docs/VoucherWithCategoriesPublish.md +11 -0
  1342. package/docs/VoucherWithCategoriesRedemption.md +13 -0
  1343. package/docs/VouchersApi.md +1016 -0
  1344. package/docs/VouchersBalanceUpdateRequestBody.md +11 -0
  1345. package/docs/VouchersBalanceUpdateResponseBody.md +44 -0
  1346. package/docs/VouchersBalanceUpdateResponseBodyRelatedObject.md +19 -0
  1347. package/docs/VouchersCreateRequestBody.md +62 -0
  1348. package/docs/VouchersCreateRequestBodyRedemption.md +9 -0
  1349. package/docs/VouchersCreateResponseBody.md +71 -0
  1350. package/docs/VouchersCreateResponseBodyGift.md +23 -0
  1351. package/docs/VouchersCreateResponseBodyLoyaltyCard.md +15 -0
  1352. package/docs/VouchersCreateResponseBodyPublish.md +11 -0
  1353. package/docs/VouchersCreateResponseBodyRedemption.md +13 -0
  1354. package/docs/VouchersCreateWithSpecificCodeRequestBody.md +60 -0
  1355. package/docs/VouchersCreateWithSpecificCodeRequestBodyRedemption.md +9 -0
  1356. package/docs/VouchersDisableResponseBody.md +71 -0
  1357. package/docs/VouchersDisableResponseBodyGift.md +23 -0
  1358. package/docs/VouchersDisableResponseBodyLoyaltyCard.md +15 -0
  1359. package/docs/VouchersDisableResponseBodyPublish.md +11 -0
  1360. package/docs/VouchersDisableResponseBodyRedemption.md +13 -0
  1361. package/docs/VouchersEnableResponseBody.md +71 -0
  1362. package/docs/VouchersEnableResponseBodyGift.md +23 -0
  1363. package/docs/VouchersEnableResponseBodyLoyaltyCard.md +15 -0
  1364. package/docs/VouchersEnableResponseBodyPublish.md +11 -0
  1365. package/docs/VouchersEnableResponseBodyRedemption.md +13 -0
  1366. package/docs/VouchersGetResponseBody.md +71 -0
  1367. package/docs/VouchersGetResponseBodyGift.md +23 -0
  1368. package/docs/VouchersGetResponseBodyLoyaltyCard.md +15 -0
  1369. package/docs/VouchersGetResponseBodyPublish.md +11 -0
  1370. package/docs/VouchersGetResponseBodyRedemption.md +13 -0
  1371. package/docs/VouchersImportCreateItemRequestBody.md +53 -0
  1372. package/docs/VouchersImportCreateItemRequestBodyRedemption.md +9 -0
  1373. package/docs/VouchersImportCreateResponseBody.md +9 -0
  1374. package/docs/VouchersImportCsvCreateResponseBody.md +9 -0
  1375. package/docs/VouchersListResponseBody.md +30 -0
  1376. package/docs/VouchersMetadataUpdateInBulkRequestBody.md +10 -0
  1377. package/docs/VouchersMetadataUpdateInBulkResponseBody.md +9 -0
  1378. package/docs/VouchersRedemptionGetResponseBody.md +15 -0
  1379. package/docs/VouchersTransactionsExportCreateRequestBody.md +9 -0
  1380. package/docs/VouchersTransactionsExportCreateResponseBody.md +44 -0
  1381. package/docs/VouchersTransactionsExportCreateResponseBodyResult.md +9 -0
  1382. package/docs/VouchersTransactionsListResponseBody.md +31 -0
  1383. package/docs/VouchersUpdateInBulkItemRequestBody.md +10 -0
  1384. package/docs/VouchersUpdateInBulkResponseBody.md +9 -0
  1385. package/docs/VouchersUpdateRequestBody.md +50 -0
  1386. package/docs/VouchersUpdateResponseBody.md +71 -0
  1387. package/docs/VouchersUpdateResponseBodyGift.md +23 -0
  1388. package/docs/VouchersUpdateResponseBodyLoyaltyCard.md +15 -0
  1389. package/docs/VouchersUpdateResponseBodyPublish.md +11 -0
  1390. package/docs/VouchersUpdateResponseBodyRedemption.md +13 -0
  1391. package/package.json +69 -58
  1392. package/dist/ApiLimitsHandler.d.ts +0 -13
  1393. package/dist/AsyncActions.d.ts +0 -17
  1394. package/dist/Balance.d.ts +0 -15
  1395. package/dist/Campaigns.d.ts +0 -66
  1396. package/dist/Categories.d.ts +0 -29
  1397. package/dist/ClientSide.d.ts +0 -77
  1398. package/dist/Consents.d.ts +0 -13
  1399. package/dist/Customers.d.ts +0 -75
  1400. package/dist/Distributions.d.ts +0 -29
  1401. package/dist/Events.d.ts +0 -15
  1402. package/dist/Exports.d.ts +0 -25
  1403. package/dist/Loyalties.d.ts +0 -171
  1404. package/dist/MetadataSchemas.d.ts +0 -17
  1405. package/dist/Orders.d.ts +0 -32
  1406. package/dist/ProductCollections.d.ts +0 -30
  1407. package/dist/Products.d.ts +0 -66
  1408. package/dist/PromotionTiers.d.ts +0 -43
  1409. package/dist/Promotions.d.ts +0 -30
  1410. package/dist/PromotionsStacks.d.ts +0 -34
  1411. package/dist/Qualifications.d.ts +0 -24
  1412. package/dist/Redemptions.d.ts +0 -53
  1413. package/dist/RequestController.d.ts +0 -31
  1414. package/dist/Rewards.d.ts +0 -46
  1415. package/dist/Segments.d.ts +0 -25
  1416. package/dist/ValidationRules.d.ts +0 -47
  1417. package/dist/Validations.d.ts +0 -39
  1418. package/dist/VoucherifyClientSide.d.ts +0 -112
  1419. package/dist/VoucherifyError.d.ts +0 -23
  1420. package/dist/VoucherifyServerSide.d.ts +0 -170
  1421. package/dist/Vouchers.d.ts +0 -84
  1422. package/dist/helpers.d.ts +0 -20
  1423. package/dist/index.d.ts +0 -63
  1424. package/dist/types/ApplicableTo.d.ts +0 -32
  1425. package/dist/types/AsyncActions.d.ts +0 -23
  1426. package/dist/types/Balance.d.ts +0 -18
  1427. package/dist/types/Campaigns.d.ts +0 -124
  1428. package/dist/types/Categories.d.ts +0 -40
  1429. package/dist/types/ClientSide.d.ts +0 -145
  1430. package/dist/types/Consents.d.ts +0 -34
  1431. package/dist/types/Customers.d.ts +0 -363
  1432. package/dist/types/DiscountVoucher.d.ts +0 -94
  1433. package/dist/types/Distributions.d.ts +0 -148
  1434. package/dist/types/Events.d.ts +0 -21
  1435. package/dist/types/Exports.d.ts +0 -151
  1436. package/dist/types/Gift.d.ts +0 -5
  1437. package/dist/types/Loyalties.d.ts +0 -1061
  1438. package/dist/types/MetadataSchemas.d.ts +0 -34
  1439. package/dist/types/Orders.d.ts +0 -199
  1440. package/dist/types/ProductCollections.d.ts +0 -99
  1441. package/dist/types/Products.d.ts +0 -108
  1442. package/dist/types/PromotionTiers.d.ts +0 -131
  1443. package/dist/types/Promotions.d.ts +0 -113
  1444. package/dist/types/PromotionsStacks.d.ts +0 -74
  1445. package/dist/types/Qualifications.d.ts +0 -92
  1446. package/dist/types/Redemptions.d.ts +0 -215
  1447. package/dist/types/Rewards.d.ts +0 -220
  1448. package/dist/types/Segments.d.ts +0 -34
  1449. package/dist/types/Stackable.d.ts +0 -106
  1450. package/dist/types/UtilityTypes.d.ts +0 -5
  1451. package/dist/types/ValidateSession.d.ts +0 -19
  1452. package/dist/types/ValidationError.d.ts +0 -9
  1453. package/dist/types/ValidationRules.d.ts +0 -96
  1454. package/dist/types/Validations.d.ts +0 -109
  1455. package/dist/types/Vouchers.d.ts +0 -452
  1456. package/dist/types/index.d.ts +0 -27
  1457. package/dist/voucherifysdk.cjs +0 -2023
  1458. package/dist/voucherifysdk.cjs.map +0 -1
  1459. package/dist/voucherifysdk.esm.js +0 -1986
  1460. package/dist/voucherifysdk.esm.js.map +0 -1
@@ -0,0 +1,3358 @@
1
+ # Voucherify.LoyaltiesApi
2
+
3
+ All URIs are relative to *https://api.voucherify.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**activateMemberPendingPoints**](LoyaltiesApi.md#activateMemberPendingPoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points
8
+ [**addMember**](LoyaltiesApi.md#addMember) | **POST** /v1/loyalties/{campaignId}/members | Add Member
9
+ [**adjustMemberPendingPoints**](LoyaltiesApi.md#adjustMemberPendingPoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | Adjust Member Pending Points
10
+ [**cancelMemberPendingPoints**](LoyaltiesApi.md#cancelMemberPendingPoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points
11
+ [**createEarningRule**](LoyaltiesApi.md#createEarningRule) | **POST** /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule
12
+ [**createInBulkLoyaltyTiers**](LoyaltiesApi.md#createInBulkLoyaltyTiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers
13
+ [**createLoyaltyProgram**](LoyaltiesApi.md#createLoyaltyProgram) | **POST** /v1/loyalties | Create Loyalty Campaign
14
+ [**createPointsExpirationExport**](LoyaltiesApi.md#createPointsExpirationExport) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration
15
+ [**createRewardAssignment1**](LoyaltiesApi.md#createRewardAssignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Loyalty Campaign Reward Assignment
16
+ [**deleteEarningRule**](LoyaltiesApi.md#deleteEarningRule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule
17
+ [**deleteLoyaltyProgram**](LoyaltiesApi.md#deleteLoyaltyProgram) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign
18
+ [**deleteRewardAssignment1**](LoyaltiesApi.md#deleteRewardAssignment1) | **DELETE** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Campaign Reward Assignment
19
+ [**disableEarningRule**](LoyaltiesApi.md#disableEarningRule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule
20
+ [**enableEarningRule**](LoyaltiesApi.md#enableEarningRule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule
21
+ [**exportLoyaltyCampaignTransactions**](LoyaltiesApi.md#exportLoyaltyCampaignTransactions) | **POST** /v1/loyalties/{campaignId}/transactions/export | Export Loyalty Campaign Transactions
22
+ [**exportLoyaltyCardTransactions**](LoyaltiesApi.md#exportLoyaltyCardTransactions) | **POST** /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions
23
+ [**exportLoyaltyCardTransactions1**](LoyaltiesApi.md#exportLoyaltyCardTransactions1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions with campaign ID
24
+ [**getEarningRule**](LoyaltiesApi.md#getEarningRule) | **GET** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule
25
+ [**getLoyaltyProgram**](LoyaltiesApi.md#getLoyaltyProgram) | **GET** /v1/loyalties/{campaignId} | Get Loyalty Campaign
26
+ [**getLoyaltyTier**](LoyaltiesApi.md#getLoyaltyTier) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier
27
+ [**getMember**](LoyaltiesApi.md#getMember) | **GET** /v1/loyalties/members/{memberId} | Get Member
28
+ [**getMember1**](LoyaltiesApi.md#getMember1) | **GET** /v1/loyalties/{campaignId}/members/{memberId} | Get Member with campaign ID
29
+ [**getRewardAssignment1**](LoyaltiesApi.md#getRewardAssignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Campaign Reward Assignments
30
+ [**getRewardAssignment2**](LoyaltiesApi.md#getRewardAssignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Campaign Reward Assignment
31
+ [**getRewardDetails**](LoyaltiesApi.md#getRewardDetails) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details
32
+ [**listCampaignPendingPoints**](LoyaltiesApi.md#listCampaignPendingPoints) | **GET** /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points
33
+ [**listEarningRules**](LoyaltiesApi.md#listEarningRules) | **GET** /v1/loyalties/{campaignId}/earning-rules | List Earning Rules
34
+ [**listLoyaltyCampaignTransactions**](LoyaltiesApi.md#listLoyaltyCampaignTransactions) | **GET** /v1/loyalties/{campaignId}/transactions | List Loyalty Campaign Transactions
35
+ [**listLoyaltyCardTransactions**](LoyaltiesApi.md#listLoyaltyCardTransactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions
36
+ [**listLoyaltyCardTransactions1**](LoyaltiesApi.md#listLoyaltyCardTransactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions with campaign ID
37
+ [**listLoyaltyPrograms**](LoyaltiesApi.md#listLoyaltyPrograms) | **GET** /v1/loyalties | List Loyalty Campaigns
38
+ [**listLoyaltyTierEarningRules**](LoyaltiesApi.md#listLoyaltyTierEarningRules) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules
39
+ [**listLoyaltyTierRewards**](LoyaltiesApi.md#listLoyaltyTierRewards) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards
40
+ [**listLoyaltyTiers**](LoyaltiesApi.md#listLoyaltyTiers) | **GET** /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers
41
+ [**listMemberActivity**](LoyaltiesApi.md#listMemberActivity) | **GET** /v1/loyalties/members/{memberId}/activity | List Member Activity
42
+ [**listMemberActivity1**](LoyaltiesApi.md#listMemberActivity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity with campaign ID
43
+ [**listMemberLoyaltyTier**](LoyaltiesApi.md#listMemberLoyaltyTier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers
44
+ [**listMemberPendingPoints**](LoyaltiesApi.md#listMemberPendingPoints) | **GET** /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points
45
+ [**listMemberPendingPoints1**](LoyaltiesApi.md#listMemberPendingPoints1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points with campaign ID
46
+ [**listMemberRewards**](LoyaltiesApi.md#listMemberRewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards
47
+ [**listMembers**](LoyaltiesApi.md#listMembers) | **GET** /v1/loyalties/{campaignId}/members | List Members
48
+ [**listPointsExpiration**](LoyaltiesApi.md#listPointsExpiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration
49
+ [**listRewardAssignments1**](LoyaltiesApi.md#listRewardAssignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments with campaign ID
50
+ [**listRewardAssignments2**](LoyaltiesApi.md#listRewardAssignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List Campaign Rewards
51
+ [**redeemReward**](LoyaltiesApi.md#redeemReward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward
52
+ [**redeemReward1**](LoyaltiesApi.md#redeemReward1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward with campaign ID
53
+ [**transferPoints**](LoyaltiesApi.md#transferPoints) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points
54
+ [**updateEarningRule**](LoyaltiesApi.md#updateEarningRule) | **PUT** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Update Earning Rule
55
+ [**updateLoyaltyCardBalance**](LoyaltiesApi.md#updateLoyaltyCardBalance) | **POST** /v1/loyalties/members/{memberId}/balance | Adjust Loyalty Card Balance
56
+ [**updateLoyaltyCardBalance1**](LoyaltiesApi.md#updateLoyaltyCardBalance1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/balance | Adjust Loyalty Card Balance with campaign ID
57
+ [**updateLoyaltyProgram**](LoyaltiesApi.md#updateLoyaltyProgram) | **PUT** /v1/loyalties/{campaignId} | Update Loyalty Campaign
58
+ [**updateRewardAssignment1**](LoyaltiesApi.md#updateRewardAssignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Campaign Reward Assignment
59
+
60
+
61
+
62
+ ## activateMemberPendingPoints
63
+
64
+ > LoyaltiesMembersPendingPointsActivateResponseBody activateMemberPendingPoints(memberId, pendingPointsId)
65
+
66
+ Activate Member Pending Points
67
+
68
+ Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
69
+
70
+ ### Example
71
+
72
+ ```javascript
73
+ import Voucherify from 'voucherify';
74
+ let defaultClient = Voucherify.ApiClient.instance;
75
+ // Configure API key authorization: X-App-Id
76
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
77
+ X-App-Id.apiKey = 'YOUR API KEY';
78
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
79
+ //X-App-Id.apiKeyPrefix = 'Token';
80
+ // Configure API key authorization: X-App-Token
81
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
82
+ X-App-Token.apiKey = 'YOUR API KEY';
83
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
84
+ //X-App-Token.apiKeyPrefix = 'Token';
85
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
86
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
87
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
88
+
89
+ let apiInstance = new Voucherify.LoyaltiesApi();
90
+ let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer.
91
+ let pendingPointsId = "pendingPointsId_example"; // String | Unique pending point identifier, assigned by Voucherify.
92
+ apiInstance.activateMemberPendingPoints(memberId, pendingPointsId, (error, data, response) => {
93
+ if (error) {
94
+ console.error(error);
95
+ } else {
96
+ console.log('API called successfully. Returned data: ' + data);
97
+ }
98
+ });
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **memberId** | **String**| Unique loyalty card code assigned to a particular customer. |
107
+ **pendingPointsId** | **String**| Unique pending point identifier, assigned by Voucherify. |
108
+
109
+ ### Return type
110
+
111
+ [**LoyaltiesMembersPendingPointsActivateResponseBody**](LoyaltiesMembersPendingPointsActivateResponseBody.md)
112
+
113
+ ### Authorization
114
+
115
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
116
+
117
+ ### HTTP request headers
118
+
119
+ - **Content-Type**: Not defined
120
+ - **Accept**: application/json
121
+
122
+
123
+ ## addMember
124
+
125
+ > LoyaltiesMembersCreateResponseBody addMember(campaignId, loyaltiesMembersCreateRequestBody)
126
+
127
+ Add Member
128
+
129
+ This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet. 📘 Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign.
130
+
131
+ ### Example
132
+
133
+ ```javascript
134
+ import Voucherify from 'voucherify';
135
+ let defaultClient = Voucherify.ApiClient.instance;
136
+ // Configure API key authorization: X-App-Id
137
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
138
+ X-App-Id.apiKey = 'YOUR API KEY';
139
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
140
+ //X-App-Id.apiKeyPrefix = 'Token';
141
+ // Configure API key authorization: X-App-Token
142
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
143
+ X-App-Token.apiKey = 'YOUR API KEY';
144
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
145
+ //X-App-Token.apiKeyPrefix = 'Token';
146
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
147
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
148
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
149
+
150
+ let apiInstance = new Voucherify.LoyaltiesApi();
151
+ let campaignId = "campaignId_example"; // String | Unique campaign ID of the loyalty program.
152
+ let loyaltiesMembersCreateRequestBody = {"customer":"source_customer_1","metadata":{"year":2022},"channel":"postman","voucher":"KpzbHUY5"}; // LoyaltiesMembersCreateRequestBody | Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint.
153
+ apiInstance.addMember(campaignId, loyaltiesMembersCreateRequestBody, (error, data, response) => {
154
+ if (error) {
155
+ console.error(error);
156
+ } else {
157
+ console.log('API called successfully. Returned data: ' + data);
158
+ }
159
+ });
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+
165
+ Name | Type | Description | Notes
166
+ ------------- | ------------- | ------------- | -------------
167
+ **campaignId** | **String**| Unique campaign ID of the loyalty program. |
168
+ **loyaltiesMembersCreateRequestBody** | [**LoyaltiesMembersCreateRequestBody**](LoyaltiesMembersCreateRequestBody.md)| Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. |
169
+
170
+ ### Return type
171
+
172
+ [**LoyaltiesMembersCreateResponseBody**](LoyaltiesMembersCreateResponseBody.md)
173
+
174
+ ### Authorization
175
+
176
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
177
+
178
+ ### HTTP request headers
179
+
180
+ - **Content-Type**: application/json
181
+ - **Accept**: application/json
182
+
183
+
184
+ ## adjustMemberPendingPoints
185
+
186
+ > LoyaltiesMembersPendingPointsBalanceResponseBody adjustMemberPendingPoints(memberId, pendingPointsId, loyaltiesMembersPendingPointsBalanceRequestBody)
187
+
188
+ Adjust Member Pending Points
189
+
190
+ Adjusts the pending points with a given ID. You can add or subtract the number of points. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
191
+
192
+ ### Example
193
+
194
+ ```javascript
195
+ import Voucherify from 'voucherify';
196
+ let defaultClient = Voucherify.ApiClient.instance;
197
+ // Configure API key authorization: X-App-Id
198
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
199
+ X-App-Id.apiKey = 'YOUR API KEY';
200
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
201
+ //X-App-Id.apiKeyPrefix = 'Token';
202
+ // Configure API key authorization: X-App-Token
203
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
204
+ X-App-Token.apiKey = 'YOUR API KEY';
205
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
206
+ //X-App-Token.apiKeyPrefix = 'Token';
207
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
208
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
209
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
210
+
211
+ let apiInstance = new Voucherify.LoyaltiesApi();
212
+ let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer.
213
+ let pendingPointsId = "pendingPointsId_example"; // String | Unique pending point identifier, assigned by Voucherify.
214
+ let loyaltiesMembersPendingPointsBalanceRequestBody = {"points":10}; // LoyaltiesMembersPendingPointsBalanceRequestBody | Define the number of pending points to be added or subtracted.
215
+ apiInstance.adjustMemberPendingPoints(memberId, pendingPointsId, loyaltiesMembersPendingPointsBalanceRequestBody, (error, data, response) => {
216
+ if (error) {
217
+ console.error(error);
218
+ } else {
219
+ console.log('API called successfully. Returned data: ' + data);
220
+ }
221
+ });
222
+ ```
223
+
224
+ ### Parameters
225
+
226
+
227
+ Name | Type | Description | Notes
228
+ ------------- | ------------- | ------------- | -------------
229
+ **memberId** | **String**| Unique loyalty card code assigned to a particular customer. |
230
+ **pendingPointsId** | **String**| Unique pending point identifier, assigned by Voucherify. |
231
+ **loyaltiesMembersPendingPointsBalanceRequestBody** | [**LoyaltiesMembersPendingPointsBalanceRequestBody**](LoyaltiesMembersPendingPointsBalanceRequestBody.md)| Define the number of pending points to be added or subtracted. |
232
+
233
+ ### Return type
234
+
235
+ [**LoyaltiesMembersPendingPointsBalanceResponseBody**](LoyaltiesMembersPendingPointsBalanceResponseBody.md)
236
+
237
+ ### Authorization
238
+
239
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
240
+
241
+ ### HTTP request headers
242
+
243
+ - **Content-Type**: application/json
244
+ - **Accept**: application/json
245
+
246
+
247
+ ## cancelMemberPendingPoints
248
+
249
+ > cancelMemberPendingPoints(memberId, pendingPointsId)
250
+
251
+ Cancel Member Pending Points
252
+
253
+ Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
254
+
255
+ ### Example
256
+
257
+ ```javascript
258
+ import Voucherify from 'voucherify';
259
+ let defaultClient = Voucherify.ApiClient.instance;
260
+ // Configure API key authorization: X-App-Id
261
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
262
+ X-App-Id.apiKey = 'YOUR API KEY';
263
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
264
+ //X-App-Id.apiKeyPrefix = 'Token';
265
+ // Configure API key authorization: X-App-Token
266
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
267
+ X-App-Token.apiKey = 'YOUR API KEY';
268
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
269
+ //X-App-Token.apiKeyPrefix = 'Token';
270
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
271
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
272
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
273
+
274
+ let apiInstance = new Voucherify.LoyaltiesApi();
275
+ let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer.
276
+ let pendingPointsId = "pendingPointsId_example"; // String | Unique pending point identifier, assigned by Voucherify.
277
+ apiInstance.cancelMemberPendingPoints(memberId, pendingPointsId, (error, data, response) => {
278
+ if (error) {
279
+ console.error(error);
280
+ } else {
281
+ console.log('API called successfully.');
282
+ }
283
+ });
284
+ ```
285
+
286
+ ### Parameters
287
+
288
+
289
+ Name | Type | Description | Notes
290
+ ------------- | ------------- | ------------- | -------------
291
+ **memberId** | **String**| Unique loyalty card code assigned to a particular customer. |
292
+ **pendingPointsId** | **String**| Unique pending point identifier, assigned by Voucherify. |
293
+
294
+ ### Return type
295
+
296
+ null (empty response body)
297
+
298
+ ### Authorization
299
+
300
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
301
+
302
+ ### HTTP request headers
303
+
304
+ - **Content-Type**: Not defined
305
+ - **Accept**: Not defined
306
+
307
+
308
+ ## createEarningRule
309
+
310
+ > [LoyaltiesEarningRulesCreateResponseBody] createEarningRule(campaignId, loyaltiesEarningRulesCreateRequestBodyItem)
311
+
312
+ Create Earning Rule
313
+
314
+ Create earning rules for a loyalty campaign. 🚧 Maximum number of earning rules You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup.
315
+
316
+ ### Example
317
+
318
+ ```javascript
319
+ import Voucherify from 'voucherify';
320
+ let defaultClient = Voucherify.ApiClient.instance;
321
+ // Configure API key authorization: X-App-Id
322
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
323
+ X-App-Id.apiKey = 'YOUR API KEY';
324
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
325
+ //X-App-Id.apiKeyPrefix = 'Token';
326
+ // Configure API key authorization: X-App-Token
327
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
328
+ X-App-Token.apiKey = 'YOUR API KEY';
329
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
330
+ //X-App-Token.apiKeyPrefix = 'Token';
331
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
332
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
333
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
334
+
335
+ let apiInstance = new Voucherify.LoyaltiesApi();
336
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
337
+ let loyaltiesEarningRulesCreateRequestBodyItem = [{"event":"order.paid","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"FIXED","points":"5"},"source":{"banner":"Order paid 5 points."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - fixed amount of points"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_AMOUNT","order":{"amount":{"every":1,"points":1}}},"source":{"banner":"Order paid - 1 point for 1 dollar spent excluding discounts."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_TOTAL_AMOUNT","order":{"total_amount":{"every":1,"points":1}}},"source":{"banner":"Order paid - 1 point for 1 dollar spent including discounts."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order total amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_METADATA","order":{"metadata":{"every":2,"points":1,"property":"number_of_store_visits"}}},"source":{"banner":"Order paid - 2 points for each store visit."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to numerical order metadata property "}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_ITEMS_AMOUNT","order_items":{"amount":{"every":2,"points":1,"object":"product","id":"prod_0bae32322150fd0546"}}},"source":{"banner":"Order paid - 2 points for 1 dollar spent on items excluding discounts."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order items amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_ITEMS_SUBTOTAL_AMOUNT","order_items":{"subtotal_amount":{"every":2,"points":1,"object":"products_collection","id":"pc_75U0dHlr7u75BJodrW1AE3t6"}}},"source":{"banner":"Order paid - 2 points for every dollar spent on the product collection."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order items subtotal amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_ITEMS_QUANTITY","order_items":{"quantity":{"every":1,"points":1,"object":"sku","id":"sku_0b7d7dfb090be5c619"}}},"source":{"banner":"Order paid - 1 point for every brand phone in your cart."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - points proportional to quantity of items in a cart of a product varient."}},{"event":"order.paid","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":1,"property":"customer_life_time_value"}}},"source":{"banner":"Order paid 1 point for 1 month of being a customer with us."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - points proportional to customer metadata property"}},{"event":"customer.segment.entered","segment":{"id":"seg_OlE7DmfzMI5pHyD5VAv512r1"},"validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":1,"property":"customer_life_time_value"}}},"source":{"banner":"Customer entered birthday segment - 1 point for each month of being a customer with us."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Entered segment - points proportional to customer metadata property"}},{"event":"customer.segment.entered","segment":{"id":"seg_OlE7DmfzMI5pHyD5VAv512r1"},"validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"FIXED","points":"5"},"source":{"banner":"Customer entered birthday segment - 5 points"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Entered segment - fixed points"}},{"event":"page_view","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"points":3,"type":"FIXED"},"custom_event":{"schema_id":"ms_gn4Qe4xsFPf7orCArCiNVY13"},"source":{"banner":"See page - 3 points"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - fixed points for viewing a page"}},{"event":"page_view","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOM_EVENT_METADATA","custom_event":{"metadata":{"every":1,"points":2,"property":"volume_number"}}},"custom_event":{"schema_id":"ms_gn4Qe4xsFPf7orCArCiNVY13"},"source":{"banner":"See page X - get 2 points multiplied by the page number"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - proportional points for viewing a page based on custom event metadata"}},{"event":"page_view","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":2,"property":"customer_life_time_value"}}},"custom_event":{"schema_id":"ms_gn4Qe4xsFPf7orCArCiNVY13"},"source":{"banner":"Get 2 points for every month you're a customer for viewing a page"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - proportional points for viewing a page based on customer metadata"}},{"event":"customer.loyalty.tier.prolonged","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":2,"property":"customer_life_time_value"}}},"loyalty_tier":{"id":"ltr_pudTGWasuIqxdiDM0go31OV1"},"source":{"banner":"Get 2 points for every month you're a customer when your loyalty tier is prolonged."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - proportional points for extending a loyalty tier based on customer metadata."}}]; // [LoyaltiesEarningRulesCreateRequestBodyItem] | Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object
338
+ apiInstance.createEarningRule(campaignId, loyaltiesEarningRulesCreateRequestBodyItem, (error, data, response) => {
339
+ if (error) {
340
+ console.error(error);
341
+ } else {
342
+ console.log('API called successfully. Returned data: ' + data);
343
+ }
344
+ });
345
+ ```
346
+
347
+ ### Parameters
348
+
349
+
350
+ Name | Type | Description | Notes
351
+ ------------- | ------------- | ------------- | -------------
352
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
353
+ **loyaltiesEarningRulesCreateRequestBodyItem** | [**[LoyaltiesEarningRulesCreateRequestBodyItem]**](LoyaltiesEarningRulesCreateRequestBodyItem.md)| Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object |
354
+
355
+ ### Return type
356
+
357
+ [**[LoyaltiesEarningRulesCreateResponseBody]**](LoyaltiesEarningRulesCreateResponseBody.md)
358
+
359
+ ### Authorization
360
+
361
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: application/json
366
+ - **Accept**: application/json
367
+
368
+
369
+ ## createInBulkLoyaltyTiers
370
+
371
+ > [LoyaltyTier] createInBulkLoyaltyTiers(campaignId, loyaltiesTiersCreateInBulkRequestBodyItem)
372
+
373
+ Create loyalty tiers
374
+
375
+ Creates loyalty tiers for desired campaign.
376
+
377
+ ### Example
378
+
379
+ ```javascript
380
+ import Voucherify from 'voucherify';
381
+ let defaultClient = Voucherify.ApiClient.instance;
382
+ // Configure API key authorization: X-App-Id
383
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
384
+ X-App-Id.apiKey = 'YOUR API KEY';
385
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
386
+ //X-App-Id.apiKeyPrefix = 'Token';
387
+ // Configure API key authorization: X-App-Token
388
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
389
+ X-App-Token.apiKey = 'YOUR API KEY';
390
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
391
+ //X-App-Token.apiKeyPrefix = 'Token';
392
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
393
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
394
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
395
+
396
+ let apiInstance = new Voucherify.LoyaltiesApi();
397
+ let campaignId = "campaignId_example"; // String | Unique loyalty campaign ID or name.
398
+ let loyaltiesTiersCreateInBulkRequestBodyItem = [new Voucherify.LoyaltiesTiersCreateInBulkRequestBodyItem()]; // [LoyaltiesTiersCreateInBulkRequestBodyItem] | Provide tier definitions you want to add to existing loyalty campaign.
399
+ apiInstance.createInBulkLoyaltyTiers(campaignId, loyaltiesTiersCreateInBulkRequestBodyItem, (error, data, response) => {
400
+ if (error) {
401
+ console.error(error);
402
+ } else {
403
+ console.log('API called successfully. Returned data: ' + data);
404
+ }
405
+ });
406
+ ```
407
+
408
+ ### Parameters
409
+
410
+
411
+ Name | Type | Description | Notes
412
+ ------------- | ------------- | ------------- | -------------
413
+ **campaignId** | **String**| Unique loyalty campaign ID or name. |
414
+ **loyaltiesTiersCreateInBulkRequestBodyItem** | [**[LoyaltiesTiersCreateInBulkRequestBodyItem]**](LoyaltiesTiersCreateInBulkRequestBodyItem.md)| Provide tier definitions you want to add to existing loyalty campaign. |
415
+
416
+ ### Return type
417
+
418
+ [**[LoyaltyTier]**](LoyaltyTier.md)
419
+
420
+ ### Authorization
421
+
422
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
423
+
424
+ ### HTTP request headers
425
+
426
+ - **Content-Type**: application/json
427
+ - **Accept**: application/json
428
+
429
+
430
+ ## createLoyaltyProgram
431
+
432
+ > LoyaltiesCreateCampaignResponseBody createLoyaltyProgram(loyaltiesCreateCampaignRequestBody)
433
+
434
+ Create Loyalty Campaign
435
+
436
+ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description.
437
+
438
+ ### Example
439
+
440
+ ```javascript
441
+ import Voucherify from 'voucherify';
442
+ let defaultClient = Voucherify.ApiClient.instance;
443
+ // Configure API key authorization: X-App-Id
444
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
445
+ X-App-Id.apiKey = 'YOUR API KEY';
446
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
447
+ //X-App-Id.apiKeyPrefix = 'Token';
448
+ // Configure API key authorization: X-App-Token
449
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
450
+ X-App-Token.apiKey = 'YOUR API KEY';
451
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
452
+ //X-App-Token.apiKeyPrefix = 'Token';
453
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
454
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
455
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
456
+
457
+ let apiInstance = new Voucherify.LoyaltiesApi();
458
+ let loyaltiesCreateCampaignRequestBody = {"name":"Loyalty Program 4","description":"This is a campaign description.","auto_join":true,"join_once":true,"use_voucher_metadata_schema":true,"start_date":"2016-10-26T00:00:00Z","expiration_date":"2024-10-26T00:00:00Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"activity_duration_after_publishing":"P24D","category_id":"cat_0b6152ce12414820dc","vouchers_count":2,"voucher":{"type":"LOYALTY_CARD","loyalty_card":{"points":0,"expiration_rules":{"period_type":"MONTH","period_value":3,"rounding_type":"END_OF_QUARTER"}},"redemption":{"quantity":2},"code_config":{"pattern":"L-CARD-#######"}},"metadata":{"test":true},"type":"STATIC","loyalty_tiers_expiration":{"qualification_type":"BALANCE","start_date":{"type":"IMMEDIATE"},"expiration_date":{"type":"CUSTOM","extend":"P3M","rounding":{"type":"MONTH","strategy":"END"}}}}; // LoyaltiesCreateCampaignRequestBody | Specify the loyalty campaign details.
459
+ apiInstance.createLoyaltyProgram(loyaltiesCreateCampaignRequestBody, (error, data, response) => {
460
+ if (error) {
461
+ console.error(error);
462
+ } else {
463
+ console.log('API called successfully. Returned data: ' + data);
464
+ }
465
+ });
466
+ ```
467
+
468
+ ### Parameters
469
+
470
+
471
+ Name | Type | Description | Notes
472
+ ------------- | ------------- | ------------- | -------------
473
+ **loyaltiesCreateCampaignRequestBody** | [**LoyaltiesCreateCampaignRequestBody**](LoyaltiesCreateCampaignRequestBody.md)| Specify the loyalty campaign details. |
474
+
475
+ ### Return type
476
+
477
+ [**LoyaltiesCreateCampaignResponseBody**](LoyaltiesCreateCampaignResponseBody.md)
478
+
479
+ ### Authorization
480
+
481
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
482
+
483
+ ### HTTP request headers
484
+
485
+ - **Content-Type**: application/json
486
+ - **Accept**: application/json
487
+
488
+
489
+ ## createPointsExpirationExport
490
+
491
+ > LoyaltiesPointsExpirationExportCreateResponseBody createPointsExpirationExport(campaignId, loyaltiesPointsExpirationExportCreateRequestBody)
492
+
493
+ Export Loyalty Campaign Point Expiration
494
+
495
+ Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
496
+
497
+ ### Example
498
+
499
+ ```javascript
500
+ import Voucherify from 'voucherify';
501
+ let defaultClient = Voucherify.ApiClient.instance;
502
+ // Configure API key authorization: X-App-Id
503
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
504
+ X-App-Id.apiKey = 'YOUR API KEY';
505
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
506
+ //X-App-Id.apiKeyPrefix = 'Token';
507
+ // Configure API key authorization: X-App-Token
508
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
509
+ X-App-Token.apiKey = 'YOUR API KEY';
510
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
511
+ //X-App-Token.apiKeyPrefix = 'Token';
512
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
513
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
514
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
515
+
516
+ let apiInstance = new Voucherify.LoyaltiesApi();
517
+ let campaignId = "campaignId_example"; // String | Unique campaign ID or name.
518
+ let loyaltiesPointsExpirationExportCreateRequestBody = {"parameters":{"fields":["id","campaign_id","voucher_id","status","expires_at","points"],"order":"-expires_at","filters":{"junction":"and","voucher_id":{"conditions":{"$in":["v_0aMj6Mdp0i3zuXrd9NnBKboc7746mlgF","v_YLn0WVWXSXbUfDvxgrgUbtfJ3SQIY655"]}}}}}; // LoyaltiesPointsExpirationExportCreateRequestBody | Specify the data filters, types of data to return and order in which the results should be returned.
519
+ apiInstance.createPointsExpirationExport(campaignId, loyaltiesPointsExpirationExportCreateRequestBody, (error, data, response) => {
520
+ if (error) {
521
+ console.error(error);
522
+ } else {
523
+ console.log('API called successfully. Returned data: ' + data);
524
+ }
525
+ });
526
+ ```
527
+
528
+ ### Parameters
529
+
530
+
531
+ Name | Type | Description | Notes
532
+ ------------- | ------------- | ------------- | -------------
533
+ **campaignId** | **String**| Unique campaign ID or name. |
534
+ **loyaltiesPointsExpirationExportCreateRequestBody** | [**LoyaltiesPointsExpirationExportCreateRequestBody**](LoyaltiesPointsExpirationExportCreateRequestBody.md)| Specify the data filters, types of data to return and order in which the results should be returned. |
535
+
536
+ ### Return type
537
+
538
+ [**LoyaltiesPointsExpirationExportCreateResponseBody**](LoyaltiesPointsExpirationExportCreateResponseBody.md)
539
+
540
+ ### Authorization
541
+
542
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
543
+
544
+ ### HTTP request headers
545
+
546
+ - **Content-Type**: application/json
547
+ - **Accept**: application/json
548
+
549
+
550
+ ## createRewardAssignment1
551
+
552
+ > LoyaltiesRewardsCreateAssignmentResponseBody createRewardAssignment1(campaignId, loyaltiesRewardsCreateAssignmentItemRequestBody)
553
+
554
+ Create Loyalty Campaign Reward Assignment
555
+
556
+ Add rewards to a loyalty campaign.
557
+
558
+ ### Example
559
+
560
+ ```javascript
561
+ import Voucherify from 'voucherify';
562
+ let defaultClient = Voucherify.ApiClient.instance;
563
+ // Configure API key authorization: X-App-Id
564
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
565
+ X-App-Id.apiKey = 'YOUR API KEY';
566
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
567
+ //X-App-Id.apiKeyPrefix = 'Token';
568
+ // Configure API key authorization: X-App-Token
569
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
570
+ X-App-Token.apiKey = 'YOUR API KEY';
571
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
572
+ //X-App-Token.apiKeyPrefix = 'Token';
573
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
574
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
575
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
576
+
577
+ let apiInstance = new Voucherify.LoyaltiesApi();
578
+ let campaignId = "campaignId_example"; // String | Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
579
+ let loyaltiesRewardsCreateAssignmentItemRequestBody = [{"reward":"rew_wg2pvCr5LDhCq4uVQZ9LhuZm","parameters":{"loyalty":{"points":2}}},{"reward":"rew_z35ffKoH0tCcck8EL56p6SIs","parameters":{"loyalty":{"points":2}}}]; // [LoyaltiesRewardsCreateAssignmentItemRequestBody] | Define the cost of the rewards in loyalty points.
580
+ apiInstance.createRewardAssignment1(campaignId, loyaltiesRewardsCreateAssignmentItemRequestBody, (error, data, response) => {
581
+ if (error) {
582
+ console.error(error);
583
+ } else {
584
+ console.log('API called successfully. Returned data: ' + data);
585
+ }
586
+ });
587
+ ```
588
+
589
+ ### Parameters
590
+
591
+
592
+ Name | Type | Description | Notes
593
+ ------------- | ------------- | ------------- | -------------
594
+ **campaignId** | **String**| Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
595
+ **loyaltiesRewardsCreateAssignmentItemRequestBody** | [**[LoyaltiesRewardsCreateAssignmentItemRequestBody]**](LoyaltiesRewardsCreateAssignmentItemRequestBody.md)| Define the cost of the rewards in loyalty points. |
596
+
597
+ ### Return type
598
+
599
+ [**LoyaltiesRewardsCreateAssignmentResponseBody**](LoyaltiesRewardsCreateAssignmentResponseBody.md)
600
+
601
+ ### Authorization
602
+
603
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
604
+
605
+ ### HTTP request headers
606
+
607
+ - **Content-Type**: application/json
608
+ - **Accept**: application/json
609
+
610
+
611
+ ## deleteEarningRule
612
+
613
+ > deleteEarningRule(campaignId, earningRuleId)
614
+
615
+ Delete Earning Rule
616
+
617
+ This method deletes an earning rule for a specific loyalty campaign.
618
+
619
+ ### Example
620
+
621
+ ```javascript
622
+ import Voucherify from 'voucherify';
623
+ let defaultClient = Voucherify.ApiClient.instance;
624
+ // Configure API key authorization: X-App-Id
625
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
626
+ X-App-Id.apiKey = 'YOUR API KEY';
627
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
628
+ //X-App-Id.apiKeyPrefix = 'Token';
629
+ // Configure API key authorization: X-App-Token
630
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
631
+ X-App-Token.apiKey = 'YOUR API KEY';
632
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
633
+ //X-App-Token.apiKeyPrefix = 'Token';
634
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
635
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
636
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
637
+
638
+ let apiInstance = new Voucherify.LoyaltiesApi();
639
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
640
+ let earningRuleId = "earningRuleId_example"; // String | A unique earning rule ID.
641
+ apiInstance.deleteEarningRule(campaignId, earningRuleId, (error, data, response) => {
642
+ if (error) {
643
+ console.error(error);
644
+ } else {
645
+ console.log('API called successfully.');
646
+ }
647
+ });
648
+ ```
649
+
650
+ ### Parameters
651
+
652
+
653
+ Name | Type | Description | Notes
654
+ ------------- | ------------- | ------------- | -------------
655
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
656
+ **earningRuleId** | **String**| A unique earning rule ID. |
657
+
658
+ ### Return type
659
+
660
+ null (empty response body)
661
+
662
+ ### Authorization
663
+
664
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
665
+
666
+ ### HTTP request headers
667
+
668
+ - **Content-Type**: Not defined
669
+ - **Accept**: Not defined
670
+
671
+
672
+ ## deleteLoyaltyProgram
673
+
674
+ > LoyaltiesDeleteResponseBody deleteLoyaltyProgram(campaignId, opts)
675
+
676
+ Delete Loyalty Campaign
677
+
678
+ Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to [the bin](/api-reference/bin/list-bin-entries).
679
+
680
+ ### Example
681
+
682
+ ```javascript
683
+ import Voucherify from 'voucherify';
684
+ let defaultClient = Voucherify.ApiClient.instance;
685
+ // Configure API key authorization: X-App-Id
686
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
687
+ X-App-Id.apiKey = 'YOUR API KEY';
688
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
689
+ //X-App-Id.apiKeyPrefix = 'Token';
690
+ // Configure API key authorization: X-App-Token
691
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
692
+ X-App-Token.apiKey = 'YOUR API KEY';
693
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
694
+ //X-App-Token.apiKeyPrefix = 'Token';
695
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
696
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
697
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
698
+
699
+ let apiInstance = new Voucherify.LoyaltiesApi();
700
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
701
+ let opts = {
702
+ 'force': true // Boolean | If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name.
703
+ };
704
+ apiInstance.deleteLoyaltyProgram(campaignId, opts, (error, data, response) => {
705
+ if (error) {
706
+ console.error(error);
707
+ } else {
708
+ console.log('API called successfully. Returned data: ' + data);
709
+ }
710
+ });
711
+ ```
712
+
713
+ ### Parameters
714
+
715
+
716
+ Name | Type | Description | Notes
717
+ ------------- | ------------- | ------------- | -------------
718
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
719
+ **force** | **Boolean**| If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name. | [optional]
720
+
721
+ ### Return type
722
+
723
+ [**LoyaltiesDeleteResponseBody**](LoyaltiesDeleteResponseBody.md)
724
+
725
+ ### Authorization
726
+
727
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
728
+
729
+ ### HTTP request headers
730
+
731
+ - **Content-Type**: Not defined
732
+ - **Accept**: application/json
733
+
734
+
735
+ ## deleteRewardAssignment1
736
+
737
+ > deleteRewardAssignment1(campaignId, assignmentId)
738
+
739
+ Delete Campaign Reward Assignment
740
+
741
+ This method deletes a reward assignment for a particular loyalty campaign.
742
+
743
+ ### Example
744
+
745
+ ```javascript
746
+ import Voucherify from 'voucherify';
747
+ let defaultClient = Voucherify.ApiClient.instance;
748
+ // Configure API key authorization: X-App-Id
749
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
750
+ X-App-Id.apiKey = 'YOUR API KEY';
751
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
752
+ //X-App-Id.apiKeyPrefix = 'Token';
753
+ // Configure API key authorization: X-App-Token
754
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
755
+ X-App-Token.apiKey = 'YOUR API KEY';
756
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
757
+ //X-App-Token.apiKeyPrefix = 'Token';
758
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
759
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
760
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
761
+
762
+ let apiInstance = new Voucherify.LoyaltiesApi();
763
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
764
+ let assignmentId = "assignmentId_example"; // String | A unique reward assignment ID.
765
+ apiInstance.deleteRewardAssignment1(campaignId, assignmentId, (error, data, response) => {
766
+ if (error) {
767
+ console.error(error);
768
+ } else {
769
+ console.log('API called successfully.');
770
+ }
771
+ });
772
+ ```
773
+
774
+ ### Parameters
775
+
776
+
777
+ Name | Type | Description | Notes
778
+ ------------- | ------------- | ------------- | -------------
779
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
780
+ **assignmentId** | **String**| A unique reward assignment ID. |
781
+
782
+ ### Return type
783
+
784
+ null (empty response body)
785
+
786
+ ### Authorization
787
+
788
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
789
+
790
+ ### HTTP request headers
791
+
792
+ - **Content-Type**: Not defined
793
+ - **Accept**: Not defined
794
+
795
+
796
+ ## disableEarningRule
797
+
798
+ > LoyaltiesEarningRulesDisableResponseBody disableEarningRule(campaignId, earningRuleId)
799
+
800
+ Disable Earning Rule
801
+
802
+ Disable an earning rule.
803
+
804
+ ### Example
805
+
806
+ ```javascript
807
+ import Voucherify from 'voucherify';
808
+ let defaultClient = Voucherify.ApiClient.instance;
809
+ // Configure API key authorization: X-App-Id
810
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
811
+ X-App-Id.apiKey = 'YOUR API KEY';
812
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
813
+ //X-App-Id.apiKeyPrefix = 'Token';
814
+ // Configure API key authorization: X-App-Token
815
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
816
+ X-App-Token.apiKey = 'YOUR API KEY';
817
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
818
+ //X-App-Token.apiKeyPrefix = 'Token';
819
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
820
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
821
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
822
+
823
+ let apiInstance = new Voucherify.LoyaltiesApi();
824
+ let campaignId = "campaignId_example"; // String | Unique campaign ID or name.
825
+ let earningRuleId = "earningRuleId_example"; // String | Unique identifier of an earning rule, assigned by Voucherify.
826
+ apiInstance.disableEarningRule(campaignId, earningRuleId, (error, data, response) => {
827
+ if (error) {
828
+ console.error(error);
829
+ } else {
830
+ console.log('API called successfully. Returned data: ' + data);
831
+ }
832
+ });
833
+ ```
834
+
835
+ ### Parameters
836
+
837
+
838
+ Name | Type | Description | Notes
839
+ ------------- | ------------- | ------------- | -------------
840
+ **campaignId** | **String**| Unique campaign ID or name. |
841
+ **earningRuleId** | **String**| Unique identifier of an earning rule, assigned by Voucherify. |
842
+
843
+ ### Return type
844
+
845
+ [**LoyaltiesEarningRulesDisableResponseBody**](LoyaltiesEarningRulesDisableResponseBody.md)
846
+
847
+ ### Authorization
848
+
849
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
850
+
851
+ ### HTTP request headers
852
+
853
+ - **Content-Type**: Not defined
854
+ - **Accept**: application/json
855
+
856
+
857
+ ## enableEarningRule
858
+
859
+ > LoyaltiesEarningRulesEnableResponseBody enableEarningRule(campaignId, earningRuleId)
860
+
861
+ Enable Earning Rule
862
+
863
+ Enable an earning rule.
864
+
865
+ ### Example
866
+
867
+ ```javascript
868
+ import Voucherify from 'voucherify';
869
+ let defaultClient = Voucherify.ApiClient.instance;
870
+ // Configure API key authorization: X-App-Id
871
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
872
+ X-App-Id.apiKey = 'YOUR API KEY';
873
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
874
+ //X-App-Id.apiKeyPrefix = 'Token';
875
+ // Configure API key authorization: X-App-Token
876
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
877
+ X-App-Token.apiKey = 'YOUR API KEY';
878
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
879
+ //X-App-Token.apiKeyPrefix = 'Token';
880
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
881
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
882
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
883
+
884
+ let apiInstance = new Voucherify.LoyaltiesApi();
885
+ let campaignId = "campaignId_example"; // String | Unique campaign ID or name.
886
+ let earningRuleId = "earningRuleId_example"; // String | Unique identifier of an earning rule, assigned by Voucherify.
887
+ apiInstance.enableEarningRule(campaignId, earningRuleId, (error, data, response) => {
888
+ if (error) {
889
+ console.error(error);
890
+ } else {
891
+ console.log('API called successfully. Returned data: ' + data);
892
+ }
893
+ });
894
+ ```
895
+
896
+ ### Parameters
897
+
898
+
899
+ Name | Type | Description | Notes
900
+ ------------- | ------------- | ------------- | -------------
901
+ **campaignId** | **String**| Unique campaign ID or name. |
902
+ **earningRuleId** | **String**| Unique identifier of an earning rule, assigned by Voucherify. |
903
+
904
+ ### Return type
905
+
906
+ [**LoyaltiesEarningRulesEnableResponseBody**](LoyaltiesEarningRulesEnableResponseBody.md)
907
+
908
+ ### Authorization
909
+
910
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
911
+
912
+ ### HTTP request headers
913
+
914
+ - **Content-Type**: Not defined
915
+ - **Accept**: application/json
916
+
917
+
918
+ ## exportLoyaltyCampaignTransactions
919
+
920
+ > CampaignsTransactionsExportCreateResponseBody exportLoyaltyCampaignTransactions(campaignId, loyaltiesTransactionsExportCreateRequestBody)
921
+
922
+ Export Loyalty Campaign Transactions
923
+
924
+ Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: 👍 Export Campaign Transactions This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions.
925
+
926
+ ### Example
927
+
928
+ ```javascript
929
+ import Voucherify from 'voucherify';
930
+ let defaultClient = Voucherify.ApiClient.instance;
931
+ // Configure API key authorization: X-App-Id
932
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
933
+ X-App-Id.apiKey = 'YOUR API KEY';
934
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
935
+ //X-App-Id.apiKeyPrefix = 'Token';
936
+ // Configure API key authorization: X-App-Token
937
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
938
+ X-App-Token.apiKey = 'YOUR API KEY';
939
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
940
+ //X-App-Token.apiKeyPrefix = 'Token';
941
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
942
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
943
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
944
+
945
+ let apiInstance = new Voucherify.LoyaltiesApi();
946
+ let campaignId = "campaignId_example"; // String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
947
+ let loyaltiesTransactionsExportCreateRequestBody = {"order":"-created_at","parameters":{"fields":["id","type","source_id","created_at"],"filters":{"created_at":{"conditions":{"$after":["2024-10-01T00:00:00.000Z"]}}}}}; // LoyaltiesTransactionsExportCreateRequestBody | Specify the parameters for the transaction export.
948
+ apiInstance.exportLoyaltyCampaignTransactions(campaignId, loyaltiesTransactionsExportCreateRequestBody, (error, data, response) => {
949
+ if (error) {
950
+ console.error(error);
951
+ } else {
952
+ console.log('API called successfully. Returned data: ' + data);
953
+ }
954
+ });
955
+ ```
956
+
957
+ ### Parameters
958
+
959
+
960
+ Name | Type | Description | Notes
961
+ ------------- | ------------- | ------------- | -------------
962
+ **campaignId** | **String**| You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. |
963
+ **loyaltiesTransactionsExportCreateRequestBody** | [**LoyaltiesTransactionsExportCreateRequestBody**](LoyaltiesTransactionsExportCreateRequestBody.md)| Specify the parameters for the transaction export. |
964
+
965
+ ### Return type
966
+
967
+ [**CampaignsTransactionsExportCreateResponseBody**](CampaignsTransactionsExportCreateResponseBody.md)
968
+
969
+ ### Authorization
970
+
971
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
972
+
973
+ ### HTTP request headers
974
+
975
+ - **Content-Type**: application/json
976
+ - **Accept**: application/json
977
+
978
+
979
+ ## exportLoyaltyCardTransactions
980
+
981
+ > LoyaltiesMembersTransactionsExportCreateResponseBody exportLoyaltyCardTransactions(memberId, loyaltiesMembersTransactionsExportCreateRequestBody)
982
+
983
+ Export Loyalty Card Transactions
984
+
985
+ Export transactions that are associated with point movements on a loyalty card.
986
+
987
+ ### Example
988
+
989
+ ```javascript
990
+ import Voucherify from 'voucherify';
991
+ let defaultClient = Voucherify.ApiClient.instance;
992
+ // Configure API key authorization: X-App-Id
993
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
994
+ X-App-Id.apiKey = 'YOUR API KEY';
995
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
996
+ //X-App-Id.apiKeyPrefix = 'Token';
997
+ // Configure API key authorization: X-App-Token
998
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
999
+ X-App-Token.apiKey = 'YOUR API KEY';
1000
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1001
+ //X-App-Token.apiKeyPrefix = 'Token';
1002
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1003
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1004
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1005
+
1006
+ let apiInstance = new Voucherify.LoyaltiesApi();
1007
+ let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to export transaction data for.
1008
+ let loyaltiesMembersTransactionsExportCreateRequestBody = {"parameters":{"order":"-created_at","fields":["id","type","source_id","reason","balance","amount","created_at","voucher_id","campaign_id","details","related_transaction_id"]}}; // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export.
1009
+ apiInstance.exportLoyaltyCardTransactions(memberId, loyaltiesMembersTransactionsExportCreateRequestBody, (error, data, response) => {
1010
+ if (error) {
1011
+ console.error(error);
1012
+ } else {
1013
+ console.log('API called successfully. Returned data: ' + data);
1014
+ }
1015
+ });
1016
+ ```
1017
+
1018
+ ### Parameters
1019
+
1020
+
1021
+ Name | Type | Description | Notes
1022
+ ------------- | ------------- | ------------- | -------------
1023
+ **memberId** | **String**| A unique code identifying the loyalty card that you are looking to export transaction data for. |
1024
+ **loyaltiesMembersTransactionsExportCreateRequestBody** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md)| Specify the parameters and filters for the transaction export. |
1025
+
1026
+ ### Return type
1027
+
1028
+ [**LoyaltiesMembersTransactionsExportCreateResponseBody**](LoyaltiesMembersTransactionsExportCreateResponseBody.md)
1029
+
1030
+ ### Authorization
1031
+
1032
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1033
+
1034
+ ### HTTP request headers
1035
+
1036
+ - **Content-Type**: application/json
1037
+ - **Accept**: application/json
1038
+
1039
+
1040
+ ## exportLoyaltyCardTransactions1
1041
+
1042
+ > LoyaltiesMembersTransactionsExportCreateResponseBody exportLoyaltyCardTransactions1(campaignId, memberId, loyaltiesMembersTransactionsExportCreateRequestBody)
1043
+
1044
+ Export Loyalty Card Transactions with campaign ID
1045
+
1046
+ Export transactions that are associated with point movements on a loyalty card.
1047
+
1048
+ ### Example
1049
+
1050
+ ```javascript
1051
+ import Voucherify from 'voucherify';
1052
+ let defaultClient = Voucherify.ApiClient.instance;
1053
+ // Configure API key authorization: X-App-Id
1054
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1055
+ X-App-Id.apiKey = 'YOUR API KEY';
1056
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1057
+ //X-App-Id.apiKeyPrefix = 'Token';
1058
+ // Configure API key authorization: X-App-Token
1059
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1060
+ X-App-Token.apiKey = 'YOUR API KEY';
1061
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1062
+ //X-App-Token.apiKeyPrefix = 'Token';
1063
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1064
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1065
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1066
+
1067
+ let apiInstance = new Voucherify.LoyaltiesApi();
1068
+ let campaignId = "campaignId_example"; // String | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
1069
+ let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to export transaction data for.
1070
+ let loyaltiesMembersTransactionsExportCreateRequestBody = {"parameters":{"order":"-created_at","fields":["id","type","source_id","reason","balance","amount","created_at","voucher_id","campaign_id","details","related_transaction_id"]}}; // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export.
1071
+ apiInstance.exportLoyaltyCardTransactions1(campaignId, memberId, loyaltiesMembersTransactionsExportCreateRequestBody, (error, data, response) => {
1072
+ if (error) {
1073
+ console.error(error);
1074
+ } else {
1075
+ console.log('API called successfully. Returned data: ' + data);
1076
+ }
1077
+ });
1078
+ ```
1079
+
1080
+ ### Parameters
1081
+
1082
+
1083
+ Name | Type | Description | Notes
1084
+ ------------- | ------------- | ------------- | -------------
1085
+ **campaignId** | **String**| A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. |
1086
+ **memberId** | **String**| A unique code identifying the loyalty card that you are looking to export transaction data for. |
1087
+ **loyaltiesMembersTransactionsExportCreateRequestBody** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md)| Specify the parameters and filters for the transaction export. |
1088
+
1089
+ ### Return type
1090
+
1091
+ [**LoyaltiesMembersTransactionsExportCreateResponseBody**](LoyaltiesMembersTransactionsExportCreateResponseBody.md)
1092
+
1093
+ ### Authorization
1094
+
1095
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1096
+
1097
+ ### HTTP request headers
1098
+
1099
+ - **Content-Type**: application/json
1100
+ - **Accept**: application/json
1101
+
1102
+
1103
+ ## getEarningRule
1104
+
1105
+ > LoyaltiesEarningRulesGetResponseBody getEarningRule(campaignId, earningRuleId)
1106
+
1107
+ Get Earning Rule
1108
+
1109
+ Retrieves an earning rule assigned to a campaign.
1110
+
1111
+ ### Example
1112
+
1113
+ ```javascript
1114
+ import Voucherify from 'voucherify';
1115
+ let defaultClient = Voucherify.ApiClient.instance;
1116
+ // Configure API key authorization: X-App-Id
1117
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1118
+ X-App-Id.apiKey = 'YOUR API KEY';
1119
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1120
+ //X-App-Id.apiKeyPrefix = 'Token';
1121
+ // Configure API key authorization: X-App-Token
1122
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1123
+ X-App-Token.apiKey = 'YOUR API KEY';
1124
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1125
+ //X-App-Token.apiKeyPrefix = 'Token';
1126
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1127
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1128
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1129
+
1130
+ let apiInstance = new Voucherify.LoyaltiesApi();
1131
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
1132
+ let earningRuleId = "earningRuleId_example"; // String | A unique earning rule ID.
1133
+ apiInstance.getEarningRule(campaignId, earningRuleId, (error, data, response) => {
1134
+ if (error) {
1135
+ console.error(error);
1136
+ } else {
1137
+ console.log('API called successfully. Returned data: ' + data);
1138
+ }
1139
+ });
1140
+ ```
1141
+
1142
+ ### Parameters
1143
+
1144
+
1145
+ Name | Type | Description | Notes
1146
+ ------------- | ------------- | ------------- | -------------
1147
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
1148
+ **earningRuleId** | **String**| A unique earning rule ID. |
1149
+
1150
+ ### Return type
1151
+
1152
+ [**LoyaltiesEarningRulesGetResponseBody**](LoyaltiesEarningRulesGetResponseBody.md)
1153
+
1154
+ ### Authorization
1155
+
1156
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1157
+
1158
+ ### HTTP request headers
1159
+
1160
+ - **Content-Type**: Not defined
1161
+ - **Accept**: application/json
1162
+
1163
+
1164
+ ## getLoyaltyProgram
1165
+
1166
+ > LoyaltiesGetCampaignResponseBody getLoyaltyProgram(campaignId)
1167
+
1168
+ Get Loyalty Campaign
1169
+
1170
+ Retrieve a specific loyalty campaign.
1171
+
1172
+ ### Example
1173
+
1174
+ ```javascript
1175
+ import Voucherify from 'voucherify';
1176
+ let defaultClient = Voucherify.ApiClient.instance;
1177
+ // Configure API key authorization: X-App-Id
1178
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1179
+ X-App-Id.apiKey = 'YOUR API KEY';
1180
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1181
+ //X-App-Id.apiKeyPrefix = 'Token';
1182
+ // Configure API key authorization: X-App-Token
1183
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1184
+ X-App-Token.apiKey = 'YOUR API KEY';
1185
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1186
+ //X-App-Token.apiKeyPrefix = 'Token';
1187
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1188
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1189
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1190
+
1191
+ let apiInstance = new Voucherify.LoyaltiesApi();
1192
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
1193
+ apiInstance.getLoyaltyProgram(campaignId, (error, data, response) => {
1194
+ if (error) {
1195
+ console.error(error);
1196
+ } else {
1197
+ console.log('API called successfully. Returned data: ' + data);
1198
+ }
1199
+ });
1200
+ ```
1201
+
1202
+ ### Parameters
1203
+
1204
+
1205
+ Name | Type | Description | Notes
1206
+ ------------- | ------------- | ------------- | -------------
1207
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
1208
+
1209
+ ### Return type
1210
+
1211
+ [**LoyaltiesGetCampaignResponseBody**](LoyaltiesGetCampaignResponseBody.md)
1212
+
1213
+ ### Authorization
1214
+
1215
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1216
+
1217
+ ### HTTP request headers
1218
+
1219
+ - **Content-Type**: Not defined
1220
+ - **Accept**: application/json
1221
+
1222
+
1223
+ ## getLoyaltyTier
1224
+
1225
+ > LoyaltiesTiersGetResponseBody getLoyaltyTier(campaignId, loyaltyTierId)
1226
+
1227
+ Get Loyalty Tier
1228
+
1229
+ Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
1230
+
1231
+ ### Example
1232
+
1233
+ ```javascript
1234
+ import Voucherify from 'voucherify';
1235
+ let defaultClient = Voucherify.ApiClient.instance;
1236
+ // Configure API key authorization: X-App-Id
1237
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1238
+ X-App-Id.apiKey = 'YOUR API KEY';
1239
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1240
+ //X-App-Id.apiKeyPrefix = 'Token';
1241
+ // Configure API key authorization: X-App-Token
1242
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1243
+ X-App-Token.apiKey = 'YOUR API KEY';
1244
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1245
+ //X-App-Token.apiKeyPrefix = 'Token';
1246
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1247
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1248
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1249
+
1250
+ let apiInstance = new Voucherify.LoyaltiesApi();
1251
+ let campaignId = "campaignId_example"; // String | Unique loyalty campaign ID or name.
1252
+ let loyaltyTierId = "loyaltyTierId_example"; // String | Unique loyalty tier ID.
1253
+ apiInstance.getLoyaltyTier(campaignId, loyaltyTierId, (error, data, response) => {
1254
+ if (error) {
1255
+ console.error(error);
1256
+ } else {
1257
+ console.log('API called successfully. Returned data: ' + data);
1258
+ }
1259
+ });
1260
+ ```
1261
+
1262
+ ### Parameters
1263
+
1264
+
1265
+ Name | Type | Description | Notes
1266
+ ------------- | ------------- | ------------- | -------------
1267
+ **campaignId** | **String**| Unique loyalty campaign ID or name. |
1268
+ **loyaltyTierId** | **String**| Unique loyalty tier ID. |
1269
+
1270
+ ### Return type
1271
+
1272
+ [**LoyaltiesTiersGetResponseBody**](LoyaltiesTiersGetResponseBody.md)
1273
+
1274
+ ### Authorization
1275
+
1276
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1277
+
1278
+ ### HTTP request headers
1279
+
1280
+ - **Content-Type**: Not defined
1281
+ - **Accept**: application/json
1282
+
1283
+
1284
+ ## getMember
1285
+
1286
+ > LoyaltiesMembersGetResponseBody getMember(memberId)
1287
+
1288
+ Get Member
1289
+
1290
+ Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
1291
+
1292
+ ### Example
1293
+
1294
+ ```javascript
1295
+ import Voucherify from 'voucherify';
1296
+ let defaultClient = Voucherify.ApiClient.instance;
1297
+ // Configure API key authorization: X-App-Id
1298
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1299
+ X-App-Id.apiKey = 'YOUR API KEY';
1300
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1301
+ //X-App-Id.apiKeyPrefix = 'Token';
1302
+ // Configure API key authorization: X-App-Token
1303
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1304
+ X-App-Token.apiKey = 'YOUR API KEY';
1305
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1306
+ //X-App-Token.apiKeyPrefix = 'Token';
1307
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1308
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1309
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1310
+
1311
+ let apiInstance = new Voucherify.LoyaltiesApi();
1312
+ let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer.
1313
+ apiInstance.getMember(memberId, (error, data, response) => {
1314
+ if (error) {
1315
+ console.error(error);
1316
+ } else {
1317
+ console.log('API called successfully. Returned data: ' + data);
1318
+ }
1319
+ });
1320
+ ```
1321
+
1322
+ ### Parameters
1323
+
1324
+
1325
+ Name | Type | Description | Notes
1326
+ ------------- | ------------- | ------------- | -------------
1327
+ **memberId** | **String**| Unique loyalty card code assigned to a particular customer. |
1328
+
1329
+ ### Return type
1330
+
1331
+ [**LoyaltiesMembersGetResponseBody**](LoyaltiesMembersGetResponseBody.md)
1332
+
1333
+ ### Authorization
1334
+
1335
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1336
+
1337
+ ### HTTP request headers
1338
+
1339
+ - **Content-Type**: Not defined
1340
+ - **Accept**: application/json
1341
+
1342
+
1343
+ ## getMember1
1344
+
1345
+ > LoyaltiesMembersGetResponseBody getMember1(campaignId, memberId)
1346
+
1347
+ Get Member with campaign ID
1348
+
1349
+ Retrieves the loyalty card with the given member ID (i.e. voucher code).
1350
+
1351
+ ### Example
1352
+
1353
+ ```javascript
1354
+ import Voucherify from 'voucherify';
1355
+ let defaultClient = Voucherify.ApiClient.instance;
1356
+ // Configure API key authorization: X-App-Id
1357
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1358
+ X-App-Id.apiKey = 'YOUR API KEY';
1359
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1360
+ //X-App-Id.apiKeyPrefix = 'Token';
1361
+ // Configure API key authorization: X-App-Token
1362
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1363
+ X-App-Token.apiKey = 'YOUR API KEY';
1364
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1365
+ //X-App-Token.apiKeyPrefix = 'Token';
1366
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1367
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1368
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1369
+
1370
+ let apiInstance = new Voucherify.LoyaltiesApi();
1371
+ let campaignId = "campaignId_example"; // String | Unique campaign ID.
1372
+ let memberId = "memberId_example"; // String | Unique code that identifies the loyalty card.
1373
+ apiInstance.getMember1(campaignId, memberId, (error, data, response) => {
1374
+ if (error) {
1375
+ console.error(error);
1376
+ } else {
1377
+ console.log('API called successfully. Returned data: ' + data);
1378
+ }
1379
+ });
1380
+ ```
1381
+
1382
+ ### Parameters
1383
+
1384
+
1385
+ Name | Type | Description | Notes
1386
+ ------------- | ------------- | ------------- | -------------
1387
+ **campaignId** | **String**| Unique campaign ID. |
1388
+ **memberId** | **String**| Unique code that identifies the loyalty card. |
1389
+
1390
+ ### Return type
1391
+
1392
+ [**LoyaltiesMembersGetResponseBody**](LoyaltiesMembersGetResponseBody.md)
1393
+
1394
+ ### Authorization
1395
+
1396
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1397
+
1398
+ ### HTTP request headers
1399
+
1400
+ - **Content-Type**: Not defined
1401
+ - **Accept**: application/json
1402
+
1403
+
1404
+ ## getRewardAssignment1
1405
+
1406
+ > LoyaltiesRewardAssignmentsGetResponseBody getRewardAssignment1(campaignId, assignmentId)
1407
+
1408
+ Get Campaign Reward Assignments
1409
+
1410
+ Retrieve specific reward assignment.
1411
+
1412
+ ### Example
1413
+
1414
+ ```javascript
1415
+ import Voucherify from 'voucherify';
1416
+ let defaultClient = Voucherify.ApiClient.instance;
1417
+ // Configure API key authorization: X-App-Id
1418
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1419
+ X-App-Id.apiKey = 'YOUR API KEY';
1420
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1421
+ //X-App-Id.apiKeyPrefix = 'Token';
1422
+ // Configure API key authorization: X-App-Token
1423
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1424
+ X-App-Token.apiKey = 'YOUR API KEY';
1425
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1426
+ //X-App-Token.apiKeyPrefix = 'Token';
1427
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1428
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1429
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1430
+
1431
+ let apiInstance = new Voucherify.LoyaltiesApi();
1432
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
1433
+ let assignmentId = "assignmentId_example"; // String | Unique reward assignment ID.
1434
+ apiInstance.getRewardAssignment1(campaignId, assignmentId, (error, data, response) => {
1435
+ if (error) {
1436
+ console.error(error);
1437
+ } else {
1438
+ console.log('API called successfully. Returned data: ' + data);
1439
+ }
1440
+ });
1441
+ ```
1442
+
1443
+ ### Parameters
1444
+
1445
+
1446
+ Name | Type | Description | Notes
1447
+ ------------- | ------------- | ------------- | -------------
1448
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
1449
+ **assignmentId** | **String**| Unique reward assignment ID. |
1450
+
1451
+ ### Return type
1452
+
1453
+ [**LoyaltiesRewardAssignmentsGetResponseBody**](LoyaltiesRewardAssignmentsGetResponseBody.md)
1454
+
1455
+ ### Authorization
1456
+
1457
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1458
+
1459
+ ### HTTP request headers
1460
+
1461
+ - **Content-Type**: Not defined
1462
+ - **Accept**: application/json
1463
+
1464
+
1465
+ ## getRewardAssignment2
1466
+
1467
+ > LoyaltiesRewardsGetResponseBody getRewardAssignment2(campaignId, assignmentId)
1468
+
1469
+ Get Campaign Reward Assignment
1470
+
1471
+ Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments).
1472
+
1473
+ ### Example
1474
+
1475
+ ```javascript
1476
+ import Voucherify from 'voucherify';
1477
+ let defaultClient = Voucherify.ApiClient.instance;
1478
+ // Configure API key authorization: X-App-Id
1479
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1480
+ X-App-Id.apiKey = 'YOUR API KEY';
1481
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1482
+ //X-App-Id.apiKeyPrefix = 'Token';
1483
+ // Configure API key authorization: X-App-Token
1484
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1485
+ X-App-Token.apiKey = 'YOUR API KEY';
1486
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1487
+ //X-App-Token.apiKeyPrefix = 'Token';
1488
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1489
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1490
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1491
+
1492
+ let apiInstance = new Voucherify.LoyaltiesApi();
1493
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
1494
+ let assignmentId = "assignmentId_example"; // String | A unique reward assignment ID.
1495
+ apiInstance.getRewardAssignment2(campaignId, assignmentId, (error, data, response) => {
1496
+ if (error) {
1497
+ console.error(error);
1498
+ } else {
1499
+ console.log('API called successfully. Returned data: ' + data);
1500
+ }
1501
+ });
1502
+ ```
1503
+
1504
+ ### Parameters
1505
+
1506
+
1507
+ Name | Type | Description | Notes
1508
+ ------------- | ------------- | ------------- | -------------
1509
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
1510
+ **assignmentId** | **String**| A unique reward assignment ID. |
1511
+
1512
+ ### Return type
1513
+
1514
+ [**LoyaltiesRewardsGetResponseBody**](LoyaltiesRewardsGetResponseBody.md)
1515
+
1516
+ ### Authorization
1517
+
1518
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1519
+
1520
+ ### HTTP request headers
1521
+
1522
+ - **Content-Type**: Not defined
1523
+ - **Accept**: application/json
1524
+
1525
+
1526
+ ## getRewardDetails
1527
+
1528
+ > LoyaltiesRewardAssignmentsRewardGetResponseBody getRewardDetails(campaignId, assignmentId)
1529
+
1530
+ Get Reward Details
1531
+
1532
+ Get reward details in the context of a loyalty campaign and reward assignment ID.
1533
+
1534
+ ### Example
1535
+
1536
+ ```javascript
1537
+ import Voucherify from 'voucherify';
1538
+ let defaultClient = Voucherify.ApiClient.instance;
1539
+ // Configure API key authorization: X-App-Id
1540
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1541
+ X-App-Id.apiKey = 'YOUR API KEY';
1542
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1543
+ //X-App-Id.apiKeyPrefix = 'Token';
1544
+ // Configure API key authorization: X-App-Token
1545
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1546
+ X-App-Token.apiKey = 'YOUR API KEY';
1547
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1548
+ //X-App-Token.apiKeyPrefix = 'Token';
1549
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1550
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1551
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1552
+
1553
+ let apiInstance = new Voucherify.LoyaltiesApi();
1554
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
1555
+ let assignmentId = "assignmentId_example"; // String | Unique reward assignment ID.
1556
+ apiInstance.getRewardDetails(campaignId, assignmentId, (error, data, response) => {
1557
+ if (error) {
1558
+ console.error(error);
1559
+ } else {
1560
+ console.log('API called successfully. Returned data: ' + data);
1561
+ }
1562
+ });
1563
+ ```
1564
+
1565
+ ### Parameters
1566
+
1567
+
1568
+ Name | Type | Description | Notes
1569
+ ------------- | ------------- | ------------- | -------------
1570
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
1571
+ **assignmentId** | **String**| Unique reward assignment ID. |
1572
+
1573
+ ### Return type
1574
+
1575
+ [**LoyaltiesRewardAssignmentsRewardGetResponseBody**](LoyaltiesRewardAssignmentsRewardGetResponseBody.md)
1576
+
1577
+ ### Authorization
1578
+
1579
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1580
+
1581
+ ### HTTP request headers
1582
+
1583
+ - **Content-Type**: Not defined
1584
+ - **Accept**: application/json
1585
+
1586
+
1587
+ ## listCampaignPendingPoints
1588
+
1589
+ > LoyaltiesPendingPointsListResponseBody listCampaignPendingPoints(campaignId, opts)
1590
+
1591
+ List Campaign Pending Points
1592
+
1593
+ Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
1594
+
1595
+ ### Example
1596
+
1597
+ ```javascript
1598
+ import Voucherify from 'voucherify';
1599
+ let defaultClient = Voucherify.ApiClient.instance;
1600
+ // Configure API key authorization: X-App-Id
1601
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1602
+ X-App-Id.apiKey = 'YOUR API KEY';
1603
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1604
+ //X-App-Id.apiKeyPrefix = 'Token';
1605
+ // Configure API key authorization: X-App-Token
1606
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1607
+ X-App-Token.apiKey = 'YOUR API KEY';
1608
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1609
+ //X-App-Token.apiKeyPrefix = 'Token';
1610
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1611
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1612
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1613
+
1614
+ let apiInstance = new Voucherify.LoyaltiesApi();
1615
+ let campaignId = "campaignId_example"; // String | Unique campaign ID.
1616
+ let opts = {
1617
+ 'limit': 56, // Number | Limit the number of the pending point entries that the API returns in the response.
1618
+ 'order': new Voucherify.ParameterOrderListPendingPoints(), // ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
1619
+ 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
1620
+ };
1621
+ apiInstance.listCampaignPendingPoints(campaignId, opts, (error, data, response) => {
1622
+ if (error) {
1623
+ console.error(error);
1624
+ } else {
1625
+ console.log('API called successfully. Returned data: ' + data);
1626
+ }
1627
+ });
1628
+ ```
1629
+
1630
+ ### Parameters
1631
+
1632
+
1633
+ Name | Type | Description | Notes
1634
+ ------------- | ------------- | ------------- | -------------
1635
+ **campaignId** | **String**| Unique campaign ID. |
1636
+ **limit** | **Number**| Limit the number of the pending point entries that the API returns in the response. | [optional]
1637
+ **order** | [**ParameterOrderListPendingPoints**](.md)| Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional]
1638
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional]
1639
+
1640
+ ### Return type
1641
+
1642
+ [**LoyaltiesPendingPointsListResponseBody**](LoyaltiesPendingPointsListResponseBody.md)
1643
+
1644
+ ### Authorization
1645
+
1646
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1647
+
1648
+ ### HTTP request headers
1649
+
1650
+ - **Content-Type**: Not defined
1651
+ - **Accept**: application/json
1652
+
1653
+
1654
+ ## listEarningRules
1655
+
1656
+ > LoyaltiesEarningRulesListResponseBody listEarningRules(campaignId, opts)
1657
+
1658
+ List Earning Rules
1659
+
1660
+ Returns a list of all earning rules within a given campaign.
1661
+
1662
+ ### Example
1663
+
1664
+ ```javascript
1665
+ import Voucherify from 'voucherify';
1666
+ let defaultClient = Voucherify.ApiClient.instance;
1667
+ // Configure API key authorization: X-App-Id
1668
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1669
+ X-App-Id.apiKey = 'YOUR API KEY';
1670
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1671
+ //X-App-Id.apiKeyPrefix = 'Token';
1672
+ // Configure API key authorization: X-App-Token
1673
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1674
+ X-App-Token.apiKey = 'YOUR API KEY';
1675
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1676
+ //X-App-Token.apiKeyPrefix = 'Token';
1677
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1678
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1679
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1680
+
1681
+ let apiInstance = new Voucherify.LoyaltiesApi();
1682
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
1683
+ let opts = {
1684
+ 'limit': 56, // Number | 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.
1685
+ 'page': 56, // Number | Which page of results to return. The lowest value is 1.
1686
+ 'order': new Voucherify.ParameterOrderListEarningRules() // ParameterOrderListEarningRules | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1687
+ };
1688
+ apiInstance.listEarningRules(campaignId, opts, (error, data, response) => {
1689
+ if (error) {
1690
+ console.error(error);
1691
+ } else {
1692
+ console.log('API called successfully. Returned data: ' + data);
1693
+ }
1694
+ });
1695
+ ```
1696
+
1697
+ ### Parameters
1698
+
1699
+
1700
+ Name | Type | Description | Notes
1701
+ ------------- | ------------- | ------------- | -------------
1702
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
1703
+ **limit** | **Number**| 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]
1704
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional]
1705
+ **order** | [**ParameterOrderListEarningRules**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
1706
+
1707
+ ### Return type
1708
+
1709
+ [**LoyaltiesEarningRulesListResponseBody**](LoyaltiesEarningRulesListResponseBody.md)
1710
+
1711
+ ### Authorization
1712
+
1713
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1714
+
1715
+ ### HTTP request headers
1716
+
1717
+ - **Content-Type**: Not defined
1718
+ - **Accept**: application/json
1719
+
1720
+
1721
+ ## listLoyaltyCampaignTransactions
1722
+
1723
+ > LoyaltiesTransactionsListResponseBody listLoyaltyCampaignTransactions(campaignId, opts)
1724
+
1725
+ List Loyalty Campaign Transactions
1726
+
1727
+ Retrieves all transactions for the campaign with the given campaign ID or campaign name.
1728
+
1729
+ ### Example
1730
+
1731
+ ```javascript
1732
+ import Voucherify from 'voucherify';
1733
+ let defaultClient = Voucherify.ApiClient.instance;
1734
+ // Configure API key authorization: X-App-Id
1735
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1736
+ X-App-Id.apiKey = 'YOUR API KEY';
1737
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1738
+ //X-App-Id.apiKeyPrefix = 'Token';
1739
+ // Configure API key authorization: X-App-Token
1740
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1741
+ X-App-Token.apiKey = 'YOUR API KEY';
1742
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1743
+ //X-App-Token.apiKeyPrefix = 'Token';
1744
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1745
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1746
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1747
+
1748
+ let apiInstance = new Voucherify.LoyaltiesApi();
1749
+ let campaignId = "campaignId_example"; // String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
1750
+ let opts = {
1751
+ 'limit': 56, // Number | 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.
1752
+ 'order': new Voucherify.ParameterOrderListTransactions(), // ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1753
+ 'startingAfterId': "startingAfterId_example", // String | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
1754
+ 'filters': new Voucherify.ParametersFiltersListCampaignTransactions() // ParametersFiltersListCampaignTransactions | Filters for listing responses. The id filter denotes the unique transaction identifier.
1755
+ };
1756
+ apiInstance.listLoyaltyCampaignTransactions(campaignId, opts, (error, data, response) => {
1757
+ if (error) {
1758
+ console.error(error);
1759
+ } else {
1760
+ console.log('API called successfully. Returned data: ' + data);
1761
+ }
1762
+ });
1763
+ ```
1764
+
1765
+ ### Parameters
1766
+
1767
+
1768
+ Name | Type | Description | Notes
1769
+ ------------- | ------------- | ------------- | -------------
1770
+ **campaignId** | **String**| You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. |
1771
+ **limit** | **Number**| 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]
1772
+ **order** | [**ParameterOrderListTransactions**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
1773
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. | [optional]
1774
+ **filters** | [**ParametersFiltersListCampaignTransactions**](.md)| Filters for listing responses. The id filter denotes the unique transaction identifier. | [optional]
1775
+
1776
+ ### Return type
1777
+
1778
+ [**LoyaltiesTransactionsListResponseBody**](LoyaltiesTransactionsListResponseBody.md)
1779
+
1780
+ ### Authorization
1781
+
1782
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1783
+
1784
+ ### HTTP request headers
1785
+
1786
+ - **Content-Type**: Not defined
1787
+ - **Accept**: application/json
1788
+
1789
+
1790
+ ## listLoyaltyCardTransactions
1791
+
1792
+ > LoyaltiesMembersTransactionsListResponseBody listLoyaltyCardTransactions(memberId, opts)
1793
+
1794
+ List Loyalty Card Transactions
1795
+
1796
+ Retrieve transaction data related to point movements for a specific loyalty card.
1797
+
1798
+ ### Example
1799
+
1800
+ ```javascript
1801
+ import Voucherify from 'voucherify';
1802
+ let defaultClient = Voucherify.ApiClient.instance;
1803
+ // Configure API key authorization: X-App-Id
1804
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1805
+ X-App-Id.apiKey = 'YOUR API KEY';
1806
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1807
+ //X-App-Id.apiKeyPrefix = 'Token';
1808
+ // Configure API key authorization: X-App-Token
1809
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1810
+ X-App-Token.apiKey = 'YOUR API KEY';
1811
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1812
+ //X-App-Token.apiKeyPrefix = 'Token';
1813
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1814
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1815
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1816
+
1817
+ let apiInstance = new Voucherify.LoyaltiesApi();
1818
+ let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
1819
+ let opts = {
1820
+ 'limit': 56, // Number | 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.
1821
+ 'order': new Voucherify.ParameterOrderListTransactions(), // ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1822
+ 'filters': new Voucherify.ParameterFiltersListMemberTransactions(), // ParameterFiltersListMemberTransactions | Filters for listing member transactions. id is the unique identifier of the transaction.
1823
+ 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
1824
+ };
1825
+ apiInstance.listLoyaltyCardTransactions(memberId, opts, (error, data, response) => {
1826
+ if (error) {
1827
+ console.error(error);
1828
+ } else {
1829
+ console.log('API called successfully. Returned data: ' + data);
1830
+ }
1831
+ });
1832
+ ```
1833
+
1834
+ ### Parameters
1835
+
1836
+
1837
+ Name | Type | Description | Notes
1838
+ ------------- | ------------- | ------------- | -------------
1839
+ **memberId** | **String**| A unique code identifying the loyalty card that you are looking to retrieve transaction data for. |
1840
+ **limit** | **Number**| 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]
1841
+ **order** | [**ParameterOrderListTransactions**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
1842
+ **filters** | [**ParameterFiltersListMemberTransactions**](.md)| Filters for listing member transactions. id is the unique identifier of the transaction. | [optional]
1843
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. | [optional]
1844
+
1845
+ ### Return type
1846
+
1847
+ [**LoyaltiesMembersTransactionsListResponseBody**](LoyaltiesMembersTransactionsListResponseBody.md)
1848
+
1849
+ ### Authorization
1850
+
1851
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1852
+
1853
+ ### HTTP request headers
1854
+
1855
+ - **Content-Type**: Not defined
1856
+ - **Accept**: application/json
1857
+
1858
+
1859
+ ## listLoyaltyCardTransactions1
1860
+
1861
+ > LoyaltiesMembersTransactionsListResponseBody listLoyaltyCardTransactions1(campaignId, memberId, opts)
1862
+
1863
+ List Loyalty Card Transactions with campaign ID
1864
+
1865
+ Retrieve transaction data related to point movements for a specific loyalty card.
1866
+
1867
+ ### Example
1868
+
1869
+ ```javascript
1870
+ import Voucherify from 'voucherify';
1871
+ let defaultClient = Voucherify.ApiClient.instance;
1872
+ // Configure API key authorization: X-App-Id
1873
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1874
+ X-App-Id.apiKey = 'YOUR API KEY';
1875
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1876
+ //X-App-Id.apiKeyPrefix = 'Token';
1877
+ // Configure API key authorization: X-App-Token
1878
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1879
+ X-App-Token.apiKey = 'YOUR API KEY';
1880
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1881
+ //X-App-Token.apiKeyPrefix = 'Token';
1882
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1883
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1884
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1885
+
1886
+ let apiInstance = new Voucherify.LoyaltiesApi();
1887
+ let campaignId = "campaignId_example"; // String | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
1888
+ let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
1889
+ let opts = {
1890
+ 'limit': 56, // Number | 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.
1891
+ 'order': new Voucherify.ParameterOrderListTransactions(), // ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1892
+ 'filters': new Voucherify.ParameterFiltersListMemberTransactions(), // ParameterFiltersListMemberTransactions | Filters for listing member transactions. id is the unique identifier of the transaction.
1893
+ 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
1894
+ };
1895
+ apiInstance.listLoyaltyCardTransactions1(campaignId, memberId, opts, (error, data, response) => {
1896
+ if (error) {
1897
+ console.error(error);
1898
+ } else {
1899
+ console.log('API called successfully. Returned data: ' + data);
1900
+ }
1901
+ });
1902
+ ```
1903
+
1904
+ ### Parameters
1905
+
1906
+
1907
+ Name | Type | Description | Notes
1908
+ ------------- | ------------- | ------------- | -------------
1909
+ **campaignId** | **String**| A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. |
1910
+ **memberId** | **String**| A unique code identifying the loyalty card that you are looking to retrieve transaction data for. |
1911
+ **limit** | **Number**| 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]
1912
+ **order** | [**ParameterOrderListTransactions**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
1913
+ **filters** | [**ParameterFiltersListMemberTransactions**](.md)| Filters for listing member transactions. id is the unique identifier of the transaction. | [optional]
1914
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. | [optional]
1915
+
1916
+ ### Return type
1917
+
1918
+ [**LoyaltiesMembersTransactionsListResponseBody**](LoyaltiesMembersTransactionsListResponseBody.md)
1919
+
1920
+ ### Authorization
1921
+
1922
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1923
+
1924
+ ### HTTP request headers
1925
+
1926
+ - **Content-Type**: Not defined
1927
+ - **Accept**: application/json
1928
+
1929
+
1930
+ ## listLoyaltyPrograms
1931
+
1932
+ > LoyaltiesListCampaignsResponseBody listLoyaltyPrograms(opts)
1933
+
1934
+ List Loyalty Campaigns
1935
+
1936
+ Returns a list of your loyalty campaigns.
1937
+
1938
+ ### Example
1939
+
1940
+ ```javascript
1941
+ import Voucherify from 'voucherify';
1942
+ let defaultClient = Voucherify.ApiClient.instance;
1943
+ // Configure API key authorization: X-App-Id
1944
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
1945
+ X-App-Id.apiKey = 'YOUR API KEY';
1946
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1947
+ //X-App-Id.apiKeyPrefix = 'Token';
1948
+ // Configure API key authorization: X-App-Token
1949
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
1950
+ X-App-Token.apiKey = 'YOUR API KEY';
1951
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1952
+ //X-App-Token.apiKeyPrefix = 'Token';
1953
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
1954
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
1955
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
1956
+
1957
+ let apiInstance = new Voucherify.LoyaltiesApi();
1958
+ let opts = {
1959
+ 'limit': 56, // Number | 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.
1960
+ 'page': 56, // Number | Which page of results to return. The lowest value is 1.
1961
+ 'expand': new Voucherify.ParameterExpandListCampaigns(), // ParameterExpandListCampaigns | Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores.
1962
+ 'order': new Voucherify.ParameterOrderListCampaigns() // ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1963
+ };
1964
+ apiInstance.listLoyaltyPrograms(opts, (error, data, response) => {
1965
+ if (error) {
1966
+ console.error(error);
1967
+ } else {
1968
+ console.log('API called successfully. Returned data: ' + data);
1969
+ }
1970
+ });
1971
+ ```
1972
+
1973
+ ### Parameters
1974
+
1975
+
1976
+ Name | Type | Description | Notes
1977
+ ------------- | ------------- | ------------- | -------------
1978
+ **limit** | **Number**| 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]
1979
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional]
1980
+ **expand** | [**ParameterExpandListCampaigns**](.md)| Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. | [optional]
1981
+ **order** | [**ParameterOrderListCampaigns**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
1982
+
1983
+ ### Return type
1984
+
1985
+ [**LoyaltiesListCampaignsResponseBody**](LoyaltiesListCampaignsResponseBody.md)
1986
+
1987
+ ### Authorization
1988
+
1989
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
1990
+
1991
+ ### HTTP request headers
1992
+
1993
+ - **Content-Type**: Not defined
1994
+ - **Accept**: application/json
1995
+
1996
+
1997
+ ## listLoyaltyTierEarningRules
1998
+
1999
+ > LoyaltiesTiersEarningRulesListResponseBody listLoyaltyTierEarningRules(campaignId, loyaltyTierId, opts)
2000
+
2001
+ List Loyalty Tier Earning Rules
2002
+
2003
+ Retrieve available earning rules for a given tier and the calculation method for earning points.
2004
+
2005
+ ### Example
2006
+
2007
+ ```javascript
2008
+ import Voucherify from 'voucherify';
2009
+ let defaultClient = Voucherify.ApiClient.instance;
2010
+ // Configure API key authorization: X-App-Id
2011
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2012
+ X-App-Id.apiKey = 'YOUR API KEY';
2013
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2014
+ //X-App-Id.apiKeyPrefix = 'Token';
2015
+ // Configure API key authorization: X-App-Token
2016
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2017
+ X-App-Token.apiKey = 'YOUR API KEY';
2018
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2019
+ //X-App-Token.apiKeyPrefix = 'Token';
2020
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2021
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2022
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2023
+
2024
+ let apiInstance = new Voucherify.LoyaltiesApi();
2025
+ let campaignId = "campaignId_example"; // String | Unique campaign ID or name.
2026
+ let loyaltyTierId = "loyaltyTierId_example"; // String | Unique loyalty tier ID.
2027
+ let opts = {
2028
+ 'limit': 56, // Number | 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.
2029
+ 'page': 56 // Number | Which page of results to return. The lowest value is 1.
2030
+ };
2031
+ apiInstance.listLoyaltyTierEarningRules(campaignId, loyaltyTierId, opts, (error, data, response) => {
2032
+ if (error) {
2033
+ console.error(error);
2034
+ } else {
2035
+ console.log('API called successfully. Returned data: ' + data);
2036
+ }
2037
+ });
2038
+ ```
2039
+
2040
+ ### Parameters
2041
+
2042
+
2043
+ Name | Type | Description | Notes
2044
+ ------------- | ------------- | ------------- | -------------
2045
+ **campaignId** | **String**| Unique campaign ID or name. |
2046
+ **loyaltyTierId** | **String**| Unique loyalty tier ID. |
2047
+ **limit** | **Number**| 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]
2048
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional]
2049
+
2050
+ ### Return type
2051
+
2052
+ [**LoyaltiesTiersEarningRulesListResponseBody**](LoyaltiesTiersEarningRulesListResponseBody.md)
2053
+
2054
+ ### Authorization
2055
+
2056
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2057
+
2058
+ ### HTTP request headers
2059
+
2060
+ - **Content-Type**: Not defined
2061
+ - **Accept**: application/json
2062
+
2063
+
2064
+ ## listLoyaltyTierRewards
2065
+
2066
+ > LoyaltiesTiersRewardsListResponseBody listLoyaltyTierRewards(campaignId, loyaltyTierId)
2067
+
2068
+ List Loyalty Tier Rewards
2069
+
2070
+ Get available rewards for a given tier.
2071
+
2072
+ ### Example
2073
+
2074
+ ```javascript
2075
+ import Voucherify from 'voucherify';
2076
+ let defaultClient = Voucherify.ApiClient.instance;
2077
+ // Configure API key authorization: X-App-Id
2078
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2079
+ X-App-Id.apiKey = 'YOUR API KEY';
2080
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2081
+ //X-App-Id.apiKeyPrefix = 'Token';
2082
+ // Configure API key authorization: X-App-Token
2083
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2084
+ X-App-Token.apiKey = 'YOUR API KEY';
2085
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2086
+ //X-App-Token.apiKeyPrefix = 'Token';
2087
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2088
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2089
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2090
+
2091
+ let apiInstance = new Voucherify.LoyaltiesApi();
2092
+ let campaignId = "campaignId_example"; // String | Unique campaign ID or name.
2093
+ let loyaltyTierId = "loyaltyTierId_example"; // String | Unique loyalty tier ID.
2094
+ apiInstance.listLoyaltyTierRewards(campaignId, loyaltyTierId, (error, data, response) => {
2095
+ if (error) {
2096
+ console.error(error);
2097
+ } else {
2098
+ console.log('API called successfully. Returned data: ' + data);
2099
+ }
2100
+ });
2101
+ ```
2102
+
2103
+ ### Parameters
2104
+
2105
+
2106
+ Name | Type | Description | Notes
2107
+ ------------- | ------------- | ------------- | -------------
2108
+ **campaignId** | **String**| Unique campaign ID or name. |
2109
+ **loyaltyTierId** | **String**| Unique loyalty tier ID. |
2110
+
2111
+ ### Return type
2112
+
2113
+ [**LoyaltiesTiersRewardsListResponseBody**](LoyaltiesTiersRewardsListResponseBody.md)
2114
+
2115
+ ### Authorization
2116
+
2117
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2118
+
2119
+ ### HTTP request headers
2120
+
2121
+ - **Content-Type**: Not defined
2122
+ - **Accept**: application/json
2123
+
2124
+
2125
+ ## listLoyaltyTiers
2126
+
2127
+ > LoyaltiesTiersListResponseBody listLoyaltyTiers(campaignId, opts)
2128
+
2129
+ List Loyalty Tiers
2130
+
2131
+ Retrieve a list of loyalty tiers which were added to the loyalty program.
2132
+
2133
+ ### Example
2134
+
2135
+ ```javascript
2136
+ import Voucherify from 'voucherify';
2137
+ let defaultClient = Voucherify.ApiClient.instance;
2138
+ // Configure API key authorization: X-App-Id
2139
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2140
+ X-App-Id.apiKey = 'YOUR API KEY';
2141
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2142
+ //X-App-Id.apiKeyPrefix = 'Token';
2143
+ // Configure API key authorization: X-App-Token
2144
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2145
+ X-App-Token.apiKey = 'YOUR API KEY';
2146
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2147
+ //X-App-Token.apiKeyPrefix = 'Token';
2148
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2149
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2150
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2151
+
2152
+ let apiInstance = new Voucherify.LoyaltiesApi();
2153
+ let campaignId = "campaignId_example"; // String | Unique loyalty campaign ID or name.
2154
+ let opts = {
2155
+ 'limit': 56, // Number | 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.
2156
+ 'order': new Voucherify.ParameterOrderListLoyaltyTiers() // ParameterOrderListLoyaltyTiers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
2157
+ };
2158
+ apiInstance.listLoyaltyTiers(campaignId, opts, (error, data, response) => {
2159
+ if (error) {
2160
+ console.error(error);
2161
+ } else {
2162
+ console.log('API called successfully. Returned data: ' + data);
2163
+ }
2164
+ });
2165
+ ```
2166
+
2167
+ ### Parameters
2168
+
2169
+
2170
+ Name | Type | Description | Notes
2171
+ ------------- | ------------- | ------------- | -------------
2172
+ **campaignId** | **String**| Unique loyalty campaign ID or name. |
2173
+ **limit** | **Number**| 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]
2174
+ **order** | [**ParameterOrderListLoyaltyTiers**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
2175
+
2176
+ ### Return type
2177
+
2178
+ [**LoyaltiesTiersListResponseBody**](LoyaltiesTiersListResponseBody.md)
2179
+
2180
+ ### Authorization
2181
+
2182
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2183
+
2184
+ ### HTTP request headers
2185
+
2186
+ - **Content-Type**: Not defined
2187
+ - **Accept**: application/json
2188
+
2189
+
2190
+ ## listMemberActivity
2191
+
2192
+ > LoyaltiesMemberActivityListResponseBody listMemberActivity(memberId, opts)
2193
+
2194
+ List Member Activity
2195
+
2196
+ 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2197
+
2198
+ ### Example
2199
+
2200
+ ```javascript
2201
+ import Voucherify from 'voucherify';
2202
+ let defaultClient = Voucherify.ApiClient.instance;
2203
+ // Configure API key authorization: X-App-Id
2204
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2205
+ X-App-Id.apiKey = 'YOUR API KEY';
2206
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2207
+ //X-App-Id.apiKeyPrefix = 'Token';
2208
+ // Configure API key authorization: X-App-Token
2209
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2210
+ X-App-Token.apiKey = 'YOUR API KEY';
2211
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2212
+ //X-App-Token.apiKeyPrefix = 'Token';
2213
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2214
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2215
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2216
+
2217
+ let apiInstance = new Voucherify.LoyaltiesApi();
2218
+ let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer.
2219
+ let opts = {
2220
+ 'limit': 56, // Number | 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.
2221
+ 'order': new Voucherify.ParameterOrderCreatedAt(), // ParameterOrderCreatedAt | Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order.
2222
+ 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
2223
+ };
2224
+ apiInstance.listMemberActivity(memberId, opts, (error, data, response) => {
2225
+ if (error) {
2226
+ console.error(error);
2227
+ } else {
2228
+ console.log('API called successfully. Returned data: ' + data);
2229
+ }
2230
+ });
2231
+ ```
2232
+
2233
+ ### Parameters
2234
+
2235
+
2236
+ Name | Type | Description | Notes
2237
+ ------------- | ------------- | ------------- | -------------
2238
+ **memberId** | **String**| Unique loyalty card assigned to a particular customer. |
2239
+ **limit** | **Number**| 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]
2240
+ **order** | [**ParameterOrderCreatedAt**](.md)| Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. | [optional]
2241
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional]
2242
+
2243
+ ### Return type
2244
+
2245
+ [**LoyaltiesMemberActivityListResponseBody**](LoyaltiesMemberActivityListResponseBody.md)
2246
+
2247
+ ### Authorization
2248
+
2249
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2250
+
2251
+ ### HTTP request headers
2252
+
2253
+ - **Content-Type**: Not defined
2254
+ - **Accept**: application/json
2255
+
2256
+
2257
+ ## listMemberActivity1
2258
+
2259
+ > LoyaltiesMemberActivityListResponseBody listMemberActivity1(campaignId, memberId, opts)
2260
+
2261
+ List Member Activity with campaign ID
2262
+
2263
+ Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2264
+
2265
+ ### Example
2266
+
2267
+ ```javascript
2268
+ import Voucherify from 'voucherify';
2269
+ let defaultClient = Voucherify.ApiClient.instance;
2270
+ // Configure API key authorization: X-App-Id
2271
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2272
+ X-App-Id.apiKey = 'YOUR API KEY';
2273
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2274
+ //X-App-Id.apiKeyPrefix = 'Token';
2275
+ // Configure API key authorization: X-App-Token
2276
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2277
+ X-App-Token.apiKey = 'YOUR API KEY';
2278
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2279
+ //X-App-Token.apiKeyPrefix = 'Token';
2280
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2281
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2282
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2283
+
2284
+ let apiInstance = new Voucherify.LoyaltiesApi();
2285
+ let campaignId = "campaignId_example"; // String | Unique campaign ID.
2286
+ let memberId = "memberId_example"; // String | A code that identifies the loyalty card.
2287
+ let opts = {
2288
+ 'limit': 56, // Number | 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.
2289
+ 'order': new Voucherify.ParameterOrderCreatedAt(), // ParameterOrderCreatedAt | Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order.
2290
+ 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
2291
+ };
2292
+ apiInstance.listMemberActivity1(campaignId, memberId, opts, (error, data, response) => {
2293
+ if (error) {
2294
+ console.error(error);
2295
+ } else {
2296
+ console.log('API called successfully. Returned data: ' + data);
2297
+ }
2298
+ });
2299
+ ```
2300
+
2301
+ ### Parameters
2302
+
2303
+
2304
+ Name | Type | Description | Notes
2305
+ ------------- | ------------- | ------------- | -------------
2306
+ **campaignId** | **String**| Unique campaign ID. |
2307
+ **memberId** | **String**| A code that identifies the loyalty card. |
2308
+ **limit** | **Number**| 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]
2309
+ **order** | [**ParameterOrderCreatedAt**](.md)| Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. | [optional]
2310
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional]
2311
+
2312
+ ### Return type
2313
+
2314
+ [**LoyaltiesMemberActivityListResponseBody**](LoyaltiesMemberActivityListResponseBody.md)
2315
+
2316
+ ### Authorization
2317
+
2318
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2319
+
2320
+ ### HTTP request headers
2321
+
2322
+ - **Content-Type**: Not defined
2323
+ - **Accept**: application/json
2324
+
2325
+
2326
+ ## listMemberLoyaltyTier
2327
+
2328
+ > LoyaltiesMembersTiersListResponseBody listMemberLoyaltyTier(memberId)
2329
+
2330
+ List Member's Loyalty Tiers
2331
+
2332
+ Retrieve member tiers using the loyalty card ID.
2333
+
2334
+ ### Example
2335
+
2336
+ ```javascript
2337
+ import Voucherify from 'voucherify';
2338
+ let defaultClient = Voucherify.ApiClient.instance;
2339
+ // Configure API key authorization: X-App-Id
2340
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2341
+ X-App-Id.apiKey = 'YOUR API KEY';
2342
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2343
+ //X-App-Id.apiKeyPrefix = 'Token';
2344
+ // Configure API key authorization: X-App-Token
2345
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2346
+ X-App-Token.apiKey = 'YOUR API KEY';
2347
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2348
+ //X-App-Token.apiKeyPrefix = 'Token';
2349
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2350
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2351
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2352
+
2353
+ let apiInstance = new Voucherify.LoyaltiesApi();
2354
+ let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer.
2355
+ apiInstance.listMemberLoyaltyTier(memberId, (error, data, response) => {
2356
+ if (error) {
2357
+ console.error(error);
2358
+ } else {
2359
+ console.log('API called successfully. Returned data: ' + data);
2360
+ }
2361
+ });
2362
+ ```
2363
+
2364
+ ### Parameters
2365
+
2366
+
2367
+ Name | Type | Description | Notes
2368
+ ------------- | ------------- | ------------- | -------------
2369
+ **memberId** | **String**| Unique loyalty card assigned to a particular customer. |
2370
+
2371
+ ### Return type
2372
+
2373
+ [**LoyaltiesMembersTiersListResponseBody**](LoyaltiesMembersTiersListResponseBody.md)
2374
+
2375
+ ### Authorization
2376
+
2377
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2378
+
2379
+ ### HTTP request headers
2380
+
2381
+ - **Content-Type**: Not defined
2382
+ - **Accept**: application/json
2383
+
2384
+
2385
+ ## listMemberPendingPoints
2386
+
2387
+ > LoyaltiesMembersPendingPointsListResponseBody listMemberPendingPoints(memberId, opts)
2388
+
2389
+ List Member Pending Points
2390
+
2391
+ 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2392
+
2393
+ ### Example
2394
+
2395
+ ```javascript
2396
+ import Voucherify from 'voucherify';
2397
+ let defaultClient = Voucherify.ApiClient.instance;
2398
+ // Configure API key authorization: X-App-Id
2399
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2400
+ X-App-Id.apiKey = 'YOUR API KEY';
2401
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2402
+ //X-App-Id.apiKeyPrefix = 'Token';
2403
+ // Configure API key authorization: X-App-Token
2404
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2405
+ X-App-Token.apiKey = 'YOUR API KEY';
2406
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2407
+ //X-App-Token.apiKeyPrefix = 'Token';
2408
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2409
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2410
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2411
+
2412
+ let apiInstance = new Voucherify.LoyaltiesApi();
2413
+ let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer.
2414
+ let opts = {
2415
+ 'limit': 56, // Number | Limit the number of the pending point entries that the API returns in the response.
2416
+ 'order': new Voucherify.ParameterOrderListPendingPoints(), // ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2417
+ 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
2418
+ };
2419
+ apiInstance.listMemberPendingPoints(memberId, opts, (error, data, response) => {
2420
+ if (error) {
2421
+ console.error(error);
2422
+ } else {
2423
+ console.log('API called successfully. Returned data: ' + data);
2424
+ }
2425
+ });
2426
+ ```
2427
+
2428
+ ### Parameters
2429
+
2430
+
2431
+ Name | Type | Description | Notes
2432
+ ------------- | ------------- | ------------- | -------------
2433
+ **memberId** | **String**| Unique loyalty card code assigned to a particular customer. |
2434
+ **limit** | **Number**| Limit the number of the pending point entries that the API returns in the response. | [optional]
2435
+ **order** | [**ParameterOrderListPendingPoints**](.md)| Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional]
2436
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional]
2437
+
2438
+ ### Return type
2439
+
2440
+ [**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
2441
+
2442
+ ### Authorization
2443
+
2444
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2445
+
2446
+ ### HTTP request headers
2447
+
2448
+ - **Content-Type**: Not defined
2449
+ - **Accept**: application/json
2450
+
2451
+
2452
+ ## listMemberPendingPoints1
2453
+
2454
+ > LoyaltiesMembersPendingPointsListResponseBody listMemberPendingPoints1(campaignId, memberId, opts)
2455
+
2456
+ List Member Pending Points with campaign ID
2457
+
2458
+ Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2459
+
2460
+ ### Example
2461
+
2462
+ ```javascript
2463
+ import Voucherify from 'voucherify';
2464
+ let defaultClient = Voucherify.ApiClient.instance;
2465
+ // Configure API key authorization: X-App-Id
2466
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2467
+ X-App-Id.apiKey = 'YOUR API KEY';
2468
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2469
+ //X-App-Id.apiKeyPrefix = 'Token';
2470
+ // Configure API key authorization: X-App-Token
2471
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2472
+ X-App-Token.apiKey = 'YOUR API KEY';
2473
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2474
+ //X-App-Token.apiKeyPrefix = 'Token';
2475
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2476
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2477
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2478
+
2479
+ let apiInstance = new Voucherify.LoyaltiesApi();
2480
+ let campaignId = "campaignId_example"; // String | Unique campaign ID.
2481
+ let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer.
2482
+ let opts = {
2483
+ 'limit': 56, // Number | Limit the number of the pending point entries that the API returns in the response.
2484
+ 'order': new Voucherify.ParameterOrderListPendingPoints(), // ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2485
+ 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
2486
+ };
2487
+ apiInstance.listMemberPendingPoints1(campaignId, memberId, opts, (error, data, response) => {
2488
+ if (error) {
2489
+ console.error(error);
2490
+ } else {
2491
+ console.log('API called successfully. Returned data: ' + data);
2492
+ }
2493
+ });
2494
+ ```
2495
+
2496
+ ### Parameters
2497
+
2498
+
2499
+ Name | Type | Description | Notes
2500
+ ------------- | ------------- | ------------- | -------------
2501
+ **campaignId** | **String**| Unique campaign ID. |
2502
+ **memberId** | **String**| Unique loyalty card code assigned to a particular customer. |
2503
+ **limit** | **Number**| Limit the number of the pending point entries that the API returns in the response. | [optional]
2504
+ **order** | [**ParameterOrderListPendingPoints**](.md)| Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional]
2505
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional]
2506
+
2507
+ ### Return type
2508
+
2509
+ [**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
2510
+
2511
+ ### Authorization
2512
+
2513
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2514
+
2515
+ ### HTTP request headers
2516
+
2517
+ - **Content-Type**: Not defined
2518
+ - **Accept**: application/json
2519
+
2520
+
2521
+ ## listMemberRewards
2522
+
2523
+ > LoyaltiesMembersRewardsListResponseBody listMemberRewards(memberId, opts)
2524
+
2525
+ List Member Rewards
2526
+
2527
+ Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
2528
+
2529
+ ### Example
2530
+
2531
+ ```javascript
2532
+ import Voucherify from 'voucherify';
2533
+ let defaultClient = Voucherify.ApiClient.instance;
2534
+ // Configure API key authorization: X-App-Id
2535
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2536
+ X-App-Id.apiKey = 'YOUR API KEY';
2537
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2538
+ //X-App-Id.apiKeyPrefix = 'Token';
2539
+ // Configure API key authorization: X-App-Token
2540
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2541
+ X-App-Token.apiKey = 'YOUR API KEY';
2542
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2543
+ //X-App-Token.apiKeyPrefix = 'Token';
2544
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2545
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2546
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2547
+
2548
+ let apiInstance = new Voucherify.LoyaltiesApi();
2549
+ let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer.
2550
+ let opts = {
2551
+ 'affordableOnly': true // Boolean | Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford.
2552
+ };
2553
+ apiInstance.listMemberRewards(memberId, opts, (error, data, response) => {
2554
+ if (error) {
2555
+ console.error(error);
2556
+ } else {
2557
+ console.log('API called successfully. Returned data: ' + data);
2558
+ }
2559
+ });
2560
+ ```
2561
+
2562
+ ### Parameters
2563
+
2564
+
2565
+ Name | Type | Description | Notes
2566
+ ------------- | ------------- | ------------- | -------------
2567
+ **memberId** | **String**| Unique loyalty card assigned to a particular customer. |
2568
+ **affordableOnly** | **Boolean**| Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford. | [optional]
2569
+
2570
+ ### Return type
2571
+
2572
+ [**LoyaltiesMembersRewardsListResponseBody**](LoyaltiesMembersRewardsListResponseBody.md)
2573
+
2574
+ ### Authorization
2575
+
2576
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2577
+
2578
+ ### HTTP request headers
2579
+
2580
+ - **Content-Type**: Not defined
2581
+ - **Accept**: application/json
2582
+
2583
+
2584
+ ## listMembers
2585
+
2586
+ > LoyaltiesListMembersResponseBody listMembers(campaignId, opts)
2587
+
2588
+ List Members
2589
+
2590
+ Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
2591
+
2592
+ ### Example
2593
+
2594
+ ```javascript
2595
+ import Voucherify from 'voucherify';
2596
+ let defaultClient = Voucherify.ApiClient.instance;
2597
+ // Configure API key authorization: X-App-Id
2598
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2599
+ X-App-Id.apiKey = 'YOUR API KEY';
2600
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2601
+ //X-App-Id.apiKeyPrefix = 'Token';
2602
+ // Configure API key authorization: X-App-Token
2603
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2604
+ X-App-Token.apiKey = 'YOUR API KEY';
2605
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2606
+ //X-App-Token.apiKeyPrefix = 'Token';
2607
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2608
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2609
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2610
+
2611
+ let apiInstance = new Voucherify.LoyaltiesApi();
2612
+ let campaignId = "campaignId_example"; // String | Unique campaign ID of the loyalty program.
2613
+ let opts = {
2614
+ 'limit': 56, // Number | 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.
2615
+ 'page': 56, // Number | Which page of results to return. The lowest value is 1.
2616
+ 'customer': "customer_example", // String | A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters.
2617
+ 'createdAt': new Voucherify.ParameterCreatedBeforeAfter(), // ParameterCreatedBeforeAfter | A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z
2618
+ 'updatedAt': new Voucherify.ParameterUpdatedBeforeAfter(), // ParameterUpdatedBeforeAfter | A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z
2619
+ 'order': new Voucherify.ParameterOrderVouchers(), // ParameterOrderVouchers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
2620
+ 'code': "code_example", // String |
2621
+ 'ids': ["null"] // [String] |
2622
+ };
2623
+ apiInstance.listMembers(campaignId, opts, (error, data, response) => {
2624
+ if (error) {
2625
+ console.error(error);
2626
+ } else {
2627
+ console.log('API called successfully. Returned data: ' + data);
2628
+ }
2629
+ });
2630
+ ```
2631
+
2632
+ ### Parameters
2633
+
2634
+
2635
+ Name | Type | Description | Notes
2636
+ ------------- | ------------- | ------------- | -------------
2637
+ **campaignId** | **String**| Unique campaign ID of the loyalty program. |
2638
+ **limit** | **Number**| 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]
2639
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional]
2640
+ **customer** | **String**| A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters. | [optional]
2641
+ **createdAt** | [**ParameterCreatedBeforeAfter**](.md)| A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z | [optional]
2642
+ **updatedAt** | [**ParameterUpdatedBeforeAfter**](.md)| A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z | [optional]
2643
+ **order** | [**ParameterOrderVouchers**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
2644
+ **code** | **String**| | [optional]
2645
+ **ids** | [**[String]**](String.md)| | [optional]
2646
+
2647
+ ### Return type
2648
+
2649
+ [**LoyaltiesListMembersResponseBody**](LoyaltiesListMembersResponseBody.md)
2650
+
2651
+ ### Authorization
2652
+
2653
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2654
+
2655
+ ### HTTP request headers
2656
+
2657
+ - **Content-Type**: Not defined
2658
+ - **Accept**: application/json
2659
+
2660
+
2661
+ ## listPointsExpiration
2662
+
2663
+ > LoyaltiesMembersPointsExpirationListResponseBody listPointsExpiration(campaignId, memberId, opts)
2664
+
2665
+ List Loyalty Card Point Expiration
2666
+
2667
+ Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the [Exports API](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
2668
+
2669
+ ### Example
2670
+
2671
+ ```javascript
2672
+ import Voucherify from 'voucherify';
2673
+ let defaultClient = Voucherify.ApiClient.instance;
2674
+ // Configure API key authorization: X-App-Id
2675
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2676
+ X-App-Id.apiKey = 'YOUR API KEY';
2677
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2678
+ //X-App-Id.apiKeyPrefix = 'Token';
2679
+ // Configure API key authorization: X-App-Token
2680
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2681
+ X-App-Token.apiKey = 'YOUR API KEY';
2682
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2683
+ //X-App-Token.apiKeyPrefix = 'Token';
2684
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2685
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2686
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2687
+
2688
+ let apiInstance = new Voucherify.LoyaltiesApi();
2689
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
2690
+ let memberId = "memberId_example"; // String | Loyalty card code.
2691
+ let opts = {
2692
+ 'limit': 56, // Number | 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.
2693
+ 'page': 56 // Number | Which page of results to return. The lowest value is 1.
2694
+ };
2695
+ apiInstance.listPointsExpiration(campaignId, memberId, opts, (error, data, response) => {
2696
+ if (error) {
2697
+ console.error(error);
2698
+ } else {
2699
+ console.log('API called successfully. Returned data: ' + data);
2700
+ }
2701
+ });
2702
+ ```
2703
+
2704
+ ### Parameters
2705
+
2706
+
2707
+ Name | Type | Description | Notes
2708
+ ------------- | ------------- | ------------- | -------------
2709
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
2710
+ **memberId** | **String**| Loyalty card code. |
2711
+ **limit** | **Number**| 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]
2712
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional]
2713
+
2714
+ ### Return type
2715
+
2716
+ [**LoyaltiesMembersPointsExpirationListResponseBody**](LoyaltiesMembersPointsExpirationListResponseBody.md)
2717
+
2718
+ ### Authorization
2719
+
2720
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2721
+
2722
+ ### HTTP request headers
2723
+
2724
+ - **Content-Type**: Not defined
2725
+ - **Accept**: application/json
2726
+
2727
+
2728
+ ## listRewardAssignments1
2729
+
2730
+ > LoyaltiesRewardAssignmentsListResponseBody listRewardAssignments1(campaignId, opts)
2731
+
2732
+ List Reward Assignments with campaign ID
2733
+
2734
+ Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response.
2735
+
2736
+ ### Example
2737
+
2738
+ ```javascript
2739
+ import Voucherify from 'voucherify';
2740
+ let defaultClient = Voucherify.ApiClient.instance;
2741
+ // Configure API key authorization: X-App-Id
2742
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2743
+ X-App-Id.apiKey = 'YOUR API KEY';
2744
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2745
+ //X-App-Id.apiKeyPrefix = 'Token';
2746
+ // Configure API key authorization: X-App-Token
2747
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2748
+ X-App-Token.apiKey = 'YOUR API KEY';
2749
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2750
+ //X-App-Token.apiKeyPrefix = 'Token';
2751
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2752
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2753
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2754
+
2755
+ let apiInstance = new Voucherify.LoyaltiesApi();
2756
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
2757
+ let opts = {
2758
+ 'limit': 56, // Number | 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.
2759
+ 'page': 56, // Number | Which page of results to return. The lowest value is 1.
2760
+ 'assignmentId': "assignmentId_example" // String | A unique reward assignment ID.
2761
+ };
2762
+ apiInstance.listRewardAssignments1(campaignId, opts, (error, data, response) => {
2763
+ if (error) {
2764
+ console.error(error);
2765
+ } else {
2766
+ console.log('API called successfully. Returned data: ' + data);
2767
+ }
2768
+ });
2769
+ ```
2770
+
2771
+ ### Parameters
2772
+
2773
+
2774
+ Name | Type | Description | Notes
2775
+ ------------- | ------------- | ------------- | -------------
2776
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
2777
+ **limit** | **Number**| 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]
2778
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional]
2779
+ **assignmentId** | **String**| A unique reward assignment ID. | [optional]
2780
+
2781
+ ### Return type
2782
+
2783
+ [**LoyaltiesRewardAssignmentsListResponseBody**](LoyaltiesRewardAssignmentsListResponseBody.md)
2784
+
2785
+ ### Authorization
2786
+
2787
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2788
+
2789
+ ### HTTP request headers
2790
+
2791
+ - **Content-Type**: Not defined
2792
+ - **Accept**: application/json
2793
+
2794
+
2795
+ ## listRewardAssignments2
2796
+
2797
+ > LoyaltiesRewardsListAssignmentsResponseBody listRewardAssignments2(campaignId, opts)
2798
+
2799
+ List Campaign Rewards
2800
+
2801
+ Returns active rewards from a given loyalty campaign.
2802
+
2803
+ ### Example
2804
+
2805
+ ```javascript
2806
+ import Voucherify from 'voucherify';
2807
+ let defaultClient = Voucherify.ApiClient.instance;
2808
+ // Configure API key authorization: X-App-Id
2809
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2810
+ X-App-Id.apiKey = 'YOUR API KEY';
2811
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2812
+ //X-App-Id.apiKeyPrefix = 'Token';
2813
+ // Configure API key authorization: X-App-Token
2814
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2815
+ X-App-Token.apiKey = 'YOUR API KEY';
2816
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2817
+ //X-App-Token.apiKeyPrefix = 'Token';
2818
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2819
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2820
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2821
+
2822
+ let apiInstance = new Voucherify.LoyaltiesApi();
2823
+ let campaignId = "campaignId_example"; // String | Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
2824
+ let opts = {
2825
+ 'limit': 56, // Number | 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.
2826
+ 'page': 56, // Number | Which page of results to return. The lowest value is 1.
2827
+ 'assignmentId': "assignmentId_example" // String | A unique reward assignment ID.
2828
+ };
2829
+ apiInstance.listRewardAssignments2(campaignId, opts, (error, data, response) => {
2830
+ if (error) {
2831
+ console.error(error);
2832
+ } else {
2833
+ console.log('API called successfully. Returned data: ' + data);
2834
+ }
2835
+ });
2836
+ ```
2837
+
2838
+ ### Parameters
2839
+
2840
+
2841
+ Name | Type | Description | Notes
2842
+ ------------- | ------------- | ------------- | -------------
2843
+ **campaignId** | **String**| Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
2844
+ **limit** | **Number**| 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]
2845
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional]
2846
+ **assignmentId** | **String**| A unique reward assignment ID. | [optional]
2847
+
2848
+ ### Return type
2849
+
2850
+ [**LoyaltiesRewardsListAssignmentsResponseBody**](LoyaltiesRewardsListAssignmentsResponseBody.md)
2851
+
2852
+ ### Authorization
2853
+
2854
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2855
+
2856
+ ### HTTP request headers
2857
+
2858
+ - **Content-Type**: Not defined
2859
+ - **Accept**: application/json
2860
+
2861
+
2862
+ ## redeemReward
2863
+
2864
+ > LoyaltiesMembersRedemptionRedeemResponseBody redeemReward(memberId, loyaltiesMembersRedemptionRedeemRequestBody)
2865
+
2866
+ Redeem Reward
2867
+
2868
+ 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
2869
+
2870
+ ### Example
2871
+
2872
+ ```javascript
2873
+ import Voucherify from 'voucherify';
2874
+ let defaultClient = Voucherify.ApiClient.instance;
2875
+ // Configure API key authorization: X-App-Id
2876
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2877
+ X-App-Id.apiKey = 'YOUR API KEY';
2878
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2879
+ //X-App-Id.apiKeyPrefix = 'Token';
2880
+ // Configure API key authorization: X-App-Token
2881
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2882
+ X-App-Token.apiKey = 'YOUR API KEY';
2883
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2884
+ //X-App-Token.apiKeyPrefix = 'Token';
2885
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2886
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2887
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2888
+
2889
+ let apiInstance = new Voucherify.LoyaltiesApi();
2890
+ let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer.
2891
+ let loyaltiesMembersRedemptionRedeemRequestBody = {"reward":{"id":"rew_INt3fGH3n7xIr3ZQcq4kkUZ1","points":100},"order":{"items":[{"product_id":"prod_0c5d6689b39320059b","quantity":"1"},{"product_id":"prod_0b2c36568000039138","quantity":"2"}]}}; // LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.
2892
+ apiInstance.redeemReward(memberId, loyaltiesMembersRedemptionRedeemRequestBody, (error, data, response) => {
2893
+ if (error) {
2894
+ console.error(error);
2895
+ } else {
2896
+ console.log('API called successfully. Returned data: ' + data);
2897
+ }
2898
+ });
2899
+ ```
2900
+
2901
+ ### Parameters
2902
+
2903
+
2904
+ Name | Type | Description | Notes
2905
+ ------------- | ------------- | ------------- | -------------
2906
+ **memberId** | **String**| Unique loyalty card assigned to a particular customer. |
2907
+ **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md)| Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. |
2908
+
2909
+ ### Return type
2910
+
2911
+ [**LoyaltiesMembersRedemptionRedeemResponseBody**](LoyaltiesMembersRedemptionRedeemResponseBody.md)
2912
+
2913
+ ### Authorization
2914
+
2915
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2916
+
2917
+ ### HTTP request headers
2918
+
2919
+ - **Content-Type**: application/json
2920
+ - **Accept**: application/json
2921
+
2922
+
2923
+ ## redeemReward1
2924
+
2925
+ > LoyaltiesMembersRedemptionRedeemResponseBody redeemReward1(campaignId, memberId, loyaltiesMembersRedemptionRedeemRequestBody)
2926
+
2927
+ Redeem Reward with campaign ID
2928
+
2929
+ Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
2930
+
2931
+ ### Example
2932
+
2933
+ ```javascript
2934
+ import Voucherify from 'voucherify';
2935
+ let defaultClient = Voucherify.ApiClient.instance;
2936
+ // Configure API key authorization: X-App-Id
2937
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
2938
+ X-App-Id.apiKey = 'YOUR API KEY';
2939
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2940
+ //X-App-Id.apiKeyPrefix = 'Token';
2941
+ // Configure API key authorization: X-App-Token
2942
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
2943
+ X-App-Token.apiKey = 'YOUR API KEY';
2944
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2945
+ //X-App-Token.apiKeyPrefix = 'Token';
2946
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
2947
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
2948
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
2949
+
2950
+ let apiInstance = new Voucherify.LoyaltiesApi();
2951
+ let campaignId = "campaignId_example"; // String | Unique campaign ID.
2952
+ let memberId = "memberId_example"; // String | A code that identifies the loyalty card.
2953
+ let loyaltiesMembersRedemptionRedeemRequestBody = {"reward":{"id":"rew_INt3fGH3n7xIr3ZQcq4kkUZ1","points":100},"order":{"items":[{"product_id":"prod_0c5d6689b39320059b","quantity":"1"},{"product_id":"prod_0b2c36568000039138","quantity":"2"}]}}; // LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.
2954
+ apiInstance.redeemReward1(campaignId, memberId, loyaltiesMembersRedemptionRedeemRequestBody, (error, data, response) => {
2955
+ if (error) {
2956
+ console.error(error);
2957
+ } else {
2958
+ console.log('API called successfully. Returned data: ' + data);
2959
+ }
2960
+ });
2961
+ ```
2962
+
2963
+ ### Parameters
2964
+
2965
+
2966
+ Name | Type | Description | Notes
2967
+ ------------- | ------------- | ------------- | -------------
2968
+ **campaignId** | **String**| Unique campaign ID. |
2969
+ **memberId** | **String**| A code that identifies the loyalty card. |
2970
+ **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md)| Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. |
2971
+
2972
+ ### Return type
2973
+
2974
+ [**LoyaltiesMembersRedemptionRedeemResponseBody**](LoyaltiesMembersRedemptionRedeemResponseBody.md)
2975
+
2976
+ ### Authorization
2977
+
2978
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
2979
+
2980
+ ### HTTP request headers
2981
+
2982
+ - **Content-Type**: application/json
2983
+ - **Accept**: application/json
2984
+
2985
+
2986
+ ## transferPoints
2987
+
2988
+ > LoyaltiesMembersTransfersCreateResponseBody transferPoints(campaignId, memberId, loyaltiesTransferPoints)
2989
+
2990
+ Transfer Loyalty Points
2991
+
2992
+ Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules.
2993
+
2994
+ ### Example
2995
+
2996
+ ```javascript
2997
+ import Voucherify from 'voucherify';
2998
+ let defaultClient = Voucherify.ApiClient.instance;
2999
+ // Configure API key authorization: X-App-Id
3000
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
3001
+ X-App-Id.apiKey = 'YOUR API KEY';
3002
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3003
+ //X-App-Id.apiKeyPrefix = 'Token';
3004
+ // Configure API key authorization: X-App-Token
3005
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
3006
+ X-App-Token.apiKey = 'YOUR API KEY';
3007
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3008
+ //X-App-Token.apiKeyPrefix = 'Token';
3009
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
3010
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
3011
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
3012
+
3013
+ let apiInstance = new Voucherify.LoyaltiesApi();
3014
+ let campaignId = "campaignId_example"; // String | A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
3015
+ let memberId = "memberId_example"; // String | A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
3016
+ let loyaltiesTransferPoints = [{"code":"0PmQ7JQI","points":1},{"code":"kCeufB8i","points":1}]; // [LoyaltiesTransferPoints] | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
3017
+ apiInstance.transferPoints(campaignId, memberId, loyaltiesTransferPoints, (error, data, response) => {
3018
+ if (error) {
3019
+ console.error(error);
3020
+ } else {
3021
+ console.log('API called successfully. Returned data: ' + data);
3022
+ }
3023
+ });
3024
+ ```
3025
+
3026
+ ### Parameters
3027
+
3028
+
3029
+ Name | Type | Description | Notes
3030
+ ------------- | ------------- | ------------- | -------------
3031
+ **campaignId** | **String**| A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). |
3032
+ **memberId** | **String**| A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). |
3033
+ **loyaltiesTransferPoints** | [**[LoyaltiesTransferPoints]**](LoyaltiesTransferPoints.md)| Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. |
3034
+
3035
+ ### Return type
3036
+
3037
+ [**LoyaltiesMembersTransfersCreateResponseBody**](LoyaltiesMembersTransfersCreateResponseBody.md)
3038
+
3039
+ ### Authorization
3040
+
3041
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
3042
+
3043
+ ### HTTP request headers
3044
+
3045
+ - **Content-Type**: application/json
3046
+ - **Accept**: application/json
3047
+
3048
+
3049
+ ## updateEarningRule
3050
+
3051
+ > LoyaltiesEarningRulesUpdateResponseBody updateEarningRule(campaignId, earningRuleId, loyaltiesEarningRulesUpdateRequestBody)
3052
+
3053
+ Update Earning Rule
3054
+
3055
+ Update an earning rule definition.
3056
+
3057
+ ### Example
3058
+
3059
+ ```javascript
3060
+ import Voucherify from 'voucherify';
3061
+ let defaultClient = Voucherify.ApiClient.instance;
3062
+ // Configure API key authorization: X-App-Id
3063
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
3064
+ X-App-Id.apiKey = 'YOUR API KEY';
3065
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3066
+ //X-App-Id.apiKeyPrefix = 'Token';
3067
+ // Configure API key authorization: X-App-Token
3068
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
3069
+ X-App-Token.apiKey = 'YOUR API KEY';
3070
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3071
+ //X-App-Token.apiKeyPrefix = 'Token';
3072
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
3073
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
3074
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
3075
+
3076
+ let apiInstance = new Voucherify.LoyaltiesApi();
3077
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
3078
+ let earningRuleId = "earningRuleId_example"; // String | A unique earning rule ID.
3079
+ let loyaltiesEarningRulesUpdateRequestBody = {"validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"FIXED","points":"5"},"source":{"banner":"Order paid 5 points."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - fixed amount of points"}}; // LoyaltiesEarningRulesUpdateRequestBody | Specify the parameters that you would like to update for the given earning rule.
3080
+ apiInstance.updateEarningRule(campaignId, earningRuleId, loyaltiesEarningRulesUpdateRequestBody, (error, data, response) => {
3081
+ if (error) {
3082
+ console.error(error);
3083
+ } else {
3084
+ console.log('API called successfully. Returned data: ' + data);
3085
+ }
3086
+ });
3087
+ ```
3088
+
3089
+ ### Parameters
3090
+
3091
+
3092
+ Name | Type | Description | Notes
3093
+ ------------- | ------------- | ------------- | -------------
3094
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
3095
+ **earningRuleId** | **String**| A unique earning rule ID. |
3096
+ **loyaltiesEarningRulesUpdateRequestBody** | [**LoyaltiesEarningRulesUpdateRequestBody**](LoyaltiesEarningRulesUpdateRequestBody.md)| Specify the parameters that you would like to update for the given earning rule. |
3097
+
3098
+ ### Return type
3099
+
3100
+ [**LoyaltiesEarningRulesUpdateResponseBody**](LoyaltiesEarningRulesUpdateResponseBody.md)
3101
+
3102
+ ### Authorization
3103
+
3104
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
3105
+
3106
+ ### HTTP request headers
3107
+
3108
+ - **Content-Type**: application/json
3109
+ - **Accept**: application/json
3110
+
3111
+
3112
+ ## updateLoyaltyCardBalance
3113
+
3114
+ > LoyaltiesMembersBalanceUpdateResponseBody updateLoyaltyCardBalance(memberId, loyaltiesMembersBalanceUpdateRequestBody)
3115
+
3116
+ Adjust Loyalty Card Balance
3117
+
3118
+ This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.
3119
+
3120
+ ### Example
3121
+
3122
+ ```javascript
3123
+ import Voucherify from 'voucherify';
3124
+ let defaultClient = Voucherify.ApiClient.instance;
3125
+ // Configure API key authorization: X-App-Id
3126
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
3127
+ X-App-Id.apiKey = 'YOUR API KEY';
3128
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3129
+ //X-App-Id.apiKeyPrefix = 'Token';
3130
+ // Configure API key authorization: X-App-Token
3131
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
3132
+ X-App-Token.apiKey = 'YOUR API KEY';
3133
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3134
+ //X-App-Token.apiKeyPrefix = 'Token';
3135
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
3136
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
3137
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
3138
+
3139
+ let apiInstance = new Voucherify.LoyaltiesApi();
3140
+ let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer.
3141
+ let loyaltiesMembersBalanceUpdateRequestBody = {"points":-100}; // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism.
3142
+ apiInstance.updateLoyaltyCardBalance(memberId, loyaltiesMembersBalanceUpdateRequestBody, (error, data, response) => {
3143
+ if (error) {
3144
+ console.error(error);
3145
+ } else {
3146
+ console.log('API called successfully. Returned data: ' + data);
3147
+ }
3148
+ });
3149
+ ```
3150
+
3151
+ ### Parameters
3152
+
3153
+
3154
+ Name | Type | Description | Notes
3155
+ ------------- | ------------- | ------------- | -------------
3156
+ **memberId** | **String**| Unique loyalty card assigned to a particular customer. |
3157
+ **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md)| Specify the point adjustment along with the expiration mechanism. |
3158
+
3159
+ ### Return type
3160
+
3161
+ [**LoyaltiesMembersBalanceUpdateResponseBody**](LoyaltiesMembersBalanceUpdateResponseBody.md)
3162
+
3163
+ ### Authorization
3164
+
3165
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
3166
+
3167
+ ### HTTP request headers
3168
+
3169
+ - **Content-Type**: application/json
3170
+ - **Accept**: application/json
3171
+
3172
+
3173
+ ## updateLoyaltyCardBalance1
3174
+
3175
+ > LoyaltiesMembersBalanceUpdateResponseBody updateLoyaltyCardBalance1(campaignId, memberId, loyaltiesMembersBalanceUpdateRequestBody)
3176
+
3177
+ Adjust Loyalty Card Balance with campaign ID
3178
+
3179
+ This method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.
3180
+
3181
+ ### Example
3182
+
3183
+ ```javascript
3184
+ import Voucherify from 'voucherify';
3185
+ let defaultClient = Voucherify.ApiClient.instance;
3186
+ // Configure API key authorization: X-App-Id
3187
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
3188
+ X-App-Id.apiKey = 'YOUR API KEY';
3189
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3190
+ //X-App-Id.apiKeyPrefix = 'Token';
3191
+ // Configure API key authorization: X-App-Token
3192
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
3193
+ X-App-Token.apiKey = 'YOUR API KEY';
3194
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3195
+ //X-App-Token.apiKeyPrefix = 'Token';
3196
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
3197
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
3198
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
3199
+
3200
+ let apiInstance = new Voucherify.LoyaltiesApi();
3201
+ let campaignId = "campaignId_example"; // String | Unique campaign ID.
3202
+ let memberId = "memberId_example"; // String | A code that identifies the loyalty card.
3203
+ let loyaltiesMembersBalanceUpdateRequestBody = {"points":100,"expiration_type":"CUSTOM_DATE","expiration_date":"2023-05-30"}; // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism.
3204
+ apiInstance.updateLoyaltyCardBalance1(campaignId, memberId, loyaltiesMembersBalanceUpdateRequestBody, (error, data, response) => {
3205
+ if (error) {
3206
+ console.error(error);
3207
+ } else {
3208
+ console.log('API called successfully. Returned data: ' + data);
3209
+ }
3210
+ });
3211
+ ```
3212
+
3213
+ ### Parameters
3214
+
3215
+
3216
+ Name | Type | Description | Notes
3217
+ ------------- | ------------- | ------------- | -------------
3218
+ **campaignId** | **String**| Unique campaign ID. |
3219
+ **memberId** | **String**| A code that identifies the loyalty card. |
3220
+ **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md)| Specify the point adjustment along with the expiration mechanism. |
3221
+
3222
+ ### Return type
3223
+
3224
+ [**LoyaltiesMembersBalanceUpdateResponseBody**](LoyaltiesMembersBalanceUpdateResponseBody.md)
3225
+
3226
+ ### Authorization
3227
+
3228
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
3229
+
3230
+ ### HTTP request headers
3231
+
3232
+ - **Content-Type**: application/json
3233
+ - **Accept**: application/json
3234
+
3235
+
3236
+ ## updateLoyaltyProgram
3237
+
3238
+ > LoyaltiesUpdateCampaignResponseBody updateLoyaltyProgram(campaignId, loyaltiesUpdateCampaignRequestBody)
3239
+
3240
+ Update Loyalty Campaign
3241
+
3242
+ Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the [loyalty cards](/api-reference/loyalties/get-member) which have not been published or redeemed yet.
3243
+
3244
+ ### Example
3245
+
3246
+ ```javascript
3247
+ import Voucherify from 'voucherify';
3248
+ let defaultClient = Voucherify.ApiClient.instance;
3249
+ // Configure API key authorization: X-App-Id
3250
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
3251
+ X-App-Id.apiKey = 'YOUR API KEY';
3252
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3253
+ //X-App-Id.apiKeyPrefix = 'Token';
3254
+ // Configure API key authorization: X-App-Token
3255
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
3256
+ X-App-Token.apiKey = 'YOUR API KEY';
3257
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3258
+ //X-App-Token.apiKeyPrefix = 'Token';
3259
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
3260
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
3261
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
3262
+
3263
+ let apiInstance = new Voucherify.LoyaltiesApi();
3264
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
3265
+ let loyaltiesUpdateCampaignRequestBody = {"description":"This is a campaign description. Updated","auto_join":false,"join_once":false,"start_date":"2013-10-26T00:00:00Z","expiration_date":"2025-10-26T00:00:00Z","validity_timeframe":{"duration":"PT2H","interval":"P2D"},"validity_day_of_week":[0,1,2,3,4,5,6],"activity_duration_after_publishing":"P25D","category_id":"cat_0b6152ce12414820dd","loyalty_card":{"points":1,"expiration_rules":{"period_type":"MONTH","period_value":4,"rounding_type":"END_OF_YEAR"}},"metadata":{"test":false},"type":"AUTO_UPDATE","loyalty_tiers_expiration":{"qualification_type":"BALANCE","start_date":{"type":"IMMEDIATE"},"expiration_date":{"type":"CUSTOM","extend":"P4M","rounding":{"type":"CUSTOM","unit":"MONTH","value":1}}}}; // LoyaltiesUpdateCampaignRequestBody | Specify the new values for the parameters that you would like to update for the given loyalty campaign.
3266
+ apiInstance.updateLoyaltyProgram(campaignId, loyaltiesUpdateCampaignRequestBody, (error, data, response) => {
3267
+ if (error) {
3268
+ console.error(error);
3269
+ } else {
3270
+ console.log('API called successfully. Returned data: ' + data);
3271
+ }
3272
+ });
3273
+ ```
3274
+
3275
+ ### Parameters
3276
+
3277
+
3278
+ Name | Type | Description | Notes
3279
+ ------------- | ------------- | ------------- | -------------
3280
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
3281
+ **loyaltiesUpdateCampaignRequestBody** | [**LoyaltiesUpdateCampaignRequestBody**](LoyaltiesUpdateCampaignRequestBody.md)| Specify the new values for the parameters that you would like to update for the given loyalty campaign. |
3282
+
3283
+ ### Return type
3284
+
3285
+ [**LoyaltiesUpdateCampaignResponseBody**](LoyaltiesUpdateCampaignResponseBody.md)
3286
+
3287
+ ### Authorization
3288
+
3289
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
3290
+
3291
+ ### HTTP request headers
3292
+
3293
+ - **Content-Type**: application/json
3294
+ - **Accept**: application/json
3295
+
3296
+
3297
+ ## updateRewardAssignment1
3298
+
3299
+ > LoyaltiesRewardsUpdateAssignmentResponseBody updateRewardAssignment1(campaignId, assignmentId, loyaltiesRewardsUpdateAssignmentRequestBody)
3300
+
3301
+ Update Campaign Reward Assignment
3302
+
3303
+ Updates rewards parameters, i.e. the points cost for the specific reward.
3304
+
3305
+ ### Example
3306
+
3307
+ ```javascript
3308
+ import Voucherify from 'voucherify';
3309
+ let defaultClient = Voucherify.ApiClient.instance;
3310
+ // Configure API key authorization: X-App-Id
3311
+ let X-App-Id = defaultClient.authentications['X-App-Id'];
3312
+ X-App-Id.apiKey = 'YOUR API KEY';
3313
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3314
+ //X-App-Id.apiKeyPrefix = 'Token';
3315
+ // Configure API key authorization: X-App-Token
3316
+ let X-App-Token = defaultClient.authentications['X-App-Token'];
3317
+ X-App-Token.apiKey = 'YOUR API KEY';
3318
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3319
+ //X-App-Token.apiKeyPrefix = 'Token';
3320
+ // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
3321
+ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
3322
+ X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
3323
+
3324
+ let apiInstance = new Voucherify.LoyaltiesApi();
3325
+ let campaignId = "campaignId_example"; // String | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
3326
+ let assignmentId = "assignmentId_example"; // String | A unique reward assignment ID.
3327
+ let loyaltiesRewardsUpdateAssignmentRequestBody = {"parameters":{"loyalty":{"points":3}}}; // LoyaltiesRewardsUpdateAssignmentRequestBody | Update the points cost for the reward assignment.
3328
+ apiInstance.updateRewardAssignment1(campaignId, assignmentId, loyaltiesRewardsUpdateAssignmentRequestBody, (error, data, response) => {
3329
+ if (error) {
3330
+ console.error(error);
3331
+ } else {
3332
+ console.log('API called successfully. Returned data: ' + data);
3333
+ }
3334
+ });
3335
+ ```
3336
+
3337
+ ### Parameters
3338
+
3339
+
3340
+ Name | Type | Description | Notes
3341
+ ------------- | ------------- | ------------- | -------------
3342
+ **campaignId** | **String**| The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. |
3343
+ **assignmentId** | **String**| A unique reward assignment ID. |
3344
+ **loyaltiesRewardsUpdateAssignmentRequestBody** | [**LoyaltiesRewardsUpdateAssignmentRequestBody**](LoyaltiesRewardsUpdateAssignmentRequestBody.md)| Update the points cost for the reward assignment. |
3345
+
3346
+ ### Return type
3347
+
3348
+ [**LoyaltiesRewardsUpdateAssignmentResponseBody**](LoyaltiesRewardsUpdateAssignmentResponseBody.md)
3349
+
3350
+ ### Authorization
3351
+
3352
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
3353
+
3354
+ ### HTTP request headers
3355
+
3356
+ - **Content-Type**: application/json
3357
+ - **Accept**: application/json
3358
+