@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,2248 @@
1
+ # Voucherify.ManagementApi
2
+
3
+ All URIs are relative to *https://api.voucherify.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**assignUser**](ManagementApi.md#assignUser) | **POST** /management/v1/projects/{projectId}/users | Assign User
8
+ [**createBrand**](ManagementApi.md#createBrand) | **POST** /management/v1/projects/{projectId}/branding | Create Brand
9
+ [**createCustomEventSchema**](ManagementApi.md#createCustomEventSchema) | **POST** /management/v1/projects/{projectId}/custom-event-schemas | Create Custom Event Schema
10
+ [**createMetadataSchema**](ManagementApi.md#createMetadataSchema) | **POST** /management/v1/projects/{projectId}/metadata-schemas | Create Metadata Schema
11
+ [**createProject**](ManagementApi.md#createProject) | **POST** /management/v1/projects | Create Project
12
+ [**createStackingRules**](ManagementApi.md#createStackingRules) | **POST** /management/v1/projects/{projectId}/stacking-rules | Create Stacking Rules
13
+ [**createWebhook**](ManagementApi.md#createWebhook) | **POST** /management/v1/projects/{projectId}/webhooks | Create Webhook
14
+ [**deleteBrand**](ManagementApi.md#deleteBrand) | **DELETE** /management/v1/projects/{projectId}/branding/{brandingId} | Delete Brand
15
+ [**deleteCustomEventSchema**](ManagementApi.md#deleteCustomEventSchema) | **DELETE** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Delete Custom Event Schema
16
+ [**deleteMetadataSchema**](ManagementApi.md#deleteMetadataSchema) | **DELETE** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Delete Metadata Schema
17
+ [**deleteProject**](ManagementApi.md#deleteProject) | **DELETE** /management/v1/projects/{projectId} | Delete Project
18
+ [**deleteStackingRules**](ManagementApi.md#deleteStackingRules) | **DELETE** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Delete Stacking Rules
19
+ [**deleteWebhook**](ManagementApi.md#deleteWebhook) | **DELETE** /management/v1/projects/{projectId}/webhooks/{webhookId} | Delete Webhook
20
+ [**getBrand**](ManagementApi.md#getBrand) | **GET** /management/v1/projects/{projectId}/branding/{brandingId} | Get Brand
21
+ [**getCustomEventSchema**](ManagementApi.md#getCustomEventSchema) | **GET** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Get Custom Event Schema
22
+ [**getMetadataSchema1**](ManagementApi.md#getMetadataSchema1) | **GET** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Get Metadata Schema
23
+ [**getProject**](ManagementApi.md#getProject) | **GET** /management/v1/projects/{projectId} | Get Project
24
+ [**getStackingRules**](ManagementApi.md#getStackingRules) | **GET** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Get Stacking Rules
25
+ [**getUser**](ManagementApi.md#getUser) | **GET** /management/v1/projects/{projectId}/users/{userId} | Get User
26
+ [**getWebhook**](ManagementApi.md#getWebhook) | **GET** /management/v1/projects/{projectId}/webhooks/{webhookId} | Get Webhook
27
+ [**inviteUser**](ManagementApi.md#inviteUser) | **POST** /management/v1/projects/users/invite | Invite a New User
28
+ [**listBrands**](ManagementApi.md#listBrands) | **GET** /management/v1/projects/{projectId}/branding | List Brands
29
+ [**listCustomEventSchemas**](ManagementApi.md#listCustomEventSchemas) | **GET** /management/v1/projects/{projectId}/custom-event-schemas | List Custom Event Schemas
30
+ [**listMetadataSchemas1**](ManagementApi.md#listMetadataSchemas1) | **GET** /management/v1/projects/{projectId}/metadata-schemas | List Metadata Schemas
31
+ [**listProjects**](ManagementApi.md#listProjects) | **GET** /management/v1/projects | List Projects
32
+ [**listStackingRules**](ManagementApi.md#listStackingRules) | **GET** /management/v1/projects/{projectId}/stacking-rules | List Stacking Rules
33
+ [**listUsers**](ManagementApi.md#listUsers) | **GET** /management/v1/projects/{projectId}/users | List Users
34
+ [**listWebhooks**](ManagementApi.md#listWebhooks) | **GET** /management/v1/projects/{projectId}/webhooks | List Webhooks
35
+ [**managementCopyCampaignTemplate**](ManagementApi.md#managementCopyCampaignTemplate) | **POST** /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy | Copy Campaign Template to a Project
36
+ [**managementListCampaignTemplates**](ManagementApi.md#managementListCampaignTemplates) | **GET** /management/v1/projects/{projectId}/templates/campaigns | List Campaign Templates
37
+ [**unassignUser**](ManagementApi.md#unassignUser) | **DELETE** /management/v1/projects/{projectId}/users/{userId} | Unassign User
38
+ [**updateBrand**](ManagementApi.md#updateBrand) | **PUT** /management/v1/projects/{projectId}/branding/{brandingId} | Update Brand
39
+ [**updateCustomEventSchema**](ManagementApi.md#updateCustomEventSchema) | **PUT** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Update Custom Event Schema
40
+ [**updateMetadataSchema**](ManagementApi.md#updateMetadataSchema) | **PUT** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Update Metadata Schema
41
+ [**updateProject**](ManagementApi.md#updateProject) | **PUT** /management/v1/projects/{projectId} | Update Project
42
+ [**updateStackingRules**](ManagementApi.md#updateStackingRules) | **PUT** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Update Stacking Rules
43
+ [**updateUser**](ManagementApi.md#updateUser) | **PUT** /management/v1/projects/{projectId}/users/{userId} | Update User
44
+ [**updateWebhook**](ManagementApi.md#updateWebhook) | **PUT** /management/v1/projects/{projectId}/webhooks/{webhookId} | Update Webhook
45
+
46
+
47
+
48
+ ## assignUser
49
+
50
+ > ManagementProjectsUsersAssignResponseBody assignUser(projectId, managementProjectsUsersAssignRequestBody)
51
+
52
+ Assign User
53
+
54
+ Assigns a user to a given project. The user must be an existing user in Voucherify. 🚧 Correct Use of Data To avoid errors, use the role key with either id or login keys.
55
+
56
+ ### Example
57
+
58
+ ```javascript
59
+ import Voucherify from 'voucherify';
60
+ let defaultClient = Voucherify.ApiClient.instance;
61
+ // Configure API key authorization: X-Management-Token
62
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
63
+ X-Management-Token.apiKey = 'YOUR API KEY';
64
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
65
+ //X-Management-Token.apiKeyPrefix = 'Token';
66
+ // Configure API key authorization: X-Management-Id
67
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
68
+ X-Management-Id.apiKey = 'YOUR API KEY';
69
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
70
+ //X-Management-Id.apiKeyPrefix = 'Token';
71
+
72
+ let apiInstance = new Voucherify.ManagementApi();
73
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
74
+ let managementProjectsUsersAssignRequestBody = new Voucherify.ManagementProjectsUsersAssignRequestBody(); // ManagementProjectsUsersAssignRequestBody | Defines the user details.
75
+ apiInstance.assignUser(projectId, managementProjectsUsersAssignRequestBody, (error, data, response) => {
76
+ if (error) {
77
+ console.error(error);
78
+ } else {
79
+ console.log('API called successfully. Returned data: ' + data);
80
+ }
81
+ });
82
+ ```
83
+
84
+ ### Parameters
85
+
86
+
87
+ Name | Type | Description | Notes
88
+ ------------- | ------------- | ------------- | -------------
89
+ **projectId** | **String**| Provide the unique identifier of the project. |
90
+ **managementProjectsUsersAssignRequestBody** | [**ManagementProjectsUsersAssignRequestBody**](ManagementProjectsUsersAssignRequestBody.md)| Defines the user details. |
91
+
92
+ ### Return type
93
+
94
+ [**ManagementProjectsUsersAssignResponseBody**](ManagementProjectsUsersAssignResponseBody.md)
95
+
96
+ ### Authorization
97
+
98
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
99
+
100
+ ### HTTP request headers
101
+
102
+ - **Content-Type**: application/json
103
+ - **Accept**: application/json
104
+
105
+
106
+ ## createBrand
107
+
108
+ > ManagementProjectsBrandingCreateResponseBody createBrand(projectId, managementProjectsBrandingCreateRequestBody)
109
+
110
+ Create Brand
111
+
112
+ Creates a new brand configuration. You can have only one brand configured for a project. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.
113
+
114
+ ### Example
115
+
116
+ ```javascript
117
+ import Voucherify from 'voucherify';
118
+ let defaultClient = Voucherify.ApiClient.instance;
119
+ // Configure API key authorization: X-Management-Token
120
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
121
+ X-Management-Token.apiKey = 'YOUR API KEY';
122
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
123
+ //X-Management-Token.apiKeyPrefix = 'Token';
124
+ // Configure API key authorization: X-Management-Id
125
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
126
+ X-Management-Id.apiKey = 'YOUR API KEY';
127
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
128
+ //X-Management-Id.apiKeyPrefix = 'Token';
129
+
130
+ let apiInstance = new Voucherify.ManagementApi();
131
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
132
+ let managementProjectsBrandingCreateRequestBody = {"brand":{"name":"Voucherify PSA","privacy_policy_url":null,"terms_of_use_url":null,"permission_reminder":"You are receiving this email because you opted in at our website.","website_url":"voucherify.io"},"address":{"street":"Porcelanowa 23","city":"Katowice","postal":"43-246","state":null,"country":"Poland"},"contact":{"email":"support@voucherify.io","phone":null},"cockpits":{"campaigns_overview_enabled":false,"loyalty_enabled":true,"gift_cards_enabled":true,"coupons_enabled":true,"referrals_enabled":true,"theme":"default","use_custom_double_opt_in_redirect_url":false,"custom_double_opt_in_redirect_url":null}}; // ManagementProjectsBrandingCreateRequestBody | Defines a brand configuration.
133
+ apiInstance.createBrand(projectId, managementProjectsBrandingCreateRequestBody, (error, data, response) => {
134
+ if (error) {
135
+ console.error(error);
136
+ } else {
137
+ console.log('API called successfully. Returned data: ' + data);
138
+ }
139
+ });
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+
145
+ Name | Type | Description | Notes
146
+ ------------- | ------------- | ------------- | -------------
147
+ **projectId** | **String**| Provide the unique identifier of the project. |
148
+ **managementProjectsBrandingCreateRequestBody** | [**ManagementProjectsBrandingCreateRequestBody**](ManagementProjectsBrandingCreateRequestBody.md)| Defines a brand configuration. |
149
+
150
+ ### Return type
151
+
152
+ [**ManagementProjectsBrandingCreateResponseBody**](ManagementProjectsBrandingCreateResponseBody.md)
153
+
154
+ ### Authorization
155
+
156
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
157
+
158
+ ### HTTP request headers
159
+
160
+ - **Content-Type**: application/json
161
+ - **Accept**: application/json
162
+
163
+
164
+ ## createCustomEventSchema
165
+
166
+ > ManagementProjectsCustomEventSchemasCreateResponseBody createCustomEventSchema(projectId, managementProjectsCustomEventSchemasCreateRequestBody)
167
+
168
+ Create Custom Event Schema
169
+
170
+ Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
171
+
172
+ ### Example
173
+
174
+ ```javascript
175
+ import Voucherify from 'voucherify';
176
+ let defaultClient = Voucherify.ApiClient.instance;
177
+ // Configure API key authorization: X-Management-Token
178
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
179
+ X-Management-Token.apiKey = 'YOUR API KEY';
180
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
181
+ //X-Management-Token.apiKeyPrefix = 'Token';
182
+ // Configure API key authorization: X-Management-Id
183
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
184
+ X-Management-Id.apiKey = 'YOUR API KEY';
185
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
186
+ //X-Management-Id.apiKeyPrefix = 'Token';
187
+
188
+ let apiInstance = new Voucherify.ManagementApi();
189
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
190
+ let managementProjectsCustomEventSchemasCreateRequestBody = new Voucherify.ManagementProjectsCustomEventSchemasCreateRequestBody(); // ManagementProjectsCustomEventSchemasCreateRequestBody | Defines the custom event schema.
191
+ apiInstance.createCustomEventSchema(projectId, managementProjectsCustomEventSchemasCreateRequestBody, (error, data, response) => {
192
+ if (error) {
193
+ console.error(error);
194
+ } else {
195
+ console.log('API called successfully. Returned data: ' + data);
196
+ }
197
+ });
198
+ ```
199
+
200
+ ### Parameters
201
+
202
+
203
+ Name | Type | Description | Notes
204
+ ------------- | ------------- | ------------- | -------------
205
+ **projectId** | **String**| Provide the unique identifier of the project. |
206
+ **managementProjectsCustomEventSchemasCreateRequestBody** | [**ManagementProjectsCustomEventSchemasCreateRequestBody**](ManagementProjectsCustomEventSchemasCreateRequestBody.md)| Defines the custom event schema. |
207
+
208
+ ### Return type
209
+
210
+ [**ManagementProjectsCustomEventSchemasCreateResponseBody**](ManagementProjectsCustomEventSchemasCreateResponseBody.md)
211
+
212
+ ### Authorization
213
+
214
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
215
+
216
+ ### HTTP request headers
217
+
218
+ - **Content-Type**: application/json
219
+ - **Accept**: application/json
220
+
221
+
222
+ ## createMetadataSchema
223
+
224
+ > ManagementProjectsMetadataSchemasCreateResponseBody createMetadataSchema(projectId, managementProjectsMetadataSchemasCreateRequestBody)
225
+
226
+ Create Metadata Schema
227
+
228
+ Creates a new metadata (custom attribute) schema for a given resource. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cant include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward Use this endpoint to define a metadata schema of a given resource for the first time. Once you configure a metadata schema for a given related_object, use the PUT [Update metadata schema](/api-reference/management/update-metadata-schema) endpoint to either update or add new metadata key-value pairs. For example, use this endpoint to define a metadata schema for related_object: campaign for the first time. If you want define a new metadata property for campaign, use the [PUT Update metadata schema](/api-reference/management/update-metadata-schema) endpoint. 📘 Metadata Documentation Read [the Getting Started with Metadata](https://support.voucherify.io/article/99-schema-validation-metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
229
+
230
+ ### Example
231
+
232
+ ```javascript
233
+ import Voucherify from 'voucherify';
234
+ let defaultClient = Voucherify.ApiClient.instance;
235
+ // Configure API key authorization: X-Management-Token
236
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
237
+ X-Management-Token.apiKey = 'YOUR API KEY';
238
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
239
+ //X-Management-Token.apiKeyPrefix = 'Token';
240
+ // Configure API key authorization: X-Management-Id
241
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
242
+ X-Management-Id.apiKey = 'YOUR API KEY';
243
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
244
+ //X-Management-Id.apiKeyPrefix = 'Token';
245
+
246
+ let apiInstance = new Voucherify.ManagementApi();
247
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
248
+ let managementProjectsMetadataSchemasCreateRequestBody = new Voucherify.ManagementProjectsMetadataSchemasCreateRequestBody(); // ManagementProjectsMetadataSchemasCreateRequestBody | Defines the metadata schema.
249
+ apiInstance.createMetadataSchema(projectId, managementProjectsMetadataSchemasCreateRequestBody, (error, data, response) => {
250
+ if (error) {
251
+ console.error(error);
252
+ } else {
253
+ console.log('API called successfully. Returned data: ' + data);
254
+ }
255
+ });
256
+ ```
257
+
258
+ ### Parameters
259
+
260
+
261
+ Name | Type | Description | Notes
262
+ ------------- | ------------- | ------------- | -------------
263
+ **projectId** | **String**| Provide the unique identifier of the project. |
264
+ **managementProjectsMetadataSchemasCreateRequestBody** | [**ManagementProjectsMetadataSchemasCreateRequestBody**](ManagementProjectsMetadataSchemasCreateRequestBody.md)| Defines the metadata schema. |
265
+
266
+ ### Return type
267
+
268
+ [**ManagementProjectsMetadataSchemasCreateResponseBody**](ManagementProjectsMetadataSchemasCreateResponseBody.md)
269
+
270
+ ### Authorization
271
+
272
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
273
+
274
+ ### HTTP request headers
275
+
276
+ - **Content-Type**: application/json
277
+ - **Accept**: application/json
278
+
279
+
280
+ ## createProject
281
+
282
+ > ManagementProjectsCreateResponseBody createProject(managementProjectsCreateRequestBody)
283
+
284
+ Create Project
285
+
286
+ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default.
287
+
288
+ ### Example
289
+
290
+ ```javascript
291
+ import Voucherify from 'voucherify';
292
+ let defaultClient = Voucherify.ApiClient.instance;
293
+ // Configure API key authorization: X-Management-Token
294
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
295
+ X-Management-Token.apiKey = 'YOUR API KEY';
296
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
297
+ //X-Management-Token.apiKeyPrefix = 'Token';
298
+ // Configure API key authorization: X-Management-Id
299
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
300
+ X-Management-Id.apiKey = 'YOUR API KEY';
301
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
302
+ //X-Management-Id.apiKeyPrefix = 'Token';
303
+
304
+ let apiInstance = new Voucherify.ManagementApi();
305
+ let managementProjectsCreateRequestBody = new Voucherify.ManagementProjectsCreateRequestBody(); // ManagementProjectsCreateRequestBody | Define project details.
306
+ apiInstance.createProject(managementProjectsCreateRequestBody, (error, data, response) => {
307
+ if (error) {
308
+ console.error(error);
309
+ } else {
310
+ console.log('API called successfully. Returned data: ' + data);
311
+ }
312
+ });
313
+ ```
314
+
315
+ ### Parameters
316
+
317
+
318
+ Name | Type | Description | Notes
319
+ ------------- | ------------- | ------------- | -------------
320
+ **managementProjectsCreateRequestBody** | [**ManagementProjectsCreateRequestBody**](ManagementProjectsCreateRequestBody.md)| Define project details. |
321
+
322
+ ### Return type
323
+
324
+ [**ManagementProjectsCreateResponseBody**](ManagementProjectsCreateResponseBody.md)
325
+
326
+ ### Authorization
327
+
328
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
329
+
330
+ ### HTTP request headers
331
+
332
+ - **Content-Type**: application/json
333
+ - **Accept**: application/json
334
+
335
+
336
+ ## createStackingRules
337
+
338
+ > ManagementProjectsStackingRulesCreateResponseBody createStackingRules(projectId, managementProjectsStackingRulesCreateRequestBody)
339
+
340
+ Create Stacking Rules
341
+
342
+ Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use [Update stacking rules](/api-reference/management/update-stacking-rules) endpoint to change the rules. 📘 Stacking rules documentation Read [the Stacking rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
343
+
344
+ ### Example
345
+
346
+ ```javascript
347
+ import Voucherify from 'voucherify';
348
+ let defaultClient = Voucherify.ApiClient.instance;
349
+ // Configure API key authorization: X-Management-Token
350
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
351
+ X-Management-Token.apiKey = 'YOUR API KEY';
352
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
353
+ //X-Management-Token.apiKeyPrefix = 'Token';
354
+ // Configure API key authorization: X-Management-Id
355
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
356
+ X-Management-Id.apiKey = 'YOUR API KEY';
357
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
358
+ //X-Management-Id.apiKeyPrefix = 'Token';
359
+
360
+ let apiInstance = new Voucherify.ManagementApi();
361
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
362
+ let managementProjectsStackingRulesCreateRequestBody = new Voucherify.ManagementProjectsStackingRulesCreateRequestBody(); // ManagementProjectsStackingRulesCreateRequestBody | Defines the stacking rule parameters.
363
+ apiInstance.createStackingRules(projectId, managementProjectsStackingRulesCreateRequestBody, (error, data, response) => {
364
+ if (error) {
365
+ console.error(error);
366
+ } else {
367
+ console.log('API called successfully. Returned data: ' + data);
368
+ }
369
+ });
370
+ ```
371
+
372
+ ### Parameters
373
+
374
+
375
+ Name | Type | Description | Notes
376
+ ------------- | ------------- | ------------- | -------------
377
+ **projectId** | **String**| Provide the unique identifier of the project. |
378
+ **managementProjectsStackingRulesCreateRequestBody** | [**ManagementProjectsStackingRulesCreateRequestBody**](ManagementProjectsStackingRulesCreateRequestBody.md)| Defines the stacking rule parameters. |
379
+
380
+ ### Return type
381
+
382
+ [**ManagementProjectsStackingRulesCreateResponseBody**](ManagementProjectsStackingRulesCreateResponseBody.md)
383
+
384
+ ### Authorization
385
+
386
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
387
+
388
+ ### HTTP request headers
389
+
390
+ - **Content-Type**: application/json
391
+ - **Accept**: application/json
392
+
393
+
394
+ ## createWebhook
395
+
396
+ > ManagementProjectsWebhooksCreateResponseBody createWebhook(projectId, managementProjectsWebhooksCreateRequestBody)
397
+
398
+ Create Webhook
399
+
400
+ Creates a new webhook configuration. 📘 Webhook Documentation Read [Webhooks v2024-01-01](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
401
+
402
+ ### Example
403
+
404
+ ```javascript
405
+ import Voucherify from 'voucherify';
406
+ let defaultClient = Voucherify.ApiClient.instance;
407
+ // Configure API key authorization: X-Management-Token
408
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
409
+ X-Management-Token.apiKey = 'YOUR API KEY';
410
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
411
+ //X-Management-Token.apiKeyPrefix = 'Token';
412
+ // Configure API key authorization: X-Management-Id
413
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
414
+ X-Management-Id.apiKey = 'YOUR API KEY';
415
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
416
+ //X-Management-Id.apiKeyPrefix = 'Token';
417
+
418
+ let apiInstance = new Voucherify.ManagementApi();
419
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
420
+ let managementProjectsWebhooksCreateRequestBody = new Voucherify.ManagementProjectsWebhooksCreateRequestBody(); // ManagementProjectsWebhooksCreateRequestBody | Defines a webhook configuration.
421
+ apiInstance.createWebhook(projectId, managementProjectsWebhooksCreateRequestBody, (error, data, response) => {
422
+ if (error) {
423
+ console.error(error);
424
+ } else {
425
+ console.log('API called successfully. Returned data: ' + data);
426
+ }
427
+ });
428
+ ```
429
+
430
+ ### Parameters
431
+
432
+
433
+ Name | Type | Description | Notes
434
+ ------------- | ------------- | ------------- | -------------
435
+ **projectId** | **String**| Provide the unique identifier of the project. |
436
+ **managementProjectsWebhooksCreateRequestBody** | [**ManagementProjectsWebhooksCreateRequestBody**](ManagementProjectsWebhooksCreateRequestBody.md)| Defines a webhook configuration. |
437
+
438
+ ### Return type
439
+
440
+ [**ManagementProjectsWebhooksCreateResponseBody**](ManagementProjectsWebhooksCreateResponseBody.md)
441
+
442
+ ### Authorization
443
+
444
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
445
+
446
+ ### HTTP request headers
447
+
448
+ - **Content-Type**: application/json
449
+ - **Accept**: application/json
450
+
451
+
452
+ ## deleteBrand
453
+
454
+ > deleteBrand(projectId, brandingId)
455
+
456
+ Delete Brand
457
+
458
+ Deletes permanently a brand configuration.
459
+
460
+ ### Example
461
+
462
+ ```javascript
463
+ import Voucherify from 'voucherify';
464
+ let defaultClient = Voucherify.ApiClient.instance;
465
+ // Configure API key authorization: X-Management-Token
466
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
467
+ X-Management-Token.apiKey = 'YOUR API KEY';
468
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
469
+ //X-Management-Token.apiKeyPrefix = 'Token';
470
+ // Configure API key authorization: X-Management-Id
471
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
472
+ X-Management-Id.apiKey = 'YOUR API KEY';
473
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
474
+ //X-Management-Id.apiKeyPrefix = 'Token';
475
+
476
+ let apiInstance = new Voucherify.ManagementApi();
477
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
478
+ let brandingId = "brandingId_example"; // String | Provide the unique identifier of the brand configuration.
479
+ apiInstance.deleteBrand(projectId, brandingId, (error, data, response) => {
480
+ if (error) {
481
+ console.error(error);
482
+ } else {
483
+ console.log('API called successfully.');
484
+ }
485
+ });
486
+ ```
487
+
488
+ ### Parameters
489
+
490
+
491
+ Name | Type | Description | Notes
492
+ ------------- | ------------- | ------------- | -------------
493
+ **projectId** | **String**| Provide the unique identifier of the project. |
494
+ **brandingId** | **String**| Provide the unique identifier of the brand configuration. |
495
+
496
+ ### Return type
497
+
498
+ null (empty response body)
499
+
500
+ ### Authorization
501
+
502
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
503
+
504
+ ### HTTP request headers
505
+
506
+ - **Content-Type**: Not defined
507
+ - **Accept**: Not defined
508
+
509
+
510
+ ## deleteCustomEventSchema
511
+
512
+ > deleteCustomEventSchema(projectId, customEventSchemaId)
513
+
514
+ Delete Custom Event Schema
515
+
516
+ Deletes permanently the custom event schema with its custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
517
+
518
+ ### Example
519
+
520
+ ```javascript
521
+ import Voucherify from 'voucherify';
522
+ let defaultClient = Voucherify.ApiClient.instance;
523
+ // Configure API key authorization: X-Management-Token
524
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
525
+ X-Management-Token.apiKey = 'YOUR API KEY';
526
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
527
+ //X-Management-Token.apiKeyPrefix = 'Token';
528
+ // Configure API key authorization: X-Management-Id
529
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
530
+ X-Management-Id.apiKey = 'YOUR API KEY';
531
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
532
+ //X-Management-Id.apiKeyPrefix = 'Token';
533
+
534
+ let apiInstance = new Voucherify.ManagementApi();
535
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
536
+ let customEventSchemaId = "customEventSchemaId_example"; // String | Provide the unique identifier of the custom event schema.
537
+ apiInstance.deleteCustomEventSchema(projectId, customEventSchemaId, (error, data, response) => {
538
+ if (error) {
539
+ console.error(error);
540
+ } else {
541
+ console.log('API called successfully.');
542
+ }
543
+ });
544
+ ```
545
+
546
+ ### Parameters
547
+
548
+
549
+ Name | Type | Description | Notes
550
+ ------------- | ------------- | ------------- | -------------
551
+ **projectId** | **String**| Provide the unique identifier of the project. |
552
+ **customEventSchemaId** | **String**| Provide the unique identifier of the custom event schema. |
553
+
554
+ ### Return type
555
+
556
+ null (empty response body)
557
+
558
+ ### Authorization
559
+
560
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
561
+
562
+ ### HTTP request headers
563
+
564
+ - **Content-Type**: Not defined
565
+ - **Accept**: Not defined
566
+
567
+
568
+ ## deleteMetadataSchema
569
+
570
+ > deleteMetadataSchema(projectId, metadataSchemaId)
571
+
572
+ Delete Metadata Schema
573
+
574
+ Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the [Create Metadata Schema](/api-reference/management/create-metadata-schema) endpoint. 🚧 Metadata Purging This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify. 📘 Metadata Documentation Read [the Getting Started with Metadata](https://support.voucherify.io/article/99-schema-validation-metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
575
+
576
+ ### Example
577
+
578
+ ```javascript
579
+ import Voucherify from 'voucherify';
580
+ let defaultClient = Voucherify.ApiClient.instance;
581
+ // Configure API key authorization: X-Management-Token
582
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
583
+ X-Management-Token.apiKey = 'YOUR API KEY';
584
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
585
+ //X-Management-Token.apiKeyPrefix = 'Token';
586
+ // Configure API key authorization: X-Management-Id
587
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
588
+ X-Management-Id.apiKey = 'YOUR API KEY';
589
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
590
+ //X-Management-Id.apiKeyPrefix = 'Token';
591
+
592
+ let apiInstance = new Voucherify.ManagementApi();
593
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
594
+ let metadataSchemaId = "metadataSchemaId_example"; // String | Provide the unique identifier of the metadata schema.
595
+ apiInstance.deleteMetadataSchema(projectId, metadataSchemaId, (error, data, response) => {
596
+ if (error) {
597
+ console.error(error);
598
+ } else {
599
+ console.log('API called successfully.');
600
+ }
601
+ });
602
+ ```
603
+
604
+ ### Parameters
605
+
606
+
607
+ Name | Type | Description | Notes
608
+ ------------- | ------------- | ------------- | -------------
609
+ **projectId** | **String**| Provide the unique identifier of the project. |
610
+ **metadataSchemaId** | **String**| Provide the unique identifier of the metadata schema. |
611
+
612
+ ### Return type
613
+
614
+ null (empty response body)
615
+
616
+ ### Authorization
617
+
618
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
619
+
620
+ ### HTTP request headers
621
+
622
+ - **Content-Type**: Not defined
623
+ - **Accept**: Not defined
624
+
625
+
626
+ ## deleteProject
627
+
628
+ > deleteProject(projectId)
629
+
630
+ Delete Project
631
+
632
+ Deletes an existing project. The users currently using the deleted project will be automatically logged out. 🚧 Sandbox Project The sandbox project cannot be deleted.
633
+
634
+ ### Example
635
+
636
+ ```javascript
637
+ import Voucherify from 'voucherify';
638
+ let defaultClient = Voucherify.ApiClient.instance;
639
+ // Configure API key authorization: X-Management-Token
640
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
641
+ X-Management-Token.apiKey = 'YOUR API KEY';
642
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
643
+ //X-Management-Token.apiKeyPrefix = 'Token';
644
+ // Configure API key authorization: X-Management-Id
645
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
646
+ X-Management-Id.apiKey = 'YOUR API KEY';
647
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
648
+ //X-Management-Id.apiKeyPrefix = 'Token';
649
+
650
+ let apiInstance = new Voucherify.ManagementApi();
651
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
652
+ apiInstance.deleteProject(projectId, (error, data, response) => {
653
+ if (error) {
654
+ console.error(error);
655
+ } else {
656
+ console.log('API called successfully.');
657
+ }
658
+ });
659
+ ```
660
+
661
+ ### Parameters
662
+
663
+
664
+ Name | Type | Description | Notes
665
+ ------------- | ------------- | ------------- | -------------
666
+ **projectId** | **String**| Provide the unique identifier of the project. |
667
+
668
+ ### Return type
669
+
670
+ null (empty response body)
671
+
672
+ ### Authorization
673
+
674
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
675
+
676
+ ### HTTP request headers
677
+
678
+ - **Content-Type**: Not defined
679
+ - **Accept**: Not defined
680
+
681
+
682
+ ## deleteStackingRules
683
+
684
+ > deleteStackingRules(projectId, stackingRulesId)
685
+
686
+ Delete Stacking Rules
687
+
688
+ Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
689
+
690
+ ### Example
691
+
692
+ ```javascript
693
+ import Voucherify from 'voucherify';
694
+ let defaultClient = Voucherify.ApiClient.instance;
695
+ // Configure API key authorization: X-Management-Token
696
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
697
+ X-Management-Token.apiKey = 'YOUR API KEY';
698
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
699
+ //X-Management-Token.apiKeyPrefix = 'Token';
700
+ // Configure API key authorization: X-Management-Id
701
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
702
+ X-Management-Id.apiKey = 'YOUR API KEY';
703
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
704
+ //X-Management-Id.apiKeyPrefix = 'Token';
705
+
706
+ let apiInstance = new Voucherify.ManagementApi();
707
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
708
+ let stackingRulesId = "stackingRulesId_example"; // String | Provide the unique identifier of the stacking rules.
709
+ apiInstance.deleteStackingRules(projectId, stackingRulesId, (error, data, response) => {
710
+ if (error) {
711
+ console.error(error);
712
+ } else {
713
+ console.log('API called successfully.');
714
+ }
715
+ });
716
+ ```
717
+
718
+ ### Parameters
719
+
720
+
721
+ Name | Type | Description | Notes
722
+ ------------- | ------------- | ------------- | -------------
723
+ **projectId** | **String**| Provide the unique identifier of the project. |
724
+ **stackingRulesId** | **String**| Provide the unique identifier of the stacking rules. |
725
+
726
+ ### Return type
727
+
728
+ null (empty response body)
729
+
730
+ ### Authorization
731
+
732
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
733
+
734
+ ### HTTP request headers
735
+
736
+ - **Content-Type**: Not defined
737
+ - **Accept**: Not defined
738
+
739
+
740
+ ## deleteWebhook
741
+
742
+ > deleteWebhook(projectId, webhookId)
743
+
744
+ Delete Webhook
745
+
746
+ Deletes a webhook configuration. 📘 Webhook Documentation Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
747
+
748
+ ### Example
749
+
750
+ ```javascript
751
+ import Voucherify from 'voucherify';
752
+ let defaultClient = Voucherify.ApiClient.instance;
753
+ // Configure API key authorization: X-Management-Token
754
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
755
+ X-Management-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-Management-Token.apiKeyPrefix = 'Token';
758
+ // Configure API key authorization: X-Management-Id
759
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
760
+ X-Management-Id.apiKey = 'YOUR API KEY';
761
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
762
+ //X-Management-Id.apiKeyPrefix = 'Token';
763
+
764
+ let apiInstance = new Voucherify.ManagementApi();
765
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
766
+ let webhookId = "webhookId_example"; // String | Provide the unique identifier of the webhook configuration.
767
+ apiInstance.deleteWebhook(projectId, webhookId, (error, data, response) => {
768
+ if (error) {
769
+ console.error(error);
770
+ } else {
771
+ console.log('API called successfully.');
772
+ }
773
+ });
774
+ ```
775
+
776
+ ### Parameters
777
+
778
+
779
+ Name | Type | Description | Notes
780
+ ------------- | ------------- | ------------- | -------------
781
+ **projectId** | **String**| Provide the unique identifier of the project. |
782
+ **webhookId** | **String**| Provide the unique identifier of the webhook configuration. |
783
+
784
+ ### Return type
785
+
786
+ null (empty response body)
787
+
788
+ ### Authorization
789
+
790
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
791
+
792
+ ### HTTP request headers
793
+
794
+ - **Content-Type**: Not defined
795
+ - **Accept**: Not defined
796
+
797
+
798
+ ## getBrand
799
+
800
+ > ManagementProjectsBrandingGetResponseBody getBrand(projectId, brandingId)
801
+
802
+ Get Brand
803
+
804
+ Retrieves a brand configuration.
805
+
806
+ ### Example
807
+
808
+ ```javascript
809
+ import Voucherify from 'voucherify';
810
+ let defaultClient = Voucherify.ApiClient.instance;
811
+ // Configure API key authorization: X-Management-Token
812
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
813
+ X-Management-Token.apiKey = 'YOUR API KEY';
814
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
815
+ //X-Management-Token.apiKeyPrefix = 'Token';
816
+ // Configure API key authorization: X-Management-Id
817
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
818
+ X-Management-Id.apiKey = 'YOUR API KEY';
819
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
820
+ //X-Management-Id.apiKeyPrefix = 'Token';
821
+
822
+ let apiInstance = new Voucherify.ManagementApi();
823
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
824
+ let brandingId = "brandingId_example"; // String | Provide the unique identifier of the brand configuration.
825
+ apiInstance.getBrand(projectId, brandingId, (error, data, response) => {
826
+ if (error) {
827
+ console.error(error);
828
+ } else {
829
+ console.log('API called successfully. Returned data: ' + data);
830
+ }
831
+ });
832
+ ```
833
+
834
+ ### Parameters
835
+
836
+
837
+ Name | Type | Description | Notes
838
+ ------------- | ------------- | ------------- | -------------
839
+ **projectId** | **String**| Provide the unique identifier of the project. |
840
+ **brandingId** | **String**| Provide the unique identifier of the brand configuration. |
841
+
842
+ ### Return type
843
+
844
+ [**ManagementProjectsBrandingGetResponseBody**](ManagementProjectsBrandingGetResponseBody.md)
845
+
846
+ ### Authorization
847
+
848
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
849
+
850
+ ### HTTP request headers
851
+
852
+ - **Content-Type**: Not defined
853
+ - **Accept**: application/json
854
+
855
+
856
+ ## getCustomEventSchema
857
+
858
+ > ManagementProjectsCustomEventSchemasGetResponseBody getCustomEventSchema(projectId, customEventSchemaId)
859
+
860
+ Get Custom Event Schema
861
+
862
+ Retrieves a custom event schema. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
863
+
864
+ ### Example
865
+
866
+ ```javascript
867
+ import Voucherify from 'voucherify';
868
+ let defaultClient = Voucherify.ApiClient.instance;
869
+ // Configure API key authorization: X-Management-Token
870
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
871
+ X-Management-Token.apiKey = 'YOUR API KEY';
872
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
873
+ //X-Management-Token.apiKeyPrefix = 'Token';
874
+ // Configure API key authorization: X-Management-Id
875
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
876
+ X-Management-Id.apiKey = 'YOUR API KEY';
877
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
878
+ //X-Management-Id.apiKeyPrefix = 'Token';
879
+
880
+ let apiInstance = new Voucherify.ManagementApi();
881
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
882
+ let customEventSchemaId = "customEventSchemaId_example"; // String | Provide the unique identifier of the custom event schema.
883
+ apiInstance.getCustomEventSchema(projectId, customEventSchemaId, (error, data, response) => {
884
+ if (error) {
885
+ console.error(error);
886
+ } else {
887
+ console.log('API called successfully. Returned data: ' + data);
888
+ }
889
+ });
890
+ ```
891
+
892
+ ### Parameters
893
+
894
+
895
+ Name | Type | Description | Notes
896
+ ------------- | ------------- | ------------- | -------------
897
+ **projectId** | **String**| Provide the unique identifier of the project. |
898
+ **customEventSchemaId** | **String**| Provide the unique identifier of the custom event schema. |
899
+
900
+ ### Return type
901
+
902
+ [**ManagementProjectsCustomEventSchemasGetResponseBody**](ManagementProjectsCustomEventSchemasGetResponseBody.md)
903
+
904
+ ### Authorization
905
+
906
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
907
+
908
+ ### HTTP request headers
909
+
910
+ - **Content-Type**: Not defined
911
+ - **Accept**: application/json
912
+
913
+
914
+ ## getMetadataSchema1
915
+
916
+ > ManagementProjectsMetadataSchemasGetResponseBody getMetadataSchema1(projectId, metadataSchemaId)
917
+
918
+ Get Metadata Schema
919
+
920
+ Retrieves a metadata schema. 📘 Metadata Documentation Read [the Getting Started with Metadata](https://support.voucherify.io/article/99-schema-validation-metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
921
+
922
+ ### Example
923
+
924
+ ```javascript
925
+ import Voucherify from 'voucherify';
926
+ let defaultClient = Voucherify.ApiClient.instance;
927
+ // Configure API key authorization: X-Management-Token
928
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
929
+ X-Management-Token.apiKey = 'YOUR API KEY';
930
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
931
+ //X-Management-Token.apiKeyPrefix = 'Token';
932
+ // Configure API key authorization: X-Management-Id
933
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
934
+ X-Management-Id.apiKey = 'YOUR API KEY';
935
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
936
+ //X-Management-Id.apiKeyPrefix = 'Token';
937
+
938
+ let apiInstance = new Voucherify.ManagementApi();
939
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
940
+ let metadataSchemaId = "metadataSchemaId_example"; // String | Provide the unique identifier of the metadata schema.
941
+ apiInstance.getMetadataSchema1(projectId, metadataSchemaId, (error, data, response) => {
942
+ if (error) {
943
+ console.error(error);
944
+ } else {
945
+ console.log('API called successfully. Returned data: ' + data);
946
+ }
947
+ });
948
+ ```
949
+
950
+ ### Parameters
951
+
952
+
953
+ Name | Type | Description | Notes
954
+ ------------- | ------------- | ------------- | -------------
955
+ **projectId** | **String**| Provide the unique identifier of the project. |
956
+ **metadataSchemaId** | **String**| Provide the unique identifier of the metadata schema. |
957
+
958
+ ### Return type
959
+
960
+ [**ManagementProjectsMetadataSchemasGetResponseBody**](ManagementProjectsMetadataSchemasGetResponseBody.md)
961
+
962
+ ### Authorization
963
+
964
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
965
+
966
+ ### HTTP request headers
967
+
968
+ - **Content-Type**: Not defined
969
+ - **Accept**: application/json
970
+
971
+
972
+ ## getProject
973
+
974
+ > ManagementProjectsGetResponseBody getProject(projectId)
975
+
976
+ Get Project
977
+
978
+ Retrieves an existing project.
979
+
980
+ ### Example
981
+
982
+ ```javascript
983
+ import Voucherify from 'voucherify';
984
+ let defaultClient = Voucherify.ApiClient.instance;
985
+ // Configure API key authorization: X-Management-Token
986
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
987
+ X-Management-Token.apiKey = 'YOUR API KEY';
988
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
989
+ //X-Management-Token.apiKeyPrefix = 'Token';
990
+ // Configure API key authorization: X-Management-Id
991
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
992
+ X-Management-Id.apiKey = 'YOUR API KEY';
993
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
994
+ //X-Management-Id.apiKeyPrefix = 'Token';
995
+
996
+ let apiInstance = new Voucherify.ManagementApi();
997
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
998
+ apiInstance.getProject(projectId, (error, data, response) => {
999
+ if (error) {
1000
+ console.error(error);
1001
+ } else {
1002
+ console.log('API called successfully. Returned data: ' + data);
1003
+ }
1004
+ });
1005
+ ```
1006
+
1007
+ ### Parameters
1008
+
1009
+
1010
+ Name | Type | Description | Notes
1011
+ ------------- | ------------- | ------------- | -------------
1012
+ **projectId** | **String**| Provide the unique identifier of the project. |
1013
+
1014
+ ### Return type
1015
+
1016
+ [**ManagementProjectsGetResponseBody**](ManagementProjectsGetResponseBody.md)
1017
+
1018
+ ### Authorization
1019
+
1020
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1021
+
1022
+ ### HTTP request headers
1023
+
1024
+ - **Content-Type**: Not defined
1025
+ - **Accept**: application/json
1026
+
1027
+
1028
+ ## getStackingRules
1029
+
1030
+ > ManagementProjectsStackingRulesGetResponseBody getStackingRules(projectId, stackingRulesId)
1031
+
1032
+ Get Stacking Rules
1033
+
1034
+ Retrieves the stacking rules for the project. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
1035
+
1036
+ ### Example
1037
+
1038
+ ```javascript
1039
+ import Voucherify from 'voucherify';
1040
+ let defaultClient = Voucherify.ApiClient.instance;
1041
+ // Configure API key authorization: X-Management-Token
1042
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1043
+ X-Management-Token.apiKey = 'YOUR API KEY';
1044
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1045
+ //X-Management-Token.apiKeyPrefix = 'Token';
1046
+ // Configure API key authorization: X-Management-Id
1047
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1048
+ X-Management-Id.apiKey = 'YOUR API KEY';
1049
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1050
+ //X-Management-Id.apiKeyPrefix = 'Token';
1051
+
1052
+ let apiInstance = new Voucherify.ManagementApi();
1053
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1054
+ let stackingRulesId = "stackingRulesId_example"; // String | Provide the unique identifier of the stacking rules.
1055
+ apiInstance.getStackingRules(projectId, stackingRulesId, (error, data, response) => {
1056
+ if (error) {
1057
+ console.error(error);
1058
+ } else {
1059
+ console.log('API called successfully. Returned data: ' + data);
1060
+ }
1061
+ });
1062
+ ```
1063
+
1064
+ ### Parameters
1065
+
1066
+
1067
+ Name | Type | Description | Notes
1068
+ ------------- | ------------- | ------------- | -------------
1069
+ **projectId** | **String**| Provide the unique identifier of the project. |
1070
+ **stackingRulesId** | **String**| Provide the unique identifier of the stacking rules. |
1071
+
1072
+ ### Return type
1073
+
1074
+ [**ManagementProjectsStackingRulesGetResponseBody**](ManagementProjectsStackingRulesGetResponseBody.md)
1075
+
1076
+ ### Authorization
1077
+
1078
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1079
+
1080
+ ### HTTP request headers
1081
+
1082
+ - **Content-Type**: Not defined
1083
+ - **Accept**: application/json
1084
+
1085
+
1086
+ ## getUser
1087
+
1088
+ > ManagementProjectsUsersGetUserResponseBody getUser(projectId, userId)
1089
+
1090
+ Get User
1091
+
1092
+ Retrieves the project users details.
1093
+
1094
+ ### Example
1095
+
1096
+ ```javascript
1097
+ import Voucherify from 'voucherify';
1098
+ let defaultClient = Voucherify.ApiClient.instance;
1099
+ // Configure API key authorization: X-Management-Token
1100
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1101
+ X-Management-Token.apiKey = 'YOUR API KEY';
1102
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1103
+ //X-Management-Token.apiKeyPrefix = 'Token';
1104
+ // Configure API key authorization: X-Management-Id
1105
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1106
+ X-Management-Id.apiKey = 'YOUR API KEY';
1107
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1108
+ //X-Management-Id.apiKeyPrefix = 'Token';
1109
+
1110
+ let apiInstance = new Voucherify.ManagementApi();
1111
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1112
+ let userId = "userId_example"; // String | Provide the unique identifier of the user. Alternatively, provide the users login.
1113
+ apiInstance.getUser(projectId, userId, (error, data, response) => {
1114
+ if (error) {
1115
+ console.error(error);
1116
+ } else {
1117
+ console.log('API called successfully. Returned data: ' + data);
1118
+ }
1119
+ });
1120
+ ```
1121
+
1122
+ ### Parameters
1123
+
1124
+
1125
+ Name | Type | Description | Notes
1126
+ ------------- | ------------- | ------------- | -------------
1127
+ **projectId** | **String**| Provide the unique identifier of the project. |
1128
+ **userId** | **String**| Provide the unique identifier of the user. Alternatively, provide the users login. |
1129
+
1130
+ ### Return type
1131
+
1132
+ [**ManagementProjectsUsersGetUserResponseBody**](ManagementProjectsUsersGetUserResponseBody.md)
1133
+
1134
+ ### Authorization
1135
+
1136
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1137
+
1138
+ ### HTTP request headers
1139
+
1140
+ - **Content-Type**: Not defined
1141
+ - **Accept**: application/json
1142
+
1143
+
1144
+ ## getWebhook
1145
+
1146
+ > ManagementProjectsWebhooksGetResponseBody getWebhook(projectId, webhookId)
1147
+
1148
+ Get Webhook
1149
+
1150
+ Retrieves a webhook configuration. 📘 Webhook Documentation Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
1151
+
1152
+ ### Example
1153
+
1154
+ ```javascript
1155
+ import Voucherify from 'voucherify';
1156
+ let defaultClient = Voucherify.ApiClient.instance;
1157
+ // Configure API key authorization: X-Management-Token
1158
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1159
+ X-Management-Token.apiKey = 'YOUR API KEY';
1160
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1161
+ //X-Management-Token.apiKeyPrefix = 'Token';
1162
+ // Configure API key authorization: X-Management-Id
1163
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1164
+ X-Management-Id.apiKey = 'YOUR API KEY';
1165
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1166
+ //X-Management-Id.apiKeyPrefix = 'Token';
1167
+
1168
+ let apiInstance = new Voucherify.ManagementApi();
1169
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1170
+ let webhookId = "webhookId_example"; // String | Provide the unique identifier of the webhook configuration.
1171
+ apiInstance.getWebhook(projectId, webhookId, (error, data, response) => {
1172
+ if (error) {
1173
+ console.error(error);
1174
+ } else {
1175
+ console.log('API called successfully. Returned data: ' + data);
1176
+ }
1177
+ });
1178
+ ```
1179
+
1180
+ ### Parameters
1181
+
1182
+
1183
+ Name | Type | Description | Notes
1184
+ ------------- | ------------- | ------------- | -------------
1185
+ **projectId** | **String**| Provide the unique identifier of the project. |
1186
+ **webhookId** | **String**| Provide the unique identifier of the webhook configuration. |
1187
+
1188
+ ### Return type
1189
+
1190
+ [**ManagementProjectsWebhooksGetResponseBody**](ManagementProjectsWebhooksGetResponseBody.md)
1191
+
1192
+ ### Authorization
1193
+
1194
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1195
+
1196
+ ### HTTP request headers
1197
+
1198
+ - **Content-Type**: Not defined
1199
+ - **Accept**: application/json
1200
+
1201
+
1202
+ ## inviteUser
1203
+
1204
+ > inviteUser(managementProjectsUsersInviteCreateRequestBody)
1205
+
1206
+ Invite a New User
1207
+
1208
+ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles.
1209
+
1210
+ ### Example
1211
+
1212
+ ```javascript
1213
+ import Voucherify from 'voucherify';
1214
+ let defaultClient = Voucherify.ApiClient.instance;
1215
+ // Configure API key authorization: X-Management-Token
1216
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1217
+ X-Management-Token.apiKey = 'YOUR API KEY';
1218
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1219
+ //X-Management-Token.apiKeyPrefix = 'Token';
1220
+ // Configure API key authorization: X-Management-Id
1221
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1222
+ X-Management-Id.apiKey = 'YOUR API KEY';
1223
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1224
+ //X-Management-Id.apiKeyPrefix = 'Token';
1225
+
1226
+ let apiInstance = new Voucherify.ManagementApi();
1227
+ let managementProjectsUsersInviteCreateRequestBody = new Voucherify.ManagementProjectsUsersInviteCreateRequestBody(); // ManagementProjectsUsersInviteCreateRequestBody | Defines the details of the invitation, the project, and roles to which the user will be assigned.
1228
+ apiInstance.inviteUser(managementProjectsUsersInviteCreateRequestBody, (error, data, response) => {
1229
+ if (error) {
1230
+ console.error(error);
1231
+ } else {
1232
+ console.log('API called successfully.');
1233
+ }
1234
+ });
1235
+ ```
1236
+
1237
+ ### Parameters
1238
+
1239
+
1240
+ Name | Type | Description | Notes
1241
+ ------------- | ------------- | ------------- | -------------
1242
+ **managementProjectsUsersInviteCreateRequestBody** | [**ManagementProjectsUsersInviteCreateRequestBody**](ManagementProjectsUsersInviteCreateRequestBody.md)| Defines the details of the invitation, the project, and roles to which the user will be assigned. |
1243
+
1244
+ ### Return type
1245
+
1246
+ null (empty response body)
1247
+
1248
+ ### Authorization
1249
+
1250
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1251
+
1252
+ ### HTTP request headers
1253
+
1254
+ - **Content-Type**: application/json
1255
+ - **Accept**: Not defined
1256
+
1257
+
1258
+ ## listBrands
1259
+
1260
+ > ManagementProjectsBrandingListResponseBody listBrands(projectId)
1261
+
1262
+ List Brands
1263
+
1264
+ Lists all brand configurations. Because a project can have only one brand, it always returns a list with one item. This endpoint can be used to retrieve the brand configuration created with the Voucherify Dashboard and the ID.
1265
+
1266
+ ### Example
1267
+
1268
+ ```javascript
1269
+ import Voucherify from 'voucherify';
1270
+ let defaultClient = Voucherify.ApiClient.instance;
1271
+ // Configure API key authorization: X-Management-Token
1272
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1273
+ X-Management-Token.apiKey = 'YOUR API KEY';
1274
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1275
+ //X-Management-Token.apiKeyPrefix = 'Token';
1276
+ // Configure API key authorization: X-Management-Id
1277
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1278
+ X-Management-Id.apiKey = 'YOUR API KEY';
1279
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1280
+ //X-Management-Id.apiKeyPrefix = 'Token';
1281
+
1282
+ let apiInstance = new Voucherify.ManagementApi();
1283
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1284
+ apiInstance.listBrands(projectId, (error, data, response) => {
1285
+ if (error) {
1286
+ console.error(error);
1287
+ } else {
1288
+ console.log('API called successfully. Returned data: ' + data);
1289
+ }
1290
+ });
1291
+ ```
1292
+
1293
+ ### Parameters
1294
+
1295
+
1296
+ Name | Type | Description | Notes
1297
+ ------------- | ------------- | ------------- | -------------
1298
+ **projectId** | **String**| Provide the unique identifier of the project. |
1299
+
1300
+ ### Return type
1301
+
1302
+ [**ManagementProjectsBrandingListResponseBody**](ManagementProjectsBrandingListResponseBody.md)
1303
+
1304
+ ### Authorization
1305
+
1306
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1307
+
1308
+ ### HTTP request headers
1309
+
1310
+ - **Content-Type**: Not defined
1311
+ - **Accept**: application/json
1312
+
1313
+
1314
+ ## listCustomEventSchemas
1315
+
1316
+ > ManagementProjectsCustomEventSchemasListResponseBody listCustomEventSchemas(projectId)
1317
+
1318
+ List Custom Event Schemas
1319
+
1320
+ Lists all custom event schemas available in the project. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
1321
+
1322
+ ### Example
1323
+
1324
+ ```javascript
1325
+ import Voucherify from 'voucherify';
1326
+ let defaultClient = Voucherify.ApiClient.instance;
1327
+ // Configure API key authorization: X-Management-Token
1328
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1329
+ X-Management-Token.apiKey = 'YOUR API KEY';
1330
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1331
+ //X-Management-Token.apiKeyPrefix = 'Token';
1332
+ // Configure API key authorization: X-Management-Id
1333
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1334
+ X-Management-Id.apiKey = 'YOUR API KEY';
1335
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1336
+ //X-Management-Id.apiKeyPrefix = 'Token';
1337
+
1338
+ let apiInstance = new Voucherify.ManagementApi();
1339
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1340
+ apiInstance.listCustomEventSchemas(projectId, (error, data, response) => {
1341
+ if (error) {
1342
+ console.error(error);
1343
+ } else {
1344
+ console.log('API called successfully. Returned data: ' + data);
1345
+ }
1346
+ });
1347
+ ```
1348
+
1349
+ ### Parameters
1350
+
1351
+
1352
+ Name | Type | Description | Notes
1353
+ ------------- | ------------- | ------------- | -------------
1354
+ **projectId** | **String**| Provide the unique identifier of the project. |
1355
+
1356
+ ### Return type
1357
+
1358
+ [**ManagementProjectsCustomEventSchemasListResponseBody**](ManagementProjectsCustomEventSchemasListResponseBody.md)
1359
+
1360
+ ### Authorization
1361
+
1362
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1363
+
1364
+ ### HTTP request headers
1365
+
1366
+ - **Content-Type**: Not defined
1367
+ - **Accept**: application/json
1368
+
1369
+
1370
+ ## listMetadataSchemas1
1371
+
1372
+ > ManagementProjectsMetadataSchemasListResponseBody listMetadataSchemas1(projectId)
1373
+
1374
+ List Metadata Schemas
1375
+
1376
+ Lists all metadata schemas available in the project. 📘 Metadata Documentation Read [the Getting Started with Metadata](https://support.voucherify.io/article/99-schema-validation-metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
1377
+
1378
+ ### Example
1379
+
1380
+ ```javascript
1381
+ import Voucherify from 'voucherify';
1382
+ let defaultClient = Voucherify.ApiClient.instance;
1383
+ // Configure API key authorization: X-Management-Token
1384
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1385
+ X-Management-Token.apiKey = 'YOUR API KEY';
1386
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1387
+ //X-Management-Token.apiKeyPrefix = 'Token';
1388
+ // Configure API key authorization: X-Management-Id
1389
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1390
+ X-Management-Id.apiKey = 'YOUR API KEY';
1391
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1392
+ //X-Management-Id.apiKeyPrefix = 'Token';
1393
+
1394
+ let apiInstance = new Voucherify.ManagementApi();
1395
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1396
+ apiInstance.listMetadataSchemas1(projectId, (error, data, response) => {
1397
+ if (error) {
1398
+ console.error(error);
1399
+ } else {
1400
+ console.log('API called successfully. Returned data: ' + data);
1401
+ }
1402
+ });
1403
+ ```
1404
+
1405
+ ### Parameters
1406
+
1407
+
1408
+ Name | Type | Description | Notes
1409
+ ------------- | ------------- | ------------- | -------------
1410
+ **projectId** | **String**| Provide the unique identifier of the project. |
1411
+
1412
+ ### Return type
1413
+
1414
+ [**ManagementProjectsMetadataSchemasListResponseBody**](ManagementProjectsMetadataSchemasListResponseBody.md)
1415
+
1416
+ ### Authorization
1417
+
1418
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1419
+
1420
+ ### HTTP request headers
1421
+
1422
+ - **Content-Type**: Not defined
1423
+ - **Accept**: application/json
1424
+
1425
+
1426
+ ## listProjects
1427
+
1428
+ > ManagementProjectsListResponseBody listProjects()
1429
+
1430
+ List Projects
1431
+
1432
+ Lists all projects for the organization. The endpoint does not require any query parameters.
1433
+
1434
+ ### Example
1435
+
1436
+ ```javascript
1437
+ import Voucherify from 'voucherify';
1438
+ let defaultClient = Voucherify.ApiClient.instance;
1439
+ // Configure API key authorization: X-Management-Token
1440
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1441
+ X-Management-Token.apiKey = 'YOUR API KEY';
1442
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1443
+ //X-Management-Token.apiKeyPrefix = 'Token';
1444
+ // Configure API key authorization: X-Management-Id
1445
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1446
+ X-Management-Id.apiKey = 'YOUR API KEY';
1447
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1448
+ //X-Management-Id.apiKeyPrefix = 'Token';
1449
+
1450
+ let apiInstance = new Voucherify.ManagementApi();
1451
+ apiInstance.listProjects((error, data, response) => {
1452
+ if (error) {
1453
+ console.error(error);
1454
+ } else {
1455
+ console.log('API called successfully. Returned data: ' + data);
1456
+ }
1457
+ });
1458
+ ```
1459
+
1460
+ ### Parameters
1461
+
1462
+ This endpoint does not need any parameter.
1463
+
1464
+ ### Return type
1465
+
1466
+ [**ManagementProjectsListResponseBody**](ManagementProjectsListResponseBody.md)
1467
+
1468
+ ### Authorization
1469
+
1470
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1471
+
1472
+ ### HTTP request headers
1473
+
1474
+ - **Content-Type**: Not defined
1475
+ - **Accept**: application/json
1476
+
1477
+
1478
+ ## listStackingRules
1479
+
1480
+ > ManagementProjectsStackingRulesListResponseBody listStackingRules(projectId)
1481
+
1482
+ List Stacking Rules
1483
+
1484
+ Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the [Get Stacking Rules](/api-reference/management/get-stacking-rules) or [Update Stacking Rules](/api-reference/management/update-stacking-rules) endpoints. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
1485
+
1486
+ ### Example
1487
+
1488
+ ```javascript
1489
+ import Voucherify from 'voucherify';
1490
+ let defaultClient = Voucherify.ApiClient.instance;
1491
+ // Configure API key authorization: X-Management-Token
1492
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1493
+ X-Management-Token.apiKey = 'YOUR API KEY';
1494
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1495
+ //X-Management-Token.apiKeyPrefix = 'Token';
1496
+ // Configure API key authorization: X-Management-Id
1497
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1498
+ X-Management-Id.apiKey = 'YOUR API KEY';
1499
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1500
+ //X-Management-Id.apiKeyPrefix = 'Token';
1501
+
1502
+ let apiInstance = new Voucherify.ManagementApi();
1503
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1504
+ apiInstance.listStackingRules(projectId, (error, data, response) => {
1505
+ if (error) {
1506
+ console.error(error);
1507
+ } else {
1508
+ console.log('API called successfully. Returned data: ' + data);
1509
+ }
1510
+ });
1511
+ ```
1512
+
1513
+ ### Parameters
1514
+
1515
+
1516
+ Name | Type | Description | Notes
1517
+ ------------- | ------------- | ------------- | -------------
1518
+ **projectId** | **String**| Provide the unique identifier of the project. |
1519
+
1520
+ ### Return type
1521
+
1522
+ [**ManagementProjectsStackingRulesListResponseBody**](ManagementProjectsStackingRulesListResponseBody.md)
1523
+
1524
+ ### Authorization
1525
+
1526
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1527
+
1528
+ ### HTTP request headers
1529
+
1530
+ - **Content-Type**: Not defined
1531
+ - **Accept**: application/json
1532
+
1533
+
1534
+ ## listUsers
1535
+
1536
+ > ManagementProjectsUsersListResponseBody listUsers(projectId)
1537
+
1538
+ List Users
1539
+
1540
+ Lists all users assigned to the project.
1541
+
1542
+ ### Example
1543
+
1544
+ ```javascript
1545
+ import Voucherify from 'voucherify';
1546
+ let defaultClient = Voucherify.ApiClient.instance;
1547
+ // Configure API key authorization: X-Management-Token
1548
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1549
+ X-Management-Token.apiKey = 'YOUR API KEY';
1550
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1551
+ //X-Management-Token.apiKeyPrefix = 'Token';
1552
+ // Configure API key authorization: X-Management-Id
1553
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1554
+ X-Management-Id.apiKey = 'YOUR API KEY';
1555
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1556
+ //X-Management-Id.apiKeyPrefix = 'Token';
1557
+
1558
+ let apiInstance = new Voucherify.ManagementApi();
1559
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1560
+ apiInstance.listUsers(projectId, (error, data, response) => {
1561
+ if (error) {
1562
+ console.error(error);
1563
+ } else {
1564
+ console.log('API called successfully. Returned data: ' + data);
1565
+ }
1566
+ });
1567
+ ```
1568
+
1569
+ ### Parameters
1570
+
1571
+
1572
+ Name | Type | Description | Notes
1573
+ ------------- | ------------- | ------------- | -------------
1574
+ **projectId** | **String**| Provide the unique identifier of the project. |
1575
+
1576
+ ### Return type
1577
+
1578
+ [**ManagementProjectsUsersListResponseBody**](ManagementProjectsUsersListResponseBody.md)
1579
+
1580
+ ### Authorization
1581
+
1582
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1583
+
1584
+ ### HTTP request headers
1585
+
1586
+ - **Content-Type**: Not defined
1587
+ - **Accept**: application/json
1588
+
1589
+
1590
+ ## listWebhooks
1591
+
1592
+ > ManagementProjectsWebhooksListResponseBody listWebhooks(projectId)
1593
+
1594
+ List Webhooks
1595
+
1596
+ Lists all webhook configurations for the project. 📘 Webhook Documentation Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
1597
+
1598
+ ### Example
1599
+
1600
+ ```javascript
1601
+ import Voucherify from 'voucherify';
1602
+ let defaultClient = Voucherify.ApiClient.instance;
1603
+ // Configure API key authorization: X-Management-Token
1604
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1605
+ X-Management-Token.apiKey = 'YOUR API KEY';
1606
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1607
+ //X-Management-Token.apiKeyPrefix = 'Token';
1608
+ // Configure API key authorization: X-Management-Id
1609
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1610
+ X-Management-Id.apiKey = 'YOUR API KEY';
1611
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1612
+ //X-Management-Id.apiKeyPrefix = 'Token';
1613
+
1614
+ let apiInstance = new Voucherify.ManagementApi();
1615
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1616
+ apiInstance.listWebhooks(projectId, (error, data, response) => {
1617
+ if (error) {
1618
+ console.error(error);
1619
+ } else {
1620
+ console.log('API called successfully. Returned data: ' + data);
1621
+ }
1622
+ });
1623
+ ```
1624
+
1625
+ ### Parameters
1626
+
1627
+
1628
+ Name | Type | Description | Notes
1629
+ ------------- | ------------- | ------------- | -------------
1630
+ **projectId** | **String**| Provide the unique identifier of the project. |
1631
+
1632
+ ### Return type
1633
+
1634
+ [**ManagementProjectsWebhooksListResponseBody**](ManagementProjectsWebhooksListResponseBody.md)
1635
+
1636
+ ### Authorization
1637
+
1638
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1639
+
1640
+ ### HTTP request headers
1641
+
1642
+ - **Content-Type**: Not defined
1643
+ - **Accept**: application/json
1644
+
1645
+
1646
+ ## managementCopyCampaignTemplate
1647
+
1648
+ > ManagementProjectsTemplatesCampaignsCopyCreateResponseBody managementCopyCampaignTemplate(projectId, campaignTemplateId, managementProjectsTemplatesCampaignsCopyCreateRequestBody)
1649
+
1650
+ Copy Campaign Template to a Project
1651
+
1652
+ Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
1653
+
1654
+ ### Example
1655
+
1656
+ ```javascript
1657
+ import Voucherify from 'voucherify';
1658
+ let defaultClient = Voucherify.ApiClient.instance;
1659
+ // Configure API key authorization: X-Management-Token
1660
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1661
+ X-Management-Token.apiKey = 'YOUR API KEY';
1662
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1663
+ //X-Management-Token.apiKeyPrefix = 'Token';
1664
+ // Configure API key authorization: X-Management-Id
1665
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1666
+ X-Management-Id.apiKey = 'YOUR API KEY';
1667
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1668
+ //X-Management-Id.apiKeyPrefix = 'Token';
1669
+
1670
+ let apiInstance = new Voucherify.ManagementApi();
1671
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1672
+ let campaignTemplateId = "campaignTemplateId_example"; // String | Provide the unique identifier of the campaign template.
1673
+ let managementProjectsTemplatesCampaignsCopyCreateRequestBody = new Voucherify.ManagementProjectsTemplatesCampaignsCopyCreateRequestBody(); // ManagementProjectsTemplatesCampaignsCopyCreateRequestBody | Determines the details about the template in the destination project as well as the destination project itself.
1674
+ apiInstance.managementCopyCampaignTemplate(projectId, campaignTemplateId, managementProjectsTemplatesCampaignsCopyCreateRequestBody, (error, data, response) => {
1675
+ if (error) {
1676
+ console.error(error);
1677
+ } else {
1678
+ console.log('API called successfully. Returned data: ' + data);
1679
+ }
1680
+ });
1681
+ ```
1682
+
1683
+ ### Parameters
1684
+
1685
+
1686
+ Name | Type | Description | Notes
1687
+ ------------- | ------------- | ------------- | -------------
1688
+ **projectId** | **String**| Provide the unique identifier of the project. |
1689
+ **campaignTemplateId** | **String**| Provide the unique identifier of the campaign template. |
1690
+ **managementProjectsTemplatesCampaignsCopyCreateRequestBody** | [**ManagementProjectsTemplatesCampaignsCopyCreateRequestBody**](ManagementProjectsTemplatesCampaignsCopyCreateRequestBody.md)| Determines the details about the template in the destination project as well as the destination project itself. |
1691
+
1692
+ ### Return type
1693
+
1694
+ [**ManagementProjectsTemplatesCampaignsCopyCreateResponseBody**](ManagementProjectsTemplatesCampaignsCopyCreateResponseBody.md)
1695
+
1696
+ ### Authorization
1697
+
1698
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1699
+
1700
+ ### HTTP request headers
1701
+
1702
+ - **Content-Type**: application/json
1703
+ - **Accept**: application/json
1704
+
1705
+
1706
+ ## managementListCampaignTemplates
1707
+
1708
+ > ManagementProjectsTemplatesCampaignsListResponseBody managementListCampaignTemplates(projectId, opts)
1709
+
1710
+ List Campaign Templates
1711
+
1712
+ Lists all campaign templates available in the project. 👍 List Campaign Templates This endpoint works in the same way as the [List Campaign Templates endpoint](/api-reference/templates/list-campaign-templates). 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
1713
+
1714
+ ### Example
1715
+
1716
+ ```javascript
1717
+ import Voucherify from 'voucherify';
1718
+ let defaultClient = Voucherify.ApiClient.instance;
1719
+ // Configure API key authorization: X-Management-Token
1720
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1721
+ X-Management-Token.apiKey = 'YOUR API KEY';
1722
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1723
+ //X-Management-Token.apiKeyPrefix = 'Token';
1724
+ // Configure API key authorization: X-Management-Id
1725
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1726
+ X-Management-Id.apiKey = 'YOUR API KEY';
1727
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1728
+ //X-Management-Id.apiKeyPrefix = 'Token';
1729
+
1730
+ let apiInstance = new Voucherify.ManagementApi();
1731
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1732
+ let opts = {
1733
+ '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.
1734
+ 'startingAfterId': "startingAfterId_example", // String | A cursor for pagination. It retrieves the campaign templates created after a template with the given ID.
1735
+ 'order': new Voucherify.ParameterTemplatesList(), // ParameterTemplatesList | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1736
+ 'includeTotal': true, // Boolean | If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default.
1737
+ 'filters': new Voucherify.ParameterFiltersListTemplates() // ParameterFiltersListTemplates | Filters for listing templates.
1738
+ };
1739
+ apiInstance.managementListCampaignTemplates(projectId, opts, (error, data, response) => {
1740
+ if (error) {
1741
+ console.error(error);
1742
+ } else {
1743
+ console.log('API called successfully. Returned data: ' + data);
1744
+ }
1745
+ });
1746
+ ```
1747
+
1748
+ ### Parameters
1749
+
1750
+
1751
+ Name | Type | Description | Notes
1752
+ ------------- | ------------- | ------------- | -------------
1753
+ **projectId** | **String**| Provide the unique identifier of the project. |
1754
+ **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]
1755
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. | [optional]
1756
+ **order** | [**ParameterTemplatesList**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional]
1757
+ **includeTotal** | **Boolean**| If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. | [optional]
1758
+ **filters** | [**ParameterFiltersListTemplates**](.md)| Filters for listing templates. | [optional]
1759
+
1760
+ ### Return type
1761
+
1762
+ [**ManagementProjectsTemplatesCampaignsListResponseBody**](ManagementProjectsTemplatesCampaignsListResponseBody.md)
1763
+
1764
+ ### Authorization
1765
+
1766
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1767
+
1768
+ ### HTTP request headers
1769
+
1770
+ - **Content-Type**: Not defined
1771
+ - **Accept**: application/json
1772
+
1773
+
1774
+ ## unassignUser
1775
+
1776
+ > unassignUser(projectId, userId)
1777
+
1778
+ Unassign User
1779
+
1780
+ Unassigns the user from the project. If the user is currently logged in, they are automatically logged out. If the user is assigned to only one project, they cannot be unassigned from that project.
1781
+
1782
+ ### Example
1783
+
1784
+ ```javascript
1785
+ import Voucherify from 'voucherify';
1786
+ let defaultClient = Voucherify.ApiClient.instance;
1787
+ // Configure API key authorization: X-Management-Token
1788
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1789
+ X-Management-Token.apiKey = 'YOUR API KEY';
1790
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1791
+ //X-Management-Token.apiKeyPrefix = 'Token';
1792
+ // Configure API key authorization: X-Management-Id
1793
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1794
+ X-Management-Id.apiKey = 'YOUR API KEY';
1795
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1796
+ //X-Management-Id.apiKeyPrefix = 'Token';
1797
+
1798
+ let apiInstance = new Voucherify.ManagementApi();
1799
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1800
+ let userId = "userId_example"; // String | Provide the unique identifier of the user. Alternatively, provide the users login.
1801
+ apiInstance.unassignUser(projectId, userId, (error, data, response) => {
1802
+ if (error) {
1803
+ console.error(error);
1804
+ } else {
1805
+ console.log('API called successfully.');
1806
+ }
1807
+ });
1808
+ ```
1809
+
1810
+ ### Parameters
1811
+
1812
+
1813
+ Name | Type | Description | Notes
1814
+ ------------- | ------------- | ------------- | -------------
1815
+ **projectId** | **String**| Provide the unique identifier of the project. |
1816
+ **userId** | **String**| Provide the unique identifier of the user. Alternatively, provide the users login. |
1817
+
1818
+ ### Return type
1819
+
1820
+ null (empty response body)
1821
+
1822
+ ### Authorization
1823
+
1824
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1825
+
1826
+ ### HTTP request headers
1827
+
1828
+ - **Content-Type**: Not defined
1829
+ - **Accept**: Not defined
1830
+
1831
+
1832
+ ## updateBrand
1833
+
1834
+ > ManagementProjectsBrandingUpdateResponseBody updateBrand(projectId, brandingId, managementProjectsBrandingUpdateRequestBody)
1835
+
1836
+ Update Brand
1837
+
1838
+ Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.
1839
+
1840
+ ### Example
1841
+
1842
+ ```javascript
1843
+ import Voucherify from 'voucherify';
1844
+ let defaultClient = Voucherify.ApiClient.instance;
1845
+ // Configure API key authorization: X-Management-Token
1846
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1847
+ X-Management-Token.apiKey = 'YOUR API KEY';
1848
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1849
+ //X-Management-Token.apiKeyPrefix = 'Token';
1850
+ // Configure API key authorization: X-Management-Id
1851
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1852
+ X-Management-Id.apiKey = 'YOUR API KEY';
1853
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1854
+ //X-Management-Id.apiKeyPrefix = 'Token';
1855
+
1856
+ let apiInstance = new Voucherify.ManagementApi();
1857
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1858
+ let brandingId = "brandingId_example"; // String | Provide the unique identifier of the brand configuration.
1859
+ let managementProjectsBrandingUpdateRequestBody = new Voucherify.ManagementProjectsBrandingUpdateRequestBody(); // ManagementProjectsBrandingUpdateRequestBody | Defines the brand configuration to be updated.
1860
+ apiInstance.updateBrand(projectId, brandingId, managementProjectsBrandingUpdateRequestBody, (error, data, response) => {
1861
+ if (error) {
1862
+ console.error(error);
1863
+ } else {
1864
+ console.log('API called successfully. Returned data: ' + data);
1865
+ }
1866
+ });
1867
+ ```
1868
+
1869
+ ### Parameters
1870
+
1871
+
1872
+ Name | Type | Description | Notes
1873
+ ------------- | ------------- | ------------- | -------------
1874
+ **projectId** | **String**| Provide the unique identifier of the project. |
1875
+ **brandingId** | **String**| Provide the unique identifier of the brand configuration. |
1876
+ **managementProjectsBrandingUpdateRequestBody** | [**ManagementProjectsBrandingUpdateRequestBody**](ManagementProjectsBrandingUpdateRequestBody.md)| Defines the brand configuration to be updated. |
1877
+
1878
+ ### Return type
1879
+
1880
+ [**ManagementProjectsBrandingUpdateResponseBody**](ManagementProjectsBrandingUpdateResponseBody.md)
1881
+
1882
+ ### Authorization
1883
+
1884
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1885
+
1886
+ ### HTTP request headers
1887
+
1888
+ - **Content-Type**: application/json
1889
+ - **Accept**: application/json
1890
+
1891
+
1892
+ ## updateCustomEventSchema
1893
+
1894
+ > ManagementProjectsCustomEventSchemasUpdateResponseBody updateCustomEventSchema(projectId, customEventSchemaId, managementProjectsCustomEventSchemasUpdateRequestBody)
1895
+
1896
+ Update Custom Event Schema
1897
+
1898
+ Updates a custom event schema. With this request, you can: - Add a nonexistent property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged. 👍 Additional Notes - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
1899
+
1900
+ ### Example
1901
+
1902
+ ```javascript
1903
+ import Voucherify from 'voucherify';
1904
+ let defaultClient = Voucherify.ApiClient.instance;
1905
+ // Configure API key authorization: X-Management-Token
1906
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1907
+ X-Management-Token.apiKey = 'YOUR API KEY';
1908
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1909
+ //X-Management-Token.apiKeyPrefix = 'Token';
1910
+ // Configure API key authorization: X-Management-Id
1911
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1912
+ X-Management-Id.apiKey = 'YOUR API KEY';
1913
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1914
+ //X-Management-Id.apiKeyPrefix = 'Token';
1915
+
1916
+ let apiInstance = new Voucherify.ManagementApi();
1917
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1918
+ let customEventSchemaId = "customEventSchemaId_example"; // String | Provide the unique identifier of the custom event schema.
1919
+ let managementProjectsCustomEventSchemasUpdateRequestBody = new Voucherify.ManagementProjectsCustomEventSchemasUpdateRequestBody(); // ManagementProjectsCustomEventSchemasUpdateRequestBody | Defines the custom event schema to be updated.
1920
+ apiInstance.updateCustomEventSchema(projectId, customEventSchemaId, managementProjectsCustomEventSchemasUpdateRequestBody, (error, data, response) => {
1921
+ if (error) {
1922
+ console.error(error);
1923
+ } else {
1924
+ console.log('API called successfully. Returned data: ' + data);
1925
+ }
1926
+ });
1927
+ ```
1928
+
1929
+ ### Parameters
1930
+
1931
+
1932
+ Name | Type | Description | Notes
1933
+ ------------- | ------------- | ------------- | -------------
1934
+ **projectId** | **String**| Provide the unique identifier of the project. |
1935
+ **customEventSchemaId** | **String**| Provide the unique identifier of the custom event schema. |
1936
+ **managementProjectsCustomEventSchemasUpdateRequestBody** | [**ManagementProjectsCustomEventSchemasUpdateRequestBody**](ManagementProjectsCustomEventSchemasUpdateRequestBody.md)| Defines the custom event schema to be updated. |
1937
+
1938
+ ### Return type
1939
+
1940
+ [**ManagementProjectsCustomEventSchemasUpdateResponseBody**](ManagementProjectsCustomEventSchemasUpdateResponseBody.md)
1941
+
1942
+ ### Authorization
1943
+
1944
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
1945
+
1946
+ ### HTTP request headers
1947
+
1948
+ - **Content-Type**: application/json
1949
+ - **Accept**: application/json
1950
+
1951
+
1952
+ ## updateMetadataSchema
1953
+
1954
+ > ManagementProjectsMetadataSchemasUpdateResponseBody updateMetadataSchema(projectId, metadataSchemaId, managementProjectsMetadataSchemasUpdateRequestBody)
1955
+
1956
+ Update Metadata Schema
1957
+
1958
+ Updates a metadata schema. With this request, you can: - Add a nonexistent attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted. 👍 Additional Notes - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint. 📘 Metadata Documentation Read [the Getting Started with Metadata](https://support.voucherify.io/article/99-schema-validation-metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
1959
+
1960
+ ### Example
1961
+
1962
+ ```javascript
1963
+ import Voucherify from 'voucherify';
1964
+ let defaultClient = Voucherify.ApiClient.instance;
1965
+ // Configure API key authorization: X-Management-Token
1966
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
1967
+ X-Management-Token.apiKey = 'YOUR API KEY';
1968
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1969
+ //X-Management-Token.apiKeyPrefix = 'Token';
1970
+ // Configure API key authorization: X-Management-Id
1971
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
1972
+ X-Management-Id.apiKey = 'YOUR API KEY';
1973
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1974
+ //X-Management-Id.apiKeyPrefix = 'Token';
1975
+
1976
+ let apiInstance = new Voucherify.ManagementApi();
1977
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
1978
+ let metadataSchemaId = "metadataSchemaId_example"; // String | Provide the unique identifier of the metadata schema.
1979
+ let managementProjectsMetadataSchemasUpdateRequestBody = new Voucherify.ManagementProjectsMetadataSchemasUpdateRequestBody(); // ManagementProjectsMetadataSchemasUpdateRequestBody | Defines the metadata schema to be updated.
1980
+ apiInstance.updateMetadataSchema(projectId, metadataSchemaId, managementProjectsMetadataSchemasUpdateRequestBody, (error, data, response) => {
1981
+ if (error) {
1982
+ console.error(error);
1983
+ } else {
1984
+ console.log('API called successfully. Returned data: ' + data);
1985
+ }
1986
+ });
1987
+ ```
1988
+
1989
+ ### Parameters
1990
+
1991
+
1992
+ Name | Type | Description | Notes
1993
+ ------------- | ------------- | ------------- | -------------
1994
+ **projectId** | **String**| Provide the unique identifier of the project. |
1995
+ **metadataSchemaId** | **String**| Provide the unique identifier of the metadata schema. |
1996
+ **managementProjectsMetadataSchemasUpdateRequestBody** | [**ManagementProjectsMetadataSchemasUpdateRequestBody**](ManagementProjectsMetadataSchemasUpdateRequestBody.md)| Defines the metadata schema to be updated. |
1997
+
1998
+ ### Return type
1999
+
2000
+ [**ManagementProjectsMetadataSchemasUpdateResponseBody**](ManagementProjectsMetadataSchemasUpdateResponseBody.md)
2001
+
2002
+ ### Authorization
2003
+
2004
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
2005
+
2006
+ ### HTTP request headers
2007
+
2008
+ - **Content-Type**: application/json
2009
+ - **Accept**: application/json
2010
+
2011
+
2012
+ ## updateProject
2013
+
2014
+ > ManagementProjectsUpdateResponseBody updateProject(projectId, managementProjectsUpdateRequestBody)
2015
+
2016
+ Update Project
2017
+
2018
+ Updates an existing project. You can add or modify settings for timezone, currency, notifications, and other details. Only the fields sent in the request will be updated.
2019
+
2020
+ ### Example
2021
+
2022
+ ```javascript
2023
+ import Voucherify from 'voucherify';
2024
+ let defaultClient = Voucherify.ApiClient.instance;
2025
+ // Configure API key authorization: X-Management-Token
2026
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
2027
+ X-Management-Token.apiKey = 'YOUR API KEY';
2028
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2029
+ //X-Management-Token.apiKeyPrefix = 'Token';
2030
+ // Configure API key authorization: X-Management-Id
2031
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
2032
+ X-Management-Id.apiKey = 'YOUR API KEY';
2033
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2034
+ //X-Management-Id.apiKeyPrefix = 'Token';
2035
+
2036
+ let apiInstance = new Voucherify.ManagementApi();
2037
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
2038
+ let managementProjectsUpdateRequestBody = new Voucherify.ManagementProjectsUpdateRequestBody(); // ManagementProjectsUpdateRequestBody | Define the project details to be updated.
2039
+ apiInstance.updateProject(projectId, managementProjectsUpdateRequestBody, (error, data, response) => {
2040
+ if (error) {
2041
+ console.error(error);
2042
+ } else {
2043
+ console.log('API called successfully. Returned data: ' + data);
2044
+ }
2045
+ });
2046
+ ```
2047
+
2048
+ ### Parameters
2049
+
2050
+
2051
+ Name | Type | Description | Notes
2052
+ ------------- | ------------- | ------------- | -------------
2053
+ **projectId** | **String**| Provide the unique identifier of the project. |
2054
+ **managementProjectsUpdateRequestBody** | [**ManagementProjectsUpdateRequestBody**](ManagementProjectsUpdateRequestBody.md)| Define the project details to be updated. |
2055
+
2056
+ ### Return type
2057
+
2058
+ [**ManagementProjectsUpdateResponseBody**](ManagementProjectsUpdateResponseBody.md)
2059
+
2060
+ ### Authorization
2061
+
2062
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
2063
+
2064
+ ### HTTP request headers
2065
+
2066
+ - **Content-Type**: application/json
2067
+ - **Accept**: application/json
2068
+
2069
+
2070
+ ## updateStackingRules
2071
+
2072
+ > ManagementProjectsStackingRulesUpdateResponseBody updateStackingRules(projectId, stackingRulesId, managementProjectsStackingRulesUpdateRequestBody)
2073
+
2074
+ Update Stacking Rules
2075
+
2076
+ Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
2077
+
2078
+ ### Example
2079
+
2080
+ ```javascript
2081
+ import Voucherify from 'voucherify';
2082
+ let defaultClient = Voucherify.ApiClient.instance;
2083
+ // Configure API key authorization: X-Management-Token
2084
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
2085
+ X-Management-Token.apiKey = 'YOUR API KEY';
2086
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2087
+ //X-Management-Token.apiKeyPrefix = 'Token';
2088
+ // Configure API key authorization: X-Management-Id
2089
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
2090
+ X-Management-Id.apiKey = 'YOUR API KEY';
2091
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2092
+ //X-Management-Id.apiKeyPrefix = 'Token';
2093
+
2094
+ let apiInstance = new Voucherify.ManagementApi();
2095
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
2096
+ let stackingRulesId = "stackingRulesId_example"; // String | Provide the unique identifier of the stacking rules.
2097
+ let managementProjectsStackingRulesUpdateRequestBody = new Voucherify.ManagementProjectsStackingRulesUpdateRequestBody(); // ManagementProjectsStackingRulesUpdateRequestBody | Defines the stacking rules to be updated.
2098
+ apiInstance.updateStackingRules(projectId, stackingRulesId, managementProjectsStackingRulesUpdateRequestBody, (error, data, response) => {
2099
+ if (error) {
2100
+ console.error(error);
2101
+ } else {
2102
+ console.log('API called successfully. Returned data: ' + data);
2103
+ }
2104
+ });
2105
+ ```
2106
+
2107
+ ### Parameters
2108
+
2109
+
2110
+ Name | Type | Description | Notes
2111
+ ------------- | ------------- | ------------- | -------------
2112
+ **projectId** | **String**| Provide the unique identifier of the project. |
2113
+ **stackingRulesId** | **String**| Provide the unique identifier of the stacking rules. |
2114
+ **managementProjectsStackingRulesUpdateRequestBody** | [**ManagementProjectsStackingRulesUpdateRequestBody**](ManagementProjectsStackingRulesUpdateRequestBody.md)| Defines the stacking rules to be updated. |
2115
+
2116
+ ### Return type
2117
+
2118
+ [**ManagementProjectsStackingRulesUpdateResponseBody**](ManagementProjectsStackingRulesUpdateResponseBody.md)
2119
+
2120
+ ### Authorization
2121
+
2122
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
2123
+
2124
+ ### HTTP request headers
2125
+
2126
+ - **Content-Type**: application/json
2127
+ - **Accept**: application/json
2128
+
2129
+
2130
+ ## updateUser
2131
+
2132
+ > ManagementProjectsUsersUpdateRoleResponseBody updateUser(projectId, userId, managementProjectsUsersUpdateRoleRequestBody)
2133
+
2134
+ Update User
2135
+
2136
+ Updates the users role.
2137
+
2138
+ ### Example
2139
+
2140
+ ```javascript
2141
+ import Voucherify from 'voucherify';
2142
+ let defaultClient = Voucherify.ApiClient.instance;
2143
+ // Configure API key authorization: X-Management-Token
2144
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
2145
+ X-Management-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-Management-Token.apiKeyPrefix = 'Token';
2148
+ // Configure API key authorization: X-Management-Id
2149
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
2150
+ X-Management-Id.apiKey = 'YOUR API KEY';
2151
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2152
+ //X-Management-Id.apiKeyPrefix = 'Token';
2153
+
2154
+ let apiInstance = new Voucherify.ManagementApi();
2155
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
2156
+ let userId = "userId_example"; // String | Provide the unique identifier of the user. Alternatively, provide the users login.
2157
+ let managementProjectsUsersUpdateRoleRequestBody = new Voucherify.ManagementProjectsUsersUpdateRoleRequestBody(); // ManagementProjectsUsersUpdateRoleRequestBody | Defines the users new role.
2158
+ apiInstance.updateUser(projectId, userId, managementProjectsUsersUpdateRoleRequestBody, (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
+ **projectId** | **String**| Provide the unique identifier of the project. |
2173
+ **userId** | **String**| Provide the unique identifier of the user. Alternatively, provide the users login. |
2174
+ **managementProjectsUsersUpdateRoleRequestBody** | [**ManagementProjectsUsersUpdateRoleRequestBody**](ManagementProjectsUsersUpdateRoleRequestBody.md)| Defines the users new role. |
2175
+
2176
+ ### Return type
2177
+
2178
+ [**ManagementProjectsUsersUpdateRoleResponseBody**](ManagementProjectsUsersUpdateRoleResponseBody.md)
2179
+
2180
+ ### Authorization
2181
+
2182
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
2183
+
2184
+ ### HTTP request headers
2185
+
2186
+ - **Content-Type**: application/json
2187
+ - **Accept**: application/json
2188
+
2189
+
2190
+ ## updateWebhook
2191
+
2192
+ > ManagementProjectsWebhooksUpdateResponseBody updateWebhook(projectId, webhookId, managementProjectsWebhooksUpdateRequestBody)
2193
+
2194
+ Update Webhook
2195
+
2196
+ Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration. 📘 Webhook Documentation Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
2197
+
2198
+ ### Example
2199
+
2200
+ ```javascript
2201
+ import Voucherify from 'voucherify';
2202
+ let defaultClient = Voucherify.ApiClient.instance;
2203
+ // Configure API key authorization: X-Management-Token
2204
+ let X-Management-Token = defaultClient.authentications['X-Management-Token'];
2205
+ X-Management-Token.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-Management-Token.apiKeyPrefix = 'Token';
2208
+ // Configure API key authorization: X-Management-Id
2209
+ let X-Management-Id = defaultClient.authentications['X-Management-Id'];
2210
+ X-Management-Id.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-Management-Id.apiKeyPrefix = 'Token';
2213
+
2214
+ let apiInstance = new Voucherify.ManagementApi();
2215
+ let projectId = "projectId_example"; // String | Provide the unique identifier of the project.
2216
+ let webhookId = "webhookId_example"; // String | Provide the unique identifier of the webhook configuration.
2217
+ let managementProjectsWebhooksUpdateRequestBody = new Voucherify.ManagementProjectsWebhooksUpdateRequestBody(); // ManagementProjectsWebhooksUpdateRequestBody | Defines the webhook configuration to be updated.
2218
+ apiInstance.updateWebhook(projectId, webhookId, managementProjectsWebhooksUpdateRequestBody, (error, data, response) => {
2219
+ if (error) {
2220
+ console.error(error);
2221
+ } else {
2222
+ console.log('API called successfully. Returned data: ' + data);
2223
+ }
2224
+ });
2225
+ ```
2226
+
2227
+ ### Parameters
2228
+
2229
+
2230
+ Name | Type | Description | Notes
2231
+ ------------- | ------------- | ------------- | -------------
2232
+ **projectId** | **String**| Provide the unique identifier of the project. |
2233
+ **webhookId** | **String**| Provide the unique identifier of the webhook configuration. |
2234
+ **managementProjectsWebhooksUpdateRequestBody** | [**ManagementProjectsWebhooksUpdateRequestBody**](ManagementProjectsWebhooksUpdateRequestBody.md)| Defines the webhook configuration to be updated. |
2235
+
2236
+ ### Return type
2237
+
2238
+ [**ManagementProjectsWebhooksUpdateResponseBody**](ManagementProjectsWebhooksUpdateResponseBody.md)
2239
+
2240
+ ### Authorization
2241
+
2242
+ [X-Management-Token](../README.md#X-Management-Token), [X-Management-Id](../README.md#X-Management-Id)
2243
+
2244
+ ### HTTP request headers
2245
+
2246
+ - **Content-Type**: application/json
2247
+ - **Accept**: application/json
2248
+