talon_one 2.4.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1161) hide show
  1. checksums.yaml +4 -4
  2. data/Makefile +43 -0
  3. data/README.md +325 -179
  4. data/docs/AcceptCouponEffectProps.md +1 -1
  5. data/docs/AcceptReferralEffectProps.md +1 -1
  6. data/docs/AccessLogEntry.md +15 -10
  7. data/docs/Account.md +9 -9
  8. data/docs/AccountAdditionalCost.md +13 -11
  9. data/docs/AccountAnalytics.md +37 -35
  10. data/docs/AccountDashboardStatistic.md +27 -0
  11. data/docs/AccountDashboardStatisticApiCalls.md +19 -0
  12. data/docs/AccountDashboardStatisticCampaigns.md +19 -0
  13. data/docs/AccountDashboardStatisticDiscount.md +21 -0
  14. data/docs/AccountDashboardStatisticLoyaltyPoints.md +19 -0
  15. data/docs/AccountDashboardStatisticReferrals.md +19 -0
  16. data/docs/AccountDashboardStatisticRevenue.md +21 -0
  17. data/docs/AccountEntity.md +1 -1
  18. data/docs/AccountLimits.md +12 -12
  19. data/docs/AddFreeItemEffectProps.md +3 -3
  20. data/docs/AddItemCatalogAction.md +23 -0
  21. data/docs/AddLoyaltyPoints.md +31 -0
  22. data/docs/AddLoyaltyPointsEffectProps.md +22 -10
  23. data/docs/AddedDeductedPointsNotificationPolicy.md +19 -0
  24. data/docs/AdditionalCost.md +1 -1
  25. data/docs/Application.md +33 -29
  26. data/docs/ApplicationAPIKey.md +16 -16
  27. data/docs/ApplicationApiHealth.md +3 -3
  28. data/docs/ApplicationCampaignStats.md +6 -6
  29. data/docs/ApplicationCustomer.md +16 -12
  30. data/docs/ApplicationCustomerEntity.md +1 -1
  31. data/docs/ApplicationEntity.md +1 -1
  32. data/docs/ApplicationEvent.md +7 -7
  33. data/docs/ApplicationNotification.md +17 -0
  34. data/docs/ApplicationReferee.md +5 -5
  35. data/docs/ApplicationSession.md +17 -15
  36. data/docs/ApplicationSessionEntity.md +1 -1
  37. data/docs/AsyncCouponCreationResponse.md +17 -0
  38. data/docs/Attribute.md +24 -14
  39. data/docs/Audience.md +19 -11
  40. data/docs/AudienceAnalytics.md +19 -0
  41. data/docs/AudienceCustomer.md +41 -0
  42. data/docs/AudienceIntegrationID.md +17 -0
  43. data/docs/AudienceMembership.md +2 -2
  44. data/docs/AwardGiveawayEffectProps.md +5 -5
  45. data/docs/BaseLoyaltyProgram.md +31 -0
  46. data/docs/BaseNotification.md +21 -0
  47. data/docs/BaseNotificationEntity.md +17 -0
  48. data/docs/BaseNotificationWebhook.md +25 -0
  49. data/docs/BaseNotifications.md +17 -0
  50. data/docs/BaseSamlConnection.md +1 -1
  51. data/docs/Binding.md +6 -4
  52. data/docs/BulkApplicationNotification.md +19 -0
  53. data/docs/BulkCampaignNotification.md +19 -0
  54. data/docs/Campaign.md +47 -37
  55. data/docs/CampaignActivationRequest.md +17 -0
  56. data/docs/CampaignAnalytics.md +8 -8
  57. data/docs/CampaignCollection.md +37 -0
  58. data/docs/CampaignCollectionWithoutPayload.md +35 -0
  59. data/docs/CampaignCopy.md +10 -10
  60. data/docs/CampaignCreatedNotification.md +21 -0
  61. data/docs/CampaignDeletedNotification.md +19 -0
  62. data/docs/CampaignEditedNotification.md +21 -0
  63. data/docs/CampaignEntity.md +1 -1
  64. data/docs/CampaignGroup.md +12 -12
  65. data/docs/CampaignNotification.md +17 -0
  66. data/docs/CampaignPrioritiesChangedNotification.md +21 -0
  67. data/docs/CampaignPrioritiesV2.md +21 -0
  68. data/docs/CampaignRulesetChangedNotification.md +21 -0
  69. data/docs/CampaignSearch.md +1 -1
  70. data/docs/CampaignSet.md +10 -8
  71. data/docs/CampaignSetBranchNode.md +6 -6
  72. data/docs/CampaignSetIDs.md +17 -0
  73. data/docs/CampaignSetLeafNode.md +1 -1
  74. data/docs/CampaignSetNode.md +1 -1
  75. data/docs/CampaignSetV2.md +25 -0
  76. data/docs/CampaignStateChangedNotification.md +23 -0
  77. data/docs/CampaignTemplate.md +61 -0
  78. data/docs/CampaignTemplateCollection.md +19 -0
  79. data/docs/CampaignTemplateParams.md +23 -0
  80. data/docs/CardLedgerTransactionLogEntry.md +41 -0
  81. data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +41 -0
  82. data/docs/CartItem.md +26 -18
  83. data/docs/Catalog.md +33 -0
  84. data/docs/CatalogAction.md +19 -0
  85. data/docs/CatalogActionFilter.md +21 -0
  86. data/docs/CatalogItem.md +29 -0
  87. data/docs/CatalogSyncRequest.md +19 -0
  88. data/docs/CatalogsStrikethroughNotificationPolicy.md +17 -0
  89. data/docs/Change.md +12 -10
  90. data/docs/ChangeProfilePassword.md +2 -2
  91. data/docs/CodeGeneratorSettings.md +4 -4
  92. data/docs/Collection.md +39 -0
  93. data/docs/CollectionItem.md +17 -0
  94. data/docs/CollectionWithoutPayload.md +37 -0
  95. data/docs/Coupon.md +33 -25
  96. data/docs/CouponConstraints.md +9 -7
  97. data/docs/CouponCreatedEffectProps.md +2 -2
  98. data/docs/CouponCreationJob.md +59 -0
  99. data/docs/CouponLimitConfigs.md +17 -0
  100. data/docs/CouponRejectionReason.md +3 -3
  101. data/docs/CouponReservations.md +2 -2
  102. data/docs/CouponSearch.md +1 -1
  103. data/docs/CouponValue.md +2 -2
  104. data/docs/CouponsNotificationPolicy.md +19 -0
  105. data/docs/CreateApplicationAPIKey.md +6 -6
  106. data/docs/CreateManagementKey.md +23 -0
  107. data/docs/CreateTemplateCampaign.md +31 -0
  108. data/docs/CreateTemplateCampaignResponse.md +21 -0
  109. data/docs/CustomEffect.md +14 -12
  110. data/docs/CustomEffectProps.md +12 -2
  111. data/docs/CustomerActivityReport.md +4 -4
  112. data/docs/CustomerAnalytics.md +7 -7
  113. data/docs/CustomerInventory.md +2 -2
  114. data/docs/CustomerProfile.md +17 -13
  115. data/docs/CustomerProfileAudienceRequestItem.md +6 -6
  116. data/docs/CustomerProfileIntegrationRequestV2.md +6 -4
  117. data/docs/CustomerProfileSearchQuery.md +1 -1
  118. data/docs/CustomerProfileUpdateV2Response.md +17 -0
  119. data/docs/CustomerSession.md +16 -14
  120. data/docs/CustomerSessionV2.md +34 -26
  121. data/docs/DeductLoyaltyPoints.md +23 -0
  122. data/docs/DeductLoyaltyPointsEffectProps.md +10 -6
  123. data/docs/Effect.md +15 -13
  124. data/docs/EffectEntity.md +14 -12
  125. data/docs/EmailEntity.md +1 -1
  126. data/docs/Endpoint.md +17 -0
  127. data/docs/Entity.md +4 -4
  128. data/docs/EntityWithTalangVisibleID.md +2 -2
  129. data/docs/Environment.md +9 -7
  130. data/docs/ErrorResponseWithStatus.md +21 -0
  131. data/docs/ErrorSource.md +1 -1
  132. data/docs/EvaluableCampaignIds.md +17 -0
  133. data/docs/Event.md +11 -11
  134. data/docs/EventType.md +10 -24
  135. data/docs/EventV2.md +23 -0
  136. data/docs/ExpiringPointsNotificationPolicy.md +19 -0
  137. data/docs/ExpiringPointsNotificationTrigger.md +19 -0
  138. data/docs/Export.md +8 -8
  139. data/docs/FeatureFlag.md +7 -7
  140. data/docs/FeedNotification.md +6 -6
  141. data/docs/FrontendState.md +16 -0
  142. data/docs/Giveaway.md +13 -9
  143. data/docs/GiveawaysPool.md +11 -9
  144. data/docs/Import.md +11 -11
  145. data/docs/ImportEntity.md +1 -1
  146. data/docs/InlineResponse200.md +1 -1
  147. data/docs/InlineResponse2001.md +3 -3
  148. data/docs/InlineResponse20010.md +2 -2
  149. data/docs/InlineResponse20011.md +3 -5
  150. data/docs/InlineResponse20012.md +2 -2
  151. data/docs/InlineResponse20013.md +3 -3
  152. data/docs/InlineResponse20014.md +4 -2
  153. data/docs/InlineResponse20015.md +2 -2
  154. data/docs/InlineResponse20016.md +5 -3
  155. data/docs/InlineResponse20017.md +1 -1
  156. data/docs/InlineResponse20018.md +2 -2
  157. data/docs/InlineResponse20019.md +3 -5
  158. data/docs/InlineResponse2002.md +2 -2
  159. data/docs/InlineResponse20020.md +5 -3
  160. data/docs/InlineResponse20021.md +5 -3
  161. data/docs/InlineResponse20022.md +5 -3
  162. data/docs/InlineResponse20023.md +3 -3
  163. data/docs/InlineResponse20024.md +3 -3
  164. data/docs/InlineResponse20025.md +3 -3
  165. data/docs/InlineResponse20026.md +3 -3
  166. data/docs/InlineResponse20027.md +3 -5
  167. data/docs/InlineResponse20028.md +5 -3
  168. data/docs/InlineResponse20029.md +5 -3
  169. data/docs/InlineResponse2003.md +2 -2
  170. data/docs/InlineResponse20030.md +19 -0
  171. data/docs/InlineResponse20031.md +19 -0
  172. data/docs/InlineResponse20032.md +19 -0
  173. data/docs/InlineResponse20033.md +19 -0
  174. data/docs/InlineResponse20034.md +19 -0
  175. data/docs/InlineResponse20035.md +19 -0
  176. data/docs/InlineResponse20036.md +19 -0
  177. data/docs/InlineResponse20037.md +21 -0
  178. data/docs/InlineResponse20038.md +19 -0
  179. data/docs/InlineResponse20039.md +19 -0
  180. data/docs/InlineResponse2004.md +2 -2
  181. data/docs/InlineResponse2005.md +3 -3
  182. data/docs/InlineResponse2006.md +3 -3
  183. data/docs/InlineResponse2007.md +3 -3
  184. data/docs/InlineResponse2008.md +3 -3
  185. data/docs/InlineResponse2009.md +2 -2
  186. data/docs/InlineResponse201.md +1 -1
  187. data/docs/IntegrationApi.md +932 -220
  188. data/docs/IntegrationCoupon.md +59 -0
  189. data/docs/IntegrationCustomerSessionResponse.md +19 -0
  190. data/docs/IntegrationEntity.md +4 -4
  191. data/docs/IntegrationEvent.md +4 -4
  192. data/docs/IntegrationEventV2Request.md +25 -0
  193. data/docs/IntegrationProfileEntity.md +2 -2
  194. data/docs/IntegrationRequest.md +2 -2
  195. data/docs/IntegrationStateV2.md +8 -4
  196. data/docs/InventoryCoupon.md +36 -28
  197. data/docs/InventoryReferral.md +43 -0
  198. data/docs/ItemAttribute.md +21 -0
  199. data/docs/LedgerEntry.md +17 -17
  200. data/docs/LedgerInfo.md +31 -0
  201. data/docs/LedgerTransactionLogEntryIntegrationAPI.md +39 -0
  202. data/docs/LimitConfig.md +8 -6
  203. data/docs/LimitCounter.md +45 -0
  204. data/docs/LoginParams.md +2 -2
  205. data/docs/Loyalty.md +4 -2
  206. data/docs/LoyaltyBalance.md +23 -0
  207. data/docs/LoyaltyBalances.md +19 -0
  208. data/docs/LoyaltyCard.md +39 -0
  209. data/docs/LoyaltyCardProfileRegistration.md +19 -0
  210. data/docs/LoyaltyCardRegistration.md +17 -0
  211. data/docs/LoyaltyDashboardData.md +33 -0
  212. data/docs/LoyaltyDashboardPointsBreakdown.md +19 -0
  213. data/docs/LoyaltyLedger.md +2 -2
  214. data/docs/LoyaltyLedgerEntry.md +19 -15
  215. data/docs/LoyaltyLedgerTransactions.md +19 -0
  216. data/docs/LoyaltyMembership.md +1 -1
  217. data/docs/LoyaltyProgram.md +26 -16
  218. data/docs/LoyaltyProgramBalance.md +12 -10
  219. data/docs/LoyaltyProgramEntity.md +1 -1
  220. data/docs/LoyaltyProgramLedgers.md +8 -8
  221. data/docs/LoyaltyProgramTransaction.md +49 -0
  222. data/docs/LoyaltyStatistics.md +18 -8
  223. data/docs/LoyaltySubLedger.md +13 -11
  224. data/docs/LoyaltyTier.md +8 -8
  225. data/docs/ManagementApi.md +4100 -1835
  226. data/docs/ManagementKey.md +31 -0
  227. data/docs/ModelReturn.md +37 -0
  228. data/docs/MultipleAttribute.md +17 -0
  229. data/docs/MultipleAudiences.md +19 -0
  230. data/docs/MultipleAudiencesItem.md +25 -0
  231. data/docs/MultipleCustomerProfileIntegrationRequestItem.md +4 -4
  232. data/docs/MultipleCustomerProfileIntegrationResponseV2.md +1 -1
  233. data/docs/MultipleNewAttribute.md +17 -0
  234. data/docs/MultipleNewAudiences.md +17 -0
  235. data/docs/MutableEntity.md +2 -2
  236. data/docs/NewAccountSignUp.md +2 -2
  237. data/docs/NewAdditionalCost.md +8 -6
  238. data/docs/NewApplication.md +26 -22
  239. data/docs/NewApplicationAPIKey.md +18 -18
  240. data/docs/NewAttribute.md +17 -9
  241. data/docs/NewAudience.md +14 -6
  242. data/docs/NewBaseNotification.md +19 -0
  243. data/docs/NewCampaign.md +17 -17
  244. data/docs/NewCampaignCollection.md +19 -0
  245. data/docs/NewCampaignGroup.md +5 -5
  246. data/docs/NewCampaignSet.md +3 -3
  247. data/docs/NewCampaignSetV2.md +21 -0
  248. data/docs/NewCampaignTemplate.md +43 -0
  249. data/docs/NewCatalog.md +21 -0
  250. data/docs/NewCollection.md +21 -0
  251. data/docs/NewCouponCreationJob.md +31 -0
  252. data/docs/NewCoupons.md +24 -18
  253. data/docs/NewCouponsForMultipleRecipients.md +17 -15
  254. data/docs/NewCustomEffect.md +6 -4
  255. data/docs/NewCustomerProfile.md +2 -2
  256. data/docs/NewCustomerSession.md +8 -8
  257. data/docs/NewCustomerSessionV2.md +19 -15
  258. data/docs/NewEvent.md +5 -5
  259. data/docs/NewEventType.md +6 -20
  260. data/docs/NewGiveawaysPool.md +6 -4
  261. data/docs/NewInternalAudience.md +21 -0
  262. data/docs/NewInvitation.md +5 -5
  263. data/docs/NewLoyaltyProgram.md +21 -11
  264. data/docs/NewLoyaltyTier.md +3 -3
  265. data/docs/NewManagementKey.md +33 -0
  266. data/docs/NewMultipleAudiencesItem.md +19 -0
  267. data/docs/NewNotificationWebhook.md +19 -0
  268. data/docs/NewPassword.md +2 -2
  269. data/docs/NewPicklist.md +19 -0
  270. data/docs/NewReferral.md +10 -10
  271. data/docs/NewReferralsForMultipleAdvocates.md +13 -13
  272. data/docs/NewReturn.md +17 -0
  273. data/docs/NewRole.md +8 -8
  274. data/docs/NewRuleset.md +7 -5
  275. data/docs/NewSamlConnection.md +1 -1
  276. data/docs/NewUser.md +3 -3
  277. data/docs/NewWebhook.md +16 -14
  278. data/docs/Notification.md +3 -3
  279. data/docs/NotificationWebhook.md +27 -0
  280. data/docs/OutgoingIntegrationBrazePolicy.md +19 -0
  281. data/docs/OutgoingIntegrationConfiguration.md +21 -0
  282. data/docs/OutgoingIntegrationType.md +25 -0
  283. data/docs/OutgoingIntegrationTypes.md +17 -0
  284. data/docs/OutgoingIntegrationWebhookTemplate.md +27 -0
  285. data/docs/OutgoingIntegrationWebhookTemplates.md +17 -0
  286. data/docs/PatchItemCatalogAction.md +23 -0
  287. data/docs/PatchManyItemsCatalogAction.md +21 -0
  288. data/docs/Picklist.md +31 -0
  289. data/docs/PriorityPosition.md +19 -0
  290. data/docs/ProfileAudiencesChanges.md +2 -2
  291. data/docs/RedeemReferralEffectProps.md +2 -2
  292. data/docs/Referral.md +19 -19
  293. data/docs/ReferralConstraints.md +5 -5
  294. data/docs/ReferralCreatedEffectProps.md +1 -1
  295. data/docs/ReferralRejectionReason.md +1 -1
  296. data/docs/RejectCouponEffectProps.md +5 -5
  297. data/docs/RejectReferralEffectProps.md +5 -5
  298. data/docs/RemoveItemCatalogAction.md +17 -0
  299. data/docs/RemoveManyItemsCatalogAction.md +17 -0
  300. data/docs/ReserveCouponEffectProps.md +21 -0
  301. data/docs/ReturnIntegrationRequest.md +19 -0
  302. data/docs/ReturnedCartItem.md +19 -0
  303. data/docs/Role.md +17 -17
  304. data/docs/RoleAssign.md +4 -4
  305. data/docs/RoleMembership.md +2 -2
  306. data/docs/RoleV2.md +25 -0
  307. data/docs/RoleV2ApplicationDetails.md +21 -0
  308. data/docs/RoleV2PermissionSet.md +19 -0
  309. data/docs/RoleV2Permissions.md +19 -0
  310. data/docs/RoleV2PermissionsRoles.md +21 -0
  311. data/docs/RollbackAddedLoyaltyPointsEffectProps.md +12 -6
  312. data/docs/RollbackCouponEffectProps.md +1 -1
  313. data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +11 -9
  314. data/docs/RollbackDiscountEffectProps.md +13 -3
  315. data/docs/RollbackReferralEffectProps.md +1 -1
  316. data/docs/Rule.md +8 -4
  317. data/docs/RuleFailureReason.md +13 -13
  318. data/docs/Ruleset.md +17 -13
  319. data/docs/SamlConnection.md +5 -5
  320. data/docs/Session.md +5 -5
  321. data/docs/SetDiscountEffectProps.md +6 -4
  322. data/docs/SetDiscountPerAdditionalCostEffectProps.md +25 -0
  323. data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +29 -0
  324. data/docs/SetDiscountPerItemEffectProps.md +17 -5
  325. data/docs/ShowBundleMetadataEffectProps.md +3 -3
  326. data/docs/ShowNotificationEffectProps.md +3 -3
  327. data/docs/StrikethroughChangedItem.md +29 -0
  328. data/docs/StrikethroughEffect.md +27 -0
  329. data/docs/StrikethroughLabelingNotification.md +25 -0
  330. data/docs/StrikethroughSetDiscountPerItemEffectProps.md +19 -0
  331. data/docs/StrikethroughTrigger.md +25 -0
  332. data/docs/TalangAttribute.md +33 -0
  333. data/docs/TalangAttributeVisibility.md +19 -0
  334. data/docs/TemplateArgDef.md +5 -1
  335. data/docs/TemplateDef.md +5 -5
  336. data/docs/TemplateLimitConfig.md +23 -0
  337. data/docs/Tier.md +19 -0
  338. data/docs/TransferLoyaltyCard.md +17 -0
  339. data/docs/TriggerWebhookEffectProps.md +2 -2
  340. data/docs/UpdateAccount.md +2 -2
  341. data/docs/UpdateApplication.md +25 -21
  342. data/docs/UpdateAttributeEffectProps.md +2 -2
  343. data/docs/UpdateAudience.md +2 -2
  344. data/docs/UpdateCampaign.md +15 -15
  345. data/docs/UpdateCampaignCollection.md +17 -0
  346. data/docs/UpdateCampaignGroup.md +5 -5
  347. data/docs/UpdateCampaignTemplate.md +47 -0
  348. data/docs/UpdateCatalog.md +21 -0
  349. data/docs/UpdateCollection.md +19 -0
  350. data/docs/UpdateCoupon.md +17 -11
  351. data/docs/UpdateCouponBatch.md +11 -9
  352. data/docs/UpdateCustomEffect.md +6 -4
  353. data/docs/UpdateLoyaltyCard.md +17 -0
  354. data/docs/UpdateLoyaltyProgram.md +15 -9
  355. data/docs/UpdatePicklist.md +19 -0
  356. data/docs/UpdateReferral.md +7 -7
  357. data/docs/UpdateReferralBatch.md +25 -0
  358. data/docs/UpdateRole.md +8 -8
  359. data/docs/UpdateUser.md +7 -7
  360. data/docs/UpdateUserLatestFeedTimestamp.md +1 -1
  361. data/docs/User.md +17 -17
  362. data/docs/UserEntity.md +2 -2
  363. data/docs/UserFeedNotifications.md +2 -2
  364. data/docs/Webhook.md +22 -20
  365. data/docs/WebhookActivationLogEntry.md +9 -9
  366. data/docs/WebhookLogEntry.md +18 -15
  367. data/docs/WillAwardGiveawayEffectProps.md +3 -3
  368. data/lib/talon_one/api/integration_api.rb +1168 -231
  369. data/lib/talon_one/api/management_api.rb +5076 -2861
  370. data/lib/talon_one/api_client.rb +2 -2
  371. data/lib/talon_one/api_error.rb +2 -2
  372. data/lib/talon_one/configuration.rb +8 -8
  373. data/lib/talon_one/models/accept_coupon_effect_props.rb +3 -3
  374. data/lib/talon_one/models/accept_referral_effect_props.rb +3 -3
  375. data/lib/talon_one/models/access_log_entry.rb +6 -6
  376. data/lib/talon_one/models/account.rb +8 -8
  377. data/lib/talon_one/models/account_additional_cost.rb +98 -10
  378. data/lib/talon_one/models/account_analytics.rb +39 -24
  379. data/lib/talon_one/models/account_dashboard_statistic.rb +271 -0
  380. data/lib/talon_one/models/account_dashboard_statistic_api_calls.rb +227 -0
  381. data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +227 -0
  382. data/lib/talon_one/models/account_dashboard_statistic_discount.rb +242 -0
  383. data/lib/talon_one/models/account_dashboard_statistic_loyalty_points.rb +227 -0
  384. data/lib/talon_one/models/account_dashboard_statistic_referrals.rb +227 -0
  385. data/lib/talon_one/models/account_dashboard_statistic_revenue.rb +242 -0
  386. data/lib/talon_one/models/account_entity.rb +2 -2
  387. data/lib/talon_one/models/account_limits.rb +14 -14
  388. data/lib/talon_one/models/add_free_item_effect_props.rb +4 -4
  389. data/lib/talon_one/models/add_item_catalog_action.rb +245 -0
  390. data/lib/talon_one/models/add_loyalty_points.rb +311 -0
  391. data/lib/talon_one/models/add_loyalty_points_effect_props.rb +109 -15
  392. data/lib/talon_one/models/added_deducted_points_notification_policy.rb +269 -0
  393. data/lib/talon_one/models/additional_cost.rb +2 -2
  394. data/lib/talon_one/models/api_error.rb +2 -2
  395. data/lib/talon_one/models/application.rb +53 -17
  396. data/lib/talon_one/models/application_api_health.rb +5 -5
  397. data/lib/talon_one/models/application_api_key.rb +12 -12
  398. data/lib/talon_one/models/application_campaign_stats.rb +9 -9
  399. data/lib/talon_one/models/application_customer.rb +68 -14
  400. data/lib/talon_one/models/application_customer_entity.rb +2 -2
  401. data/lib/talon_one/models/application_entity.rb +2 -2
  402. data/lib/talon_one/models/application_event.rb +5 -5
  403. data/lib/talon_one/models/application_notification.rb +212 -0
  404. data/lib/talon_one/models/application_referee.rb +44 -6
  405. data/lib/talon_one/models/application_session.rb +60 -11
  406. data/lib/talon_one/models/application_session_entity.rb +2 -2
  407. data/lib/talon_one/models/async_coupon_creation_response.rb +212 -0
  408. data/lib/talon_one/models/attribute.rb +108 -9
  409. data/lib/talon_one/models/attributes_mandatory.rb +2 -2
  410. data/lib/talon_one/models/attributes_settings.rb +2 -2
  411. data/lib/talon_one/models/audience.rb +57 -56
  412. data/lib/talon_one/models/audience_analytics.rb +218 -0
  413. data/lib/talon_one/models/audience_customer.rb +395 -0
  414. data/lib/talon_one/models/audience_integration_id.rb +231 -0
  415. data/lib/talon_one/models/audience_membership.rb +2 -2
  416. data/lib/talon_one/models/award_giveaway_effect_props.rb +21 -2
  417. data/lib/talon_one/models/base_loyalty_program.rb +294 -0
  418. data/lib/talon_one/models/base_notification.rb +260 -0
  419. data/lib/talon_one/models/base_notification_entity.rb +211 -0
  420. data/lib/talon_one/models/base_notification_webhook.rb +275 -0
  421. data/lib/talon_one/models/base_notifications.rb +209 -0
  422. data/lib/talon_one/models/base_saml_connection.rb +2 -2
  423. data/lib/talon_one/models/binding.rb +17 -7
  424. data/lib/talon_one/models/bulk_application_notification.rb +227 -0
  425. data/lib/talon_one/models/bulk_campaign_notification.rb +227 -0
  426. data/lib/talon_one/models/campaign.rb +66 -16
  427. data/lib/talon_one/models/campaign_activation_request.rb +214 -0
  428. data/lib/talon_one/models/campaign_analytics.rb +2 -2
  429. data/lib/talon_one/models/campaign_collection.rb +370 -0
  430. data/lib/talon_one/models/campaign_collection_without_payload.rb +358 -0
  431. data/lib/talon_one/models/campaign_copy.rb +6 -6
  432. data/lib/talon_one/models/campaign_created_notification.rb +235 -0
  433. data/lib/talon_one/models/campaign_deleted_notification.rb +227 -0
  434. data/lib/talon_one/models/campaign_edited_notification.rb +235 -0
  435. data/lib/talon_one/models/campaign_entity.rb +2 -2
  436. data/lib/talon_one/models/campaign_group.rb +7 -7
  437. data/lib/talon_one/models/campaign_group_entity.rb +2 -2
  438. data/lib/talon_one/models/campaign_notification.rb +212 -0
  439. data/lib/talon_one/models/campaign_priorities_changed_notification.rb +236 -0
  440. data/lib/talon_one/models/campaign_priorities_v2.rb +230 -0
  441. data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +230 -0
  442. data/lib/talon_one/models/campaign_search.rb +3 -3
  443. data/lib/talon_one/models/campaign_set.rb +19 -9
  444. data/lib/talon_one/models/campaign_set_branch_node.rb +5 -5
  445. data/lib/talon_one/models/campaign_set_i_ds.rb +208 -0
  446. data/lib/talon_one/models/campaign_set_leaf_node.rb +3 -3
  447. data/lib/talon_one/models/campaign_set_node.rb +2 -2
  448. data/lib/talon_one/models/campaign_set_v2.rb +291 -0
  449. data/lib/talon_one/models/campaign_state_changed_notification.rb +251 -0
  450. data/lib/talon_one/models/campaign_template.rb +543 -0
  451. data/lib/talon_one/models/campaign_template_collection.rb +252 -0
  452. data/lib/talon_one/models/campaign_template_params.rb +305 -0
  453. data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +508 -0
  454. data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +508 -0
  455. data/lib/talon_one/models/cart_item.rb +59 -41
  456. data/lib/talon_one/models/catalog.rb +330 -0
  457. data/lib/talon_one/models/catalog_action.rb +261 -0
  458. data/lib/talon_one/models/catalog_action_filter.rb +277 -0
  459. data/lib/talon_one/models/catalog_item.rb +313 -0
  460. data/lib/talon_one/models/catalog_sync_request.rb +238 -0
  461. data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +231 -0
  462. data/lib/talon_one/models/change.rb +20 -10
  463. data/lib/talon_one/models/change_profile_password.rb +2 -2
  464. data/lib/talon_one/models/code_generator_settings.rb +4 -4
  465. data/lib/talon_one/models/collection.rb +382 -0
  466. data/lib/talon_one/models/collection_item.rb +212 -0
  467. data/lib/talon_one/models/collection_without_payload.rb +370 -0
  468. data/lib/talon_one/models/coupon.rb +100 -15
  469. data/lib/talon_one/models/coupon_constraints.rb +40 -6
  470. data/lib/talon_one/models/coupon_created_effect_props.rb +4 -4
  471. data/lib/talon_one/models/coupon_creation_job.rb +603 -0
  472. data/lib/talon_one/models/coupon_limit_configs.rb +209 -0
  473. data/lib/talon_one/models/coupon_rejection_reason.rb +4 -4
  474. data/lib/talon_one/models/coupon_reservations.rb +3 -3
  475. data/lib/talon_one/models/coupon_search.rb +3 -3
  476. data/lib/talon_one/models/coupon_value.rb +3 -3
  477. data/lib/talon_one/models/coupons_notification_policy.rb +269 -0
  478. data/lib/talon_one/models/create_application_api_key.rb +7 -7
  479. data/lib/talon_one/models/create_management_key.rb +256 -0
  480. data/lib/talon_one/models/create_template_campaign.rb +314 -0
  481. data/lib/talon_one/models/create_template_campaign_response.rb +236 -0
  482. data/lib/talon_one/models/custom_effect.rb +76 -19
  483. data/lib/talon_one/models/custom_effect_props.rb +67 -12
  484. data/lib/talon_one/models/customer_activity_report.rb +24 -5
  485. data/lib/talon_one/models/customer_analytics.rb +10 -10
  486. data/lib/talon_one/models/customer_inventory.rb +4 -3
  487. data/lib/talon_one/models/customer_profile.rb +66 -22
  488. data/lib/talon_one/models/customer_profile_audience_request.rb +2 -2
  489. data/lib/talon_one/models/customer_profile_audience_request_item.rb +24 -2
  490. data/lib/talon_one/models/customer_profile_integration_request_v2.rb +17 -5
  491. data/lib/talon_one/models/customer_profile_search_query.rb +3 -3
  492. data/lib/talon_one/models/customer_profile_update_v2_response.rb +212 -0
  493. data/lib/talon_one/models/customer_session.rb +47 -13
  494. data/lib/talon_one/models/customer_session_v2.rb +103 -30
  495. data/lib/talon_one/models/{loyalty_points.rb → deduct_loyalty_points.rb} +28 -38
  496. data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +51 -11
  497. data/lib/talon_one/models/effect.rb +20 -9
  498. data/lib/talon_one/models/effect_entity.rb +23 -13
  499. data/lib/talon_one/models/email_entity.rb +2 -2
  500. data/lib/talon_one/models/endpoint.rb +212 -0
  501. data/lib/talon_one/models/entity.rb +4 -4
  502. data/lib/talon_one/models/entity_with_talang_visible_id.rb +2 -2
  503. data/lib/talon_one/models/environment.rb +24 -11
  504. data/lib/talon_one/models/error_effect_props.rb +2 -2
  505. data/lib/talon_one/models/error_response.rb +2 -2
  506. data/lib/talon_one/models/error_response_with_status.rb +228 -0
  507. data/lib/talon_one/models/error_source.rb +3 -3
  508. data/lib/talon_one/models/evaluable_campaign_ids.rb +209 -0
  509. data/lib/talon_one/models/event.rb +6 -6
  510. data/lib/talon_one/models/event_type.rb +11 -154
  511. data/lib/talon_one/models/event_v2.rb +264 -0
  512. data/lib/talon_one/models/expiring_points_notification_policy.rb +247 -0
  513. data/lib/talon_one/models/expiring_points_notification_trigger.rb +280 -0
  514. data/lib/talon_one/models/export.rb +8 -8
  515. data/lib/talon_one/models/feature_flag.rb +6 -6
  516. data/lib/talon_one/models/features_feed.rb +2 -2
  517. data/lib/talon_one/models/feed_notification.rb +9 -9
  518. data/lib/talon_one/models/frontend_state.rb +39 -0
  519. data/lib/talon_one/models/func_arg_def.rb +4 -4
  520. data/lib/talon_one/models/function_def.rb +2 -2
  521. data/lib/talon_one/models/giveaway.rb +29 -9
  522. data/lib/talon_one/models/giveaways_pool.rb +22 -7
  523. data/lib/talon_one/models/import.rb +7 -7
  524. data/lib/talon_one/models/import_entity.rb +2 -2
  525. data/lib/talon_one/models/inline_response200.rb +2 -2
  526. data/lib/talon_one/models/inline_response2001.rb +13 -13
  527. data/lib/talon_one/models/inline_response20010.rb +3 -3
  528. data/lib/talon_one/models/inline_response20011.rb +9 -13
  529. data/lib/talon_one/models/inline_response20012.rb +3 -3
  530. data/lib/talon_one/models/inline_response20013.rb +15 -13
  531. data/lib/talon_one/models/inline_response20014.rb +13 -9
  532. data/lib/talon_one/models/inline_response20015.rb +8 -3
  533. data/lib/talon_one/models/inline_response20016.rb +13 -9
  534. data/lib/talon_one/models/inline_response20017.rb +3 -3
  535. data/lib/talon_one/models/inline_response20018.rb +3 -3
  536. data/lib/talon_one/models/inline_response20019.rb +9 -13
  537. data/lib/talon_one/models/inline_response2002.rb +3 -3
  538. data/lib/talon_one/models/inline_response20020.rb +13 -9
  539. data/lib/talon_one/models/inline_response20021.rb +13 -9
  540. data/lib/talon_one/models/inline_response20022.rb +13 -9
  541. data/lib/talon_one/models/inline_response20023.rb +13 -13
  542. data/lib/talon_one/models/inline_response20024.rb +13 -13
  543. data/lib/talon_one/models/inline_response20025.rb +10 -15
  544. data/lib/talon_one/models/inline_response20026.rb +13 -13
  545. data/lib/talon_one/models/inline_response20027.rb +9 -13
  546. data/lib/talon_one/models/inline_response20028.rb +13 -9
  547. data/lib/talon_one/models/inline_response20029.rb +13 -9
  548. data/lib/talon_one/models/inline_response2003.rb +3 -3
  549. data/lib/talon_one/models/inline_response20030.rb +227 -0
  550. data/lib/talon_one/models/inline_response20031.rb +227 -0
  551. data/lib/talon_one/models/inline_response20032.rb +227 -0
  552. data/lib/talon_one/models/inline_response20033.rb +227 -0
  553. data/lib/talon_one/models/inline_response20034.rb +227 -0
  554. data/lib/talon_one/models/inline_response20035.rb +227 -0
  555. data/lib/talon_one/models/inline_response20036.rb +227 -0
  556. data/lib/talon_one/models/inline_response20037.rb +231 -0
  557. data/lib/talon_one/models/inline_response20038.rb +227 -0
  558. data/lib/talon_one/models/inline_response20039.rb +227 -0
  559. data/lib/talon_one/models/inline_response2004.rb +3 -3
  560. data/lib/talon_one/models/inline_response2005.rb +13 -13
  561. data/lib/talon_one/models/inline_response2006.rb +13 -13
  562. data/lib/talon_one/models/inline_response2007.rb +13 -13
  563. data/lib/talon_one/models/inline_response2008.rb +13 -13
  564. data/lib/talon_one/models/inline_response2009.rb +3 -3
  565. data/lib/talon_one/models/inline_response201.rb +2 -2
  566. data/lib/talon_one/models/integration_coupon.rb +569 -0
  567. data/lib/talon_one/models/integration_customer_session_response.rb +217 -0
  568. data/lib/talon_one/models/integration_entity.rb +23 -4
  569. data/lib/talon_one/models/integration_event.rb +3 -3
  570. data/lib/talon_one/models/integration_event_v2_request.rb +298 -0
  571. data/lib/talon_one/models/integration_profile_entity.rb +3 -3
  572. data/lib/talon_one/models/integration_request.rb +3 -3
  573. data/lib/talon_one/models/integration_state.rb +2 -2
  574. data/lib/talon_one/models/integration_state_v2.rb +30 -9
  575. data/lib/talon_one/models/inventory_coupon.rb +98 -13
  576. data/lib/talon_one/models/inventory_referral.rb +446 -0
  577. data/lib/talon_one/models/item_attribute.rb +243 -0
  578. data/lib/talon_one/models/ledger_entry.rb +11 -11
  579. data/lib/talon_one/models/ledger_info.rb +302 -0
  580. data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +474 -0
  581. data/lib/talon_one/models/library_attribute.rb +2 -2
  582. data/lib/talon_one/models/limit_config.rb +28 -6
  583. data/lib/talon_one/models/limit_counter.rb +398 -0
  584. data/lib/talon_one/models/login_params.rb +2 -2
  585. data/lib/talon_one/models/loyalty.rb +16 -4
  586. data/lib/talon_one/models/loyalty_balance.rb +238 -0
  587. data/lib/talon_one/models/{new_feature_flags.rb → loyalty_balances.rb} +22 -30
  588. data/lib/talon_one/models/loyalty_card.rb +419 -0
  589. data/lib/talon_one/models/loyalty_card_profile_registration.rb +246 -0
  590. data/lib/talon_one/models/loyalty_card_registration.rb +212 -0
  591. data/lib/talon_one/models/loyalty_dashboard_data.rb +331 -0
  592. data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +225 -0
  593. data/lib/talon_one/models/loyalty_ledger.rb +4 -4
  594. data/lib/talon_one/models/loyalty_ledger_entry.rb +27 -13
  595. data/lib/talon_one/models/loyalty_ledger_transactions.rb +220 -0
  596. data/lib/talon_one/models/loyalty_membership.rb +2 -2
  597. data/lib/talon_one/models/loyalty_program.rb +143 -37
  598. data/lib/talon_one/models/loyalty_program_balance.rb +21 -11
  599. data/lib/talon_one/models/loyalty_program_entity.rb +2 -2
  600. data/lib/talon_one/models/loyalty_program_ledgers.rb +8 -8
  601. data/lib/talon_one/models/loyalty_program_transaction.rb +553 -0
  602. data/lib/talon_one/models/loyalty_statistics.rb +83 -10
  603. data/lib/talon_one/models/loyalty_sub_ledger.rb +26 -17
  604. data/lib/talon_one/models/loyalty_tier.rb +10 -10
  605. data/lib/talon_one/models/management_key.rb +317 -0
  606. data/lib/talon_one/models/manager_config.rb +2 -2
  607. data/lib/talon_one/models/meta.rb +2 -2
  608. data/lib/talon_one/models/model_return.rb +384 -0
  609. data/lib/talon_one/models/multi_application_entity.rb +2 -2
  610. data/lib/talon_one/models/multiple_attribute.rb +208 -0
  611. data/lib/talon_one/models/{feature_flags.rb → multiple_audiences.rb} +19 -34
  612. data/lib/talon_one/models/multiple_audiences_item.rb +354 -0
  613. data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +2 -2
  614. data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +23 -4
  615. data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +3 -3
  616. data/lib/talon_one/models/multiple_new_attribute.rb +208 -0
  617. data/lib/talon_one/models/multiple_new_audiences.rb +213 -0
  618. data/lib/talon_one/models/mutable_entity.rb +3 -3
  619. data/lib/talon_one/models/new_account.rb +2 -2
  620. data/lib/talon_one/models/new_account_sign_up.rb +2 -2
  621. data/lib/talon_one/models/new_additional_cost.rb +96 -8
  622. data/lib/talon_one/models/new_application.rb +50 -14
  623. data/lib/talon_one/models/new_application_api_key.rb +13 -13
  624. data/lib/talon_one/models/new_attribute.rb +97 -7
  625. data/lib/talon_one/models/new_audience.rb +56 -54
  626. data/lib/talon_one/models/new_base_notification.rb +226 -0
  627. data/lib/talon_one/models/new_campaign.rb +10 -10
  628. data/lib/talon_one/models/new_campaign_collection.rb +253 -0
  629. data/lib/talon_one/models/new_campaign_group.rb +4 -4
  630. data/lib/talon_one/models/new_campaign_set.rb +3 -3
  631. data/lib/talon_one/models/new_campaign_set_v2.rb +261 -0
  632. data/lib/talon_one/models/new_campaign_template.rb +418 -0
  633. data/lib/talon_one/models/new_catalog.rb +240 -0
  634. data/lib/talon_one/models/new_collection.rb +265 -0
  635. data/lib/talon_one/models/new_coupon_creation_job.rb +396 -0
  636. data/lib/talon_one/models/new_coupons.rb +87 -14
  637. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +44 -10
  638. data/lib/talon_one/models/new_custom_effect.rb +74 -16
  639. data/lib/talon_one/models/new_customer_profile.rb +3 -3
  640. data/lib/talon_one/models/new_customer_session.rb +7 -7
  641. data/lib/talon_one/models/new_customer_session_v2.rb +38 -14
  642. data/lib/talon_one/models/new_event.rb +3 -3
  643. data/lib/talon_one/models/new_event_type.rb +9 -152
  644. data/lib/talon_one/models/new_giveaways_pool.rb +22 -7
  645. data/lib/talon_one/models/{update_loyalty_tier.rb → new_internal_audience.rb} +34 -39
  646. data/lib/talon_one/models/new_invitation.rb +5 -5
  647. data/lib/talon_one/models/new_invite_email.rb +2 -2
  648. data/lib/talon_one/models/new_loyalty_program.rb +128 -25
  649. data/lib/talon_one/models/new_loyalty_tier.rb +9 -9
  650. data/lib/talon_one/models/new_management_key.rb +332 -0
  651. data/lib/talon_one/models/new_multiple_audiences_item.rb +266 -0
  652. data/lib/talon_one/models/new_notification_webhook.rb +229 -0
  653. data/lib/talon_one/models/new_password.rb +2 -2
  654. data/lib/talon_one/models/new_password_email.rb +2 -2
  655. data/lib/talon_one/models/new_picklist.rb +263 -0
  656. data/lib/talon_one/models/new_referral.rb +24 -5
  657. data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +7 -7
  658. data/lib/talon_one/models/new_return.rb +214 -0
  659. data/lib/talon_one/models/new_role.rb +17 -17
  660. data/lib/talon_one/models/new_ruleset.rb +17 -5
  661. data/lib/talon_one/models/new_saml_connection.rb +2 -2
  662. data/lib/talon_one/models/new_template_def.rb +2 -2
  663. data/lib/talon_one/models/new_user.rb +2 -2
  664. data/lib/talon_one/models/new_webhook.rb +30 -9
  665. data/lib/talon_one/models/notification.rb +5 -5
  666. data/lib/talon_one/models/notification_webhook.rb +290 -0
  667. data/lib/talon_one/models/outgoing_integration_braze_policy.rb +227 -0
  668. data/lib/talon_one/models/outgoing_integration_configuration.rb +241 -0
  669. data/lib/talon_one/models/outgoing_integration_type.rb +357 -0
  670. data/lib/talon_one/models/outgoing_integration_types.rb +209 -0
  671. data/lib/talon_one/models/outgoing_integration_webhook_template.rb +328 -0
  672. data/lib/talon_one/models/outgoing_integration_webhook_templates.rb +209 -0
  673. data/lib/talon_one/models/patch_item_catalog_action.rb +245 -0
  674. data/lib/talon_one/models/patch_many_items_catalog_action.rb +230 -0
  675. data/lib/talon_one/models/picklist.rb +339 -0
  676. data/lib/talon_one/models/priority_position.rb +264 -0
  677. data/lib/talon_one/models/profile_audiences_changes.rb +2 -2
  678. data/lib/talon_one/models/redeem_referral_effect_props.rb +5 -5
  679. data/lib/talon_one/models/referral.rb +27 -8
  680. data/lib/talon_one/models/referral_constraints.rb +4 -4
  681. data/lib/talon_one/models/referral_created_effect_props.rb +3 -3
  682. data/lib/talon_one/models/referral_rejection_reason.rb +4 -4
  683. data/lib/talon_one/models/reject_coupon_effect_props.rb +7 -7
  684. data/lib/talon_one/models/reject_referral_effect_props.rb +7 -7
  685. data/lib/talon_one/models/remove_item_catalog_action.rb +213 -0
  686. data/lib/talon_one/models/remove_many_items_catalog_action.rb +210 -0
  687. data/lib/talon_one/models/reserve_coupon_effect_props.rb +243 -0
  688. data/lib/talon_one/models/return_integration_request.rb +246 -0
  689. data/lib/talon_one/models/returned_cart_item.rb +222 -0
  690. data/lib/talon_one/models/role.rb +10 -10
  691. data/lib/talon_one/models/role_assign.rb +4 -4
  692. data/lib/talon_one/models/role_membership.rb +4 -4
  693. data/lib/talon_one/models/role_v2.rb +248 -0
  694. data/lib/talon_one/models/role_v2_application_details.rb +227 -0
  695. data/lib/talon_one/models/role_v2_permission_set.rb +228 -0
  696. data/lib/talon_one/models/role_v2_permissions.rb +218 -0
  697. data/lib/talon_one/models/role_v2_permissions_roles.rb +230 -0
  698. data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +74 -10
  699. data/lib/talon_one/models/rollback_coupon_effect_props.rb +3 -3
  700. data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +57 -13
  701. data/lib/talon_one/models/rollback_discount_effect_props.rb +59 -9
  702. data/lib/talon_one/models/rollback_referral_effect_props.rb +3 -3
  703. data/lib/talon_one/models/rule.rb +23 -3
  704. data/lib/talon_one/models/rule_failure_reason.rb +15 -15
  705. data/lib/talon_one/models/ruleset.rb +40 -23
  706. data/lib/talon_one/models/saml_connection.rb +4 -4
  707. data/lib/talon_one/models/saml_connection_metadata.rb +2 -2
  708. data/lib/talon_one/models/saml_login_endpoint.rb +2 -2
  709. data/lib/talon_one/models/session.rb +4 -4
  710. data/lib/talon_one/models/set_discount_effect_props.rb +19 -9
  711. data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +268 -0
  712. data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +293 -0
  713. data/lib/talon_one/models/set_discount_per_item_effect_props.rb +71 -11
  714. data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +6 -6
  715. data/lib/talon_one/models/show_notification_effect_props.rb +5 -5
  716. data/lib/talon_one/models/slot_def.rb +2 -2
  717. data/lib/talon_one/models/strikethrough_changed_item.rb +318 -0
  718. data/lib/talon_one/models/strikethrough_effect.rb +287 -0
  719. data/lib/talon_one/models/strikethrough_labeling_notification.rb +273 -0
  720. data/lib/talon_one/models/strikethrough_set_discount_per_item_effect_props.rb +228 -0
  721. data/lib/talon_one/models/strikethrough_trigger.rb +273 -0
  722. data/lib/talon_one/models/talang_attribute.rb +363 -0
  723. data/lib/talon_one/models/{application_customer_search.rb → talang_attribute_visibility.rb} +22 -30
  724. data/lib/talon_one/models/template_arg_def.rb +28 -8
  725. data/lib/talon_one/models/template_def.rb +4 -4
  726. data/lib/talon_one/models/template_limit_config.rb +308 -0
  727. data/lib/talon_one/models/tier.rb +227 -0
  728. data/lib/talon_one/models/transfer_loyalty_card.rb +231 -0
  729. data/lib/talon_one/models/trigger_webhook_effect_props.rb +4 -4
  730. data/lib/talon_one/models/update_account.rb +4 -4
  731. data/lib/talon_one/models/update_application.rb +52 -16
  732. data/lib/talon_one/models/update_attribute_effect_props.rb +4 -4
  733. data/lib/talon_one/models/update_audience.rb +3 -3
  734. data/lib/talon_one/models/update_campaign.rb +7 -7
  735. data/lib/talon_one/models/update_campaign_collection.rb +207 -0
  736. data/lib/talon_one/models/update_campaign_group.rb +4 -4
  737. data/lib/talon_one/models/update_campaign_template.rb +445 -0
  738. data/lib/talon_one/models/update_catalog.rb +229 -0
  739. data/lib/talon_one/models/update_collection.rb +219 -0
  740. data/lib/talon_one/models/update_coupon.rb +84 -11
  741. data/lib/talon_one/models/update_coupon_batch.rb +39 -10
  742. data/lib/talon_one/models/update_custom_effect.rb +73 -16
  743. data/lib/talon_one/models/update_loyalty_card.rb +212 -0
  744. data/lib/talon_one/models/update_loyalty_program.rb +57 -10
  745. data/lib/talon_one/models/update_picklist.rb +264 -0
  746. data/lib/talon_one/models/update_referral.rb +20 -5
  747. data/lib/talon_one/models/update_referral_batch.rb +276 -0
  748. data/lib/talon_one/models/update_role.rb +14 -14
  749. data/lib/talon_one/models/update_user.rb +5 -5
  750. data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +4 -4
  751. data/lib/talon_one/models/user.rb +7 -7
  752. data/lib/talon_one/models/user_entity.rb +3 -3
  753. data/lib/talon_one/models/user_feed_notifications.rb +5 -5
  754. data/lib/talon_one/models/webhook.rb +33 -12
  755. data/lib/talon_one/models/webhook_activation_log_entry.rb +7 -7
  756. data/lib/talon_one/models/webhook_log_entry.rb +8 -8
  757. data/lib/talon_one/models/will_award_giveaway_effect_props.rb +21 -2
  758. data/lib/talon_one/version.rb +3 -3
  759. data/lib/talon_one.rb +153 -7
  760. data/spec/api/integration_api_spec.rb +249 -72
  761. data/spec/api/management_api_spec.rb +951 -580
  762. data/spec/api_client_spec.rb +2 -2
  763. data/spec/configuration_spec.rb +5 -5
  764. data/spec/models/accept_coupon_effect_props_spec.rb +2 -2
  765. data/spec/models/accept_referral_effect_props_spec.rb +2 -2
  766. data/spec/models/access_log_entry_spec.rb +2 -2
  767. data/spec/models/account_additional_cost_spec.rb +12 -2
  768. data/spec/models/account_analytics_spec.rb +8 -2
  769. data/spec/models/account_dashboard_statistic_api_calls_spec.rb +47 -0
  770. data/spec/models/account_dashboard_statistic_campaigns_spec.rb +47 -0
  771. data/spec/models/account_dashboard_statistic_discount_spec.rb +53 -0
  772. data/spec/models/account_dashboard_statistic_loyalty_points_spec.rb +47 -0
  773. data/spec/models/account_dashboard_statistic_referrals_spec.rb +47 -0
  774. data/spec/models/account_dashboard_statistic_revenue_spec.rb +53 -0
  775. data/spec/models/account_dashboard_statistic_spec.rb +71 -0
  776. data/spec/models/account_entity_spec.rb +2 -2
  777. data/spec/models/account_limits_spec.rb +2 -2
  778. data/spec/models/account_spec.rb +2 -2
  779. data/spec/models/add_free_item_effect_props_spec.rb +2 -2
  780. data/spec/models/add_item_catalog_action_spec.rb +59 -0
  781. data/spec/models/add_loyalty_points_effect_props_spec.rb +38 -2
  782. data/spec/models/add_loyalty_points_spec.rb +83 -0
  783. data/spec/models/added_deducted_points_notification_policy_spec.rb +51 -0
  784. data/spec/models/additional_cost_spec.rb +2 -2
  785. data/spec/models/api_error_spec.rb +2 -2
  786. data/spec/models/application_api_health_spec.rb +2 -2
  787. data/spec/models/application_api_key_spec.rb +3 -3
  788. data/spec/models/application_campaign_stats_spec.rb +2 -2
  789. data/spec/models/application_customer_entity_spec.rb +2 -2
  790. data/spec/models/application_customer_spec.rb +14 -2
  791. data/spec/models/application_entity_spec.rb +2 -2
  792. data/spec/models/application_event_spec.rb +2 -2
  793. data/spec/models/application_notification_spec.rb +41 -0
  794. data/spec/models/application_referee_spec.rb +2 -2
  795. data/spec/models/application_session_entity_spec.rb +2 -2
  796. data/spec/models/application_session_spec.rb +9 -3
  797. data/spec/models/application_spec.rb +18 -2
  798. data/spec/models/async_coupon_creation_response_spec.rb +41 -0
  799. data/spec/models/attribute_spec.rb +36 -2
  800. data/spec/models/attributes_mandatory_spec.rb +2 -2
  801. data/spec/models/attributes_settings_spec.rb +2 -2
  802. data/spec/models/audience_analytics_spec.rb +47 -0
  803. data/spec/models/audience_customer_spec.rb +113 -0
  804. data/spec/models/audience_integration_id_spec.rb +41 -0
  805. data/spec/models/audience_membership_spec.rb +2 -2
  806. data/spec/models/audience_spec.rb +26 -6
  807. data/spec/models/award_giveaway_effect_props_spec.rb +2 -2
  808. data/spec/models/base_loyalty_program_spec.rb +83 -0
  809. data/spec/models/base_notification_entity_spec.rb +41 -0
  810. data/spec/models/base_notification_spec.rb +53 -0
  811. data/spec/models/base_notification_webhook_spec.rb +65 -0
  812. data/spec/models/base_notifications_spec.rb +41 -0
  813. data/spec/models/base_saml_connection_spec.rb +2 -2
  814. data/spec/models/binding_spec.rb +8 -2
  815. data/spec/models/bulk_application_notification_spec.rb +47 -0
  816. data/spec/models/bulk_campaign_notification_spec.rb +47 -0
  817. data/spec/models/campaign_activation_request_spec.rb +41 -0
  818. data/spec/models/campaign_analytics_spec.rb +2 -2
  819. data/spec/models/campaign_collection_spec.rb +101 -0
  820. data/spec/models/campaign_collection_without_payload_spec.rb +95 -0
  821. data/spec/models/campaign_copy_spec.rb +2 -2
  822. data/spec/models/campaign_created_notification_spec.rb +53 -0
  823. data/spec/models/campaign_deleted_notification_spec.rb +47 -0
  824. data/spec/models/campaign_edited_notification_spec.rb +53 -0
  825. data/spec/models/campaign_entity_spec.rb +2 -2
  826. data/spec/models/campaign_group_entity_spec.rb +2 -2
  827. data/spec/models/campaign_group_spec.rb +2 -2
  828. data/spec/models/campaign_notification_spec.rb +41 -0
  829. data/spec/models/campaign_priorities_changed_notification_spec.rb +53 -0
  830. data/spec/models/campaign_priorities_v2_spec.rb +53 -0
  831. data/spec/models/campaign_ruleset_changed_notification_spec.rb +53 -0
  832. data/spec/models/campaign_search_spec.rb +2 -2
  833. data/spec/models/campaign_set_branch_node_spec.rb +2 -2
  834. data/spec/models/campaign_set_i_ds_spec.rb +41 -0
  835. data/spec/models/campaign_set_leaf_node_spec.rb +2 -2
  836. data/spec/models/campaign_set_node_spec.rb +2 -2
  837. data/spec/models/campaign_set_spec.rb +8 -2
  838. data/spec/models/campaign_set_v2_spec.rb +65 -0
  839. data/spec/models/campaign_spec.rb +33 -3
  840. data/spec/models/campaign_state_changed_notification_spec.rb +59 -0
  841. data/spec/models/campaign_template_collection_spec.rb +47 -0
  842. data/spec/models/campaign_template_params_spec.rb +63 -0
  843. data/spec/models/campaign_template_spec.rb +181 -0
  844. data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +117 -0
  845. data/spec/models/card_ledger_transaction_log_entry_spec.rb +117 -0
  846. data/spec/models/cart_item_spec.rb +26 -2
  847. data/spec/models/catalog_action_filter_spec.rb +57 -0
  848. data/spec/models/catalog_action_spec.rb +51 -0
  849. data/spec/models/catalog_item_spec.rb +77 -0
  850. data/spec/models/catalog_spec.rb +89 -0
  851. data/spec/models/catalog_sync_request_spec.rb +47 -0
  852. data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +41 -0
  853. data/spec/models/change_profile_password_spec.rb +2 -2
  854. data/spec/models/change_spec.rb +8 -2
  855. data/spec/models/code_generator_settings_spec.rb +2 -2
  856. data/spec/models/collection_item_spec.rb +41 -0
  857. data/spec/models/collection_spec.rb +107 -0
  858. data/spec/models/collection_without_payload_spec.rb +101 -0
  859. data/spec/models/coupon_constraints_spec.rb +8 -2
  860. data/spec/models/coupon_created_effect_props_spec.rb +2 -2
  861. data/spec/models/coupon_creation_job_spec.rb +167 -0
  862. data/spec/models/coupon_limit_configs_spec.rb +41 -0
  863. data/spec/models/coupon_rejection_reason_spec.rb +3 -3
  864. data/spec/models/coupon_reservations_spec.rb +2 -2
  865. data/spec/models/coupon_search_spec.rb +2 -2
  866. data/spec/models/coupon_spec.rb +26 -2
  867. data/spec/models/coupon_value_spec.rb +2 -2
  868. data/spec/models/coupons_notification_policy_spec.rb +51 -0
  869. data/spec/models/create_application_api_key_spec.rb +3 -3
  870. data/spec/models/create_management_key_spec.rb +59 -0
  871. data/spec/models/create_template_campaign_response_spec.rb +53 -0
  872. data/spec/models/create_template_campaign_spec.rb +83 -0
  873. data/spec/models/custom_effect_props_spec.rb +33 -3
  874. data/spec/models/custom_effect_spec.rb +14 -8
  875. data/spec/models/customer_activity_report_spec.rb +2 -2
  876. data/spec/models/customer_analytics_spec.rb +2 -2
  877. data/spec/models/customer_inventory_spec.rb +2 -2
  878. data/spec/models/customer_profile_audience_request_item_spec.rb +2 -2
  879. data/spec/models/customer_profile_audience_request_spec.rb +2 -2
  880. data/spec/models/customer_profile_integration_request_v2_spec.rb +8 -2
  881. data/spec/models/customer_profile_search_query_spec.rb +2 -2
  882. data/spec/models/customer_profile_spec.rb +15 -3
  883. data/spec/models/customer_profile_update_v2_response_spec.rb +41 -0
  884. data/spec/models/customer_session_spec.rb +9 -3
  885. data/spec/models/customer_session_v2_spec.rb +28 -4
  886. data/spec/models/deduct_loyalty_points_effect_props_spec.rb +14 -2
  887. data/spec/models/deduct_loyalty_points_spec.rb +59 -0
  888. data/spec/models/effect_entity_spec.rb +8 -2
  889. data/spec/models/effect_spec.rb +8 -2
  890. data/spec/models/email_entity_spec.rb +2 -2
  891. data/spec/models/endpoint_spec.rb +41 -0
  892. data/spec/models/entity_spec.rb +2 -2
  893. data/spec/models/entity_with_talang_visible_id_spec.rb +2 -2
  894. data/spec/models/environment_spec.rb +9 -3
  895. data/spec/models/error_effect_props_spec.rb +2 -2
  896. data/spec/models/error_response_spec.rb +2 -2
  897. data/spec/models/error_response_with_status_spec.rb +53 -0
  898. data/spec/models/error_source_spec.rb +2 -2
  899. data/spec/models/evaluable_campaign_ids_spec.rb +41 -0
  900. data/spec/models/event_spec.rb +2 -2
  901. data/spec/models/event_type_spec.rb +2 -52
  902. data/spec/models/event_v2_spec.rb +59 -0
  903. data/spec/models/expiring_points_notification_policy_spec.rb +47 -0
  904. data/spec/models/expiring_points_notification_trigger_spec.rb +51 -0
  905. data/spec/models/export_spec.rb +3 -3
  906. data/spec/models/feature_flag_spec.rb +2 -2
  907. data/spec/models/features_feed_spec.rb +2 -2
  908. data/spec/models/feed_notification_spec.rb +2 -2
  909. data/spec/models/frontend_state_spec.rb +35 -0
  910. data/spec/models/func_arg_def_spec.rb +3 -3
  911. data/spec/models/function_def_spec.rb +2 -2
  912. data/spec/models/giveaway_spec.rb +14 -2
  913. data/spec/models/giveaways_pool_spec.rb +8 -2
  914. data/spec/models/import_entity_spec.rb +2 -2
  915. data/spec/models/import_spec.rb +2 -2
  916. data/spec/models/inline_response20010_spec.rb +2 -2
  917. data/spec/models/inline_response20011_spec.rb +2 -8
  918. data/spec/models/inline_response20012_spec.rb +2 -2
  919. data/spec/models/inline_response20013_spec.rb +3 -3
  920. data/spec/models/inline_response20014_spec.rb +8 -2
  921. data/spec/models/inline_response20015_spec.rb +2 -2
  922. data/spec/models/inline_response20016_spec.rb +8 -2
  923. data/spec/models/inline_response20017_spec.rb +2 -2
  924. data/spec/models/inline_response20018_spec.rb +2 -2
  925. data/spec/models/inline_response20019_spec.rb +2 -8
  926. data/spec/models/inline_response2001_spec.rb +3 -3
  927. data/spec/models/inline_response20020_spec.rb +8 -2
  928. data/spec/models/inline_response20021_spec.rb +8 -2
  929. data/spec/models/inline_response20022_spec.rb +8 -2
  930. data/spec/models/inline_response20023_spec.rb +3 -3
  931. data/spec/models/inline_response20024_spec.rb +3 -3
  932. data/spec/models/inline_response20025_spec.rb +3 -3
  933. data/spec/models/inline_response20026_spec.rb +3 -3
  934. data/spec/models/inline_response20027_spec.rb +2 -8
  935. data/spec/models/inline_response20028_spec.rb +8 -2
  936. data/spec/models/inline_response20029_spec.rb +8 -2
  937. data/spec/models/inline_response2002_spec.rb +2 -2
  938. data/spec/models/inline_response20030_spec.rb +47 -0
  939. data/spec/models/inline_response20031_spec.rb +47 -0
  940. data/spec/models/inline_response20032_spec.rb +47 -0
  941. data/spec/models/inline_response20033_spec.rb +47 -0
  942. data/spec/models/inline_response20034_spec.rb +47 -0
  943. data/spec/models/inline_response20035_spec.rb +47 -0
  944. data/spec/models/inline_response20036_spec.rb +47 -0
  945. data/spec/models/inline_response20037_spec.rb +53 -0
  946. data/spec/models/inline_response20038_spec.rb +47 -0
  947. data/spec/models/inline_response20039_spec.rb +47 -0
  948. data/spec/models/inline_response2003_spec.rb +2 -2
  949. data/spec/models/inline_response2004_spec.rb +2 -2
  950. data/spec/models/inline_response2005_spec.rb +3 -3
  951. data/spec/models/inline_response2006_spec.rb +3 -3
  952. data/spec/models/inline_response2007_spec.rb +3 -3
  953. data/spec/models/inline_response2008_spec.rb +3 -3
  954. data/spec/models/inline_response2009_spec.rb +2 -2
  955. data/spec/models/inline_response200_spec.rb +2 -2
  956. data/spec/models/inline_response201_spec.rb +2 -2
  957. data/spec/models/integration_coupon_spec.rb +167 -0
  958. data/spec/models/integration_customer_session_response_spec.rb +47 -0
  959. data/spec/models/integration_entity_spec.rb +2 -2
  960. data/spec/models/integration_event_spec.rb +2 -2
  961. data/spec/models/integration_event_v2_request_spec.rb +69 -0
  962. data/spec/models/integration_profile_entity_spec.rb +2 -2
  963. data/spec/models/integration_request_spec.rb +3 -3
  964. data/spec/models/integration_state_spec.rb +2 -2
  965. data/spec/models/integration_state_v2_spec.rb +14 -2
  966. data/spec/models/inventory_coupon_spec.rb +26 -2
  967. data/spec/models/inventory_referral_spec.rb +119 -0
  968. data/spec/models/item_attribute_spec.rb +53 -0
  969. data/spec/models/ledger_entry_spec.rb +2 -2
  970. data/spec/models/ledger_info_spec.rb +83 -0
  971. data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +111 -0
  972. data/spec/models/library_attribute_spec.rb +2 -2
  973. data/spec/models/limit_config_spec.rb +12 -2
  974. data/spec/models/limit_counter_spec.rb +125 -0
  975. data/spec/models/login_params_spec.rb +2 -2
  976. data/spec/models/loyalty_balance_spec.rb +59 -0
  977. data/spec/models/loyalty_balances_spec.rb +47 -0
  978. data/spec/models/loyalty_card_profile_registration_spec.rb +47 -0
  979. data/spec/models/loyalty_card_registration_spec.rb +41 -0
  980. data/spec/models/loyalty_card_spec.rb +107 -0
  981. data/spec/models/loyalty_dashboard_data_spec.rb +89 -0
  982. data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +47 -0
  983. data/spec/models/loyalty_ledger_entry_spec.rb +14 -2
  984. data/spec/models/loyalty_ledger_spec.rb +2 -2
  985. data/spec/models/loyalty_ledger_transactions_spec.rb +47 -0
  986. data/spec/models/loyalty_membership_spec.rb +2 -2
  987. data/spec/models/loyalty_program_balance_spec.rb +8 -2
  988. data/spec/models/loyalty_program_entity_spec.rb +2 -2
  989. data/spec/models/loyalty_program_ledgers_spec.rb +2 -2
  990. data/spec/models/loyalty_program_spec.rb +39 -9
  991. data/spec/models/loyalty_program_transaction_spec.rb +141 -0
  992. data/spec/models/loyalty_spec.rb +8 -2
  993. data/spec/models/loyalty_statistics_spec.rb +32 -2
  994. data/spec/models/loyalty_sub_ledger_spec.rb +8 -2
  995. data/spec/models/loyalty_tier_spec.rb +2 -2
  996. data/spec/models/management_key_spec.rb +83 -0
  997. data/spec/models/manager_config_spec.rb +2 -2
  998. data/spec/models/meta_spec.rb +2 -2
  999. data/spec/models/model_return_spec.rb +101 -0
  1000. data/spec/models/multi_application_entity_spec.rb +2 -2
  1001. data/spec/models/multiple_attribute_spec.rb +41 -0
  1002. data/spec/models/multiple_audiences_item_spec.rb +69 -0
  1003. data/spec/models/multiple_audiences_spec.rb +47 -0
  1004. data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +2 -2
  1005. data/spec/models/multiple_customer_profile_integration_request_spec.rb +2 -2
  1006. data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +2 -2
  1007. data/spec/models/multiple_new_attribute_spec.rb +41 -0
  1008. data/spec/models/multiple_new_audiences_spec.rb +41 -0
  1009. data/spec/models/mutable_entity_spec.rb +2 -2
  1010. data/spec/models/new_account_sign_up_spec.rb +2 -2
  1011. data/spec/models/new_account_spec.rb +2 -2
  1012. data/spec/models/new_additional_cost_spec.rb +12 -2
  1013. data/spec/models/new_application_api_key_spec.rb +3 -3
  1014. data/spec/models/new_application_spec.rb +18 -2
  1015. data/spec/models/new_attribute_spec.rb +30 -2
  1016. data/spec/models/new_audience_spec.rb +26 -6
  1017. data/spec/models/new_base_notification_spec.rb +47 -0
  1018. data/spec/models/new_campaign_collection_spec.rb +47 -0
  1019. data/spec/models/new_campaign_group_spec.rb +2 -2
  1020. data/spec/models/new_campaign_set_spec.rb +2 -2
  1021. data/spec/models/new_campaign_set_v2_spec.rb +53 -0
  1022. data/spec/models/new_campaign_spec.rb +3 -3
  1023. data/spec/models/new_campaign_template_spec.rb +127 -0
  1024. data/spec/models/new_catalog_spec.rb +53 -0
  1025. data/spec/models/new_collection_spec.rb +53 -0
  1026. data/spec/models/new_coupon_creation_job_spec.rb +83 -0
  1027. data/spec/models/new_coupons_for_multiple_recipients_spec.rb +8 -2
  1028. data/spec/models/new_coupons_spec.rb +20 -2
  1029. data/spec/models/new_custom_effect_spec.rb +14 -8
  1030. data/spec/models/new_customer_profile_spec.rb +2 -2
  1031. data/spec/models/new_customer_session_spec.rb +3 -3
  1032. data/spec/models/new_customer_session_v2_spec.rb +15 -3
  1033. data/spec/models/new_event_spec.rb +2 -2
  1034. data/spec/models/new_event_type_spec.rb +2 -52
  1035. data/spec/models/new_giveaways_pool_spec.rb +8 -2
  1036. data/spec/models/new_internal_audience_spec.rb +53 -0
  1037. data/spec/models/new_invitation_spec.rb +2 -2
  1038. data/spec/models/new_invite_email_spec.rb +2 -2
  1039. data/spec/models/new_loyalty_program_spec.rb +38 -8
  1040. data/spec/models/new_loyalty_tier_spec.rb +2 -2
  1041. data/spec/models/new_management_key_spec.rb +89 -0
  1042. data/spec/models/new_multiple_audiences_item_spec.rb +47 -0
  1043. data/spec/models/new_notification_webhook_spec.rb +47 -0
  1044. data/spec/models/new_password_email_spec.rb +2 -2
  1045. data/spec/models/new_password_spec.rb +2 -2
  1046. data/spec/models/new_picklist_spec.rb +51 -0
  1047. data/spec/models/new_referral_spec.rb +2 -2
  1048. data/spec/models/new_referrals_for_multiple_advocates_spec.rb +2 -2
  1049. data/spec/models/new_return_spec.rb +41 -0
  1050. data/spec/models/new_role_spec.rb +3 -3
  1051. data/spec/models/new_ruleset_spec.rb +8 -2
  1052. data/spec/models/new_saml_connection_spec.rb +2 -2
  1053. data/spec/models/new_template_def_spec.rb +2 -2
  1054. data/spec/models/new_user_spec.rb +2 -2
  1055. data/spec/models/new_webhook_spec.rb +2 -2
  1056. data/spec/models/notification_spec.rb +2 -2
  1057. data/spec/models/notification_webhook_spec.rb +71 -0
  1058. data/spec/models/outgoing_integration_braze_policy_spec.rb +47 -0
  1059. data/spec/models/outgoing_integration_configuration_spec.rb +53 -0
  1060. data/spec/models/outgoing_integration_type_spec.rb +65 -0
  1061. data/spec/models/outgoing_integration_types_spec.rb +41 -0
  1062. data/spec/models/outgoing_integration_webhook_template_spec.rb +65 -0
  1063. data/spec/models/outgoing_integration_webhook_templates_spec.rb +41 -0
  1064. data/spec/models/patch_item_catalog_action_spec.rb +59 -0
  1065. data/spec/models/patch_many_items_catalog_action_spec.rb +53 -0
  1066. data/spec/models/picklist_spec.rb +87 -0
  1067. data/spec/models/priority_position_spec.rb +51 -0
  1068. data/spec/models/profile_audiences_changes_spec.rb +2 -2
  1069. data/spec/models/redeem_referral_effect_props_spec.rb +2 -2
  1070. data/spec/models/referral_constraints_spec.rb +2 -2
  1071. data/spec/models/referral_created_effect_props_spec.rb +2 -2
  1072. data/spec/models/referral_rejection_reason_spec.rb +3 -3
  1073. data/spec/models/referral_spec.rb +2 -2
  1074. data/spec/models/reject_coupon_effect_props_spec.rb +2 -2
  1075. data/spec/models/reject_referral_effect_props_spec.rb +2 -2
  1076. data/spec/models/remove_item_catalog_action_spec.rb +41 -0
  1077. data/spec/models/remove_many_items_catalog_action_spec.rb +41 -0
  1078. data/spec/models/reserve_coupon_effect_props_spec.rb +53 -0
  1079. data/spec/models/return_integration_request_spec.rb +51 -0
  1080. data/spec/models/returned_cart_item_spec.rb +47 -0
  1081. data/spec/models/role_assign_spec.rb +2 -2
  1082. data/spec/models/role_membership_spec.rb +2 -2
  1083. data/spec/models/role_spec.rb +2 -2
  1084. data/spec/models/role_v2_application_details_spec.rb +53 -0
  1085. data/spec/models/role_v2_permission_set_spec.rb +47 -0
  1086. data/spec/models/role_v2_permissions_roles_spec.rb +53 -0
  1087. data/spec/models/role_v2_permissions_spec.rb +47 -0
  1088. data/spec/models/role_v2_spec.rb +65 -0
  1089. data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +20 -2
  1090. data/spec/models/rollback_coupon_effect_props_spec.rb +2 -2
  1091. data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +8 -2
  1092. data/spec/models/rollback_discount_effect_props_spec.rb +32 -2
  1093. data/spec/models/rollback_referral_effect_props_spec.rb +2 -2
  1094. data/spec/models/rule_failure_reason_spec.rb +2 -2
  1095. data/spec/models/rule_spec.rb +14 -2
  1096. data/spec/models/ruleset_spec.rb +17 -5
  1097. data/spec/models/saml_connection_metadata_spec.rb +2 -2
  1098. data/spec/models/saml_connection_spec.rb +2 -2
  1099. data/spec/models/saml_login_endpoint_spec.rb +2 -2
  1100. data/spec/models/session_spec.rb +2 -2
  1101. data/spec/models/set_discount_effect_props_spec.rb +8 -2
  1102. data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +65 -0
  1103. data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +77 -0
  1104. data/spec/models/set_discount_per_item_effect_props_spec.rb +38 -2
  1105. data/spec/models/show_bundle_metadata_effect_props_spec.rb +2 -2
  1106. data/spec/models/show_notification_effect_props_spec.rb +2 -2
  1107. data/spec/models/slot_def_spec.rb +2 -2
  1108. data/spec/models/strikethrough_changed_item_spec.rb +77 -0
  1109. data/spec/models/strikethrough_effect_spec.rb +71 -0
  1110. data/spec/models/strikethrough_labeling_notification_spec.rb +65 -0
  1111. data/spec/models/strikethrough_set_discount_per_item_effect_props_spec.rb +47 -0
  1112. data/spec/models/strikethrough_trigger_spec.rb +65 -0
  1113. data/spec/models/talang_attribute_spec.rb +97 -0
  1114. data/spec/models/talang_attribute_visibility_spec.rb +47 -0
  1115. data/spec/models/template_arg_def_spec.rb +15 -3
  1116. data/spec/models/template_def_spec.rb +2 -2
  1117. data/spec/models/template_limit_config_spec.rb +67 -0
  1118. data/spec/models/tier_spec.rb +47 -0
  1119. data/spec/models/transfer_loyalty_card_spec.rb +41 -0
  1120. data/spec/models/trigger_webhook_effect_props_spec.rb +2 -2
  1121. data/spec/models/update_account_spec.rb +2 -2
  1122. data/spec/models/update_application_spec.rb +18 -2
  1123. data/spec/models/update_attribute_effect_props_spec.rb +2 -2
  1124. data/spec/models/update_audience_spec.rb +2 -2
  1125. data/spec/models/update_campaign_collection_spec.rb +41 -0
  1126. data/spec/models/update_campaign_group_spec.rb +2 -2
  1127. data/spec/models/update_campaign_spec.rb +3 -3
  1128. data/spec/models/update_campaign_template_spec.rb +139 -0
  1129. data/spec/models/update_catalog_spec.rb +53 -0
  1130. data/spec/models/update_collection_spec.rb +47 -0
  1131. data/spec/models/update_coupon_batch_spec.rb +8 -2
  1132. data/spec/models/update_coupon_spec.rb +20 -2
  1133. data/spec/models/update_custom_effect_spec.rb +14 -8
  1134. data/spec/models/update_loyalty_card_spec.rb +41 -0
  1135. data/spec/models/update_loyalty_program_spec.rb +20 -2
  1136. data/spec/models/update_picklist_spec.rb +51 -0
  1137. data/spec/models/update_referral_batch_spec.rb +65 -0
  1138. data/spec/models/update_referral_spec.rb +2 -2
  1139. data/spec/models/update_role_spec.rb +3 -3
  1140. data/spec/models/update_user_latest_feed_timestamp_spec.rb +2 -2
  1141. data/spec/models/update_user_spec.rb +2 -2
  1142. data/spec/models/user_entity_spec.rb +2 -2
  1143. data/spec/models/user_feed_notifications_spec.rb +2 -2
  1144. data/spec/models/user_spec.rb +2 -2
  1145. data/spec/models/webhook_activation_log_entry_spec.rb +2 -2
  1146. data/spec/models/webhook_log_entry_spec.rb +2 -2
  1147. data/spec/models/webhook_spec.rb +2 -2
  1148. data/spec/models/will_award_giveaway_effect_props_spec.rb +2 -2
  1149. data/spec/spec_helper.rb +2 -2
  1150. data/talon_one.gemspec +2 -2
  1151. metadata +828 -243
  1152. data/docs/ApplicationCustomerSearch.md +0 -21
  1153. data/docs/FeatureFlags.md +0 -23
  1154. data/docs/LoyaltyPoints.md +0 -25
  1155. data/docs/NewFeatureFlags.md +0 -21
  1156. data/docs/UpdateLoyaltyTier.md +0 -19
  1157. data/spec/models/application_customer_search_spec.rb +0 -53
  1158. data/spec/models/feature_flags_spec.rb +0 -59
  1159. data/spec/models/loyalty_points_spec.rb +0 -65
  1160. data/spec/models/new_feature_flags_spec.rb +0 -53
  1161. data/spec/models/update_loyalty_tier_spec.rb +0 -47
@@ -1,9 +1,9 @@
1
1
  =begin
2
2
  #Talon.One API
3
3
 
4
- #The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
4
+ #Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
5
5
 
6
- The version of the OpenAPI document: 1.0.0
6
+ The version of the OpenAPI document:
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.3.1
@@ -32,11 +32,26 @@ describe 'ManagementApi' do
32
32
  end
33
33
  end
34
34
 
35
+ # unit tests for add_loyalty_card_points
36
+ # Add points to card in a given loyalty program
37
+ # Add points to the given loyalty card in the specified card-based loyalty program.
38
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
39
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
40
+ # @param body body
41
+ # @param [Hash] opts the optional parameters
42
+ # @return [nil]
43
+ describe 'add_loyalty_card_points test' do
44
+ it 'should work' do
45
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
46
+ end
47
+ end
48
+
35
49
  # unit tests for add_loyalty_points
36
- # Add points in a certain loyalty program for the specified customer
37
- # @param program_id
38
- # @param integration_id
39
- # @param body
50
+ # Add points to customer profile
51
+ # Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
52
+ # @param loyalty_program_id The identifier for the loyalty program.
53
+ # @param integration_id The identifier of the profile.
54
+ # @param body body
40
55
  # @param [Hash] opts the optional parameters
41
56
  # @return [nil]
42
57
  describe 'add_loyalty_points test' do
@@ -46,23 +61,35 @@ describe 'ManagementApi' do
46
61
  end
47
62
 
48
63
  # unit tests for copy_campaign_to_applications
49
- # Copy the campaign into every specified application
50
- # Copy the campaign into every specified application.
51
- # @param application_id
52
- # @param campaign_id
53
- # @param body
64
+ # Copy the campaign into the specified Application
65
+ # Copy the campaign into all specified Applications.
66
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
67
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
68
+ # @param body body
54
69
  # @param [Hash] opts the optional parameters
55
- # @return [InlineResponse2002]
70
+ # @return [InlineResponse2003]
56
71
  describe 'copy_campaign_to_applications test' do
57
72
  it 'should work' do
58
73
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
59
74
  end
60
75
  end
61
76
 
77
+ # unit tests for create_account_collection
78
+ # Create account-level collection
79
+ # Create account-level collection.
80
+ # @param body body
81
+ # @param [Hash] opts the optional parameters
82
+ # @return [Collection]
83
+ describe 'create_account_collection test' do
84
+ it 'should work' do
85
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
86
+ end
87
+ end
88
+
62
89
  # unit tests for create_additional_cost
63
- # Define a new additional cost
64
- # Defines a new _additional cost_ in this account. These additional costs are shared across all applications in your account, and are never required.
65
- # @param body
90
+ # Create additional cost
91
+ # Create an [additional cost](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). These additional costs are shared across all applications in your account, and are never required.
92
+ # @param body body
66
93
  # @param [Hash] opts the optional parameters
67
94
  # @return [AccountAdditionalCost]
68
95
  describe 'create_additional_cost test' do
@@ -72,9 +99,9 @@ describe 'ManagementApi' do
72
99
  end
73
100
 
74
101
  # unit tests for create_attribute
75
- # Define a new custom attribute
76
- # Defines a new _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating / updating these objects, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
77
- # @param body
102
+ # Create custom attribute
103
+ # Create a _custom attribute_ in this account. [Custom attributes](https://docs.talon.one/docs/dev/concepts/attributes) allow you to add data to Talon.One domain entities like campaigns, coupons, customers and so on. These attributes can then be given values when creating/updating these entities, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all Applications in your account and are never required.
104
+ # @param body body
78
105
  # @param [Hash] opts the optional parameters
79
106
  # @return [Attribute]
80
107
  describe 'create_attribute test' do
@@ -83,52 +110,94 @@ describe 'ManagementApi' do
83
110
  end
84
111
  end
85
112
 
86
- # unit tests for create_campaign
87
- # Create a Campaign
88
- # @param application_id
89
- # @param body
113
+ # unit tests for create_campaign_from_template
114
+ # Create campaign from campaign template
115
+ # Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing [campaign collections](https://docs.talon.one/docs/product/campaigns/managing-collections), the corresponding collections for the new campaign are created automatically.
116
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
117
+ # @param body body
90
118
  # @param [Hash] opts the optional parameters
91
- # @return [Campaign]
92
- describe 'create_campaign test' do
119
+ # @return [CreateTemplateCampaignResponse]
120
+ describe 'create_campaign_from_template test' do
121
+ it 'should work' do
122
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
123
+ end
124
+ end
125
+
126
+ # unit tests for create_collection
127
+ # Create collection
128
+ # Create a collection.
129
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
130
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
131
+ # @param body body
132
+ # @param [Hash] opts the optional parameters
133
+ # @return [Collection]
134
+ describe 'create_collection test' do
93
135
  it 'should work' do
94
136
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
95
137
  end
96
138
  end
97
139
 
98
140
  # unit tests for create_coupons
99
- # Create Coupons
141
+ # Create coupons
100
142
  # Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
101
- # @param application_id
102
- # @param campaign_id
103
- # @param body
143
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
144
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
145
+ # @param body body
104
146
  # @param [Hash] opts the optional parameters
105
- # @option opts [String] :silent If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
106
- # @return [InlineResponse2004]
147
+ # @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
148
+ # @return [InlineResponse2006]
107
149
  describe 'create_coupons test' do
108
150
  it 'should work' do
109
151
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
152
  end
111
153
  end
112
154
 
155
+ # unit tests for create_coupons_async
156
+ # Create coupons asynchronously
157
+ # Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete. If you want to create less than 20,001 coupons, you can use the [Create coupons](https://docs.talon.one/management-api#tag/Coupons/operation/createCoupons) endpoint.
158
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
159
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
160
+ # @param body body
161
+ # @param [Hash] opts the optional parameters
162
+ # @return [AsyncCouponCreationResponse]
163
+ describe 'create_coupons_async test' do
164
+ it 'should work' do
165
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
166
+ end
167
+ end
168
+
113
169
  # unit tests for create_coupons_for_multiple_recipients
114
- # Create Coupons for Multiple Recipients
170
+ # Create coupons for multiple recipients
115
171
  # Create coupons according to some pattern for up to 1000 recipients.
116
- # @param application_id
117
- # @param campaign_id
118
- # @param body
172
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
173
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
174
+ # @param body body
119
175
  # @param [Hash] opts the optional parameters
120
- # @option opts [String] :silent If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
121
- # @return [InlineResponse2004]
176
+ # @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
177
+ # @return [InlineResponse2006]
122
178
  describe 'create_coupons_for_multiple_recipients test' do
123
179
  it 'should work' do
124
180
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
125
181
  end
126
182
  end
127
183
 
184
+ # unit tests for create_notification_webhook
185
+ # Create notification about campaign-related changes
186
+ # Create a [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). A notification about campaign-related changes is different from regular webhooks in that it is Application-scoped and has a predefined payload. [Regular webhooks](https://docs.talon.one/docs/dev/getting-started/webhooks) have user-definable payloads. **Tip:** - You can create these notifications using the Campaign Manager. See [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). - You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_created/post).
187
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
188
+ # @param body body
189
+ # @param [Hash] opts the optional parameters
190
+ # @return [NotificationWebhook]
191
+ describe 'create_notification_webhook test' do
192
+ it 'should work' do
193
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
194
+ end
195
+ end
196
+
128
197
  # unit tests for create_password_recovery_email
129
198
  # Request a password reset
130
- # Sends an email with a password recovery link to the email of an existing account.
131
- # @param body
199
+ # Send an email with a password recovery link to the email address of an existing account. **Note:** The password recovery link expires 30 minutes after this endpoint is triggered.
200
+ # @param body body
132
201
  # @param [Hash] opts the optional parameters
133
202
  # @return [NewPasswordEmail]
134
203
  describe 'create_password_recovery_email test' do
@@ -137,34 +206,49 @@ describe 'ManagementApi' do
137
206
  end
138
207
  end
139
208
 
140
- # unit tests for create_ruleset
141
- # Create a Ruleset
142
- # @param application_id
143
- # @param campaign_id
144
- # @param body
209
+ # unit tests for create_session
210
+ # Create session
211
+ # Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class=\"redoc-section\"> <p class=\"title\">Granular API key</p> Instead of using a session, you can also use the <a href=\"https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature</a> in the Campaign Manager to decide which endpoints can be used with a given key. </div>
212
+ # @param body body
145
213
  # @param [Hash] opts the optional parameters
146
- # @return [Ruleset]
147
- describe 'create_ruleset test' do
214
+ # @return [Session]
215
+ describe 'create_session test' do
148
216
  it 'should work' do
149
217
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
150
218
  end
151
219
  end
152
220
 
153
- # unit tests for create_session
154
- # Create a Session
155
- # @param body
221
+ # unit tests for deduct_loyalty_card_points
222
+ # Deduct points from card in a given loyalty program.
223
+ # Deduct points from the given loyalty card in the specified card-based loyalty program.
224
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
225
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
226
+ # @param body body
156
227
  # @param [Hash] opts the optional parameters
157
- # @return [Session]
158
- describe 'create_session test' do
228
+ # @return [nil]
229
+ describe 'deduct_loyalty_card_points test' do
230
+ it 'should work' do
231
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
232
+ end
233
+ end
234
+
235
+ # unit tests for delete_account_collection
236
+ # Delete account-level collection
237
+ # Delete the given account-level collection.
238
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
239
+ # @param [Hash] opts the optional parameters
240
+ # @return [nil]
241
+ describe 'delete_account_collection test' do
159
242
  it 'should work' do
160
243
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
161
244
  end
162
245
  end
163
246
 
164
247
  # unit tests for delete_campaign
165
- # Delete a Campaign
166
- # @param application_id
167
- # @param campaign_id
248
+ # Delete campaign
249
+ # Delete the given campaign.
250
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
251
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
168
252
  # @param [Hash] opts the optional parameters
169
253
  # @return [nil]
170
254
  describe 'delete_campaign test' do
@@ -173,11 +257,26 @@ describe 'ManagementApi' do
173
257
  end
174
258
  end
175
259
 
260
+ # unit tests for delete_collection
261
+ # Delete collection
262
+ # Delete the given collection.
263
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
264
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
265
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
266
+ # @param [Hash] opts the optional parameters
267
+ # @return [nil]
268
+ describe 'delete_collection test' do
269
+ it 'should work' do
270
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
271
+ end
272
+ end
273
+
176
274
  # unit tests for delete_coupon
177
- # Delete one Coupon
178
- # @param application_id
179
- # @param campaign_id
180
- # @param coupon_id The ID of the coupon code to delete
275
+ # Delete coupon
276
+ # Delete the specified coupon.
277
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
278
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
279
+ # @param coupon_id The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.
181
280
  # @param [Hash] opts the optional parameters
182
281
  # @return [nil]
183
282
  describe 'delete_coupon test' do
@@ -187,9 +286,10 @@ describe 'ManagementApi' do
187
286
  end
188
287
 
189
288
  # unit tests for delete_coupons
190
- # Delete Coupons
191
- # @param application_id
192
- # @param campaign_id
289
+ # Delete coupons
290
+ # Deletes all the coupons matching the specified criteria.
291
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
292
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
193
293
  # @param [Hash] opts the optional parameters
194
294
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
195
295
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
@@ -198,11 +298,11 @@ describe 'ManagementApi' do
198
298
  # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
199
299
  # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
200
300
  # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
201
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
301
+ # @option opts [String] :valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
202
302
  # @option opts [String] :batch_id Filter results by batches of coupons
203
- # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
204
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
205
- # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
303
+ # @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
304
+ # @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
305
+ # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field.
206
306
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
207
307
  # @return [nil]
208
308
  describe 'delete_coupons test' do
@@ -211,34 +311,49 @@ describe 'ManagementApi' do
211
311
  end
212
312
  end
213
313
 
214
- # unit tests for delete_referral
215
- # Delete one Referral
216
- # @param application_id
217
- # @param campaign_id
218
- # @param referral_id The ID of the referral code to delete
314
+ # unit tests for delete_loyalty_card
315
+ # Delete loyalty card
316
+ # Delete the given loyalty card.
317
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
318
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
219
319
  # @param [Hash] opts the optional parameters
220
320
  # @return [nil]
221
- describe 'delete_referral test' do
321
+ describe 'delete_loyalty_card test' do
222
322
  it 'should work' do
223
323
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
224
324
  end
225
325
  end
226
326
 
227
- # unit tests for delete_ruleset
228
- # Delete a Ruleset
229
- # @param application_id
230
- # @param campaign_id
231
- # @param ruleset_id
327
+ # unit tests for delete_notification_webhook
328
+ # Delete notification about campaign-related changes
329
+ # Remove the given existing [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications).
330
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
331
+ # @param notification_webhook_id The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.
232
332
  # @param [Hash] opts the optional parameters
233
333
  # @return [nil]
234
- describe 'delete_ruleset test' do
334
+ describe 'delete_notification_webhook test' do
335
+ it 'should work' do
336
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
337
+ end
338
+ end
339
+
340
+ # unit tests for delete_referral
341
+ # Delete referral
342
+ # Delete the specified referral.
343
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
344
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
345
+ # @param referral_id The ID of the referral code.
346
+ # @param [Hash] opts the optional parameters
347
+ # @return [nil]
348
+ describe 'delete_referral test' do
235
349
  it 'should work' do
236
350
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
237
351
  end
238
352
  end
239
353
 
240
354
  # unit tests for destroy_session
241
- # Destroy a Session
355
+ # Destroy session
356
+ # Destroys the session.
242
357
  # @param [Hash] opts the optional parameters
243
358
  # @return [nil]
244
359
  describe 'destroy_session test' do
@@ -247,24 +362,50 @@ describe 'ManagementApi' do
247
362
  end
248
363
  end
249
364
 
365
+ # unit tests for export_account_collection_items
366
+ # Export account-level collection's items
367
+ # Download a CSV file containing items from an account-level collection. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
368
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
369
+ # @param [Hash] opts the optional parameters
370
+ # @return [String]
371
+ describe 'export_account_collection_items test' do
372
+ it 'should work' do
373
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
374
+ end
375
+ end
376
+
377
+ # unit tests for export_collection_items
378
+ # Export a collection's items
379
+ # Download a CSV file containing a collection's items. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
380
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
381
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
382
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
383
+ # @param [Hash] opts the optional parameters
384
+ # @return [String]
385
+ describe 'export_collection_items test' do
386
+ it 'should work' do
387
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
388
+ end
389
+ end
390
+
250
391
  # unit tests for export_coupons
251
- # Export Coupons to a CSV file
252
- # Download a file with the coupons that match the given attributes.
253
- # @param application_id
392
+ # Export coupons
393
+ # Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon is reserved. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
394
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
254
395
  # @param [Hash] opts the optional parameters
255
396
  # @option opts [Float] :campaign_id Filter results by campaign.
256
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
397
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
257
398
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
258
399
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
259
400
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
260
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
401
+ # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
261
402
  # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
262
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
403
+ # @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
263
404
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
264
405
  # @option opts [String] :batch_id Filter results by batches of coupons
265
406
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
266
407
  # @option opts [String] :date_format Determines the format of dates in the export document.
267
- # @option opts [String] :campaign_state Filter results by the state of the campaign.
408
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
268
409
  # @return [String]
269
410
  describe 'export_coupons test' do
270
411
  it 'should work' do
@@ -273,9 +414,9 @@ describe 'ManagementApi' do
273
414
  end
274
415
 
275
416
  # unit tests for export_customer_sessions
276
- # Export Customer Sessions to a CSV file
277
- # Download a file with the customer sessions that match the request.
278
- # @param application_id
417
+ # Export customer sessions
418
+ # Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/product/server-infrastructure-and-data-retention#data-retention-policy). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of the session. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `coupons`: Coupon codes in the session.
419
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
279
420
  # @param [Hash] opts the optional parameters
280
421
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
281
422
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
@@ -290,9 +431,9 @@ describe 'ManagementApi' do
290
431
  end
291
432
 
292
433
  # unit tests for export_effects
293
- # Export triggered Effects to a CSV file
294
- # Download a file with the triggered effects that match the given attributes.
295
- # @param application_id
434
+ # Export triggered effects
435
+ # Download a CSV file containing the triggered effects that match the given attributes. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue.
436
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
296
437
  # @param [Hash] opts the optional parameters
297
438
  # @option opts [Float] :campaign_id Filter results by campaign.
298
439
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
@@ -306,10 +447,11 @@ describe 'ManagementApi' do
306
447
  end
307
448
 
308
449
  # unit tests for export_loyalty_balance
309
- # Export customer loyalty balance to a CSV file
310
- # Download a file with the balance of each customer in the loyalty program
311
- # @param program_id
450
+ # Export customer loyalty balance to CSV
451
+ # ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
452
+ # @param loyalty_program_id The identifier for the loyalty program.
312
453
  # @param [Hash] opts the optional parameters
454
+ # @option opts [DateTime] :end_date Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
313
455
  # @return [String]
314
456
  describe 'export_loyalty_balance test' do
315
457
  it 'should work' do
@@ -317,13 +459,55 @@ describe 'ManagementApi' do
317
459
  end
318
460
  end
319
461
 
462
+ # unit tests for export_loyalty_balances
463
+ # Export customer loyalty balances
464
+ # Download a CSV file containing the balance of each customer in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
465
+ # @param loyalty_program_id The identifier for the loyalty program.
466
+ # @param [Hash] opts the optional parameters
467
+ # @option opts [DateTime] :end_date Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
468
+ # @return [String]
469
+ describe 'export_loyalty_balances test' do
470
+ it 'should work' do
471
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
472
+ end
473
+ end
474
+
475
+ # unit tests for export_loyalty_card_balances
476
+ # Export loyalty card transaction logs to CSV
477
+ # Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
478
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
479
+ # @param [Hash] opts the optional parameters
480
+ # @option opts [DateTime] :end_date Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
481
+ # @return [String]
482
+ describe 'export_loyalty_card_balances test' do
483
+ it 'should work' do
484
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
485
+ end
486
+ end
487
+
488
+ # unit tests for export_loyalty_card_ledger
489
+ # Export a loyalty card ledger log
490
+ # Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
491
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
492
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
493
+ # @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
494
+ # @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
495
+ # @param [Hash] opts the optional parameters
496
+ # @option opts [String] :date_format Determines the format of dates in the export document.
497
+ # @return [String]
498
+ describe 'export_loyalty_card_ledger test' do
499
+ it 'should work' do
500
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
501
+ end
502
+ end
503
+
320
504
  # unit tests for export_loyalty_ledger
321
- # Export a customer's loyalty ledger log to a CSV file
322
- # Download a file with a customer's ledger log in the loyalty program
323
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
324
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
325
- # @param program_id
326
- # @param integration_id
505
+ # Export customer's transaction logs
506
+ # Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The type of the loyalty program. - `name`: The name of the loyalty program. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived.
507
+ # @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
508
+ # @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
509
+ # @param loyalty_program_id The identifier for the loyalty program.
510
+ # @param integration_id The identifier of the profile.
327
511
  # @param [Hash] opts the optional parameters
328
512
  # @option opts [String] :date_format Determines the format of dates in the export document.
329
513
  # @return [String]
@@ -333,38 +517,39 @@ describe 'ManagementApi' do
333
517
  end
334
518
  end
335
519
 
336
- # unit tests for get_access_logs
337
- # Get access logs for application (with total count)
338
- # @param application_id
339
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
340
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
520
+ # unit tests for export_referrals
521
+ # Export referrals
522
+ # Download a CSV file containing the referrals that match the given parameters. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
523
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
341
524
  # @param [Hash] opts the optional parameters
342
- # @option opts [String] :path Only return results where the request path matches the given regular expression.
343
- # @option opts [String] :method Only return results where the request method matches the given regular expression.
344
- # @option opts [String] :status Filter results by HTTP status codes.
345
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
346
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
347
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
348
- # @return [InlineResponse2008]
349
- describe 'get_access_logs test' do
525
+ # @option opts [Float] :campaign_id Filter results by campaign.
526
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
527
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
528
+ # @option opts [String] :valid - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.
529
+ # @option opts [String] :usable - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned.
530
+ # @option opts [String] :batch_id Filter results by batches of referrals
531
+ # @option opts [String] :date_format Determines the format of dates in the export document.
532
+ # @return [String]
533
+ describe 'export_referrals test' do
350
534
  it 'should work' do
351
535
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
352
536
  end
353
537
  end
354
538
 
355
539
  # unit tests for get_access_logs_without_total_count
356
- # Get access logs for application
357
- # @param application_id
358
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
359
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
540
+ # Get access logs for Application
541
+ # Retrieve the list of API calls sent to the specified Application.
542
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
543
+ # @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
544
+ # @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
360
545
  # @param [Hash] opts the optional parameters
361
546
  # @option opts [String] :path Only return results where the request path matches the given regular expression.
362
547
  # @option opts [String] :method Only return results where the request method matches the given regular expression.
363
548
  # @option opts [String] :status Filter results by HTTP status codes.
364
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
549
+ # @option opts [Integer] :page_size The number of items in this response.
365
550
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
366
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
367
- # @return [InlineResponse2009]
551
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
552
+ # @return [InlineResponse20017]
368
553
  describe 'get_access_logs_without_total_count test' do
369
554
  it 'should work' do
370
555
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -372,9 +557,9 @@ describe 'ManagementApi' do
372
557
  end
373
558
 
374
559
  # unit tests for get_account
375
- # Get Account Details
560
+ # Get account details
376
561
  # Return the details of your companies Talon.One account.
377
- # @param account_id
562
+ # @param account_id The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property.
378
563
  # @param [Hash] opts the optional parameters
379
564
  # @return [Account]
380
565
  describe 'get_account test' do
@@ -384,9 +569,9 @@ describe 'ManagementApi' do
384
569
  end
385
570
 
386
571
  # unit tests for get_account_analytics
387
- # Get Account Analytics
388
- # Return the analytics of your companies Talon.One account.
389
- # @param account_id
572
+ # Get account analytics
573
+ # Return the analytics of your Talon.One account.
574
+ # @param account_id The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#operation/getUsers) endpoint in the `accountId` property.
390
575
  # @param [Hash] opts the optional parameters
391
576
  # @return [AccountAnalytics]
392
577
  describe 'get_account_analytics test' do
@@ -395,10 +580,22 @@ describe 'ManagementApi' do
395
580
  end
396
581
  end
397
582
 
583
+ # unit tests for get_account_collection
584
+ # Get account-level collection
585
+ # Retrieve a given account-level collection.
586
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
587
+ # @param [Hash] opts the optional parameters
588
+ # @return [Collection]
589
+ describe 'get_account_collection test' do
590
+ it 'should work' do
591
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
592
+ end
593
+ end
594
+
398
595
  # unit tests for get_additional_cost
399
- # Get an additional cost
400
- # Returns additional cost for the account by its id.
401
- # @param additional_cost_id
596
+ # Get additional cost
597
+ # Returns the additional cost.
598
+ # @param additional_cost_id The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**.
402
599
  # @param [Hash] opts the optional parameters
403
600
  # @return [AccountAdditionalCost]
404
601
  describe 'get_additional_cost test' do
@@ -411,10 +608,10 @@ describe 'ManagementApi' do
411
608
  # List additional costs
412
609
  # Returns all the defined additional costs for the account.
413
610
  # @param [Hash] opts the optional parameters
414
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
611
+ # @option opts [Integer] :page_size The number of items in this response.
415
612
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
416
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
417
- # @return [InlineResponse20021]
613
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
614
+ # @return [InlineResponse20031]
418
615
  describe 'get_additional_costs test' do
419
616
  it 'should work' do
420
617
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -422,18 +619,18 @@ describe 'ManagementApi' do
422
619
  end
423
620
 
424
621
  # unit tests for get_all_access_logs
425
- # Get all access logs
622
+ # List access logs
426
623
  # Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
427
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
428
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
624
+ # @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
625
+ # @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
429
626
  # @param [Hash] opts the optional parameters
430
627
  # @option opts [String] :path Only return results where the request path matches the given regular expression.
431
628
  # @option opts [String] :method Only return results where the request method matches the given regular expression.
432
629
  # @option opts [String] :status Filter results by HTTP status codes.
433
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
630
+ # @option opts [Integer] :page_size The number of items in this response.
434
631
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
435
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
436
- # @return [InlineResponse2008]
632
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
633
+ # @return [InlineResponse20018]
437
634
  describe 'get_all_access_logs test' do
438
635
  it 'should work' do
439
636
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -441,9 +638,10 @@ describe 'ManagementApi' do
441
638
  end
442
639
 
443
640
  # unit tests for get_all_roles
444
- # Get all roles
641
+ # List roles
642
+ # List all roles.
445
643
  # @param [Hash] opts the optional parameters
446
- # @return [InlineResponse20029]
644
+ # @return [InlineResponse20039]
447
645
  describe 'get_all_roles test' do
448
646
  it 'should work' do
449
647
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -453,7 +651,7 @@ describe 'ManagementApi' do
453
651
  # unit tests for get_application
454
652
  # Get Application
455
653
  # Get the application specified by the ID.
456
- # @param application_id
654
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
457
655
  # @param [Hash] opts the optional parameters
458
656
  # @return [Application]
459
657
  describe 'get_application test' do
@@ -463,8 +661,9 @@ describe 'ManagementApi' do
463
661
  end
464
662
 
465
663
  # unit tests for get_application_api_health
466
- # Get report of health of application API
467
- # @param application_id
664
+ # Get Application health
665
+ # Display the health of the Application and show the last time the Application was used. You can also display this information from the **Settings** of an Application, in the **Developer Settings** menu. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status).
666
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
468
667
  # @param [Hash] opts the optional parameters
469
668
  # @return [ApplicationApiHealth]
470
669
  describe 'get_application_api_health test' do
@@ -474,9 +673,10 @@ describe 'ManagementApi' do
474
673
  end
475
674
 
476
675
  # unit tests for get_application_customer
477
- # Get Application Customer
478
- # @param application_id
479
- # @param customer_id
676
+ # Get application's customer
677
+ # Retrieve the customers of the specified application.
678
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
679
+ # @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
480
680
  # @param [Hash] opts the optional parameters
481
681
  # @return [ApplicationCustomer]
482
682
  describe 'get_application_customer test' do
@@ -485,82 +685,78 @@ describe 'ManagementApi' do
485
685
  end
486
686
  end
487
687
 
488
- # unit tests for get_application_customers
489
- # List Application Customers
490
- # @param application_id
688
+ # unit tests for get_application_customer_friends
689
+ # List friends referred by customer profile
690
+ # List the friends referred by the specified customer profile in this Application.
691
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
692
+ # @param integration_id The Integration ID of the Advocate's Profile.
491
693
  # @param [Hash] opts the optional parameters
492
- # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
493
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
694
+ # @option opts [Integer] :page_size The number of items in this response.
494
695
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
495
- # @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query.
496
- # @return [InlineResponse20011]
497
- describe 'get_application_customers test' do
696
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
697
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
698
+ # @return [InlineResponse20029]
699
+ describe 'get_application_customer_friends test' do
498
700
  it 'should work' do
499
701
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
500
702
  end
501
703
  end
502
704
 
503
- # unit tests for get_application_customers_by_attributes
504
- # Get a list of the customer profiles that match the given attributes (with total count)
505
- # Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
506
- # @param body
705
+ # unit tests for get_application_customers
706
+ # List application's customers
707
+ # List all the customers of the specified application.
708
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
507
709
  # @param [Hash] opts the optional parameters
508
- # @return [InlineResponse20012]
509
- describe 'get_application_customers_by_attributes test' do
710
+ # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
711
+ # @option opts [Integer] :page_size The number of items in this response.
712
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
713
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
714
+ # @return [InlineResponse20020]
715
+ describe 'get_application_customers test' do
510
716
  it 'should work' do
511
717
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
512
718
  end
513
719
  end
514
720
 
515
- # unit tests for get_application_event_types
516
- # List Applications Event Types
517
- # Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](/integration-api/reference/#trackEvent)
518
- # @param application_id
721
+ # unit tests for get_application_customers_by_attributes
722
+ # List application customers matching the given attributes
723
+ # Get a list of the application customers matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.
724
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
725
+ # @param body body
519
726
  # @param [Hash] opts the optional parameters
520
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
727
+ # @option opts [Integer] :page_size The number of items in this response.
521
728
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
522
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
523
- # @return [InlineResponse20018]
524
- describe 'get_application_event_types test' do
729
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
730
+ # @return [InlineResponse20021]
731
+ describe 'get_application_customers_by_attributes test' do
525
732
  it 'should work' do
526
733
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
527
734
  end
528
735
  end
529
736
 
530
- # unit tests for get_application_events
531
- # List Applications Events (with total count)
532
- # Lists all events recorded for an application.
533
- # @param application_id
737
+ # unit tests for get_application_event_types
738
+ # List Applications event types
739
+ # Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#operation/trackEvent)
740
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
534
741
  # @param [Hash] opts the optional parameters
535
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
742
+ # @option opts [Integer] :page_size The number of items in this response.
536
743
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
537
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
538
- # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
539
- # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
540
- # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
541
- # @option opts [String] :session Session integration ID filter for events. Must be exact match.
542
- # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
543
- # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
544
- # @option opts [String] :customer_email Customer e-mail address filter for events. Will match substrings case-insensitively.
545
- # @option opts [String] :coupon_code Coupon code
546
- # @option opts [String] :referral_code Referral code
547
- # @option opts [String] :rule_query Rule name filter for events
548
- # @option opts [String] :campaign_query Campaign name filter for events
549
- # @return [InlineResponse20016]
550
- describe 'get_application_events test' do
744
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
745
+ # @return [InlineResponse20027]
746
+ describe 'get_application_event_types test' do
551
747
  it 'should work' do
552
748
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
553
749
  end
554
750
  end
555
751
 
556
752
  # unit tests for get_application_events_without_total_count
557
- # List Applications Events
558
- # Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results.
559
- # @param application_id
753
+ # List Applications events
754
+ # Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
755
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
560
756
  # @param [Hash] opts the optional parameters
561
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
757
+ # @option opts [Integer] :page_size The number of items in this response.
562
758
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
563
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
759
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
564
760
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
565
761
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
566
762
  # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
@@ -572,7 +768,7 @@ describe 'ManagementApi' do
572
768
  # @option opts [String] :referral_code Referral code
573
769
  # @option opts [String] :rule_query Rule name filter for events
574
770
  # @option opts [String] :campaign_query Campaign name filter for events
575
- # @return [InlineResponse20017]
771
+ # @return [InlineResponse20026]
576
772
  describe 'get_application_events_without_total_count test' do
577
773
  it 'should work' do
578
774
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -580,9 +776,10 @@ describe 'ManagementApi' do
580
776
  end
581
777
 
582
778
  # unit tests for get_application_session
583
- # Get Application Session
584
- # @param application_id
585
- # @param session_id
779
+ # Get Application session
780
+ # Get the details of the given session. You can list the sessions with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
781
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
782
+ # @param session_id The **internal** ID of the session. You can get the ID with the [List Application sessions](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.
586
783
  # @param [Hash] opts the optional parameters
587
784
  # @return [ApplicationSession]
588
785
  describe 'get_application_session test' do
@@ -592,12 +789,13 @@ describe 'ManagementApi' do
592
789
  end
593
790
 
594
791
  # unit tests for get_application_sessions
595
- # List Application Sessions
596
- # @param application_id
792
+ # List Application sessions
793
+ # List all the sessions of the specified Application.
794
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
597
795
  # @param [Hash] opts the optional parameters
598
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
796
+ # @option opts [Integer] :page_size The number of items in this response.
599
797
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
600
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
798
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
601
799
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
602
800
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
603
801
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
@@ -605,7 +803,7 @@ describe 'ManagementApi' do
605
803
  # @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
606
804
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
607
805
  # @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
608
- # @return [InlineResponse20015]
806
+ # @return [InlineResponse20025]
609
807
  describe 'get_application_sessions test' do
610
808
  it 'should work' do
611
809
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -614,12 +812,12 @@ describe 'ManagementApi' do
614
812
 
615
813
  # unit tests for get_applications
616
814
  # List Applications
617
- # List all application in the current account.
815
+ # List all applications in the current account.
618
816
  # @param [Hash] opts the optional parameters
619
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
817
+ # @option opts [Integer] :page_size The number of items in this response.
620
818
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
621
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
622
- # @return [InlineResponse2001]
819
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
820
+ # @return [InlineResponse2002]
623
821
  describe 'get_applications test' do
624
822
  it 'should work' do
625
823
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -627,9 +825,9 @@ describe 'ManagementApi' do
627
825
  end
628
826
 
629
827
  # unit tests for get_attribute
630
- # Get a custom attribute
631
- # Returns custom attribute for the account by its id.
632
- # @param attribute_id
828
+ # Get custom attribute
829
+ # Retrieve the specified custom attribute.
830
+ # @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
633
831
  # @param [Hash] opts the optional parameters
634
832
  # @return [Attribute]
635
833
  describe 'get_attribute test' do
@@ -640,13 +838,13 @@ describe 'ManagementApi' do
640
838
 
641
839
  # unit tests for get_attributes
642
840
  # List custom attributes
643
- # Returns all the defined custom attributes for the account.
841
+ # Return all the custom attributes for the account.
644
842
  # @param [Hash] opts the optional parameters
645
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
843
+ # @option opts [Integer] :page_size The number of items in this response.
646
844
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
647
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
648
- # @option opts [String] :entity Returned attributes will be filtered by supplied entity
649
- # @return [InlineResponse20020]
845
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
846
+ # @option opts [String] :entity Returned attributes will be filtered by supplied entity.
847
+ # @return [InlineResponse20030]
650
848
  describe 'get_attributes test' do
651
849
  it 'should work' do
652
850
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -654,14 +852,14 @@ describe 'ManagementApi' do
654
852
  end
655
853
 
656
854
  # unit tests for get_audiences
657
- # Get all audiences
658
- # Get All audiences created in the account.
855
+ # List audiences
856
+ # Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).
659
857
  # @param [Hash] opts the optional parameters
660
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
858
+ # @option opts [Integer] :page_size The number of items in this response.
661
859
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
662
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
663
- # @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query.
664
- # @return [InlineResponse20019]
860
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
861
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
862
+ # @return [InlineResponse20028]
665
863
  describe 'get_audiences test' do
666
864
  it 'should work' do
667
865
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -669,9 +867,10 @@ describe 'ManagementApi' do
669
867
  end
670
868
 
671
869
  # unit tests for get_campaign
672
- # Get a Campaign
673
- # @param application_id
674
- # @param campaign_id
870
+ # Get campaign
871
+ # Retrieve the given campaign.
872
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
873
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
675
874
  # @param [Hash] opts the optional parameters
676
875
  # @return [Campaign]
677
876
  describe 'get_campaign test' do
@@ -682,13 +881,14 @@ describe 'ManagementApi' do
682
881
 
683
882
  # unit tests for get_campaign_analytics
684
883
  # Get analytics of campaigns
685
- # @param application_id
686
- # @param campaign_id
687
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
688
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
884
+ # Retrieve statistical data about the performance of the given campaign.
885
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
886
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
887
+ # @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
888
+ # @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
689
889
  # @param [Hash] opts the optional parameters
690
890
  # @option opts [String] :granularity The time interval between the results in the returned time-series.
691
- # @return [InlineResponse20010]
891
+ # @return [InlineResponse20019]
692
892
  describe 'get_campaign_analytics test' do
693
893
  it 'should work' do
694
894
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -696,36 +896,56 @@ describe 'ManagementApi' do
696
896
  end
697
897
 
698
898
  # unit tests for get_campaign_by_attributes
699
- # Get a list of all campaigns that match the given attributes
700
- # Gets a list of all the campaigns that exactly match a set of attributes.
701
- # @param application_id
702
- # @param body
899
+ # List campaigns that match the given attributes
900
+ # Get a list of all the campaigns that match a set of attributes.
901
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
902
+ # @param body body
703
903
  # @param [Hash] opts the optional parameters
704
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
904
+ # @option opts [Integer] :page_size The number of items in this response.
705
905
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
706
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
707
- # @option opts [String] :campaign_state Filter results by the state of the campaign.
708
- # @return [InlineResponse2002]
906
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
907
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
908
+ # @return [InlineResponse2003]
709
909
  describe 'get_campaign_by_attributes test' do
710
910
  it 'should work' do
711
911
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
712
912
  end
713
913
  end
714
914
 
915
+ # unit tests for get_campaign_templates
916
+ # List campaign templates
917
+ # Retrieve a list of campaign templates.
918
+ # @param [Hash] opts the optional parameters
919
+ # @option opts [Integer] :page_size The number of items in this response.
920
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
921
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
922
+ # @option opts [String] :state Filter results by the state of the campaign template.
923
+ # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
924
+ # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
925
+ # @option opts [Integer] :user_id Filter results by user ID.
926
+ # @return [InlineResponse2009]
927
+ describe 'get_campaign_templates test' do
928
+ it 'should work' do
929
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
930
+ end
931
+ end
932
+
715
933
  # unit tests for get_campaigns
716
- # List your Campaigns
717
- # @param application_id
934
+ # List campaigns
935
+ # List the campaigns of the specified application that match your filter criteria.
936
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
718
937
  # @param [Hash] opts the optional parameters
719
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
938
+ # @option opts [Integer] :page_size The number of items in this response.
720
939
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
721
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
722
- # @option opts [String] :campaign_state Filter results by the state of the campaign.
940
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
941
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
723
942
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
724
943
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
725
944
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
726
945
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
727
946
  # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
728
- # @return [InlineResponse2002]
947
+ # @option opts [Integer] :template_id The ID of the Campaign Template this Campaign was created from.
948
+ # @return [InlineResponse2003]
729
949
  describe 'get_campaigns test' do
730
950
  it 'should work' do
731
951
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -733,124 +953,74 @@ describe 'ManagementApi' do
733
953
  end
734
954
 
735
955
  # unit tests for get_changes
736
- # Get audit log for an account
737
- # Get list of changes caused by API calls for an account. Only accessible for admins.
956
+ # Get audit logs for an account
957
+ # Retrieve the audit logs displayed in **Accounts > Audit logs**.
738
958
  # @param [Hash] opts the optional parameters
739
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
959
+ # @option opts [Integer] :page_size The number of items in this response.
740
960
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
741
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
742
- # @option opts [Integer] :application_id
961
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
962
+ # @option opts [Float] :application_id Filter results by Application ID.
743
963
  # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
744
- # @option opts [Integer] :user_id
964
+ # @option opts [Integer] :user_id Filter results by user ID.
745
965
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
746
966
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
747
- # @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query.
967
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
968
+ # @option opts [Integer] :management_key_id Filter results that match the given management key ID.
748
969
  # @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
749
- # @return [InlineResponse20027]
970
+ # @return [InlineResponse20037]
750
971
  describe 'get_changes test' do
751
972
  it 'should work' do
752
973
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
753
974
  end
754
975
  end
755
976
 
756
- # unit tests for get_coupons
757
- # List Coupons (with total count)
758
- # @param application_id
759
- # @param campaign_id
977
+ # unit tests for get_collection
978
+ # Get collection
979
+ # Retrieve a given collection.
980
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
981
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
982
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
760
983
  # @param [Hash] opts the optional parameters
761
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
762
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
763
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
764
- # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
765
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
766
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
767
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
768
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
769
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
770
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
771
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
772
- # @option opts [String] :batch_id Filter results by batches of coupons
773
- # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
774
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
775
- # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
776
- # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
777
- # @return [InlineResponse2004]
778
- describe 'get_coupons test' do
984
+ # @return [Collection]
985
+ describe 'get_collection test' do
779
986
  it 'should work' do
780
987
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
781
988
  end
782
989
  end
783
990
 
784
- # unit tests for get_coupons_by_attributes
785
- # Get a list of the coupons that match the given attributes
786
- # Gets a list of all the coupons that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request.
787
- # @param application_id
788
- # @param campaign_id
789
- # @param body
991
+ # unit tests for get_collection_items
992
+ # Get collection items
993
+ # Retrieve the items from the given collection.
994
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
790
995
  # @param [Hash] opts the optional parameters
791
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
996
+ # @option opts [Integer] :page_size The number of items in this response.
792
997
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
793
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
794
- # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
795
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
796
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
797
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
798
- # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
799
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
800
- # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
801
- # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
802
- # @option opts [String] :batch_id Filter results by batches of coupons
803
- # @return [InlineResponse2004]
804
- describe 'get_coupons_by_attributes test' do
805
- it 'should work' do
806
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
807
- end
808
- end
809
-
810
- # unit tests for get_coupons_by_attributes_application_wide
811
- # Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
812
- # Gets a list of all the coupons with attributes matching the query criteria Application wide
813
- # @param application_id
814
- # @param body
815
- # @param [Hash] opts the optional parameters
816
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
817
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
818
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
819
- # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
820
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
821
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
822
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
823
- # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
824
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
825
- # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
826
- # @option opts [String] :batch_id Filter results by batches of coupons
827
- # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
828
- # @option opts [String] :campaign_state Filter results by the state of the campaign.
829
- # @return [InlineResponse2004]
830
- describe 'get_coupons_by_attributes_application_wide test' do
998
+ # @return [InlineResponse20015]
999
+ describe 'get_collection_items test' do
831
1000
  it 'should work' do
832
1001
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
833
1002
  end
834
1003
  end
835
1004
 
836
1005
  # unit tests for get_coupons_without_total_count
837
- # List Coupons
838
- # @param application_id
839
- # @param campaign_id
1006
+ # List coupons
1007
+ # List all the coupons matching the specified criteria.
1008
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1009
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
840
1010
  # @param [Hash] opts the optional parameters
841
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1011
+ # @option opts [Integer] :page_size The number of items in this response.
842
1012
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
843
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1013
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
844
1014
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
845
1015
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
846
1016
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
847
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
1017
+ # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
848
1018
  # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
849
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
1019
+ # @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
850
1020
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
851
1021
  # @option opts [String] :batch_id Filter results by batches of coupons
852
1022
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
853
- # @return [InlineResponse2005]
1023
+ # @return [InlineResponse2007]
854
1024
  describe 'get_coupons_without_total_count test' do
855
1025
  it 'should work' do
856
1026
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -858,14 +1028,14 @@ describe 'ManagementApi' do
858
1028
  end
859
1029
 
860
1030
  # unit tests for get_customer_activity_report
861
- # Get Activity Report for Single Customer
862
- # Fetch summary report for single application customer based on a time range
863
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
864
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
865
- # @param application_id
866
- # @param customer_id
867
- # @param [Hash] opts the optional parameters
868
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1031
+ # Get customer's activity report
1032
+ # Fetch the summary report of a given customer in the given application, in a time range.
1033
+ # @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
1034
+ # @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
1035
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1036
+ # @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
1037
+ # @param [Hash] opts the optional parameters
1038
+ # @option opts [Integer] :page_size The number of items in this response.
869
1039
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
870
1040
  # @return [CustomerActivityReport]
871
1041
  describe 'get_customer_activity_report test' do
@@ -874,42 +1044,21 @@ describe 'ManagementApi' do
874
1044
  end
875
1045
  end
876
1046
 
877
- # unit tests for get_customer_activity_reports
878
- # Get Activity Reports for Application Customers (with total count)
879
- # Fetch summary reports for all application customers based on a time range
880
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
881
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
882
- # @param application_id
883
- # @param [Hash] opts the optional parameters
884
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
885
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
886
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
887
- # @option opts [String] :name Only return reports matching the customer name
888
- # @option opts [String] :integration_id Only return reports matching the integrationId
889
- # @option opts [String] :campaign_name Only return reports matching the campaignName
890
- # @option opts [String] :advocate_name Only return reports matching the current customer referrer name
891
- # @return [InlineResponse20013]
892
- describe 'get_customer_activity_reports test' do
893
- it 'should work' do
894
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
895
- end
896
- end
897
-
898
1047
  # unit tests for get_customer_activity_reports_without_total_count
899
1048
  # Get Activity Reports for Application Customers
900
- # Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only if there are more results.
901
- # @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
902
- # @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
903
- # @param application_id
1049
+ # Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
1050
+ # @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
1051
+ # @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
1052
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
904
1053
  # @param [Hash] opts the optional parameters
905
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1054
+ # @option opts [Integer] :page_size The number of items in this response.
906
1055
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
907
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1056
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
908
1057
  # @option opts [String] :name Only return reports matching the customer name
909
- # @option opts [String] :integration_id Only return reports matching the integrationId
1058
+ # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
910
1059
  # @option opts [String] :campaign_name Only return reports matching the campaignName
911
1060
  # @option opts [String] :advocate_name Only return reports matching the current customer referrer name
912
- # @return [InlineResponse20014]
1061
+ # @return [InlineResponse20024]
913
1062
  describe 'get_customer_activity_reports_without_total_count test' do
914
1063
  it 'should work' do
915
1064
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -917,14 +1066,14 @@ describe 'ManagementApi' do
917
1066
  end
918
1067
 
919
1068
  # unit tests for get_customer_analytics
920
- # Get Analytics Report for a Customer
921
- # Fetch analytics for single application customer
922
- # @param application_id
923
- # @param customer_id
1069
+ # Get customer's analytics report
1070
+ # Fetch analytics for a given customer in the given application.
1071
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1072
+ # @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
924
1073
  # @param [Hash] opts the optional parameters
925
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1074
+ # @option opts [Integer] :page_size The number of items in this response.
926
1075
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
927
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1076
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
928
1077
  # @return [CustomerAnalytics]
929
1078
  describe 'get_customer_analytics test' do
930
1079
  it 'should work' do
@@ -933,10 +1082,11 @@ describe 'ManagementApi' do
933
1082
  end
934
1083
 
935
1084
  # unit tests for get_customer_profile
936
- # Get Customer Profile
937
- # @param customer_id
1085
+ # Get customer profile
1086
+ # Return the details of the specified customer profile. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`. </div>
1087
+ # @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
938
1088
  # @param [Hash] opts the optional parameters
939
- # @return [ApplicationCustomer]
1089
+ # @return [CustomerProfile]
940
1090
  describe 'get_customer_profile test' do
941
1091
  it 'should work' do
942
1092
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -944,11 +1094,13 @@ describe 'ManagementApi' do
944
1094
  end
945
1095
 
946
1096
  # unit tests for get_customer_profiles
947
- # List Customer Profiles
1097
+ # List customer profiles
1098
+ # List all customer profiles.
948
1099
  # @param [Hash] opts the optional parameters
949
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1100
+ # @option opts [Integer] :page_size The number of items in this response.
950
1101
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
951
- # @return [InlineResponse20012]
1102
+ # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
1103
+ # @return [InlineResponse20023]
952
1104
  describe 'get_customer_profiles test' do
953
1105
  it 'should work' do
954
1106
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -956,13 +1108,14 @@ describe 'ManagementApi' do
956
1108
  end
957
1109
 
958
1110
  # unit tests for get_customers_by_attributes
959
- # Get a list of the customer profiles that match the given attributes
960
- # Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
961
- # @param body
1111
+ # List customer profiles matching the given attributes
1112
+ # Get a list of the customer profiles matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.
1113
+ # @param body body
962
1114
  # @param [Hash] opts the optional parameters
963
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1115
+ # @option opts [Integer] :page_size The number of items in this response.
964
1116
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
965
- # @return [InlineResponse20012]
1117
+ # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
1118
+ # @return [InlineResponse20022]
966
1119
  describe 'get_customers_by_attributes test' do
967
1120
  it 'should work' do
968
1121
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -970,16 +1123,15 @@ describe 'ManagementApi' do
970
1123
  end
971
1124
 
972
1125
  # unit tests for get_event_types
973
- # List Event Types
974
- # Fetch all event type definitions for your account. Each event type can be
1126
+ # List event types
1127
+ # Fetch all event type definitions for your account.
975
1128
  # @param [Hash] opts the optional parameters
976
- # @option opts [String] :application_ids Filter by one or more application ids separated by comma
977
1129
  # @option opts [String] :name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
978
1130
  # @option opts [Boolean] :include_old_versions Include all versions of every event type.
979
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1131
+ # @option opts [Integer] :page_size The number of items in this response.
980
1132
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
981
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
982
- # @return [InlineResponse20025]
1133
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1134
+ # @return [InlineResponse20035]
983
1135
  describe 'get_event_types test' do
984
1136
  it 'should work' do
985
1137
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -987,26 +1139,74 @@ describe 'ManagementApi' do
987
1139
  end
988
1140
 
989
1141
  # unit tests for get_exports
990
- # Get Exports
991
- # Get a list of all past exports
1142
+ # Get exports
1143
+ # List all past exports
992
1144
  # @param [Hash] opts the optional parameters
993
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1145
+ # @option opts [Integer] :page_size The number of items in this response.
994
1146
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
995
- # @option opts [Integer] :application_id
996
- # @option opts [Integer] :campaign_id
1147
+ # @option opts [Float] :application_id Filter results by Application ID.
1148
+ # @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
997
1149
  # @option opts [String] :entity The name of the entity type that was exported.
998
- # @return [InlineResponse20028]
1150
+ # @return [InlineResponse20038]
999
1151
  describe 'get_exports test' do
1000
1152
  it 'should work' do
1001
1153
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1002
1154
  end
1003
1155
  end
1004
1156
 
1157
+ # unit tests for get_loyalty_card
1158
+ # Get loyalty card
1159
+ # Get the given loyalty card.
1160
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1161
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1162
+ # @param [Hash] opts the optional parameters
1163
+ # @return [LoyaltyCard]
1164
+ describe 'get_loyalty_card test' do
1165
+ it 'should work' do
1166
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1167
+ end
1168
+ end
1169
+
1170
+ # unit tests for get_loyalty_card_transaction_logs
1171
+ # Get loyalty card transaction logs
1172
+ # Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
1173
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1174
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1175
+ # @param [Hash] opts the optional parameters
1176
+ # @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
1177
+ # @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
1178
+ # @option opts [Integer] :page_size The number of items in this response.
1179
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1180
+ # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
1181
+ # @return [InlineResponse20013]
1182
+ describe 'get_loyalty_card_transaction_logs test' do
1183
+ it 'should work' do
1184
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1185
+ end
1186
+ end
1187
+
1188
+ # unit tests for get_loyalty_cards
1189
+ # List loyalty cards
1190
+ # For the given card-based loyalty program, list the loyalty cards that match your filter criteria.
1191
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1192
+ # @param [Hash] opts the optional parameters
1193
+ # @option opts [Integer] :page_size The number of items in this response.
1194
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1195
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1196
+ # @option opts [String] :identifier Optional query parameter to search cards by identifier.
1197
+ # @option opts [Integer] :profile_id Filter by the profile ID.
1198
+ # @return [InlineResponse20012]
1199
+ describe 'get_loyalty_cards test' do
1200
+ it 'should work' do
1201
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1202
+ end
1203
+ end
1204
+
1005
1205
  # unit tests for get_loyalty_points
1006
- # get the Loyalty Ledger for this integrationID
1007
- # Get the Loyalty Ledger for this profile integration ID.
1008
- # @param program_id The identifier for the application, must be unique within the account.
1009
- # @param integration_id The identifier for the application, must be unique within the account.
1206
+ # Get customer's full loyalty ledger
1207
+ # Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
1208
+ # @param loyalty_program_id The identifier for the loyalty program.
1209
+ # @param integration_id The identifier of the profile.
1010
1210
  # @param [Hash] opts the optional parameters
1011
1211
  # @return [LoyaltyLedger]
1012
1212
  describe 'get_loyalty_points test' do
@@ -1016,8 +1216,9 @@ describe 'ManagementApi' do
1016
1216
  end
1017
1217
 
1018
1218
  # unit tests for get_loyalty_program
1019
- # Get a loyalty program
1020
- # @param program_id
1219
+ # Get loyalty program
1220
+ # Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
1221
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1021
1222
  # @param [Hash] opts the optional parameters
1022
1223
  # @return [LoyaltyProgram]
1023
1224
  describe 'get_loyalty_program test' do
@@ -1026,10 +1227,29 @@ describe 'ManagementApi' do
1026
1227
  end
1027
1228
  end
1028
1229
 
1230
+ # unit tests for get_loyalty_program_transactions
1231
+ # List loyalty program transactions
1232
+ # Retrieve all loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
1233
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1234
+ # @param [Hash] opts the optional parameters
1235
+ # @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
1236
+ # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
1237
+ # @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
1238
+ # @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
1239
+ # @option opts [Integer] :page_size The number of items in this response.
1240
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1241
+ # @return [InlineResponse20011]
1242
+ describe 'get_loyalty_program_transactions test' do
1243
+ it 'should work' do
1244
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1245
+ end
1246
+ end
1247
+
1029
1248
  # unit tests for get_loyalty_programs
1030
- # List all loyalty Programs
1249
+ # List loyalty programs
1250
+ # List the loyalty programs of the account.
1031
1251
  # @param [Hash] opts the optional parameters
1032
- # @return [InlineResponse2007]
1252
+ # @return [InlineResponse20010]
1033
1253
  describe 'get_loyalty_programs test' do
1034
1254
  it 'should work' do
1035
1255
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1037,8 +1257,9 @@ describe 'ManagementApi' do
1037
1257
  end
1038
1258
 
1039
1259
  # unit tests for get_loyalty_statistics
1040
- # Get loyalty program statistics by loyalty program ID
1041
- # @param program_id
1260
+ # Get loyalty program statistics
1261
+ # Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
1262
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1042
1263
  # @param [Hash] opts the optional parameters
1043
1264
  # @return [LoyaltyStatistics]
1044
1265
  describe 'get_loyalty_statistics test' do
@@ -1047,42 +1268,47 @@ describe 'ManagementApi' do
1047
1268
  end
1048
1269
  end
1049
1270
 
1050
- # unit tests for get_referrals
1051
- # List Referrals (with total count)
1052
- # @param application_id
1053
- # @param campaign_id
1271
+ # unit tests for get_notification_webhook
1272
+ # Get notification about campaign-related changes
1273
+ # Return the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications).
1274
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1275
+ # @param notification_webhook_id The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.
1054
1276
  # @param [Hash] opts the optional parameters
1055
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1056
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1057
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1058
- # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1059
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1060
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1061
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
1062
- # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
1063
- # @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
1064
- # @return [InlineResponse201]
1065
- describe 'get_referrals test' do
1277
+ # @return [NotificationWebhook]
1278
+ describe 'get_notification_webhook test' do
1279
+ it 'should work' do
1280
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1281
+ end
1282
+ end
1283
+
1284
+ # unit tests for get_notification_webhooks
1285
+ # List notifications about campaign-related changes
1286
+ # List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application.
1287
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1288
+ # @param [Hash] opts the optional parameters
1289
+ # @return [InlineResponse2004]
1290
+ describe 'get_notification_webhooks test' do
1066
1291
  it 'should work' do
1067
1292
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1068
1293
  end
1069
1294
  end
1070
1295
 
1071
1296
  # unit tests for get_referrals_without_total_count
1072
- # List Referrals
1073
- # @param application_id
1074
- # @param campaign_id
1297
+ # List referrals
1298
+ # List all referrals of the specified campaign.
1299
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1300
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1075
1301
  # @param [Hash] opts the optional parameters
1076
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1302
+ # @option opts [Integer] :page_size The number of items in this response.
1077
1303
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1078
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1304
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1079
1305
  # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1080
1306
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1081
1307
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1082
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
1308
+ # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
1083
1309
  # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
1084
1310
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
1085
- # @return [InlineResponse2006]
1311
+ # @return [InlineResponse2008]
1086
1312
  describe 'get_referrals_without_total_count test' do
1087
1313
  it 'should work' do
1088
1314
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1090,8 +1316,9 @@ describe 'ManagementApi' do
1090
1316
  end
1091
1317
 
1092
1318
  # unit tests for get_role
1093
- # Get information for the specified role
1094
- # @param role_id
1319
+ # Get role
1320
+ # Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles).
1321
+ # @param role_id The Id of role.
1095
1322
  # @param [Hash] opts the optional parameters
1096
1323
  # @return [Role]
1097
1324
  describe 'get_role test' do
@@ -1101,10 +1328,11 @@ describe 'ManagementApi' do
1101
1328
  end
1102
1329
 
1103
1330
  # unit tests for get_ruleset
1104
- # Get a Ruleset
1105
- # @param application_id
1106
- # @param campaign_id
1107
- # @param ruleset_id
1331
+ # Get ruleset
1332
+ # Retrieve the specified ruleset.
1333
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1334
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1335
+ # @param ruleset_id The ID of the ruleset.
1108
1336
  # @param [Hash] opts the optional parameters
1109
1337
  # @return [Ruleset]
1110
1338
  describe 'get_ruleset test' do
@@ -1114,14 +1342,15 @@ describe 'ManagementApi' do
1114
1342
  end
1115
1343
 
1116
1344
  # unit tests for get_rulesets
1117
- # List Campaign Rulesets
1118
- # @param application_id
1119
- # @param campaign_id
1345
+ # List campaign rulesets
1346
+ # List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. **Important:** The response also includes deleted rules. You should only consider the latest revision of the returned rulesets.
1347
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1348
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1120
1349
  # @param [Hash] opts the optional parameters
1121
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1350
+ # @option opts [Integer] :page_size The number of items in this response.
1122
1351
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1123
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1124
- # @return [InlineResponse2003]
1352
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1353
+ # @return [InlineResponse2005]
1125
1354
  describe 'get_rulesets test' do
1126
1355
  it 'should work' do
1127
1356
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1129,9 +1358,9 @@ describe 'ManagementApi' do
1129
1358
  end
1130
1359
 
1131
1360
  # unit tests for get_user
1132
- # Get a single User
1133
- # Retrieves the data (including an invitation code) for a user. Non-admin users can only get themselves.
1134
- # @param user_id
1361
+ # Get user
1362
+ # Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.
1363
+ # @param user_id The ID of the user.
1135
1364
  # @param [Hash] opts the optional parameters
1136
1365
  # @return [User]
1137
1366
  describe 'get_user test' do
@@ -1141,13 +1370,13 @@ describe 'ManagementApi' do
1141
1370
  end
1142
1371
 
1143
1372
  # unit tests for get_users
1144
- # List Users in your account
1373
+ # List users in account
1145
1374
  # Retrieve all users in your account.
1146
1375
  # @param [Hash] opts the optional parameters
1147
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1376
+ # @option opts [Integer] :page_size The number of items in this response.
1148
1377
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1149
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1150
- # @return [InlineResponse20026]
1378
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1379
+ # @return [InlineResponse20036]
1151
1380
  describe 'get_users test' do
1152
1381
  it 'should work' do
1153
1382
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1155,9 +1384,9 @@ describe 'ManagementApi' do
1155
1384
  end
1156
1385
 
1157
1386
  # unit tests for get_webhook
1158
- # Get Webhook
1159
- # Returns an webhook by its id.
1160
- # @param webhook_id
1387
+ # Get webhook
1388
+ # Returns a webhook by its id.
1389
+ # @param webhook_id The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**.
1161
1390
  # @param [Hash] opts the optional parameters
1162
1391
  # @return [Webhook]
1163
1392
  describe 'get_webhook test' do
@@ -1167,19 +1396,19 @@ describe 'ManagementApi' do
1167
1396
  end
1168
1397
 
1169
1398
  # unit tests for get_webhook_activation_logs
1170
- # List Webhook activation Log Entries
1171
- # Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
1399
+ # List webhook activation log entries
1400
+ # Webhook activation log entries are created as soon as an integration request triggers a webhook effect. See the [docs](https://docs.talon.one/docs/dev/getting-started/webhooks).
1172
1401
  # @param [Hash] opts the optional parameters
1173
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1402
+ # @option opts [Integer] :page_size The number of items in this response.
1174
1403
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1175
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1404
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1176
1405
  # @option opts [String] :integration_request_uuid Filter results by integration request UUID.
1177
1406
  # @option opts [Float] :webhook_id Filter results by Webhook.
1178
- # @option opts [Float] :application_id
1407
+ # @option opts [Float] :application_id Filter results by Application ID.
1179
1408
  # @option opts [Float] :campaign_id Filter results by campaign.
1180
1409
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
1181
- # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
1182
- # @return [InlineResponse20023]
1410
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
1411
+ # @return [InlineResponse20033]
1183
1412
  describe 'get_webhook_activation_logs test' do
1184
1413
  it 'should work' do
1185
1414
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1187,19 +1416,20 @@ describe 'ManagementApi' do
1187
1416
  end
1188
1417
 
1189
1418
  # unit tests for get_webhook_logs
1190
- # List Webhook Log Entries
1419
+ # List webhook log entries
1420
+ # Retrieve all webhook log entries.
1191
1421
  # @param [Hash] opts the optional parameters
1192
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1422
+ # @option opts [Integer] :page_size The number of items in this response.
1193
1423
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1194
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1424
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1195
1425
  # @option opts [String] :status Filter results by HTTP status codes.
1196
1426
  # @option opts [Float] :webhook_id Filter results by Webhook.
1197
- # @option opts [Float] :application_id
1427
+ # @option opts [Float] :application_id Filter results by Application ID.
1198
1428
  # @option opts [Float] :campaign_id Filter results by campaign.
1199
1429
  # @option opts [String] :request_uuid Filter results by request UUID.
1200
1430
  # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
1201
1431
  # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any timezone. Talon.One will convert to UTC internally.
1202
- # @return [InlineResponse20024]
1432
+ # @return [InlineResponse20034]
1203
1433
  describe 'get_webhook_logs test' do
1204
1434
  it 'should work' do
1205
1435
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1207,24 +1437,66 @@ describe 'ManagementApi' do
1207
1437
  end
1208
1438
 
1209
1439
  # unit tests for get_webhooks
1210
- # List Webhooks
1440
+ # List webhooks
1441
+ # List all webhooks.
1211
1442
  # @param [Hash] opts the optional parameters
1212
- # @option opts [String] :application_ids Filter by one or more application ids separated by comma
1213
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1214
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1443
+ # @option opts [String] :application_ids Filter by one or more application IDs separated by a comma.
1444
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1445
+ # @option opts [Integer] :page_size The number of items in this response.
1215
1446
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1216
- # @return [InlineResponse20022]
1447
+ # @return [InlineResponse20032]
1217
1448
  describe 'get_webhooks test' do
1218
1449
  it 'should work' do
1219
1450
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1220
1451
  end
1221
1452
  end
1222
1453
 
1454
+ # unit tests for import_account_collection
1455
+ # Import data in existing account-level collection
1456
+ # Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
1457
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
1458
+ # @param [Hash] opts the optional parameters
1459
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1460
+ # @return [Import]
1461
+ describe 'import_account_collection test' do
1462
+ it 'should work' do
1463
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1464
+ end
1465
+ end
1466
+
1467
+ # unit tests for import_allowed_list
1468
+ # Import allowed values for attribute
1469
+ # Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
1470
+ # @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
1471
+ # @param [Hash] opts the optional parameters
1472
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1473
+ # @return [Import]
1474
+ describe 'import_allowed_list test' do
1475
+ it 'should work' do
1476
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1477
+ end
1478
+ end
1479
+
1480
+ # unit tests for import_collection
1481
+ # Import data in existing collection
1482
+ # Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
1483
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1484
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1485
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
1486
+ # @param [Hash] opts the optional parameters
1487
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1488
+ # @return [Import]
1489
+ describe 'import_collection test' do
1490
+ it 'should work' do
1491
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1492
+ end
1493
+ end
1494
+
1223
1495
  # unit tests for import_coupons
1224
- # Import coupons via CSV file
1225
- # Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
1226
- # @param application_id
1227
- # @param campaign_id
1496
+ # Import coupons
1497
+ # Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the customer who receives the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the coupon entity, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
1498
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1499
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1228
1500
  # @param [Hash] opts the optional parameters
1229
1501
  # @option opts [String] :up_file The file with the information about the data that should be imported.
1230
1502
  # @return [Import]
@@ -1234,10 +1506,23 @@ describe 'ManagementApi' do
1234
1506
  end
1235
1507
  end
1236
1508
 
1509
+ # unit tests for import_loyalty_cards
1510
+ # Import loyalty cards
1511
+ # Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
1512
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1513
+ # @param [Hash] opts the optional parameters
1514
+ # @option opts [String] :up_file The file with the information about the data that should be imported.
1515
+ # @return [Import]
1516
+ describe 'import_loyalty_cards test' do
1517
+ it 'should work' do
1518
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1519
+ end
1520
+ end
1521
+
1237
1522
  # unit tests for import_loyalty_points
1238
- # Import loyalty points via CSV file
1239
- # Upload a CSV file containing the loyalty points that should be created. The file should be sent as multipart data.
1240
- # @param program_id
1523
+ # Import loyalty points
1524
+ # Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the loyalty program type, you can import the points into a given customer profile or into a given _active_ loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate`: The earliest date when the points can be redeemed. On this date and until the expiration date, the points are `active`. - `expirydate`: The latest date when the points can be redeemed. After this date, the points are `expired`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
1525
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1241
1526
  # @param [Hash] opts the optional parameters
1242
1527
  # @option opts [String] :up_file The file with the information about the data that should be imported.
1243
1528
  # @return [Import]
@@ -1248,9 +1533,9 @@ describe 'ManagementApi' do
1248
1533
  end
1249
1534
 
1250
1535
  # unit tests for import_pool_giveaways
1251
- # Import giveaways codes into a giveaways pool
1252
- # Upload a CSV file containing the giveaways codes that should be created. Send the file as multipart data. The CSV file can contain the following columns: - `code` (required): the code of your giveaway, for instance, a gift card redemption code. - `startdate`: the start date in RFC3339 of the code redemption period. - `enddate`: the last date in RFC3339 of the code redemption period. - `attributes`: A json object describing _custom_ giveaways attribute names and their values. Double the double-quotes in the object. For example, if you created a custom attribute called `provider`, set it with `\"{\"\"provider\"\": \"\"myPartnerCompany\"\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the timezone of your choice. It is converted to UTC internally by Talon.One.
1253
- # @param pool_id
1536
+ # Import giveaway codes into a giveaway pool
1537
+ # Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): the code of your giveaway, for instance, a gift card redemption code. - `startdate`: the start date in RFC3339 of the code redemption period. - `enddate`: the last date in RFC3339 of the code redemption period. - `attributes`: A json object describing _custom_ giveaway attribute names and their values. Double the double-quotes in the object. For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated to the giveaway entity, set it with `\"{\"\"provider\"\": \"\"myPartnerCompany\"\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
1538
+ # @param pool_id The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
1254
1539
  # @param [Hash] opts the optional parameters
1255
1540
  # @option opts [String] :up_file The file with the information about the data that should be imported.
1256
1541
  # @return [Import]
@@ -1261,10 +1546,10 @@ describe 'ManagementApi' do
1261
1546
  end
1262
1547
 
1263
1548
  # unit tests for import_referrals
1264
- # Import referrals via CSV file
1265
- # Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file can contain the following colums: - `code` (required): the referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: the start date in RFC3339 of the code redemption period. - `expirydate`: the end date in RFC3339 of the code redemption period. - `limitval`: The maximum amount of redemptions of this code. Unlimited (0) when blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. For example, if you created a custom attribute called `category`, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. You can use the timezone of your choice. It is converted to UTC internally by Talon.One.
1266
- # @param application_id
1267
- # @param campaign_id
1549
+ # Import referrals
1550
+ # Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the referral entity, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
1551
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1552
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1268
1553
  # @param [Hash] opts the optional parameters
1269
1554
  # @option opts [String] :up_file The file with the information about the data that should be imported.
1270
1555
  # @return [Import]
@@ -1274,11 +1559,89 @@ describe 'ManagementApi' do
1274
1559
  end
1275
1560
  end
1276
1561
 
1562
+ # unit tests for list_account_collections
1563
+ # List collections in account
1564
+ # List collections in account.
1565
+ # @param [Hash] opts the optional parameters
1566
+ # @option opts [Integer] :page_size The number of items in this response.
1567
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1568
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1569
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
1570
+ # @option opts [String] :name Filter by the name of the Collection.
1571
+ # @return [InlineResponse20014]
1572
+ describe 'list_account_collections test' do
1573
+ it 'should work' do
1574
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1575
+ end
1576
+ end
1577
+
1578
+ # unit tests for list_collections
1579
+ # List collections
1580
+ # List collections in the campaign.
1581
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1582
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1583
+ # @param [Hash] opts the optional parameters
1584
+ # @option opts [Integer] :page_size The number of items in this response.
1585
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1586
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1587
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
1588
+ # @option opts [String] :name Filter by the name of the Collection.
1589
+ # @return [InlineResponse20016]
1590
+ describe 'list_collections test' do
1591
+ it 'should work' do
1592
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1593
+ end
1594
+ end
1595
+
1596
+ # unit tests for list_collections_in_application
1597
+ # List collections in application
1598
+ # List collections from all campaigns in the Application.
1599
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1600
+ # @param [Hash] opts the optional parameters
1601
+ # @option opts [Integer] :page_size The number of items in this response.
1602
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1603
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1604
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
1605
+ # @option opts [String] :name Filter by the name of the Collection.
1606
+ # @return [InlineResponse20016]
1607
+ describe 'list_collections_in_application test' do
1608
+ it 'should work' do
1609
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1610
+ end
1611
+ end
1612
+
1613
+ # unit tests for post_added_deducted_points_notification
1614
+ # Create notification about added or deducted loyalty points
1615
+ # Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications).
1616
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1617
+ # @param body body
1618
+ # @param [Hash] opts the optional parameters
1619
+ # @return [BaseNotification]
1620
+ describe 'post_added_deducted_points_notification test' do
1621
+ it 'should work' do
1622
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1623
+ end
1624
+ end
1625
+
1626
+ # unit tests for post_catalogs_strikethrough_notification
1627
+ # Create strikethrough notification
1628
+ # Create a notification for the in the given Application. For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
1629
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1630
+ # @param body body
1631
+ # @param [Hash] opts the optional parameters
1632
+ # @return [BaseNotification]
1633
+ describe 'post_catalogs_strikethrough_notification test' do
1634
+ it 'should work' do
1635
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1636
+ end
1637
+ end
1638
+
1277
1639
  # unit tests for remove_loyalty_points
1278
- # Deduct points in a certain loyalty program for the specified customer
1279
- # @param program_id
1280
- # @param integration_id
1281
- # @param body
1640
+ # Deduct points from customer profile
1641
+ # Deduct points from the specified loyalty program and specified customer profile. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
1642
+ # @param loyalty_program_id The identifier for the loyalty program.
1643
+ # @param integration_id The identifier of the profile.
1644
+ # @param body body
1282
1645
  # @param [Hash] opts the optional parameters
1283
1646
  # @return [nil]
1284
1647
  describe 'remove_loyalty_points test' do
@@ -1290,7 +1653,7 @@ describe 'ManagementApi' do
1290
1653
  # unit tests for reset_password
1291
1654
  # Reset password
1292
1655
  # Consumes the supplied password reset token and updates the password for the associated account.
1293
- # @param body
1656
+ # @param body body
1294
1657
  # @param [Hash] opts the optional parameters
1295
1658
  # @return [NewPassword]
1296
1659
  describe 'reset_password test' do
@@ -1299,115 +1662,90 @@ describe 'ManagementApi' do
1299
1662
  end
1300
1663
  end
1301
1664
 
1302
- # unit tests for search_coupons_advanced
1303
- # Get a list of the coupons that match the given attributes (with total count)
1304
- # Gets a list of all the coupons with attributes matching the query criteria
1305
- # @param application_id
1306
- # @param campaign_id
1307
- # @param body
1665
+ # unit tests for search_coupons_advanced_application_wide_without_total_count
1666
+ # List coupons that match the given attributes (without total count)
1667
+ # List the coupons whose attributes match the query criteria in all **active** campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
1668
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1669
+ # @param body body
1308
1670
  # @param [Hash] opts the optional parameters
1309
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1671
+ # @option opts [Integer] :page_size The number of items in this response.
1310
1672
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1311
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1673
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1312
1674
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1313
1675
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1314
1676
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1315
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
1677
+ # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
1316
1678
  # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
1317
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
1679
+ # @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
1318
1680
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
1319
- # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1320
1681
  # @option opts [String] :batch_id Filter results by batches of coupons
1321
- # @return [InlineResponse2004]
1322
- describe 'search_coupons_advanced test' do
1682
+ # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1683
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
1684
+ # @return [InlineResponse2007]
1685
+ describe 'search_coupons_advanced_application_wide_without_total_count test' do
1323
1686
  it 'should work' do
1324
1687
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1325
1688
  end
1326
1689
  end
1327
1690
 
1328
- # unit tests for search_coupons_advanced_application_wide
1329
- # Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
1330
- # Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
1331
- # @param application_id
1332
- # @param body
1691
+ # unit tests for search_coupons_advanced_without_total_count
1692
+ # List coupons that match the given attributes in campaign (without total count)
1693
+ # List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
1694
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1695
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1696
+ # @param body body
1333
1697
  # @param [Hash] opts the optional parameters
1334
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1698
+ # @option opts [Integer] :page_size The number of items in this response.
1335
1699
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1336
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1700
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
1337
1701
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1338
1702
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1339
1703
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1340
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
1704
+ # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
1341
1705
  # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
1342
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
1706
+ # @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
1343
1707
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
1344
- # @option opts [String] :batch_id Filter results by batches of coupons
1345
1708
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1346
- # @option opts [String] :campaign_state Filter results by the state of the campaign.
1347
- # @return [InlineResponse2004]
1348
- describe 'search_coupons_advanced_application_wide test' do
1709
+ # @option opts [String] :batch_id Filter results by batches of coupons
1710
+ # @return [InlineResponse2007]
1711
+ describe 'search_coupons_advanced_without_total_count test' do
1349
1712
  it 'should work' do
1350
1713
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1351
1714
  end
1352
1715
  end
1353
1716
 
1354
- # unit tests for search_coupons_advanced_application_wide_without_total_count
1355
- # Get a list of the coupons that match the given attributes in all active campaigns of an application
1356
- # Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
1357
- # @param application_id
1358
- # @param body
1717
+ # unit tests for transfer_loyalty_card
1718
+ # Transfer loyalty card data
1719
+ # Transfer card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
1720
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1721
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1722
+ # @param body body
1359
1723
  # @param [Hash] opts the optional parameters
1360
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1361
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1362
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1363
- # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1364
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1365
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1366
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
1367
- # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
1368
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
1369
- # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
1370
- # @option opts [String] :batch_id Filter results by batches of coupons
1371
- # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1372
- # @option opts [String] :campaign_state Filter results by the state of the campaign.
1373
- # @return [InlineResponse2005]
1374
- describe 'search_coupons_advanced_application_wide_without_total_count test' do
1724
+ # @return [nil]
1725
+ describe 'transfer_loyalty_card test' do
1375
1726
  it 'should work' do
1376
1727
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1377
1728
  end
1378
1729
  end
1379
1730
 
1380
- # unit tests for search_coupons_advanced_without_total_count
1381
- # Get a list of the coupons that match the given attributes
1382
- # Gets a list of all the coupons with attributes matching the query criteria
1383
- # @param application_id
1384
- # @param campaign_id
1385
- # @param body
1731
+ # unit tests for update_account_collection
1732
+ # Update account-level collection
1733
+ # Edit the description of the account-level collection and enable or disable the collection in the specified Applications.
1734
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
1735
+ # @param body body
1386
1736
  # @param [Hash] opts the optional parameters
1387
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1388
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1389
- # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
1390
- # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1391
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1392
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
1393
- # @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
1394
- # @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
1395
- # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
1396
- # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
1397
- # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1398
- # @option opts [String] :batch_id Filter results by batches of coupons
1399
- # @return [InlineResponse2005]
1400
- describe 'search_coupons_advanced_without_total_count test' do
1737
+ # @return [Collection]
1738
+ describe 'update_account_collection test' do
1401
1739
  it 'should work' do
1402
1740
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1403
1741
  end
1404
1742
  end
1405
1743
 
1406
1744
  # unit tests for update_additional_cost
1407
- # Update an additional cost
1745
+ # Update additional cost
1408
1746
  # Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations.
1409
- # @param additional_cost_id
1410
- # @param body
1747
+ # @param additional_cost_id The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**.
1748
+ # @param body body
1411
1749
  # @param [Hash] opts the optional parameters
1412
1750
  # @return [AccountAdditionalCost]
1413
1751
  describe 'update_additional_cost test' do
@@ -1417,10 +1755,10 @@ describe 'ManagementApi' do
1417
1755
  end
1418
1756
 
1419
1757
  # unit tests for update_attribute
1420
- # Update a custom attribute
1421
- # Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
1422
- # @param attribute_id
1423
- # @param body
1758
+ # Update custom attribute
1759
+ # Update an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the description. To change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute.
1760
+ # @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
1761
+ # @param body body
1424
1762
  # @param [Hash] opts the optional parameters
1425
1763
  # @return [Attribute]
1426
1764
  describe 'update_attribute test' do
@@ -1430,10 +1768,11 @@ describe 'ManagementApi' do
1430
1768
  end
1431
1769
 
1432
1770
  # unit tests for update_campaign
1433
- # Update a Campaign
1434
- # @param application_id
1435
- # @param campaign_id
1436
- # @param body
1771
+ # Update campaign
1772
+ # Update the given campaign.
1773
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1774
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1775
+ # @param body body
1437
1776
  # @param [Hash] opts the optional parameters
1438
1777
  # @return [Campaign]
1439
1778
  describe 'update_campaign test' do
@@ -1442,12 +1781,28 @@ describe 'ManagementApi' do
1442
1781
  end
1443
1782
  end
1444
1783
 
1784
+ # unit tests for update_collection
1785
+ # Update collection description
1786
+ # Edit the description of the collection.
1787
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1788
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1789
+ # @param collection_id The ID of the collection. You can get it with the [List collection in account](#operation/listCollectionsInApplication) endpoint.
1790
+ # @param body body
1791
+ # @param [Hash] opts the optional parameters
1792
+ # @return [Collection]
1793
+ describe 'update_collection test' do
1794
+ it 'should work' do
1795
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1796
+ end
1797
+ end
1798
+
1445
1799
  # unit tests for update_coupon
1446
- # Update a Coupon
1447
- # @param application_id
1448
- # @param campaign_id
1449
- # @param coupon_id The ID of the coupon code to update
1450
- # @param body
1800
+ # Update coupon
1801
+ # Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this PUT endpoint only, any property you do not explicitly set in your request will be set to <code>null</code>.</p> </div>
1802
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1803
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1804
+ # @param coupon_id The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.
1805
+ # @param body body
1451
1806
  # @param [Hash] opts the optional parameters
1452
1807
  # @return [Coupon]
1453
1808
  describe 'update_coupon test' do
@@ -1457,10 +1812,11 @@ describe 'ManagementApi' do
1457
1812
  end
1458
1813
 
1459
1814
  # unit tests for update_coupon_batch
1460
- # Update a Batch of Coupons
1461
- # @param application_id
1462
- # @param campaign_id
1463
- # @param body
1815
+ # Update coupons
1816
+ # Update all coupons, or a specific batch of coupons, in a campaign. You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
1817
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1818
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1819
+ # @param body body
1464
1820
  # @param [Hash] opts the optional parameters
1465
1821
  # @return [nil]
1466
1822
  describe 'update_coupon_batch test' do
@@ -1469,29 +1825,44 @@ describe 'ManagementApi' do
1469
1825
  end
1470
1826
  end
1471
1827
 
1472
- # unit tests for update_referral
1473
- # Update one Referral
1474
- # @param application_id
1475
- # @param campaign_id
1476
- # @param referral_id The ID of the referral code to delete
1477
- # @param body
1828
+ # unit tests for update_loyalty_card
1829
+ # Update loyalty card status
1830
+ # Update the status of the given loyalty card. A card can be _active_ or _inactive_.
1831
+ # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1832
+ # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1833
+ # @param body body
1478
1834
  # @param [Hash] opts the optional parameters
1479
- # @return [Referral]
1480
- describe 'update_referral test' do
1835
+ # @return [LoyaltyCard]
1836
+ describe 'update_loyalty_card test' do
1481
1837
  it 'should work' do
1482
1838
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1483
1839
  end
1484
1840
  end
1485
1841
 
1486
- # unit tests for update_ruleset
1487
- # Update a Ruleset
1488
- # @param application_id
1489
- # @param campaign_id
1490
- # @param ruleset_id
1491
- # @param body
1842
+ # unit tests for update_notification_webhook
1843
+ # Update notification about campaign-related changes
1844
+ # Update the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications). **Tip:** You can review the payload you will receive in the [specs](https://docs.talon.one/outbound-notifications#/paths/campaign_edited/post).
1845
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1846
+ # @param notification_webhook_id The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.
1847
+ # @param body body
1492
1848
  # @param [Hash] opts the optional parameters
1493
- # @return [Ruleset]
1494
- describe 'update_ruleset test' do
1849
+ # @return [NotificationWebhook]
1850
+ describe 'update_notification_webhook test' do
1851
+ it 'should work' do
1852
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1853
+ end
1854
+ end
1855
+
1856
+ # unit tests for update_referral
1857
+ # Update referral
1858
+ # Update the specified referral.
1859
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1860
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1861
+ # @param referral_id The ID of the referral code.
1862
+ # @param body body
1863
+ # @param [Hash] opts the optional parameters
1864
+ # @return [Referral]
1865
+ describe 'update_referral test' do
1495
1866
  it 'should work' do
1496
1867
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1497
1868
  end