talon_one 3.0.2 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (638) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +150 -49
  3. data/docs/AccountAnalytics.md +3 -1
  4. data/docs/AccountDashboardStatistic.md +0 -2
  5. data/docs/AccountDashboardStatisticCampaigns.md +4 -2
  6. data/docs/Achievement.md +39 -0
  7. data/docs/AchievementAdditionalProperties.md +23 -0
  8. data/docs/AchievementProgress.md +35 -0
  9. data/docs/AddItemCatalogAction.md +3 -1
  10. data/docs/AddLoyaltyPoints.md +2 -2
  11. data/docs/AddLoyaltyPointsEffectProps.md +1 -1
  12. data/docs/AddToAudienceEffectProps.md +23 -0
  13. data/docs/AdditionalCampaignProperties.md +59 -0
  14. data/docs/Application.md +3 -5
  15. data/docs/ApplicationAPIKey.md +6 -2
  16. data/docs/ApplicationAnalyticsDataPoint.md +31 -0
  17. data/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md +19 -0
  18. data/docs/ApplicationAnalyticsDataPointAvgSessionValue.md +19 -0
  19. data/docs/ApplicationAnalyticsDataPointSessionsCount.md +19 -0
  20. data/docs/ApplicationAnalyticsDataPointTotalRevenue.md +19 -0
  21. data/docs/ApplicationCampaignAnalytics.md +45 -0
  22. data/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md +21 -0
  23. data/docs/ApplicationCampaignAnalyticsAvgSessionValue.md +21 -0
  24. data/docs/ApplicationCampaignAnalyticsCouponsCount.md +19 -0
  25. data/docs/ApplicationCampaignAnalyticsSessionsCount.md +21 -0
  26. data/docs/ApplicationCampaignAnalyticsTotalDiscounts.md +19 -0
  27. data/docs/ApplicationCampaignAnalyticsTotalRevenue.md +21 -0
  28. data/docs/ApplicationCustomer.md +2 -2
  29. data/docs/ApplicationEvent.md +4 -0
  30. data/docs/ApplicationNotification.md +1 -1
  31. data/docs/ApplicationSession.md +5 -3
  32. data/docs/ApplicationStoreEntity.md +17 -0
  33. data/docs/Audience.md +1 -1
  34. data/docs/AudienceAnalytics.md +1 -1
  35. data/docs/AudienceCustomer.md +2 -2
  36. data/docs/BaseCampaign.md +45 -0
  37. data/docs/BaseLoyaltyProgram.md +9 -1
  38. data/docs/BaseNotification.md +5 -1
  39. data/docs/BaseNotificationEntity.md +3 -1
  40. data/docs/BaseNotificationWebhook.md +3 -1
  41. data/docs/BulkOperationOnCampaigns.md +19 -0
  42. data/docs/Campaign.md +25 -17
  43. data/docs/CampaignBudget.md +21 -0
  44. data/docs/CampaignCopy.md +3 -1
  45. data/docs/CampaignCreatedNotification.md +2 -2
  46. data/docs/CampaignEvaluationGroup.md +31 -0
  47. data/docs/CampaignEvaluationPosition.md +21 -0
  48. data/docs/CampaignEvaluationTreeChangedNotification.md +21 -0
  49. data/docs/CampaignGroup.md +6 -6
  50. data/docs/CampaignNotificationPolicy.md +17 -0
  51. data/docs/CampaignSet.md +3 -5
  52. data/docs/CampaignSetBranchNode.md +13 -3
  53. data/docs/CampaignTemplate.md +2 -0
  54. data/docs/CardExpiringPointsNotificationPolicy.md +21 -0
  55. data/docs/CardExpiringPointsNotificationTrigger.md +19 -0
  56. data/docs/CardLedgerPointsEntryIntegrationAPI.md +35 -0
  57. data/docs/CartItem.md +4 -2
  58. data/docs/CatalogItem.md +3 -1
  59. data/docs/ChangeLoyaltyTierLevelEffectProps.md +27 -0
  60. data/docs/Coupon.md +4 -2
  61. data/docs/CouponCreationJob.md +1 -1
  62. data/docs/CouponsNotificationPolicy.md +3 -1
  63. data/docs/CreateAchievement.md +27 -0
  64. data/docs/CreateApplicationAPIKey.md +7 -3
  65. data/docs/CreateTemplateCampaign.md +6 -2
  66. data/docs/CustomEffectProps.md +1 -1
  67. data/docs/CustomerInventory.md +3 -1
  68. data/docs/CustomerProfile.md +2 -2
  69. data/docs/CustomerProfileAudienceRequestItem.md +1 -1
  70. data/docs/CustomerProfileIntegrationResponseV2.md +33 -0
  71. data/docs/CustomerSession.md +1 -1
  72. data/docs/CustomerSessionV2.md +8 -6
  73. data/docs/DeactivateUserRequest.md +17 -0
  74. data/docs/DeleteUserRequest.md +17 -0
  75. data/docs/Effect.md +2 -0
  76. data/docs/EffectEntity.md +3 -1
  77. data/docs/EmailEntity.md +1 -1
  78. data/docs/Environment.md +2 -0
  79. data/docs/Event.md +2 -0
  80. data/docs/EventV2.md +4 -2
  81. data/docs/ExpiringCouponsNotificationPolicy.md +21 -0
  82. data/docs/ExpiringCouponsNotificationTrigger.md +19 -0
  83. data/docs/ExpiringPointsNotificationPolicy.md +4 -2
  84. data/docs/FuncArgDef.md +1 -1
  85. data/docs/GetIntegrationCouponRequest.md +19 -0
  86. data/docs/IdentifiableEntity.md +17 -0
  87. data/docs/IncreaseAchievementProgressEffectProps.md +29 -0
  88. data/docs/InlineResponse20010.md +1 -1
  89. data/docs/InlineResponse20011.md +1 -1
  90. data/docs/InlineResponse20012.md +1 -1
  91. data/docs/InlineResponse20013.md +3 -3
  92. data/docs/InlineResponse20014.md +2 -2
  93. data/docs/InlineResponse20015.md +3 -5
  94. data/docs/InlineResponse20016.md +3 -3
  95. data/docs/InlineResponse20017.md +1 -1
  96. data/docs/InlineResponse20018.md +1 -1
  97. data/docs/InlineResponse20019.md +2 -2
  98. data/docs/InlineResponse20020.md +1 -1
  99. data/docs/InlineResponse20021.md +2 -4
  100. data/docs/InlineResponse20022.md +3 -3
  101. data/docs/InlineResponse20023.md +1 -1
  102. data/docs/InlineResponse20024.md +3 -1
  103. data/docs/InlineResponse20025.md +1 -1
  104. data/docs/InlineResponse20026.md +2 -2
  105. data/docs/InlineResponse20027.md +2 -2
  106. data/docs/InlineResponse20028.md +3 -3
  107. data/docs/InlineResponse20029.md +3 -5
  108. data/docs/InlineResponse2003.md +3 -3
  109. data/docs/InlineResponse20030.md +1 -1
  110. data/docs/InlineResponse20031.md +3 -3
  111. data/docs/InlineResponse20032.md +3 -3
  112. data/docs/InlineResponse20033.md +5 -3
  113. data/docs/InlineResponse20034.md +1 -1
  114. data/docs/InlineResponse20035.md +5 -3
  115. data/docs/InlineResponse20036.md +1 -1
  116. data/docs/InlineResponse20037.md +1 -1
  117. data/docs/InlineResponse20038.md +2 -4
  118. data/docs/InlineResponse20039.md +1 -1
  119. data/docs/InlineResponse2004.md +3 -3
  120. data/docs/InlineResponse20040.md +1 -1
  121. data/docs/InlineResponse20041.md +19 -0
  122. data/docs/InlineResponse20042.md +21 -0
  123. data/docs/InlineResponse20043.md +19 -0
  124. data/docs/InlineResponse20044.md +19 -0
  125. data/docs/InlineResponse20045.md +21 -0
  126. data/docs/InlineResponse20046.md +19 -0
  127. data/docs/InlineResponse20047.md +19 -0
  128. data/docs/InlineResponse2005.md +1 -1
  129. data/docs/InlineResponse2006.md +1 -1
  130. data/docs/InlineResponse2007.md +1 -1
  131. data/docs/InlineResponse2008.md +2 -2
  132. data/docs/InlineResponse2009.md +1 -1
  133. data/docs/IntegrationApi.md +204 -117
  134. data/docs/IntegrationCoupon.md +3 -1
  135. data/docs/IntegrationEvent.md +2 -0
  136. data/docs/IntegrationEventV2Request.md +4 -2
  137. data/docs/IntegrationRequest.md +1 -1
  138. data/docs/IntegrationStoreEntity.md +17 -0
  139. data/docs/InventoryCoupon.md +4 -2
  140. data/docs/LedgerPointsEntryIntegrationAPI.md +33 -0
  141. data/docs/LoginParams.md +1 -1
  142. data/docs/LoyaltyLedgerTransactions.md +1 -1
  143. data/docs/LoyaltyProgram.md +15 -1
  144. data/docs/LoyaltyProgramLedgers.md +2 -0
  145. data/docs/LoyaltyProgramSubledgers.md +19 -0
  146. data/docs/LoyaltyProgramTransaction.md +4 -2
  147. data/docs/ManagementApi.md +3313 -1620
  148. data/docs/MessageLogEntries.md +19 -0
  149. data/docs/MessageLogEntry.md +39 -0
  150. data/docs/MessageLogRequest.md +19 -0
  151. data/docs/MessageLogResponse.md +21 -0
  152. data/docs/NewAccountSignUp.md +1 -1
  153. data/docs/NewApplication.md +6 -10
  154. data/docs/NewApplicationAPIKey.md +6 -2
  155. data/docs/NewAudience.md +1 -1
  156. data/docs/NewBaseNotification.md +2 -0
  157. data/docs/NewCampaign.md +8 -2
  158. data/docs/NewCampaignEvaluationGroup.md +27 -0
  159. data/docs/NewCampaignGroup.md +6 -6
  160. data/docs/NewCampaignTemplate.md +3 -1
  161. data/docs/NewCoupons.md +4 -2
  162. data/docs/NewCustomerSession.md +1 -1
  163. data/docs/NewCustomerSessionV2.md +5 -3
  164. data/docs/NewEvent.md +2 -0
  165. data/docs/NewInternalAudience.md +1 -1
  166. data/docs/NewInvitation.md +8 -6
  167. data/docs/NewInviteEmail.md +4 -4
  168. data/docs/NewLoyaltyProgram.md +8 -0
  169. data/docs/NewNotificationTest.md +29 -0
  170. data/docs/NewNotificationWebhook.md +3 -1
  171. data/docs/NewPicklist.md +1 -1
  172. data/docs/NewRoleV2.md +23 -0
  173. data/docs/NewStore.md +23 -0
  174. data/docs/NewUser.md +1 -1
  175. data/docs/NotificationActivation.md +17 -0
  176. data/docs/NotificationListItem.md +23 -0
  177. data/docs/NotificationTest.md +27 -0
  178. data/docs/OneTimeCode.md +23 -0
  179. data/docs/OutgoingIntegrationCleverTapPolicy.md +21 -0
  180. data/docs/OutgoingIntegrationConfiguration.md +1 -1
  181. data/docs/OutgoingIntegrationIterablePolicy.md +19 -0
  182. data/docs/OutgoingIntegrationMoEngagePolicy.md +23 -0
  183. data/docs/OutgoingIntegrationTemplate.md +33 -0
  184. data/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md +35 -0
  185. data/docs/OutgoingIntegrationTemplates.md +17 -0
  186. data/docs/OutgoingIntegrationType.md +1 -1
  187. data/docs/PatchItemCatalogAction.md +2 -0
  188. data/docs/PendingPointsNotificationPolicy.md +19 -0
  189. data/docs/Picklist.md +1 -1
  190. data/docs/Product.md +17 -0
  191. data/docs/RemoveFromAudienceEffectProps.md +23 -0
  192. data/docs/ReturnedCartItem.md +1 -1
  193. data/docs/Role.md +1 -1
  194. data/docs/RoleAssign.md +2 -2
  195. data/docs/RoleV2.md +12 -6
  196. data/docs/RoleV2ApplicationDetails.md +6 -4
  197. data/docs/RoleV2Base.md +23 -0
  198. data/docs/RoleV2PermissionSet.md +3 -3
  199. data/docs/RoleV2Permissions.md +3 -3
  200. data/docs/RoleV2RolesGroup.md +21 -0
  201. data/docs/RollbackAddedLoyaltyPointsEffectProps.md +1 -1
  202. data/docs/RollbackDiscountEffectProps.md +1 -1
  203. data/docs/SSOConfig.md +17 -0
  204. data/docs/SamlConnectionInternal.md +19 -0
  205. data/docs/SamlLoginEndpoint.md +4 -2
  206. data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +1 -1
  207. data/docs/SetDiscountPerItemEffectProps.md +6 -2
  208. data/docs/Store.md +33 -0
  209. data/docs/TemplateArgDef.md +1 -1
  210. data/docs/Tier.md +5 -1
  211. data/docs/TierDowngradeNotificationPolicy.md +19 -0
  212. data/docs/TierUpgradeNotificationPolicy.md +19 -0
  213. data/docs/TierWillDowngradeNotificationPolicy.md +21 -0
  214. data/docs/TierWillDowngradeNotificationTrigger.md +19 -0
  215. data/docs/TimePoint.md +27 -0
  216. data/docs/TrackEventV2Response.md +33 -0
  217. data/docs/TwoFAConfig.md +19 -0
  218. data/docs/UpdateAchievement.md +27 -0
  219. data/docs/UpdateApplication.md +4 -6
  220. data/docs/UpdateApplicationAPIKey.md +17 -0
  221. data/docs/UpdateCampaign.md +9 -3
  222. data/docs/UpdateCampaignEvaluationGroup.md +27 -0
  223. data/docs/UpdateCampaignGroup.md +6 -6
  224. data/docs/UpdateCampaignTemplate.md +3 -1
  225. data/docs/UpdateCoupon.md +4 -2
  226. data/docs/UpdateCouponBatch.md +2 -2
  227. data/docs/UpdateLoyaltyProgram.md +8 -0
  228. data/docs/UpdatePicklist.md +1 -1
  229. data/docs/UpdateStore.md +21 -0
  230. data/docs/UpdateUser.md +8 -6
  231. data/docs/User.md +19 -13
  232. data/docs/WebhookWithOutgoingIntegrationDetails.md +45 -0
  233. data/lib/talon_one/api/integration_api.rb +283 -136
  234. data/lib/talon_one/api/management_api.rb +2787 -890
  235. data/lib/talon_one/models/account_additional_cost.rb +3 -3
  236. data/lib/talon_one/models/account_analytics.rb +19 -4
  237. data/lib/talon_one/models/account_dashboard_statistic.rb +1 -13
  238. data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +20 -5
  239. data/lib/talon_one/models/achievement.rb +406 -0
  240. data/lib/talon_one/models/achievement_additional_properties.rb +252 -0
  241. data/lib/talon_one/models/achievement_progress.rb +410 -0
  242. data/lib/talon_one/models/add_item_catalog_action.rb +12 -3
  243. data/lib/talon_one/models/add_loyalty_points.rb +2 -2
  244. data/lib/talon_one/models/add_loyalty_points_effect_props.rb +1 -1
  245. data/lib/talon_one/models/add_to_audience_effect_props.rb +238 -0
  246. data/lib/talon_one/models/additional_campaign_properties.rb +463 -0
  247. data/lib/talon_one/models/application.rb +12 -50
  248. data/lib/talon_one/models/application_analytics_data_point.rb +273 -0
  249. data/lib/talon_one/models/application_analytics_data_point_avg_items_per_session.rb +216 -0
  250. data/lib/talon_one/models/application_analytics_data_point_avg_session_value.rb +216 -0
  251. data/lib/talon_one/models/application_analytics_data_point_sessions_count.rb +216 -0
  252. data/lib/talon_one/models/application_analytics_data_point_total_revenue.rb +216 -0
  253. data/lib/talon_one/models/application_api_key.rb +37 -5
  254. data/lib/talon_one/models/application_campaign_analytics.rb +379 -0
  255. data/lib/talon_one/models/application_campaign_analytics_avg_items_per_session.rb +225 -0
  256. data/lib/talon_one/models/application_campaign_analytics_avg_session_value.rb +225 -0
  257. data/lib/talon_one/models/application_campaign_analytics_coupons_count.rb +216 -0
  258. data/lib/talon_one/models/application_campaign_analytics_sessions_count.rb +225 -0
  259. data/lib/talon_one/models/application_campaign_analytics_total_discounts.rb +216 -0
  260. data/lib/talon_one/models/application_campaign_analytics_total_revenue.rb +225 -0
  261. data/lib/talon_one/models/application_customer.rb +2 -2
  262. data/lib/talon_one/models/application_event.rb +45 -1
  263. data/lib/talon_one/models/application_notification.rb +1 -1
  264. data/lib/talon_one/models/application_session.rb +51 -17
  265. data/lib/talon_one/models/application_store_entity.rb +207 -0
  266. data/lib/talon_one/models/attribute.rb +2 -2
  267. data/lib/talon_one/models/audience_analytics.rb +2 -2
  268. data/lib/talon_one/models/audience_customer.rb +2 -2
  269. data/lib/talon_one/models/base_campaign.rb +449 -0
  270. data/lib/talon_one/models/base_loyalty_program.rb +102 -4
  271. data/lib/talon_one/models/base_notification.rb +65 -4
  272. data/lib/talon_one/models/base_notification_entity.rb +16 -4
  273. data/lib/talon_one/models/base_notification_webhook.rb +16 -4
  274. data/lib/talon_one/models/bulk_operation_on_campaigns.rb +263 -0
  275. data/lib/talon_one/models/campaign.rb +105 -20
  276. data/lib/talon_one/models/campaign_budget.rb +280 -0
  277. data/lib/talon_one/models/campaign_copy.rb +14 -4
  278. data/lib/talon_one/models/campaign_created_notification.rb +10 -10
  279. data/lib/talon_one/models/campaign_evaluation_group.rb +378 -0
  280. data/lib/talon_one/models/campaign_evaluation_position.rb +243 -0
  281. data/lib/talon_one/models/campaign_evaluation_tree_changed_notification.rb +236 -0
  282. data/lib/talon_one/models/campaign_group.rb +4 -4
  283. data/lib/talon_one/models/campaign_notification_policy.rb +231 -0
  284. data/lib/talon_one/models/campaign_set.rb +16 -31
  285. data/lib/talon_one/models/campaign_set_branch_node.rb +100 -6
  286. data/lib/talon_one/models/campaign_template.rb +30 -1
  287. data/lib/talon_one/models/card_expiring_points_notification_policy.rb +259 -0
  288. data/lib/talon_one/models/card_expiring_points_notification_trigger.rb +280 -0
  289. data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +410 -0
  290. data/lib/talon_one/models/cart_item.rb +12 -3
  291. data/lib/talon_one/models/catalog_item.rb +13 -4
  292. data/lib/talon_one/models/change_loyalty_tier_level_effect_props.rb +278 -0
  293. data/lib/talon_one/models/coupon.rb +15 -5
  294. data/lib/talon_one/models/coupon_creation_job.rb +1 -1
  295. data/lib/talon_one/models/coupons_notification_policy.rb +16 -4
  296. data/lib/talon_one/models/create_achievement.rb +320 -0
  297. data/lib/talon_one/models/create_application_api_key.rb +40 -8
  298. data/lib/talon_one/models/create_template_campaign.rb +27 -5
  299. data/lib/talon_one/models/custom_effect_props.rb +1 -1
  300. data/lib/talon_one/models/customer_inventory.rb +15 -4
  301. data/lib/talon_one/models/customer_profile.rb +2 -2
  302. data/lib/talon_one/models/customer_profile_audience_request_item.rb +1 -1
  303. data/lib/talon_one/models/customer_profile_integration_response_v2.rb +307 -0
  304. data/lib/talon_one/models/customer_session.rb +1 -1
  305. data/lib/talon_one/models/customer_session_v2.rb +41 -7
  306. data/lib/talon_one/models/deactivate_user_request.rb +213 -0
  307. data/lib/talon_one/models/delete_user_request.rb +213 -0
  308. data/lib/talon_one/models/effect.rb +11 -1
  309. data/lib/talon_one/models/effect_entity.rb +14 -4
  310. data/lib/talon_one/models/email_entity.rb +1 -1
  311. data/lib/talon_one/models/environment.rb +13 -1
  312. data/lib/talon_one/models/event.rb +35 -1
  313. data/lib/talon_one/models/event_v2.rb +37 -3
  314. data/lib/talon_one/models/expiring_coupons_notification_policy.rb +259 -0
  315. data/lib/talon_one/models/expiring_coupons_notification_trigger.rb +280 -0
  316. data/lib/talon_one/models/expiring_points_notification_policy.rb +16 -4
  317. data/lib/talon_one/models/func_arg_def.rb +0 -5
  318. data/lib/talon_one/models/get_integration_coupon_request.rb +257 -0
  319. data/lib/talon_one/models/identifiable_entity.rb +212 -0
  320. data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +298 -0
  321. data/lib/talon_one/models/inline_response20010.rb +1 -1
  322. data/lib/talon_one/models/inline_response20011.rb +1 -1
  323. data/lib/talon_one/models/inline_response20012.rb +1 -1
  324. data/lib/talon_one/models/inline_response20013.rb +11 -11
  325. data/lib/talon_one/models/inline_response20014.rb +1 -3
  326. data/lib/talon_one/models/inline_response20015.rb +7 -11
  327. data/lib/talon_one/models/inline_response20016.rb +3 -1
  328. data/lib/talon_one/models/inline_response20017.rb +1 -1
  329. data/lib/talon_one/models/inline_response20018.rb +1 -1
  330. data/lib/talon_one/models/inline_response20019.rb +10 -10
  331. data/lib/talon_one/models/inline_response20020.rb +1 -1
  332. data/lib/talon_one/models/inline_response20021.rb +7 -11
  333. data/lib/talon_one/models/inline_response20022.rb +10 -10
  334. data/lib/talon_one/models/inline_response20023.rb +1 -1
  335. data/lib/talon_one/models/inline_response20024.rb +10 -6
  336. data/lib/talon_one/models/inline_response20025.rb +1 -1
  337. data/lib/talon_one/models/inline_response20026.rb +6 -1
  338. data/lib/talon_one/models/inline_response20027.rb +1 -6
  339. data/lib/talon_one/models/inline_response20028.rb +11 -11
  340. data/lib/talon_one/models/inline_response20029.rb +7 -11
  341. data/lib/talon_one/models/inline_response2003.rb +11 -11
  342. data/lib/talon_one/models/inline_response20030.rb +1 -1
  343. data/lib/talon_one/models/inline_response20031.rb +8 -13
  344. data/lib/talon_one/models/inline_response20032.rb +8 -13
  345. data/lib/talon_one/models/inline_response20033.rb +11 -7
  346. data/lib/talon_one/models/inline_response20034.rb +1 -1
  347. data/lib/talon_one/models/inline_response20035.rb +11 -7
  348. data/lib/talon_one/models/inline_response20036.rb +1 -1
  349. data/lib/talon_one/models/inline_response20037.rb +1 -1
  350. data/lib/talon_one/models/inline_response20038.rb +7 -11
  351. data/lib/talon_one/models/inline_response20039.rb +1 -1
  352. data/lib/talon_one/models/inline_response2004.rb +11 -11
  353. data/lib/talon_one/models/inline_response20040.rb +1 -1
  354. data/lib/talon_one/models/inline_response20041.rb +227 -0
  355. data/lib/talon_one/models/inline_response20042.rb +231 -0
  356. data/lib/talon_one/models/inline_response20043.rb +227 -0
  357. data/lib/talon_one/models/inline_response20044.rb +227 -0
  358. data/lib/talon_one/models/inline_response20045.rb +231 -0
  359. data/lib/talon_one/models/inline_response20046.rb +222 -0
  360. data/lib/talon_one/models/inline_response20047.rb +227 -0
  361. data/lib/talon_one/models/inline_response2005.rb +1 -1
  362. data/lib/talon_one/models/inline_response2006.rb +1 -1
  363. data/lib/talon_one/models/inline_response2007.rb +1 -1
  364. data/lib/talon_one/models/inline_response2008.rb +10 -10
  365. data/lib/talon_one/models/inline_response2009.rb +1 -1
  366. data/lib/talon_one/models/integration_coupon.rb +12 -2
  367. data/lib/talon_one/models/integration_event.rb +35 -1
  368. data/lib/talon_one/models/integration_event_v2_request.rb +37 -3
  369. data/lib/talon_one/models/integration_request.rb +1 -1
  370. data/lib/talon_one/models/integration_store_entity.rb +231 -0
  371. data/lib/talon_one/models/inventory_coupon.rb +13 -3
  372. data/lib/talon_one/models/ledger_points_entry_integration_api.rb +400 -0
  373. data/lib/talon_one/models/login_params.rb +1 -1
  374. data/lib/talon_one/models/loyalty.rb +1 -1
  375. data/lib/talon_one/models/loyalty_ledger_transactions.rb +1 -1
  376. data/lib/talon_one/models/loyalty_program.rb +136 -4
  377. data/lib/talon_one/models/loyalty_program_ledgers.rb +12 -2
  378. data/lib/talon_one/models/loyalty_program_subledgers.rb +230 -0
  379. data/lib/talon_one/models/loyalty_program_transaction.rb +13 -3
  380. data/lib/talon_one/models/message_log_entries.rb +241 -0
  381. data/lib/talon_one/models/message_log_entry.rb +395 -0
  382. data/lib/talon_one/models/message_log_request.rb +249 -0
  383. data/lib/talon_one/models/message_log_response.rb +264 -0
  384. data/lib/talon_one/models/new_account_sign_up.rb +1 -1
  385. data/lib/talon_one/models/new_additional_cost.rb +3 -3
  386. data/lib/talon_one/models/new_application.rb +2 -51
  387. data/lib/talon_one/models/new_application_api_key.rb +37 -5
  388. data/lib/talon_one/models/new_attribute.rb +2 -2
  389. data/lib/talon_one/models/new_base_notification.rb +13 -1
  390. data/lib/talon_one/models/new_campaign.rb +52 -5
  391. data/lib/talon_one/models/new_campaign_evaluation_group.rb +347 -0
  392. data/lib/talon_one/models/new_campaign_group.rb +4 -4
  393. data/lib/talon_one/models/new_campaign_template.rb +33 -4
  394. data/lib/talon_one/models/new_coupons.rb +15 -5
  395. data/lib/talon_one/models/new_customer_session.rb +1 -1
  396. data/lib/talon_one/models/new_customer_session_v2.rb +38 -4
  397. data/lib/talon_one/models/new_event.rb +35 -1
  398. data/lib/talon_one/models/new_invitation.rb +24 -18
  399. data/lib/talon_one/models/new_invite_email.rb +2 -38
  400. data/lib/talon_one/models/new_loyalty_program.rb +99 -1
  401. data/lib/talon_one/models/new_notification_test.rb +327 -0
  402. data/lib/talon_one/models/new_notification_webhook.rb +16 -4
  403. data/lib/talon_one/models/new_picklist.rb +1 -1
  404. data/lib/talon_one/models/new_role_v2.rb +249 -0
  405. data/lib/talon_one/models/new_store.rb +309 -0
  406. data/lib/talon_one/models/new_user.rb +1 -1
  407. data/lib/talon_one/models/notification_activation.rb +212 -0
  408. data/lib/talon_one/models/notification_list_item.rb +257 -0
  409. data/lib/talon_one/models/notification_test.rb +227 -0
  410. data/lib/talon_one/models/one_time_code.rb +252 -0
  411. data/lib/talon_one/models/outgoing_integration_clever_tap_policy.rb +242 -0
  412. data/lib/talon_one/models/outgoing_integration_configuration.rb +1 -0
  413. data/lib/talon_one/models/outgoing_integration_iterable_policy.rb +227 -0
  414. data/lib/talon_one/models/outgoing_integration_mo_engage_policy.rb +257 -0
  415. data/lib/talon_one/models/outgoing_integration_template.rb +409 -0
  416. data/lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb +425 -0
  417. data/lib/talon_one/models/outgoing_integration_templates.rb +209 -0
  418. data/lib/talon_one/models/patch_item_catalog_action.rb +11 -2
  419. data/lib/talon_one/models/pending_points_notification_policy.rb +243 -0
  420. data/lib/talon_one/models/picklist.rb +1 -1
  421. data/lib/talon_one/models/product.rb +232 -0
  422. data/lib/talon_one/models/remove_from_audience_effect_props.rb +238 -0
  423. data/lib/talon_one/models/returned_cart_item.rb +1 -1
  424. data/lib/talon_one/models/role.rb +1 -1
  425. data/lib/talon_one/models/role_assign.rb +2 -2
  426. data/lib/talon_one/models/role_v2.rb +63 -12
  427. data/lib/talon_one/models/role_v2_application_details.rb +17 -7
  428. data/lib/talon_one/models/role_v2_base.rb +238 -0
  429. data/lib/talon_one/models/role_v2_permission_set.rb +12 -11
  430. data/lib/talon_one/models/role_v2_permissions.rb +2 -2
  431. data/lib/talon_one/models/role_v2_roles_group.rb +233 -0
  432. data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +1 -1
  433. data/lib/talon_one/models/rollback_discount_effect_props.rb +1 -1
  434. data/lib/talon_one/models/saml_connection_internal.rb +265 -0
  435. data/lib/talon_one/models/saml_login_endpoint.rb +17 -2
  436. data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +1 -1
  437. data/lib/talon_one/models/set_discount_per_item_effect_props.rb +25 -5
  438. data/lib/talon_one/models/sso_config.rb +212 -0
  439. data/lib/talon_one/models/store.rb +381 -0
  440. data/lib/talon_one/models/talang_attribute.rb +2 -2
  441. data/lib/talon_one/models/template_arg_def.rb +0 -5
  442. data/lib/talon_one/models/tier.rb +58 -4
  443. data/lib/talon_one/models/tier_downgrade_notification_policy.rb +243 -0
  444. data/lib/talon_one/models/tier_upgrade_notification_policy.rb +243 -0
  445. data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +259 -0
  446. data/lib/talon_one/models/tier_will_downgrade_notification_trigger.rb +261 -0
  447. data/lib/talon_one/models/time_point.rb +345 -0
  448. data/lib/talon_one/models/track_event_v2_response.rb +307 -0
  449. data/lib/talon_one/models/two_fa_config.rb +222 -0
  450. data/lib/talon_one/models/update_achievement.rb +291 -0
  451. data/lib/talon_one/models/update_application.rb +15 -53
  452. data/lib/talon_one/models/update_application_api_key.rb +212 -0
  453. data/lib/talon_one/models/update_campaign.rb +52 -6
  454. data/lib/talon_one/models/update_campaign_evaluation_group.rb +348 -0
  455. data/lib/talon_one/models/update_campaign_group.rb +4 -4
  456. data/lib/talon_one/models/update_campaign_template.rb +28 -4
  457. data/lib/talon_one/models/update_coupon.rb +15 -5
  458. data/lib/talon_one/models/update_coupon_batch.rb +2 -2
  459. data/lib/talon_one/models/update_loyalty_program.rb +99 -1
  460. data/lib/talon_one/models/update_picklist.rb +1 -1
  461. data/lib/talon_one/models/update_store.rb +265 -0
  462. data/lib/talon_one/models/update_user.rb +25 -14
  463. data/lib/talon_one/models/user.rb +73 -42
  464. data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +449 -0
  465. data/lib/talon_one/version.rb +1 -1
  466. data/lib/talon_one.rb +86 -16
  467. data/spec/api/integration_api_spec.rb +74 -47
  468. data/spec/api/management_api_spec.rb +669 -299
  469. data/spec/models/account_analytics_spec.rb +6 -0
  470. data/spec/models/account_dashboard_statistic_campaigns_spec.rb +6 -0
  471. data/spec/models/account_dashboard_statistic_spec.rb +0 -6
  472. data/spec/models/achievement_additional_properties_spec.rb +59 -0
  473. data/spec/models/achievement_progress_spec.rb +99 -0
  474. data/spec/models/achievement_spec.rb +107 -0
  475. data/spec/models/add_item_catalog_action_spec.rb +6 -0
  476. data/spec/models/add_to_audience_effect_props_spec.rb +59 -0
  477. data/spec/models/additional_campaign_properties_spec.rb +171 -0
  478. data/spec/models/application_analytics_data_point_avg_items_per_session_spec.rb +47 -0
  479. data/spec/models/application_analytics_data_point_avg_session_value_spec.rb +47 -0
  480. data/spec/models/application_analytics_data_point_sessions_count_spec.rb +47 -0
  481. data/spec/models/application_analytics_data_point_spec.rb +83 -0
  482. data/spec/models/application_analytics_data_point_total_revenue_spec.rb +47 -0
  483. data/spec/models/application_api_key_spec.rb +17 -1
  484. data/spec/models/application_campaign_analytics_avg_items_per_session_spec.rb +53 -0
  485. data/spec/models/application_campaign_analytics_avg_session_value_spec.rb +53 -0
  486. data/spec/models/application_campaign_analytics_coupons_count_spec.rb +47 -0
  487. data/spec/models/application_campaign_analytics_sessions_count_spec.rb +53 -0
  488. data/spec/models/application_campaign_analytics_spec.rb +129 -0
  489. data/spec/models/application_campaign_analytics_total_discounts_spec.rb +47 -0
  490. data/spec/models/application_campaign_analytics_total_revenue_spec.rb +53 -0
  491. data/spec/models/application_event_spec.rb +12 -0
  492. data/spec/models/application_session_spec.rb +9 -3
  493. data/spec/models/application_spec.rb +6 -20
  494. data/spec/models/application_store_entity_spec.rb +41 -0
  495. data/spec/models/attribute_spec.rb +1 -1
  496. data/spec/models/base_campaign_spec.rb +137 -0
  497. data/spec/models/base_loyalty_program_spec.rb +36 -0
  498. data/spec/models/base_notification_entity_spec.rb +6 -0
  499. data/spec/models/base_notification_spec.rb +16 -0
  500. data/spec/models/base_notification_webhook_spec.rb +6 -0
  501. data/spec/models/bulk_operation_on_campaigns_spec.rb +51 -0
  502. data/spec/models/campaign_budget_spec.rb +53 -0
  503. data/spec/models/campaign_copy_spec.rb +6 -0
  504. data/spec/models/campaign_created_notification_spec.rb +1 -1
  505. data/spec/models/campaign_evaluation_group_spec.rb +91 -0
  506. data/spec/models/campaign_evaluation_position_spec.rb +53 -0
  507. data/spec/models/campaign_evaluation_tree_changed_notification_spec.rb +53 -0
  508. data/spec/models/campaign_notification_policy_spec.rb +41 -0
  509. data/spec/models/campaign_set_branch_node_spec.rb +38 -0
  510. data/spec/models/campaign_set_spec.rb +2 -8
  511. data/spec/models/campaign_spec.rb +33 -1
  512. data/spec/models/campaign_template_spec.rb +11 -1
  513. data/spec/models/card_expiring_points_notification_policy_spec.rb +53 -0
  514. data/spec/models/card_expiring_points_notification_trigger_spec.rb +51 -0
  515. data/spec/models/card_ledger_points_entry_integration_api_spec.rb +95 -0
  516. data/spec/models/cart_item_spec.rb +6 -0
  517. data/spec/models/catalog_item_spec.rb +6 -0
  518. data/spec/models/change_loyalty_tier_level_effect_props_spec.rb +71 -0
  519. data/spec/models/coupon_spec.rb +6 -0
  520. data/spec/models/coupons_notification_policy_spec.rb +6 -0
  521. data/spec/models/create_achievement_spec.rb +71 -0
  522. data/spec/models/create_application_api_key_spec.rb +17 -1
  523. data/spec/models/create_template_campaign_spec.rb +12 -0
  524. data/spec/models/customer_inventory_spec.rb +6 -0
  525. data/spec/models/customer_profile_integration_response_v2_spec.rb +89 -0
  526. data/spec/models/customer_session_v2_spec.rb +6 -0
  527. data/spec/models/deactivate_user_request_spec.rb +41 -0
  528. data/spec/models/delete_user_request_spec.rb +41 -0
  529. data/spec/models/effect_entity_spec.rb +6 -0
  530. data/spec/models/effect_spec.rb +6 -0
  531. data/spec/models/environment_spec.rb +6 -0
  532. data/spec/models/event_spec.rb +6 -0
  533. data/spec/models/event_v2_spec.rb +6 -0
  534. data/spec/models/expiring_coupons_notification_policy_spec.rb +53 -0
  535. data/spec/models/expiring_coupons_notification_trigger_spec.rb +51 -0
  536. data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
  537. data/spec/models/get_integration_coupon_request_spec.rb +47 -0
  538. data/spec/models/identifiable_entity_spec.rb +41 -0
  539. data/spec/models/increase_achievement_progress_effect_props_spec.rb +77 -0
  540. data/spec/models/inline_response20013_spec.rb +1 -1
  541. data/spec/models/inline_response20015_spec.rb +0 -6
  542. data/spec/models/inline_response20019_spec.rb +1 -1
  543. data/spec/models/inline_response20021_spec.rb +0 -6
  544. data/spec/models/inline_response20022_spec.rb +2 -2
  545. data/spec/models/inline_response20024_spec.rb +6 -0
  546. data/spec/models/inline_response20028_spec.rb +1 -1
  547. data/spec/models/inline_response20029_spec.rb +0 -6
  548. data/spec/models/inline_response20031_spec.rb +1 -1
  549. data/spec/models/inline_response20032_spec.rb +1 -1
  550. data/spec/models/inline_response20033_spec.rb +6 -0
  551. data/spec/models/inline_response20035_spec.rb +6 -0
  552. data/spec/models/inline_response20038_spec.rb +0 -6
  553. data/spec/models/inline_response2003_spec.rb +1 -1
  554. data/spec/models/inline_response20041_spec.rb +47 -0
  555. data/spec/models/inline_response20042_spec.rb +53 -0
  556. data/spec/models/inline_response20043_spec.rb +47 -0
  557. data/spec/models/inline_response20044_spec.rb +47 -0
  558. data/spec/models/inline_response20045_spec.rb +53 -0
  559. data/spec/models/inline_response20046_spec.rb +47 -0
  560. data/spec/models/inline_response20047_spec.rb +47 -0
  561. data/spec/models/inline_response2004_spec.rb +1 -1
  562. data/spec/models/inline_response2008_spec.rb +1 -1
  563. data/spec/models/integration_coupon_spec.rb +6 -0
  564. data/spec/models/integration_event_spec.rb +6 -0
  565. data/spec/models/integration_event_v2_request_spec.rb +6 -0
  566. data/spec/models/integration_store_entity_spec.rb +41 -0
  567. data/spec/models/inventory_coupon_spec.rb +6 -0
  568. data/spec/models/ledger_points_entry_integration_api_spec.rb +89 -0
  569. data/spec/models/loyalty_program_ledgers_spec.rb +6 -0
  570. data/spec/models/loyalty_program_spec.rb +54 -0
  571. data/spec/models/loyalty_program_subledgers_spec.rb +47 -0
  572. data/spec/models/loyalty_program_transaction_spec.rb +6 -0
  573. data/spec/models/message_log_entries_spec.rb +47 -0
  574. data/spec/models/message_log_entry_spec.rb +111 -0
  575. data/spec/models/message_log_request_spec.rb +47 -0
  576. data/spec/models/message_log_response_spec.rb +53 -0
  577. data/spec/models/new_application_api_key_spec.rb +17 -1
  578. data/spec/models/new_application_spec.rb +0 -20
  579. data/spec/models/new_attribute_spec.rb +1 -1
  580. data/spec/models/new_base_notification_spec.rb +6 -0
  581. data/spec/models/new_campaign_evaluation_group_spec.rb +79 -0
  582. data/spec/models/new_campaign_spec.rb +23 -1
  583. data/spec/models/new_campaign_template_spec.rb +11 -1
  584. data/spec/models/new_coupons_spec.rb +6 -0
  585. data/spec/models/new_customer_session_v2_spec.rb +6 -0
  586. data/spec/models/new_event_spec.rb +6 -0
  587. data/spec/models/new_invitation_spec.rb +7 -1
  588. data/spec/models/new_loyalty_program_spec.rb +36 -0
  589. data/spec/models/new_notification_test_spec.rb +79 -0
  590. data/spec/models/new_notification_webhook_spec.rb +6 -0
  591. data/spec/models/new_role_v2_spec.rb +59 -0
  592. data/spec/models/new_store_spec.rb +59 -0
  593. data/spec/models/notification_activation_spec.rb +41 -0
  594. data/spec/models/notification_list_item_spec.rb +59 -0
  595. data/spec/models/notification_test_spec.rb +47 -0
  596. data/spec/models/one_time_code_spec.rb +59 -0
  597. data/spec/models/outgoing_integration_clever_tap_policy_spec.rb +53 -0
  598. data/spec/models/outgoing_integration_iterable_policy_spec.rb +47 -0
  599. data/spec/models/outgoing_integration_mo_engage_policy_spec.rb +59 -0
  600. data/spec/models/outgoing_integration_template_spec.rb +87 -0
  601. data/spec/models/outgoing_integration_template_with_configuration_details_spec.rb +93 -0
  602. data/spec/models/outgoing_integration_templates_spec.rb +41 -0
  603. data/spec/models/patch_item_catalog_action_spec.rb +6 -0
  604. data/spec/models/pending_points_notification_policy_spec.rb +47 -0
  605. data/spec/models/product_spec.rb +41 -0
  606. data/spec/models/remove_from_audience_effect_props_spec.rb +59 -0
  607. data/spec/models/role_v2_application_details_spec.rb +6 -0
  608. data/spec/models/role_v2_base_spec.rb +59 -0
  609. data/spec/models/role_v2_permission_set_spec.rb +1 -1
  610. data/spec/models/role_v2_roles_group_spec.rb +53 -0
  611. data/spec/models/role_v2_spec.rb +21 -3
  612. data/spec/models/saml_connection_internal_spec.rb +47 -0
  613. data/spec/models/saml_login_endpoint_spec.rb +6 -0
  614. data/spec/models/set_discount_per_item_effect_props_spec.rb +12 -0
  615. data/spec/models/sso_config_spec.rb +41 -0
  616. data/spec/models/store_spec.rb +89 -0
  617. data/spec/models/talang_attribute_spec.rb +1 -1
  618. data/spec/models/tier_downgrade_notification_policy_spec.rb +47 -0
  619. data/spec/models/tier_spec.rb +16 -0
  620. data/spec/models/tier_upgrade_notification_policy_spec.rb +47 -0
  621. data/spec/models/tier_will_downgrade_notification_policy_spec.rb +53 -0
  622. data/spec/models/tier_will_downgrade_notification_trigger_spec.rb +51 -0
  623. data/spec/models/time_point_spec.rb +71 -0
  624. data/spec/models/track_event_v2_response_spec.rb +89 -0
  625. data/spec/models/two_fa_config_spec.rb +47 -0
  626. data/spec/models/update_achievement_spec.rb +71 -0
  627. data/spec/models/update_application_api_key_spec.rb +41 -0
  628. data/spec/models/update_application_spec.rb +6 -20
  629. data/spec/models/update_campaign_evaluation_group_spec.rb +79 -0
  630. data/spec/models/update_campaign_spec.rb +23 -1
  631. data/spec/models/update_campaign_template_spec.rb +11 -1
  632. data/spec/models/update_coupon_spec.rb +6 -0
  633. data/spec/models/update_loyalty_program_spec.rb +36 -0
  634. data/spec/models/update_store_spec.rb +53 -0
  635. data/spec/models/update_user_spec.rb +12 -6
  636. data/spec/models/user_spec.rb +23 -5
  637. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +123 -0
  638. metadata +713 -369
@@ -67,7 +67,7 @@ describe 'ManagementApi' do
67
67
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
68
68
  # @param body body
69
69
  # @param [Hash] opts the optional parameters
70
- # @return [InlineResponse2004]
70
+ # @return [InlineResponse2006]
71
71
  describe 'copy_campaign_to_applications test' do
72
72
  it 'should work' do
73
73
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -76,7 +76,7 @@ describe 'ManagementApi' do
76
76
 
77
77
  # unit tests for create_account_collection
78
78
  # Create account-level collection
79
- # Create account-level collection.
79
+ # Create an account-level collection.
80
80
  # @param body body
81
81
  # @param [Hash] opts the optional parameters
82
82
  # @return [Collection]
@@ -86,6 +86,20 @@ describe 'ManagementApi' do
86
86
  end
87
87
  end
88
88
 
89
+ # unit tests for create_achievement
90
+ # Create achievement
91
+ # Create a new achievement in a specific campaign.
92
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
93
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
94
+ # @param body body
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [Achievement]
97
+ describe 'create_achievement test' do
98
+ it 'should work' do
99
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
100
+ end
101
+ end
102
+
89
103
  # unit tests for create_additional_cost
90
104
  # Create additional cost
91
105
  # 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.
@@ -124,8 +138,8 @@ describe 'ManagementApi' do
124
138
  end
125
139
 
126
140
  # unit tests for create_collection
127
- # Create collection
128
- # Create a collection.
141
+ # Create campaign-level collection
142
+ # Create a campaign-level collection in a given campaign.
129
143
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
130
144
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
131
145
  # @param body body
@@ -145,7 +159,7 @@ describe 'ManagementApi' do
145
159
  # @param body body
146
160
  # @param [Hash] opts the optional parameters
147
161
  # @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 [InlineResponse2007]
162
+ # @return [InlineResponse2008]
149
163
  describe 'create_coupons test' do
150
164
  it 'should work' do
151
165
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -174,21 +188,32 @@ describe 'ManagementApi' do
174
188
  # @param body body
175
189
  # @param [Hash] opts the optional parameters
176
190
  # @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 [InlineResponse2007]
191
+ # @return [InlineResponse2008]
178
192
  describe 'create_coupons_for_multiple_recipients test' do
179
193
  it 'should work' do
180
194
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
181
195
  end
182
196
  end
183
197
 
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.
198
+ # unit tests for create_invite_email
199
+ # Resend invitation email
200
+ # Resend an email invitation to an existing user. **Note:** The invitation token is valid for 24 hours after the email has been sent.
201
+ # @param body body
202
+ # @param [Hash] opts the optional parameters
203
+ # @return [NewInviteEmail]
204
+ describe 'create_invite_email test' do
205
+ it 'should work' do
206
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
207
+ end
208
+ end
209
+
210
+ # unit tests for create_invite_v2
211
+ # Invite user
212
+ # Create a new user in the account and send an invitation to their email address. **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
188
213
  # @param body body
189
214
  # @param [Hash] opts the optional parameters
190
- # @return [NotificationWebhook]
191
- describe 'create_notification_webhook test' do
215
+ # @return [User]
216
+ describe 'create_invite_v2 test' do
192
217
  it 'should work' do
193
218
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
194
219
  end
@@ -218,6 +243,31 @@ describe 'ManagementApi' do
218
243
  end
219
244
  end
220
245
 
246
+ # unit tests for create_store
247
+ # Create store
248
+ # Create a new store in a specific Application.
249
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
250
+ # @param body body
251
+ # @param [Hash] opts the optional parameters
252
+ # @return [Store]
253
+ describe 'create_store test' do
254
+ it 'should work' do
255
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
256
+ end
257
+ end
258
+
259
+ # unit tests for deactivate_user_by_email
260
+ # Deactivate user by email address
261
+ # Deactivate a specific user by their email address.
262
+ # @param body body
263
+ # @param [Hash] opts the optional parameters
264
+ # @return [nil]
265
+ describe 'deactivate_user_by_email test' do
266
+ it 'should work' do
267
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
268
+ end
269
+ end
270
+
221
271
  # unit tests for deduct_loyalty_card_points
222
272
  # Deduct points from card
223
273
  # Deduct points from the given loyalty card in the specified card-based loyalty program.
@@ -234,8 +284,8 @@ describe 'ManagementApi' do
234
284
 
235
285
  # unit tests for delete_account_collection
236
286
  # 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.
287
+ # Delete a given account-level collection.
288
+ # @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
239
289
  # @param [Hash] opts the optional parameters
240
290
  # @return [nil]
241
291
  describe 'delete_account_collection test' do
@@ -244,6 +294,20 @@ describe 'ManagementApi' do
244
294
  end
245
295
  end
246
296
 
297
+ # unit tests for delete_achievement
298
+ # Delete achievement
299
+ # Delete the specified achievement.
300
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
301
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
302
+ # @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
303
+ # @param [Hash] opts the optional parameters
304
+ # @return [nil]
305
+ describe 'delete_achievement test' do
306
+ it 'should work' do
307
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
308
+ end
309
+ end
310
+
247
311
  # unit tests for delete_campaign
248
312
  # Delete campaign
249
313
  # Delete the given campaign.
@@ -258,11 +322,11 @@ describe 'ManagementApi' do
258
322
  end
259
323
 
260
324
  # unit tests for delete_collection
261
- # Delete collection
262
- # Delete the given collection.
325
+ # Delete campaign-level collection
326
+ # Delete a given campaign-level collection.
263
327
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
264
328
  # @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.
329
+ # @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
266
330
  # @param [Hash] opts the optional parameters
267
331
  # @return [nil]
268
332
  describe 'delete_collection test' do
@@ -292,12 +356,12 @@ describe 'ManagementApi' do
292
356
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
293
357
  # @param [Hash] opts the optional parameters
294
358
  # @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.
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.
296
- # @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.
297
- # @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.
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.
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.
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.
359
+ # @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 time zone setting. Talon.One will convert to UTC internally.
360
+ # @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 time zone setting. Talon.One will convert to UTC internally.
361
+ # @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 time zone setting. Talon.One will convert to UTC internally.
362
+ # @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 time zone setting. Talon.One will convert to UTC internally.
363
+ # @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 time zone setting. Talon.One will convert to UTC internally.
364
+ # @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 time zone setting. Talon.One will convert to UTC internally.
301
365
  # @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.
302
366
  # @option opts [String] :batch_id Filter results by batches of coupons
303
367
  # @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
@@ -324,28 +388,52 @@ describe 'ManagementApi' do
324
388
  end
325
389
  end
326
390
 
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).
391
+ # unit tests for delete_referral
392
+ # Delete referral
393
+ # Delete the specified referral.
330
394
  # @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.
395
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
396
+ # @param referral_id The ID of the referral code.
332
397
  # @param [Hash] opts the optional parameters
333
398
  # @return [nil]
334
- describe 'delete_notification_webhook test' do
399
+ describe 'delete_referral test' do
335
400
  it 'should work' do
336
401
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
337
402
  end
338
403
  end
339
404
 
340
- # unit tests for delete_referral
341
- # Delete referral
342
- # Delete the specified referral.
405
+ # unit tests for delete_store
406
+ # Delete store
407
+ # Delete the specified store.
343
408
  # @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.
409
+ # @param store_id The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
346
410
  # @param [Hash] opts the optional parameters
347
411
  # @return [nil]
348
- describe 'delete_referral test' do
412
+ describe 'delete_store test' do
413
+ it 'should work' do
414
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
415
+ end
416
+ end
417
+
418
+ # unit tests for delete_user
419
+ # Delete user
420
+ # Delete a specific user.
421
+ # @param user_id The ID of the user.
422
+ # @param [Hash] opts the optional parameters
423
+ # @return [nil]
424
+ describe 'delete_user test' do
425
+ it 'should work' do
426
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
427
+ end
428
+ end
429
+
430
+ # unit tests for delete_user_by_email
431
+ # Delete user by email address
432
+ # Delete a specific user by their email address.
433
+ # @param body body
434
+ # @param [Hash] opts the optional parameters
435
+ # @return [nil]
436
+ describe 'delete_user_by_email test' do
349
437
  it 'should work' do
350
438
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
351
439
  end
@@ -364,8 +452,8 @@ describe 'ManagementApi' do
364
452
 
365
453
  # unit tests for export_account_collection_items
366
454
  # 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.
455
+ # Download a CSV file containing items from a given 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/).
456
+ # @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
369
457
  # @param [Hash] opts the optional parameters
370
458
  # @return [String]
371
459
  describe 'export_account_collection_items test' do
@@ -374,12 +462,38 @@ describe 'ManagementApi' do
374
462
  end
375
463
  end
376
464
 
465
+ # unit tests for export_achievements
466
+ # Export achievement customer data
467
+ # Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. The CSV file contains the following columns: - `profileIntegrationID`: The integration ID of the customer profile participating in the achievement. - `title`: The display name of the achievement in the Campaign Manager. - `target`: The required number of actions or the transactional milestone to complete the achievement. - `progress`: The current progress of the customer in the achievement. - `status`: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired']. - `startDate`: The date on which the customer profile started the achievement in RFC3339. - `endDate`: The date on which the achievement ends and resets for the customer profile in RFC3339. - `completionDate`: The date on which the customer profile completed the achievement in RFC3339.
468
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
469
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
470
+ # @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
471
+ # @param [Hash] opts the optional parameters
472
+ # @return [String]
473
+ describe 'export_achievements test' do
474
+ it 'should work' do
475
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
476
+ end
477
+ end
478
+
479
+ # unit tests for export_audiences_memberships
480
+ # Export audience members
481
+ # Download a CSV file containing the integration IDs of the members of an audience. **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 file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
482
+ # @param audience_id The ID of the audience.
483
+ # @param [Hash] opts the optional parameters
484
+ # @return [String]
485
+ describe 'export_audiences_memberships test' do
486
+ it 'should work' do
487
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
488
+ end
489
+ end
490
+
377
491
  # 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/).
492
+ # Export campaign-level collection's items
493
+ # Download a CSV file containing items from a given campaign-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/).
380
494
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
381
495
  # @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.
496
+ # @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
383
497
  # @param [Hash] opts the optional parameters
384
498
  # @return [String]
385
499
  describe 'export_collection_items test' do
@@ -390,22 +504,23 @@ describe 'ManagementApi' do
390
504
 
391
505
  # unit tests for export_coupons
392
506
  # 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.
507
+ # 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 can contain 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
508
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
395
509
  # @param [Hash] opts the optional parameters
396
510
  # @option opts [Float] :campaign_id Filter results by campaign.
397
511
  # @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.
398
512
  # @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.
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.
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.
513
+ # @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 time zone setting. Talon.One will convert to UTC internally.
514
+ # @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 time zone setting. Talon.One will convert to UTC internally.
401
515
  # @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.
402
516
  # @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`.
403
517
  # @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.
404
- # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
518
+ # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.
405
519
  # @option opts [String] :batch_id Filter results by batches of coupons
406
- # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
520
+ # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
407
521
  # @option opts [String] :date_format Determines the format of dates in the export document.
408
522
  # @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.
523
+ # @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data.
409
524
  # @return [String]
410
525
  describe 'export_coupons test' do
411
526
  it 'should work' do
@@ -415,7 +530,7 @@ describe 'ManagementApi' do
415
530
 
416
531
  # unit tests for export_customer_sessions
417
532
  # 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.
533
+ # 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-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `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. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
419
534
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
420
535
  # @param [Hash] opts the optional parameters
421
536
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
@@ -430,14 +545,28 @@ describe 'ManagementApi' do
430
545
  end
431
546
  end
432
547
 
548
+ # unit tests for export_customers_tiers
549
+ # Export customers' tier data
550
+ # Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported.
551
+ # @param loyalty_program_id The identifier for the loyalty program.
552
+ # @param [Hash] opts the optional parameters
553
+ # @option opts [Array<String>] :subledger_ids An array of subledgers IDs to filter the export by.
554
+ # @option opts [Array<String>] :tier_names An array of tier names to filter the export by.
555
+ # @return [String]
556
+ describe 'export_customers_tiers test' do
557
+ it 'should work' do
558
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
559
+ end
560
+ end
561
+
433
562
  # unit tests for export_effects
434
563
  # 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: - &#x60;applicationid&#x60;: The ID of the Application. - &#x60;campaignid&#x60;: The ID of the campaign. - &#x60;couponid&#x60;: The ID of the coupon, when applicable to the effect. - &#x60;created&#x60;: The timestamp of the effect. - &#x60;event_type&#x60;: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/events). - &#x60;eventid&#x60;: The internal ID of the effect. - &#x60;name&#x60;: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - &#x60;profileintegrationid&#x60;: The ID of the customer profile, when applicable. - &#x60;props&#x60;: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - &#x60;ruleindex&#x60;: The index of the rule. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;sessionid&#x60;: The internal ID of the session that triggered the effect. - &#x60;profileid&#x60;: The internal ID of the customer profile. - &#x60;sessionintegrationid&#x60;: The integration ID of the session. - &#x60;total_revenue&#x60;: The total revenue.
564
+ # 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: - &#x60;applicationid&#x60;: The ID of the Application. - &#x60;campaignid&#x60;: The ID of the campaign. - &#x60;couponid&#x60;: The ID of the coupon, when applicable to the effect. - &#x60;created&#x60;: The timestamp of the effect. - &#x60;event_type&#x60;: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - &#x60;eventid&#x60;: The internal ID of the effect. - &#x60;name&#x60;: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - &#x60;profileintegrationid&#x60;: The ID of the customer profile, when applicable. - &#x60;props&#x60;: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - &#x60;ruleindex&#x60;: The index of the rule. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;sessionid&#x60;: The internal ID of the session that triggered the effect. - &#x60;profileid&#x60;: The internal ID of the customer profile. - &#x60;sessionintegrationid&#x60;: The integration ID of the session. - &#x60;total_revenue&#x60;: The total revenue. - &#x60;store_integration_id&#x60;: The integration ID of the store. You choose this ID when you create a store.
436
565
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
437
566
  # @param [Hash] opts the optional parameters
438
567
  # @option opts [Float] :campaign_id Filter results by campaign.
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.
440
- # @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.
568
+ # @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 time zone setting. Talon.One will convert to UTC internally.
569
+ # @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 time zone setting. Talon.One will convert to UTC internally.
441
570
  # @option opts [String] :date_format Determines the format of dates in the export document.
442
571
  # @return [String]
443
572
  describe 'export_effects test' do
@@ -451,7 +580,7 @@ describe 'ManagementApi' do
451
580
  # ⚠️ 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
581
  # @param loyalty_program_id The identifier for the loyalty program.
453
582
  # @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.
583
+ # @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
455
584
  # @return [String]
456
585
  describe 'export_loyalty_balance test' do
457
586
  it 'should work' do
@@ -464,7 +593,7 @@ describe 'ManagementApi' do
464
593
  # 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: - &#x60;loyaltyProgramID&#x60;: The ID of the loyalty program. - &#x60;loyaltySubledger&#x60;: The name of the subdleger, when applicatble. - &#x60;profileIntegrationID&#x60;: The integration ID of the customer profile. - &#x60;currentBalance&#x60;: The current point balance. - &#x60;pendingBalance&#x60;: The number of pending points. - &#x60;expiredBalance&#x60;: The number of expired points. - &#x60;spentBalance&#x60;: The number of spent points. - &#x60;currentTier&#x60;: The tier that the customer is in at the time of the export.
465
594
  # @param loyalty_program_id The identifier for the loyalty program.
466
595
  # @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.
596
+ # @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
468
597
  # @return [String]
469
598
  describe 'export_loyalty_balances test' do
470
599
  it 'should work' do
@@ -477,7 +606,7 @@ describe 'ManagementApi' do
477
606
  # 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: - &#x60;loyaltyProgramID&#x60;: The ID of the loyalty program. - &#x60;loyaltySubledger&#x60;: The name of the subdleger, when applicatble. - &#x60;cardIdentifier&#x60;: The alphanumeric identifier of the loyalty card. - &#x60;cardState&#x60;:The state of the loyalty card. It can be &#x60;active&#x60; or &#x60;inactive&#x60;. - &#x60;currentBalance&#x60;: The current point balance. - &#x60;pendingBalance&#x60;: The number of pending points. - &#x60;expiredBalance&#x60;: The number of expired points. - &#x60;spentBalance&#x60;: The number of spent points.
478
607
  # @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
608
  # @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.
609
+ # @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
481
610
  # @return [String]
482
611
  describe 'export_loyalty_card_balances test' do
483
612
  it 'should work' do
@@ -490,8 +619,8 @@ describe 'ManagementApi' do
490
619
  # 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
620
  # @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
621
  # @param loyalty_card_id 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.
622
+ # @param range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
623
+ # @param range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
495
624
  # @param [Hash] opts the optional parameters
496
625
  # @option opts [String] :date_format Determines the format of dates in the export document.
497
626
  # @return [String]
@@ -503,9 +632,9 @@ describe 'ManagementApi' do
503
632
 
504
633
  # unit tests for export_loyalty_ledger
505
634
  # Export customer&#39;s transaction logs
506
- # Download a CSV file containing a customer&#39;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: - &#x60;customerprofileid&#x60;: The ID of the profile. - &#x60;customersessionid&#x60;: The ID of the customer session. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;rulename&#x60;: The name of the rule. - &#x60;programid&#x60;: The ID of the loyalty program. - &#x60;type&#x60;: The type of the loyalty program. - &#x60;name&#x60;: The name of the loyalty program. - &#x60;subledgerid&#x60;: The ID of the subledger, when applicable. - &#x60;startdate&#x60;: The start date of the program. - &#x60;expirydate&#x60;: The expiration date of the program. - &#x60;id&#x60;: The ID of the transaction. - &#x60;created&#x60;: The timestamp of the creation of the loyalty program. - &#x60;amount&#x60;: The number of points in that transaction. - &#x60;archived&#x60;: 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.
635
+ # Download a CSV file containing a customer&#39;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: - &#x60;customerprofileid&#x60;: The ID of the profile. - &#x60;customersessionid&#x60;: The ID of the customer session. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;rulename&#x60;: The name of the rule. - &#x60;programid&#x60;: The ID of the loyalty program. - &#x60;type&#x60;: The type of the loyalty program. - &#x60;name&#x60;: The name of the loyalty program. - &#x60;subledgerid&#x60;: The ID of the subledger, when applicable. - &#x60;startdate&#x60;: The start date of the program. - &#x60;expirydate&#x60;: The expiration date of the program. - &#x60;id&#x60;: The ID of the transaction. - &#x60;created&#x60;: The timestamp of the creation of the loyalty program. - &#x60;amount&#x60;: The number of points in that transaction. - &#x60;archived&#x60;: Whether the session related to the transaction is archived. - &#x60;campaignid&#x60;: The ID of the campaign.
636
+ # @param range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
637
+ # @param range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
509
638
  # @param loyalty_program_id The identifier for the loyalty program.
510
639
  # @param integration_id The identifier of the profile.
511
640
  # @param [Hash] opts the optional parameters
@@ -517,14 +646,28 @@ describe 'ManagementApi' do
517
646
  end
518
647
  end
519
648
 
649
+ # unit tests for export_pool_giveaways
650
+ # Export giveaway codes of a giveaway pool
651
+ # Download a CSV file containing the giveaway codes of a specific giveaway pool. **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: - &#x60;id&#x60;: The internal ID of the giveaway. - &#x60;poolid&#x60;: The internal ID of the giveaway pool. - &#x60;code&#x60;: The giveaway code. - &#x60;startdate&#x60;: The validity start date in RFC3339 of the giveaway (can be empty). - &#x60;enddate&#x60;: The validity end date in RFC3339 of the giveaway (can be empty). - &#x60;attributes&#x60;: Any custom attributes associated with the giveaway code (can be empty). - &#x60;used&#x60;: An indication of whether the giveaway is already awarded. - &#x60;importid&#x60;: The ID of the import which created the giveaway. - &#x60;created&#x60;: The creation time of the giveaway code. - &#x60;profileintegrationid&#x60;: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - &#x60;profileid&#x60;: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
652
+ # @param pool_id The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
653
+ # @param [Hash] opts the optional parameters
654
+ # @option opts [DateTime] :created_before Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.
655
+ # @option opts [DateTime] :created_after Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
656
+ # @return [String]
657
+ describe 'export_pool_giveaways test' do
658
+ it 'should work' do
659
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
660
+ end
661
+ end
662
+
520
663
  # unit tests for export_referrals
521
664
  # Export referrals
522
665
  # 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: - &#x60;code&#x60;: The referral code. - &#x60;advocateprofileintegrationid&#x60;: The profile ID of the advocate. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;limitval&#x60;: The maximum number of redemptions of this code. Defaults to &#x60;1&#x60; when left blank. - &#x60;attributes&#x60;: A json object describing _custom_ referral attribute names and their values.
523
666
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
524
667
  # @param [Hash] opts the optional parameters
525
668
  # @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.
669
+ # @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 time zone setting. Talon.One will convert to UTC internally.
670
+ # @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 time zone setting. Talon.One will convert to UTC internally.
528
671
  # @option opts [String] :valid - &#x60;expired&#x60;: Matches referrals in which the expiration date is set and in the past. - &#x60;validNow&#x60;: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - &#x60;validFuture&#x60;: Matches referrals in which start date is set and in the future.
529
672
  # @option opts [String] :usable - &#x60;true&#x60;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned. - &#x60;false&#x60;, only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60; will be returned.
530
673
  # @option opts [String] :batch_id Filter results by batches of referrals
@@ -540,16 +683,16 @@ describe 'ManagementApi' do
540
683
  # Get access logs for Application
541
684
  # Retrieve the list of API calls sent to the specified Application.
542
685
  # @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.
686
+ # @param range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
687
+ # @param range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
545
688
  # @param [Hash] opts the optional parameters
546
689
  # @option opts [String] :path Only return results where the request path matches the given regular expression.
547
690
  # @option opts [String] :method Only return results where the request method matches the given regular expression.
548
691
  # @option opts [String] :status Filter results by HTTP status codes.
549
- # @option opts [Integer] :page_size The number of items in this response.
550
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
692
+ # @option opts [Integer] :page_size The number of items in the response.
693
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
551
694
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
552
- # @return [InlineResponse20018]
695
+ # @return [InlineResponse20019]
553
696
  describe 'get_access_logs_without_total_count test' do
554
697
  it 'should work' do
555
698
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -583,7 +726,7 @@ describe 'ManagementApi' do
583
726
  # unit tests for get_account_collection
584
727
  # Get account-level collection
585
728
  # 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.
729
+ # @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
587
730
  # @param [Hash] opts the optional parameters
588
731
  # @return [Collection]
589
732
  describe 'get_account_collection test' do
@@ -592,6 +735,20 @@ describe 'ManagementApi' do
592
735
  end
593
736
  end
594
737
 
738
+ # unit tests for get_achievement
739
+ # Get achievement
740
+ # Get the details of a specific achievement.
741
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
742
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
743
+ # @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
744
+ # @param [Hash] opts the optional parameters
745
+ # @return [Achievement]
746
+ describe 'get_achievement test' do
747
+ it 'should work' do
748
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
749
+ end
750
+ end
751
+
595
752
  # unit tests for get_additional_cost
596
753
  # Get additional cost
597
754
  # Returns the additional cost.
@@ -608,10 +765,10 @@ describe 'ManagementApi' do
608
765
  # List additional costs
609
766
  # Returns all the defined additional costs for the account.
610
767
  # @param [Hash] opts the optional parameters
611
- # @option opts [Integer] :page_size The number of items in this response.
612
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
768
+ # @option opts [Integer] :page_size The number of items in the response.
769
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
613
770
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
614
- # @return [InlineResponse20032]
771
+ # @return [InlineResponse20036]
615
772
  describe 'get_additional_costs test' do
616
773
  it 'should work' do
617
774
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -621,16 +778,16 @@ describe 'ManagementApi' do
621
778
  # unit tests for get_all_access_logs
622
779
  # List access logs
623
780
  # Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
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.
626
781
  # @param [Hash] opts the optional parameters
782
+ # @option opts [DateTime] :range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
783
+ # @option opts [DateTime] :range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
627
784
  # @option opts [String] :path Only return results where the request path matches the given regular expression.
628
785
  # @option opts [String] :method Only return results where the request method matches the given regular expression.
629
786
  # @option opts [String] :status Filter results by HTTP status codes.
630
- # @option opts [Integer] :page_size The number of items in this response.
631
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
787
+ # @option opts [Integer] :page_size The number of items in the response.
788
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
632
789
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
633
- # @return [InlineResponse20019]
790
+ # @return [InlineResponse20020]
634
791
  describe 'get_all_access_logs test' do
635
792
  it 'should work' do
636
793
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -641,7 +798,7 @@ describe 'ManagementApi' do
641
798
  # List roles
642
799
  # List all roles.
643
800
  # @param [Hash] opts the optional parameters
644
- # @return [InlineResponse20040]
801
+ # @return [InlineResponse20044]
645
802
  describe 'get_all_roles test' do
646
803
  it 'should work' do
647
804
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -691,11 +848,11 @@ describe 'ManagementApi' do
691
848
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
692
849
  # @param integration_id The Integration ID of the Advocate&#39;s Profile.
693
850
  # @param [Hash] opts the optional parameters
694
- # @option opts [Integer] :page_size The number of items in this response.
695
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
851
+ # @option opts [Integer] :page_size The number of items in the response.
852
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
696
853
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
697
854
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
698
- # @return [InlineResponse20030]
855
+ # @return [InlineResponse20033]
699
856
  describe 'get_application_customer_friends test' do
700
857
  it 'should work' do
701
858
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -708,10 +865,10 @@ describe 'ManagementApi' do
708
865
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
709
866
  # @param [Hash] opts the optional parameters
710
867
  # @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.
868
+ # @option opts [Integer] :page_size The number of items in the response.
869
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
713
870
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
714
- # @return [InlineResponse20021]
871
+ # @return [InlineResponse20022]
715
872
  describe 'get_application_customers test' do
716
873
  it 'should work' do
717
874
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -724,10 +881,10 @@ describe 'ManagementApi' do
724
881
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
725
882
  # @param body body
726
883
  # @param [Hash] opts the optional parameters
727
- # @option opts [Integer] :page_size The number of items in this response.
728
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
884
+ # @option opts [Integer] :page_size The number of items in the response.
885
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
729
886
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
730
- # @return [InlineResponse20022]
887
+ # @return [InlineResponse20023]
731
888
  describe 'get_application_customers_by_attributes test' do
732
889
  it 'should work' do
733
890
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -736,13 +893,13 @@ describe 'ManagementApi' do
736
893
 
737
894
  # unit tests for get_application_event_types
738
895
  # List Applications event types
739
- # Get all of the distinct values of the Event &#x60;type&#x60; property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#operation/trackEvent)
896
+ # Get all of the distinct values of the Event &#x60;type&#x60; property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2)
740
897
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
741
898
  # @param [Hash] opts the optional parameters
742
- # @option opts [Integer] :page_size The number of items in this response.
743
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
899
+ # @option opts [Integer] :page_size The number of items in the response.
900
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
744
901
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
745
- # @return [InlineResponse20028]
902
+ # @return [InlineResponse20029]
746
903
  describe 'get_application_event_types test' do
747
904
  it 'should work' do
748
905
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -754,12 +911,12 @@ describe 'ManagementApi' do
754
911
  # 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
912
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
756
913
  # @param [Hash] opts the optional parameters
757
- # @option opts [Integer] :page_size The number of items in this response.
758
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
914
+ # @option opts [Integer] :page_size The number of items in the response.
915
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
759
916
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
760
917
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
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.
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.
918
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
919
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
763
920
  # @option opts [String] :session Session integration ID filter for events. Must be exact match.
764
921
  # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
765
922
  # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
@@ -768,7 +925,7 @@ describe 'ManagementApi' do
768
925
  # @option opts [String] :referral_code Referral code
769
926
  # @option opts [String] :rule_query Rule name filter for events
770
927
  # @option opts [String] :campaign_query Campaign name filter for events
771
- # @return [InlineResponse20027]
928
+ # @return [InlineResponse20028]
772
929
  describe 'get_application_events_without_total_count test' do
773
930
  it 'should work' do
774
931
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -793,17 +950,18 @@ describe 'ManagementApi' do
793
950
  # List all the sessions of the specified Application.
794
951
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
795
952
  # @param [Hash] opts the optional parameters
796
- # @option opts [Integer] :page_size The number of items in this response.
797
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
953
+ # @option opts [Integer] :page_size The number of items in the response.
954
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
798
955
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
799
956
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
800
957
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
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.
802
- # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
958
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
959
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
803
960
  # @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
804
961
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
805
962
  # @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
806
- # @return [InlineResponse20026]
963
+ # @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
964
+ # @return [InlineResponse20027]
807
965
  describe 'get_application_sessions test' do
808
966
  it 'should work' do
809
967
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -814,10 +972,10 @@ describe 'ManagementApi' do
814
972
  # List Applications
815
973
  # List all applications in the current account.
816
974
  # @param [Hash] opts the optional parameters
817
- # @option opts [Integer] :page_size The number of items in this response.
818
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
975
+ # @option opts [Integer] :page_size The number of items in the response.
976
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
819
977
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
820
- # @return [InlineResponse2003]
978
+ # @return [InlineResponse2005]
821
979
  describe 'get_applications test' do
822
980
  it 'should work' do
823
981
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -840,32 +998,61 @@ describe 'ManagementApi' do
840
998
  # List custom attributes
841
999
  # Return all the custom attributes for the account.
842
1000
  # @param [Hash] opts the optional parameters
843
- # @option opts [Integer] :page_size The number of items in this response.
844
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1001
+ # @option opts [Integer] :page_size The number of items in the response.
1002
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
845
1003
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
846
1004
  # @option opts [String] :entity Returned attributes will be filtered by supplied entity.
847
- # @return [InlineResponse20031]
1005
+ # @return [InlineResponse20034]
848
1006
  describe 'get_attributes test' do
849
1007
  it 'should work' do
850
1008
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
851
1009
  end
852
1010
  end
853
1011
 
1012
+ # unit tests for get_audience_memberships
1013
+ # List audience members
1014
+ # Get a paginated list of the customer profiles in a given audience. A maximum of 1000 customer profiles per page is allowed.
1015
+ # @param audience_id The ID of the audience.
1016
+ # @param [Hash] opts the optional parameters
1017
+ # @option opts [Integer] :page_size The number of items in the response.
1018
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1019
+ # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1020
+ # @option opts [String] :profile_query The filter to select a profile.
1021
+ # @return [InlineResponse20032]
1022
+ describe 'get_audience_memberships test' do
1023
+ it 'should work' do
1024
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1025
+ end
1026
+ end
1027
+
854
1028
  # unit tests for get_audiences
855
1029
  # List audiences
856
1030
  # Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).
857
1031
  # @param [Hash] opts the optional parameters
858
- # @option opts [Integer] :page_size The number of items in this response.
859
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1032
+ # @option opts [Integer] :page_size The number of items in the response.
1033
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
860
1034
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
861
1035
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
862
- # @return [InlineResponse20029]
1036
+ # @return [InlineResponse20030]
863
1037
  describe 'get_audiences test' do
864
1038
  it 'should work' do
865
1039
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
866
1040
  end
867
1041
  end
868
1042
 
1043
+ # unit tests for get_audiences_analytics
1044
+ # List audience analytics
1045
+ # Get a list of audience IDs and their member count.
1046
+ # @param audience_ids The IDs of one or more audiences, separated by commas, by which to filter results.
1047
+ # @param [Hash] opts the optional parameters
1048
+ # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1049
+ # @return [InlineResponse20031]
1050
+ describe 'get_audiences_analytics test' do
1051
+ it 'should work' do
1052
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1053
+ end
1054
+ end
1055
+
869
1056
  # unit tests for get_campaign
870
1057
  # Get campaign
871
1058
  # Retrieve the given campaign.
@@ -884,11 +1071,11 @@ describe 'ManagementApi' do
884
1071
  # Retrieve statistical data about the performance of the given campaign.
885
1072
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
886
1073
  # @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.
1074
+ # @param range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1075
+ # @param range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
889
1076
  # @param [Hash] opts the optional parameters
890
1077
  # @option opts [String] :granularity The time interval between the results in the returned time-series.
891
- # @return [InlineResponse20020]
1078
+ # @return [InlineResponse20021]
892
1079
  describe 'get_campaign_analytics test' do
893
1080
  it 'should work' do
894
1081
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -901,29 +1088,55 @@ describe 'ManagementApi' do
901
1088
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
902
1089
  # @param body body
903
1090
  # @param [Hash] opts the optional parameters
904
- # @option opts [Integer] :page_size The number of items in this response.
905
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1091
+ # @option opts [Integer] :page_size The number of items in the response.
1092
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
906
1093
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
907
1094
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
908
- # @return [InlineResponse2004]
1095
+ # @return [InlineResponse2006]
909
1096
  describe 'get_campaign_by_attributes test' do
910
1097
  it 'should work' do
911
1098
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
912
1099
  end
913
1100
  end
914
1101
 
1102
+ # unit tests for get_campaign_group
1103
+ # Get campaign access group
1104
+ # Get a campaign access group specified by its ID.
1105
+ # @param campaign_group_id The ID of the campaign access group.
1106
+ # @param [Hash] opts the optional parameters
1107
+ # @return [CampaignGroup]
1108
+ describe 'get_campaign_group test' do
1109
+ it 'should work' do
1110
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1111
+ end
1112
+ end
1113
+
1114
+ # unit tests for get_campaign_groups
1115
+ # List campaign access groups
1116
+ # List the campaign access groups in the current account.
1117
+ # @param [Hash] opts the optional parameters
1118
+ # @option opts [Integer] :page_size The number of items in the response.
1119
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1120
+ # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1121
+ # @return [InlineResponse20011]
1122
+ describe 'get_campaign_groups test' do
1123
+ it 'should work' do
1124
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1125
+ end
1126
+ end
1127
+
915
1128
  # unit tests for get_campaign_templates
916
1129
  # List campaign templates
917
1130
  # Retrieve a list of campaign templates.
918
1131
  # @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.
1132
+ # @option opts [Integer] :page_size The number of items in the response.
1133
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
921
1134
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
922
1135
  # @option opts [String] :state Filter results by the state of the campaign template.
923
1136
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
924
1137
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values.
925
1138
  # @option opts [Integer] :user_id Filter results by user ID.
926
- # @return [InlineResponse20010]
1139
+ # @return [InlineResponse20012]
927
1140
  describe 'get_campaign_templates test' do
928
1141
  it 'should work' do
929
1142
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -935,17 +1148,18 @@ describe 'ManagementApi' do
935
1148
  # List the campaigns of the specified application that match your filter criteria.
936
1149
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
937
1150
  # @param [Hash] opts the optional parameters
938
- # @option opts [Integer] :page_size The number of items in this response.
939
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1151
+ # @option opts [Integer] :page_size The number of items in the response.
1152
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
940
1153
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
941
1154
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
942
1155
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
943
1156
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values
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.
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.
946
- # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
1157
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1158
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1159
+ # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
947
1160
  # @option opts [Integer] :template_id The ID of the Campaign Template this Campaign was created from.
948
- # @return [InlineResponse2004]
1161
+ # @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
1162
+ # @return [InlineResponse2006]
949
1163
  describe 'get_campaigns test' do
950
1164
  it 'should work' do
951
1165
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -956,18 +1170,18 @@ describe 'ManagementApi' do
956
1170
  # Get audit logs for an account
957
1171
  # Retrieve the audit logs displayed in **Accounts &gt; Audit logs**.
958
1172
  # @param [Hash] opts the optional parameters
959
- # @option opts [Integer] :page_size The number of items in this response.
960
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1173
+ # @option opts [Integer] :page_size The number of items in the response.
1174
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
961
1175
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
962
1176
  # @option opts [Float] :application_id Filter results by Application ID.
963
1177
  # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
964
1178
  # @option opts [Integer] :user_id Filter results by user ID.
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.
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.
1179
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1180
+ # @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 time zone setting. Talon.One will convert to UTC internally.
967
1181
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
968
1182
  # @option opts [Integer] :management_key_id Filter results that match the given management key ID.
969
1183
  # @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.
970
- # @return [InlineResponse20038]
1184
+ # @return [InlineResponse20042]
971
1185
  describe 'get_changes test' do
972
1186
  it 'should work' do
973
1187
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -975,11 +1189,11 @@ describe 'ManagementApi' do
975
1189
  end
976
1190
 
977
1191
  # unit tests for get_collection
978
- # Get collection
979
- # Retrieve a given collection.
1192
+ # Get campaign-level collection
1193
+ # Retrieve a given campaign-level collection.
980
1194
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
981
1195
  # @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.
1196
+ # @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
983
1197
  # @param [Hash] opts the optional parameters
984
1198
  # @return [Collection]
985
1199
  describe 'get_collection test' do
@@ -990,12 +1204,12 @@ describe 'ManagementApi' do
990
1204
 
991
1205
  # unit tests for get_collection_items
992
1206
  # 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.
1207
+ # Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.
1208
+ # @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
995
1209
  # @param [Hash] opts the optional parameters
996
- # @option opts [Integer] :page_size The number of items in this response.
997
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
998
- # @return [InlineResponse20016]
1210
+ # @option opts [Integer] :page_size The number of items in the response.
1211
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1212
+ # @return [InlineResponse20018]
999
1213
  describe 'get_collection_items test' do
1000
1214
  it 'should work' do
1001
1215
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1008,19 +1222,19 @@ describe 'ManagementApi' do
1008
1222
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1009
1223
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1010
1224
  # @param [Hash] opts the optional parameters
1011
- # @option opts [Integer] :page_size The number of items in this response.
1012
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1225
+ # @option opts [Integer] :page_size The number of items in the response.
1226
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1013
1227
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1014
1228
  # @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.
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.
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.
1229
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1230
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1017
1231
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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.
1018
1232
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
1019
1233
  # @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.
1020
1234
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
1021
1235
  # @option opts [String] :batch_id Filter results by batches of coupons
1022
1236
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1023
- # @return [InlineResponse2008]
1237
+ # @return [InlineResponse2009]
1024
1238
  describe 'get_coupons_without_total_count test' do
1025
1239
  it 'should work' do
1026
1240
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1030,13 +1244,13 @@ describe 'ManagementApi' do
1030
1244
  # unit tests for get_customer_activity_report
1031
1245
  # Get customer&#39;s activity report
1032
1246
  # 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.
1247
+ # @param range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1248
+ # @param range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1035
1249
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1036
1250
  # @param customer_id The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
1037
1251
  # @param [Hash] opts the optional parameters
1038
- # @option opts [Integer] :page_size The number of items in this response.
1039
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1252
+ # @option opts [Integer] :page_size The number of items in the response.
1253
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1040
1254
  # @return [CustomerActivityReport]
1041
1255
  describe 'get_customer_activity_report test' do
1042
1256
  it 'should work' do
@@ -1047,18 +1261,18 @@ describe 'ManagementApi' do
1047
1261
  # unit tests for get_customer_activity_reports_without_total_count
1048
1262
  # Get Activity Reports for Application Customers
1049
1263
  # 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.
1264
+ # @param range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1265
+ # @param range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1052
1266
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1053
1267
  # @param [Hash] opts the optional parameters
1054
- # @option opts [Integer] :page_size The number of items in this response.
1055
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1268
+ # @option opts [Integer] :page_size The number of items in the response.
1269
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1056
1270
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1057
1271
  # @option opts [String] :name Only return reports matching the customer name
1058
1272
  # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
1059
1273
  # @option opts [String] :campaign_name Only return reports matching the campaignName
1060
1274
  # @option opts [String] :advocate_name Only return reports matching the current customer referrer name
1061
- # @return [InlineResponse20025]
1275
+ # @return [InlineResponse20026]
1062
1276
  describe 'get_customer_activity_reports_without_total_count test' do
1063
1277
  it 'should work' do
1064
1278
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1071,8 +1285,8 @@ describe 'ManagementApi' do
1071
1285
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1072
1286
  # @param customer_id The value of the &#x60;id&#x60; property of a customer profile. Get it with the [List Application&#39;s customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
1073
1287
  # @param [Hash] opts the optional parameters
1074
- # @option opts [Integer] :page_size The number of items in this response.
1075
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1288
+ # @option opts [Integer] :page_size The number of items in the response.
1289
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1076
1290
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1077
1291
  # @return [CustomerAnalytics]
1078
1292
  describe 'get_customer_analytics test' do
@@ -1093,14 +1307,31 @@ describe 'ManagementApi' do
1093
1307
  end
1094
1308
  end
1095
1309
 
1310
+ # unit tests for get_customer_profile_achievement_progress
1311
+ # List customer achievements
1312
+ # For the given customer profile, list all the achievements that match your filter criteria.
1313
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1314
+ # @param integration_id The identifier of the profile.
1315
+ # @param [Hash] opts the optional parameters
1316
+ # @option opts [Integer] :page_size The number of items in the response.
1317
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1318
+ # @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
1319
+ # @option opts [String] :title Filter results by the &#x60;title&#x60; of an achievement.
1320
+ # @return [InlineResponse20047]
1321
+ describe 'get_customer_profile_achievement_progress test' do
1322
+ it 'should work' do
1323
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1324
+ end
1325
+ end
1326
+
1096
1327
  # unit tests for get_customer_profiles
1097
1328
  # List customer profiles
1098
1329
  # List all customer profiles.
1099
1330
  # @param [Hash] opts the optional parameters
1100
- # @option opts [Integer] :page_size The number of items in this response.
1101
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1331
+ # @option opts [Integer] :page_size The number of items in the response.
1332
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1102
1333
  # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
1103
- # @return [InlineResponse20024]
1334
+ # @return [InlineResponse20025]
1104
1335
  describe 'get_customer_profiles test' do
1105
1336
  it 'should work' do
1106
1337
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1112,10 +1343,10 @@ describe 'ManagementApi' do
1112
1343
  # 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
1344
  # @param body body
1114
1345
  # @param [Hash] opts the optional parameters
1115
- # @option opts [Integer] :page_size The number of items in this response.
1116
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1346
+ # @option opts [Integer] :page_size The number of items in the response.
1347
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1117
1348
  # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
1118
- # @return [InlineResponse20023]
1349
+ # @return [InlineResponse20024]
1119
1350
  describe 'get_customers_by_attributes test' do
1120
1351
  it 'should work' do
1121
1352
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1128,10 +1359,10 @@ describe 'ManagementApi' do
1128
1359
  # @param [Hash] opts the optional parameters
1129
1360
  # @option opts [String] :name Filter results to event types with the given name. This parameter implies &#x60;includeOldVersions&#x60;.
1130
1361
  # @option opts [Boolean] :include_old_versions Include all versions of every event type.
1131
- # @option opts [Integer] :page_size The number of items in this response.
1132
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1362
+ # @option opts [Integer] :page_size The number of items in the response.
1363
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1133
1364
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1134
- # @return [InlineResponse20036]
1365
+ # @return [InlineResponse20040]
1135
1366
  describe 'get_event_types test' do
1136
1367
  it 'should work' do
1137
1368
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1142,12 +1373,12 @@ describe 'ManagementApi' do
1142
1373
  # Get exports
1143
1374
  # List all past exports
1144
1375
  # @param [Hash] opts the optional parameters
1145
- # @option opts [Integer] :page_size The number of items in this response.
1146
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1376
+ # @option opts [Integer] :page_size The number of items in the response.
1377
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1147
1378
  # @option opts [Float] :application_id Filter results by Application ID.
1148
1379
  # @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
1149
1380
  # @option opts [String] :entity The name of the entity type that was exported.
1150
- # @return [InlineResponse20039]
1381
+ # @return [InlineResponse20043]
1151
1382
  describe 'get_exports test' do
1152
1383
  it 'should work' do
1153
1384
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1169,16 +1400,16 @@ describe 'ManagementApi' do
1169
1400
 
1170
1401
  # unit tests for get_loyalty_card_transaction_logs
1171
1402
  # List card&#39;s transactions
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.
1403
+ # Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-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
1404
  # @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
1405
  # @param loyalty_card_id 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
1406
  # @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.
1407
+ # @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. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1408
+ # @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. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1409
+ # @option opts [Integer] :page_size The number of items in the response.
1410
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1180
1411
  # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
1181
- # @return [InlineResponse20014]
1412
+ # @return [InlineResponse20016]
1182
1413
  describe 'get_loyalty_card_transaction_logs test' do
1183
1414
  it 'should work' do
1184
1415
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1190,12 +1421,12 @@ describe 'ManagementApi' do
1190
1421
  # For the given card-based loyalty program, list the loyalty cards that match your filter criteria.
1191
1422
  # @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
1423
  # @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.
1424
+ # @option opts [Integer] :page_size The number of items in the response.
1425
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1195
1426
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1196
1427
  # @option opts [String] :identifier Optional query parameter to search cards by identifier.
1197
1428
  # @option opts [Integer] :profile_id Filter by the profile ID.
1198
- # @return [InlineResponse20013]
1429
+ # @return [InlineResponse20015]
1199
1430
  describe 'get_loyalty_cards test' do
1200
1431
  it 'should work' do
1201
1432
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1218,7 +1449,7 @@ describe 'ManagementApi' do
1218
1449
  # unit tests for get_loyalty_program
1219
1450
  # Get loyalty program
1220
1451
  # 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.
1452
+ # @param loyalty_program_id Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1222
1453
  # @param [Hash] opts the optional parameters
1223
1454
  # @return [LoyaltyProgram]
1224
1455
  describe 'get_loyalty_program test' do
@@ -1229,16 +1460,16 @@ describe 'ManagementApi' do
1229
1460
 
1230
1461
  # unit tests for get_loyalty_program_transactions
1231
1462
  # 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&#39;s [Get customer&#39;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.
1463
+ # Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. **Note:** 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&#39;s [Get customer&#39;s loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
1464
+ # @param loyalty_program_id Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1234
1465
  # @param [Hash] opts the optional parameters
1235
1466
  # @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file.
1236
1467
  # @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 [InlineResponse20012]
1468
+ # @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. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1469
+ # @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. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
1470
+ # @option opts [Integer] :page_size The number of items in the response.
1471
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1472
+ # @return [InlineResponse20014]
1242
1473
  describe 'get_loyalty_program_transactions test' do
1243
1474
  it 'should work' do
1244
1475
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1249,7 +1480,7 @@ describe 'ManagementApi' do
1249
1480
  # List loyalty programs
1250
1481
  # List the loyalty programs of the account.
1251
1482
  # @param [Hash] opts the optional parameters
1252
- # @return [InlineResponse20011]
1483
+ # @return [InlineResponse20013]
1253
1484
  describe 'get_loyalty_programs test' do
1254
1485
  it 'should work' do
1255
1486
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1259,56 +1490,31 @@ describe 'ManagementApi' do
1259
1490
  # unit tests for get_loyalty_statistics
1260
1491
  # Get loyalty program statistics
1261
1492
  # 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.
1493
+ # @param loyalty_program_id Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1263
1494
  # @param [Hash] opts the optional parameters
1264
- # @return [LoyaltyStatistics]
1495
+ # @return [LoyaltyDashboardData]
1265
1496
  describe 'get_loyalty_statistics test' do
1266
1497
  it 'should work' do
1267
1498
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1268
1499
  end
1269
1500
  end
1270
1501
 
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.
1276
- # @param [Hash] opts the optional parameters
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 [InlineResponse2005]
1290
- describe 'get_notification_webhooks test' do
1291
- it 'should work' do
1292
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1293
- end
1294
- end
1295
-
1296
1502
  # unit tests for get_referrals_without_total_count
1297
1503
  # List referrals
1298
1504
  # List all referrals of the specified campaign.
1299
1505
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1300
1506
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1301
1507
  # @param [Hash] opts the optional parameters
1302
- # @option opts [Integer] :page_size The number of items in this response.
1303
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1508
+ # @option opts [Integer] :page_size The number of items in the response.
1509
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1304
1510
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1305
1511
  # @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.
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.
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.
1512
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1513
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1308
1514
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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.
1309
1515
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
1310
1516
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field
1311
- # @return [InlineResponse2009]
1517
+ # @return [InlineResponse20010]
1312
1518
  describe 'get_referrals_without_total_count test' do
1313
1519
  it 'should work' do
1314
1520
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1317,8 +1523,8 @@ describe 'ManagementApi' do
1317
1523
 
1318
1524
  # unit tests for get_role
1319
1525
  # 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.
1526
+ # Get the details of a specific role. To see all the roles, use [List roles](#operation/getAllRoles).
1527
+ # @param role_id ID of role. **Note**: To find the ID of a role, use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint.
1322
1528
  # @param [Hash] opts the optional parameters
1323
1529
  # @return [Role]
1324
1530
  describe 'get_role test' do
@@ -1347,16 +1553,29 @@ describe 'ManagementApi' do
1347
1553
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1348
1554
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1349
1555
  # @param [Hash] opts the optional parameters
1350
- # @option opts [Integer] :page_size The number of items in this response.
1351
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1556
+ # @option opts [Integer] :page_size The number of items in the response.
1557
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1352
1558
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1353
- # @return [InlineResponse2006]
1559
+ # @return [InlineResponse2007]
1354
1560
  describe 'get_rulesets test' do
1355
1561
  it 'should work' do
1356
1562
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1357
1563
  end
1358
1564
  end
1359
1565
 
1566
+ # unit tests for get_store
1567
+ # Get store
1568
+ # Get store details for a specific store ID.
1569
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1570
+ # @param store_id The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
1571
+ # @param [Hash] opts the optional parameters
1572
+ # @return [Store]
1573
+ describe 'get_store test' do
1574
+ it 'should work' do
1575
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1576
+ end
1577
+ end
1578
+
1360
1579
  # unit tests for get_user
1361
1580
  # Get user
1362
1581
  # Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.
@@ -1373,10 +1592,10 @@ describe 'ManagementApi' do
1373
1592
  # List users in account
1374
1593
  # Retrieve all users in your account.
1375
1594
  # @param [Hash] opts the optional parameters
1376
- # @option opts [Integer] :page_size The number of items in this response.
1377
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1595
+ # @option opts [Integer] :page_size The number of items in the response.
1596
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1378
1597
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1379
- # @return [InlineResponse20037]
1598
+ # @return [InlineResponse20041]
1380
1599
  describe 'get_users test' do
1381
1600
  it 'should work' do
1382
1601
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1399,16 +1618,16 @@ describe 'ManagementApi' do
1399
1618
  # List webhook activation log entries
1400
1619
  # 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).
1401
1620
  # @param [Hash] opts the optional parameters
1402
- # @option opts [Integer] :page_size The number of items in this response.
1403
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1621
+ # @option opts [Integer] :page_size The number of items in the response.
1622
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1404
1623
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1405
1624
  # @option opts [String] :integration_request_uuid Filter results by integration request UUID.
1406
1625
  # @option opts [Float] :webhook_id Filter results by Webhook.
1407
1626
  # @option opts [Float] :application_id Filter results by Application ID.
1408
1627
  # @option opts [Float] :campaign_id Filter results by campaign.
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.
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 [InlineResponse20034]
1628
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
1629
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
1630
+ # @return [InlineResponse20038]
1412
1631
  describe 'get_webhook_activation_logs test' do
1413
1632
  it 'should work' do
1414
1633
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1419,17 +1638,17 @@ describe 'ManagementApi' do
1419
1638
  # List webhook log entries
1420
1639
  # Retrieve all webhook log entries.
1421
1640
  # @param [Hash] opts the optional parameters
1422
- # @option opts [Integer] :page_size The number of items in this response.
1423
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1641
+ # @option opts [Integer] :page_size The number of items in the response.
1642
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1424
1643
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1425
1644
  # @option opts [String] :status Filter results by HTTP status codes.
1426
1645
  # @option opts [Float] :webhook_id Filter results by Webhook.
1427
1646
  # @option opts [Float] :application_id Filter results by Application ID.
1428
1647
  # @option opts [Float] :campaign_id Filter results by campaign.
1429
1648
  # @option opts [String] :request_uuid Filter results by request UUID.
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.
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.
1432
- # @return [InlineResponse20035]
1649
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1650
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1651
+ # @return [InlineResponse20039]
1433
1652
  describe 'get_webhook_logs test' do
1434
1653
  it 'should work' do
1435
1654
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1440,11 +1659,15 @@ describe 'ManagementApi' do
1440
1659
  # List webhooks
1441
1660
  # List all webhooks.
1442
1661
  # @param [Hash] opts the optional parameters
1443
- # @option opts [String] :application_ids Filter by one or more application IDs separated by a comma.
1662
+ # @option opts [String] :application_ids Filter by one or more Application IDs, separated by a comma.
1444
1663
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1445
- # @option opts [Integer] :page_size The number of items in this response.
1446
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1447
- # @return [InlineResponse20033]
1664
+ # @option opts [Integer] :page_size The number of items in the response.
1665
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1666
+ # @option opts [String] :creation_type Filter results by creation type.
1667
+ # @option opts [String] :visibility Filter results by visibility.
1668
+ # @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
1669
+ # @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
1670
+ # @return [InlineResponse20037]
1448
1671
  describe 'get_webhooks test' do
1449
1672
  it 'should work' do
1450
1673
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1452,11 +1675,11 @@ describe 'ManagementApi' do
1452
1675
  end
1453
1676
 
1454
1677
  # unit tests for import_account_collection
1455
- # Import data in existing account-level collection
1678
+ # Import data into existing account-level collection
1456
1679
  # 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: - &#x60;item&#x60;: the values in your collection. A collection is limited to 500,000 items. Example: &#x60;&#x60;&#x60; item Addidas Nike Asics &#x60;&#x60;&#x60; **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.
1680
+ # @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
1458
1681
  # @param [Hash] opts the optional parameters
1459
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1682
+ # @option opts [String] :up_file The file containing the data that is being imported.
1460
1683
  # @return [Import]
1461
1684
  describe 'import_account_collection test' do
1462
1685
  it 'should work' do
@@ -1469,7 +1692,7 @@ describe 'ManagementApi' do
1469
1692
  # 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: - &#x60;item&#x60; (required): the values in your allowed list, for example a list of SKU&#39;s. An allowed list is limited to 500,000 items. Example: &#x60;&#x60;&#x60;text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 &#x60;&#x60;&#x60;
1470
1693
  # @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager&#39;s URL when you display the details of an attribute in **Account** &gt; **Tools** &gt; **Attributes**.
1471
1694
  # @param [Hash] opts the optional parameters
1472
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1695
+ # @option opts [String] :up_file The file containing the data that is being imported.
1473
1696
  # @return [Import]
1474
1697
  describe 'import_allowed_list test' do
1475
1698
  it 'should work' do
@@ -1477,14 +1700,27 @@ describe 'ManagementApi' do
1477
1700
  end
1478
1701
  end
1479
1702
 
1703
+ # unit tests for import_audiences_memberships
1704
+ # Import audience members
1705
+ # Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - &#x60;profileintegrationid&#x60;: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: &#x60;&#x60;&#x60;text profileintegrationid charles alexa &#x60;&#x60;&#x60;
1706
+ # @param audience_id The ID of the audience.
1707
+ # @param [Hash] opts the optional parameters
1708
+ # @option opts [String] :up_file The file containing the data that is being imported.
1709
+ # @return [Import]
1710
+ describe 'import_audiences_memberships test' do
1711
+ it 'should work' do
1712
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1713
+ end
1714
+ end
1715
+
1480
1716
  # unit tests for import_collection
1481
- # Import data in existing collection
1717
+ # Import data into existing campaign-level collection
1482
1718
  # 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: - &#x60;item&#x60;: the values in your collection. A collection is limited to 500,000 items. Example: &#x60;&#x60;&#x60; item Addidas Nike Asics &#x60;&#x60;&#x60; **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
1719
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1484
1720
  # @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.
1721
+ # @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
1486
1722
  # @param [Hash] opts the optional parameters
1487
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1723
+ # @option opts [String] :up_file The file containing the data that is being imported.
1488
1724
  # @return [Import]
1489
1725
  describe 'import_collection test' do
1490
1726
  it 'should work' do
@@ -1494,11 +1730,12 @@ describe 'ManagementApi' do
1494
1730
 
1495
1731
  # unit tests for import_coupons
1496
1732
  # 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: - &#x60;value&#x60; (required): The coupon code. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;recipientintegrationid&#x60;: 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). - &#x60;limitval&#x60;: The maximum number of redemptions of this code. For unlimited redemptions, use &#x60;0&#x60;. Defaults to &#x60;1&#x60; when not provided. - &#x60;discountlimit&#x60;: The total discount value that the code can give. This is typically used to represent a gift card value. - &#x60;attributes&#x60;: 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 &#x60;category&#x60; associated to the coupon entity, set it with &#x60;\&quot;{\&quot;\&quot;category\&quot;\&quot;: \&quot;\&quot;10_off\&quot;\&quot;}\&quot;&#x60;. 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:** &#x60;&#x60;&#x60;text \&quot;value\&quot;,\&quot;expirydate\&quot;,\&quot;startdate\&quot;,\&quot;recipientintegrationid\&quot;,\&quot;limitval\&quot;,\&quot;attributes\&quot;,\&quot;discountlimit\&quot; COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\&quot;{\&quot;\&quot;Category\&quot;\&quot;: \&quot;\&quot;10_off\&quot;\&quot;}\&quot;,2.4 &#x60;&#x60;&#x60; Once imported, you can find the &#x60;batchId&#x60; in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
1733
+ # 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: - &#x60;value&#x60; (required): The coupon code. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;recipientintegrationid&#x60;: 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). - &#x60;limitval&#x60;: The maximum number of redemptions of this code. For unlimited redemptions, use &#x60;0&#x60;. Defaults to &#x60;1&#x60; when not provided. - &#x60;discountlimit&#x60;: The total discount value that the code can give. This is typically used to represent a gift card value. - &#x60;attributes&#x60;: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;category&#x60; associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: &#x60;\&quot;{\&quot;category\&quot;: \&quot;10_off\&quot;}\&quot;&#x60;. 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:** &#x60;&#x60;&#x60;text \&quot;value\&quot;,\&quot;expirydate\&quot;,\&quot;startdate\&quot;,\&quot;recipientintegrationid\&quot;,\&quot;limitval\&quot;,\&quot;attributes\&quot;,\&quot;discountlimit\&quot; COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\&quot;{\&quot;\&quot;Category\&quot;\&quot;: \&quot;\&quot;10_off\&quot;\&quot;}\&quot;,2.4 &#x60;&#x60;&#x60; Once imported, you can find the &#x60;batchId&#x60; in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
1498
1734
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1499
1735
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1500
1736
  # @param [Hash] opts the optional parameters
1501
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1737
+ # @option opts [Boolean] :skip_duplicates An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when &#x60;skipDuplicates&#x3D;true&#x60;.
1738
+ # @option opts [String] :up_file The file containing the data that is being imported.
1502
1739
  # @return [Import]
1503
1740
  describe 'import_coupons test' do
1504
1741
  it 'should work' do
@@ -1511,7 +1748,7 @@ describe 'ManagementApi' do
1511
1748
  # 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: - &#x60;identifier&#x60; (required): The alphanumeric identifier of the loyalty card. - &#x60;state&#x60; (required): The state of the loyalty card. It can be &#x60;active&#x60; or &#x60;inactive&#x60;. - &#x60;customerprofileids&#x60; (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:** &#x60;&#x60;&#x60;csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA &#x60;&#x60;&#x60;
1512
1749
  # @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
1750
  # @param [Hash] opts the optional parameters
1514
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1751
+ # @option opts [String] :up_file The file containing the data that is being imported.
1515
1752
  # @return [Import]
1516
1753
  describe 'import_loyalty_cards test' do
1517
1754
  it 'should work' do
@@ -1519,12 +1756,25 @@ describe 'ManagementApi' do
1519
1756
  end
1520
1757
  end
1521
1758
 
1759
+ # unit tests for import_loyalty_customers_tiers
1760
+ # Import customers into loyalty tiers
1761
+ # Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - &#x60;subledgerid&#x60; (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - &#x60;customerprofileid&#x60;: The integration ID of the customer profile to whom the tier should be assigned. - &#x60;tiername&#x60;: The name of an existing tier to assign to the customer. - &#x60;expirydate&#x60;: The expiration date of the tier. It should be a future date. About customer assignment to a tier: - If the customer isn&#39;t already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that&#39;s specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer&#39;s tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. 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:** &#x60;&#x60;&#x60;csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z &#x60;&#x60;&#x60;
1762
+ # @param loyalty_program_id Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1763
+ # @param [Hash] opts the optional parameters
1764
+ # @option opts [String] :up_file The file containing the data that is being imported.
1765
+ # @return [Import]
1766
+ describe 'import_loyalty_customers_tiers test' do
1767
+ it 'should work' do
1768
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1769
+ end
1770
+ end
1771
+
1522
1772
  # unit tests for import_loyalty_points
1523
1773
  # 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: - &#x60;customerprofileid&#x60; (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - &#x60;identifier&#x60; (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - &#x60;amount&#x60;: The amount of points to award to the customer profile. - &#x60;startdate&#x60;: The earliest date when the points can be redeemed. On this date and until the expiration date, the points are &#x60;active&#x60;. - &#x60;expirydate&#x60;: The latest date when the points can be redeemed. After this date, the points are &#x60;expired&#x60;. - &#x60;subledgerid&#x60; (optional): The ID of the subledger that should received the points. - &#x60;reason&#x60; (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 &#x60;startdate&#x60;. If &#x60;startdate&#x60; matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for &#x60;startdate&#x60; is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** &#x60;&#x60;&#x60;text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60; **Example for card-based programs:** &#x60;&#x60;&#x60;text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60;
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.
1774
+ # 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 type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - &#x60;customerprofileid&#x60; (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - &#x60;identifier&#x60; (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - &#x60;amount&#x60;: The amount of points to award to the customer profile. - &#x60;startdate&#x60; (optional): The earliest date when the points can be redeemed. The points are &#x60;active&#x60; from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string &#x60;immediate&#x60;. Empty or missing values are considered &#x60;immediate&#x60;. - &#x60;expirydate&#x60; (optional): The latest date when the points can be redeemed. The points are &#x60;expired&#x60; after this date. **Note**: It must be an RFC3339 timestamp string or string &#x60;unlimited&#x60;. Empty or missing values are considered &#x60;unlimited&#x60;. - &#x60;subledgerid&#x60; (optional): The ID of the subledger that should received the points. - &#x60;reason&#x60; (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 &#x60;startdate&#x60;. If &#x60;startdate&#x60; matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for &#x60;startdate&#x60; is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** &#x60;&#x60;&#x60;text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60; **Example for card-based programs:** &#x60;&#x60;&#x60;text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60;
1775
+ # @param loyalty_program_id Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1526
1776
  # @param [Hash] opts the optional parameters
1527
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1777
+ # @option opts [String] :up_file The file containing the data that is being imported.
1528
1778
  # @return [Import]
1529
1779
  describe 'import_loyalty_points test' do
1530
1780
  it 'should work' do
@@ -1534,10 +1784,10 @@ describe 'ManagementApi' do
1534
1784
 
1535
1785
  # unit tests for import_pool_giveaways
1536
1786
  # 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: - &#x60;code&#x60; (required): the code of your giveaway, for instance, a gift card redemption code. - &#x60;startdate&#x60;: the start date in RFC3339 of the code redemption period. - &#x60;enddate&#x60;: the last date in RFC3339 of the code redemption period. - &#x60;attributes&#x60;: 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 &#x60;provider&#x60; associated to the giveaway entity, set it with &#x60;\&quot;{\&quot;\&quot;provider\&quot;\&quot;: \&quot;\&quot;myPartnerCompany\&quot;\&quot;}\&quot;&#x60;. The &#x60;startdate&#x60; and &#x60;enddate&#x60; 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:** &#x60;&#x60;&#x60;text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\&quot;{\&quot;\&quot;provider\&quot;\&quot;: \&quot;\&quot;Amazon\&quot;\&quot;}\&quot; GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\&quot;{\&quot;\&quot;provider\&quot;\&quot;: \&quot;\&quot;Amazon\&quot;\&quot;}\&quot; GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\&quot;{\&quot;\&quot;provider\&quot;\&quot;: \&quot;\&quot;Aliexpress\&quot;\&quot;}\&quot; &#x60;&#x60;&#x60;
1787
+ # 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: - &#x60;code&#x60; (required): The code of your giveaway, for instance, a gift card redemption code. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;enddate&#x60;: The last date in RFC3339 of the code redemption period. - &#x60;attributes&#x60;: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;provider&#x60; associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: &#x60;\&quot;{\&quot;provider\&quot;: \&quot;myPartnerCompany\&quot;}\&quot;&#x60;. The &#x60;startdate&#x60; and &#x60;enddate&#x60; 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 setting of your choice. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **Example:** &#x60;&#x60;&#x60;text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\&quot;{\&quot;\&quot;provider\&quot;\&quot;: \&quot;\&quot;Amazon\&quot;\&quot;}\&quot; GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\&quot;{\&quot;\&quot;provider\&quot;\&quot;: \&quot;\&quot;Amazon\&quot;\&quot;}\&quot; GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\&quot;{\&quot;\&quot;provider\&quot;\&quot;: \&quot;\&quot;Aliexpress\&quot;\&quot;}\&quot; &#x60;&#x60;&#x60;
1538
1788
  # @param pool_id The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
1539
1789
  # @param [Hash] opts the optional parameters
1540
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1790
+ # @option opts [String] :up_file The file containing the data that is being imported.
1541
1791
  # @return [Import]
1542
1792
  describe 'import_pool_giveaways test' do
1543
1793
  it 'should work' do
@@ -1547,11 +1797,11 @@ describe 'ManagementApi' do
1547
1797
 
1548
1798
  # unit tests for import_referrals
1549
1799
  # 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: - &#x60;code&#x60; (required): The referral code. - &#x60;advocateprofileintegrationid&#x60; (required): The profile ID of the advocate. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;limitval&#x60;: The maximum number of redemptions of this code. Defaults to &#x60;1&#x60; when left blank. - &#x60;attributes&#x60;: 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 &#x60;category&#x60; associated to the referral entity, set it with &#x60;\&quot;{\&quot;\&quot;category\&quot;\&quot;: \&quot;\&quot;10_off\&quot;\&quot;}\&quot;&#x60;. 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:** &#x60;&#x60;&#x60;text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\&quot;{\&quot;\&quot;my_attribute\&quot;\&quot;: \&quot;\&quot;10_off\&quot;\&quot;}\&quot; REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\&quot;{\&quot;\&quot;my_attribute\&quot;\&quot;: \&quot;\&quot;20_off\&quot;\&quot;}\&quot; &#x60;&#x60;&#x60;
1800
+ # 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: - &#x60;code&#x60; (required): The referral code. - &#x60;advocateprofileintegrationid&#x60; (required): The profile ID of the advocate. - &#x60;startdate&#x60;: The start date in RFC3339 of the code redemption period. - &#x60;expirydate&#x60;: The end date in RFC3339 of the code redemption period. - &#x60;limitval&#x60;: The maximum number of redemptions of this code. Defaults to &#x60;1&#x60; when left blank. - &#x60;attributes&#x60;: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called &#x60;category&#x60; associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: &#x60;\&quot;{\&quot;category\&quot;: \&quot;10_off\&quot;}\&quot;&#x60;. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each &#x60;advocateprofileintegrationid&#x60; column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **Note:** We recommend limiting your file size to 500MB. **Example:** &#x60;&#x60;&#x60;text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\&quot;{\&quot;\&quot;my_attribute\&quot;\&quot;: \&quot;\&quot;10_off\&quot;\&quot;}\&quot; REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\&quot;{\&quot;\&quot;my_attribute\&quot;\&quot;: \&quot;\&quot;20_off\&quot;\&quot;}\&quot; &#x60;&#x60;&#x60;
1551
1801
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1552
1802
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1553
1803
  # @param [Hash] opts the optional parameters
1554
- # @option opts [String] :up_file The file with the information about the data that should be imported.
1804
+ # @option opts [String] :up_file The file containing the data that is being imported.
1555
1805
  # @return [Import]
1556
1806
  describe 'import_referrals test' do
1557
1807
  it 'should work' do
@@ -1561,31 +1811,64 @@ describe 'ManagementApi' do
1561
1811
 
1562
1812
  # unit tests for list_account_collections
1563
1813
  # List collections in account
1564
- # List collections in account.
1814
+ # List account-level collections in the account.
1565
1815
  # @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.
1816
+ # @option opts [Integer] :page_size The number of items in the response.
1817
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1568
1818
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1569
1819
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
1570
- # @option opts [String] :name Filter by the name of the Collection.
1571
- # @return [InlineResponse20015]
1820
+ # @option opts [String] :name Filter by collection name.
1821
+ # @return [InlineResponse20017]
1572
1822
  describe 'list_account_collections test' do
1573
1823
  it 'should work' do
1574
1824
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1575
1825
  end
1576
1826
  end
1577
1827
 
1828
+ # unit tests for list_achievements
1829
+ # List achievements
1830
+ # List all the achievements for a specific campaign.
1831
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1832
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1833
+ # @param [Hash] opts the optional parameters
1834
+ # @option opts [Integer] :page_size The number of items in the response.
1835
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1836
+ # @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no &#x60;title&#x60; is provided, all the achievements from the campaign are returned.
1837
+ # @return [InlineResponse20046]
1838
+ describe 'list_achievements test' do
1839
+ it 'should work' do
1840
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1841
+ end
1842
+ end
1843
+
1844
+ # unit tests for list_catalog_items
1845
+ # List items in a catalog
1846
+ # Return a paginated list of cart items in the given catalog.
1847
+ # @param catalog_id The ID of the catalog. You can find the ID in the Campaign Manager in **Account** &gt; **Tools** &gt; **Cart item catalogs**.
1848
+ # @param [Hash] opts the optional parameters
1849
+ # @option opts [Integer] :page_size The number of items in the response.
1850
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1851
+ # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
1852
+ # @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
1853
+ # @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
1854
+ # @return [InlineResponse20035]
1855
+ describe 'list_catalog_items test' do
1856
+ it 'should work' do
1857
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1858
+ end
1859
+ end
1860
+
1578
1861
  # unit tests for list_collections
1579
- # List collections
1580
- # List collections in the campaign.
1862
+ # List collections in campaign
1863
+ # List collections in a given campaign.
1581
1864
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1582
1865
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1583
1866
  # @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.
1867
+ # @option opts [Integer] :page_size The number of items in the response.
1868
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1586
1869
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1587
1870
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
1588
- # @option opts [String] :name Filter by the name of the Collection.
1871
+ # @option opts [String] :name Filter by collection name.
1589
1872
  # @return [InlineResponse20017]
1590
1873
  describe 'list_collections test' do
1591
1874
  it 'should work' do
@@ -1594,15 +1877,15 @@ describe 'ManagementApi' do
1594
1877
  end
1595
1878
 
1596
1879
  # unit tests for list_collections_in_application
1597
- # List collections in application
1598
- # List collections from all campaigns in the Application.
1880
+ # List collections in Application
1881
+ # List campaign-level collections from all campaigns in a given Application.
1599
1882
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1600
1883
  # @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.
1884
+ # @option opts [Integer] :page_size The number of items in the response.
1885
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1603
1886
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1604
1887
  # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
1605
- # @option opts [String] :name Filter by the name of the Collection.
1888
+ # @option opts [String] :name Filter by collection name.
1606
1889
  # @return [InlineResponse20017]
1607
1890
  describe 'list_collections_in_application test' do
1608
1891
  it 'should work' do
@@ -1610,10 +1893,43 @@ describe 'ManagementApi' do
1610
1893
  end
1611
1894
  end
1612
1895
 
1896
+ # unit tests for list_stores
1897
+ # List stores
1898
+ # List all stores for a specific Application.
1899
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1900
+ # @param [Hash] opts the optional parameters
1901
+ # @option opts [Integer] :page_size The number of items in the response.
1902
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1903
+ # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1904
+ # @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 &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
1905
+ # @option opts [Float] :campaign_id Filter results by campaign.
1906
+ # @option opts [String] :name The name of the store.
1907
+ # @option opts [String] :integration_id The integration ID of the store.
1908
+ # @option opts [String] :query Filter results by &#x60;name&#x60; or &#x60;integrationId&#x60;.
1909
+ # @return [InlineResponse20045]
1910
+ describe 'list_stores test' do
1911
+ it 'should work' do
1912
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1913
+ end
1914
+ end
1915
+
1916
+ # unit tests for notification_activation
1917
+ # Activate or deactivate notification
1918
+ # Activate or deactivate the given notification. When &#x60;enabled&#x60; is false, updates will no longer be sent for the given notification.
1919
+ # @param notification_id The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
1920
+ # @param body body
1921
+ # @param [Hash] opts the optional parameters
1922
+ # @return [nil]
1923
+ describe 'notification_activation test' do
1924
+ it 'should work' do
1925
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1926
+ end
1927
+ end
1928
+
1613
1929
  # unit tests for post_added_deducted_points_notification
1614
1930
  # 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.
1931
+ # 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 loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
1932
+ # @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1617
1933
  # @param body body
1618
1934
  # @param [Hash] opts the optional parameters
1619
1935
  # @return [BaseNotification]
@@ -1636,9 +1952,22 @@ describe 'ManagementApi' do
1636
1952
  end
1637
1953
  end
1638
1954
 
1955
+ # unit tests for post_pending_points_notification
1956
+ # Create notification about pending loyalty points
1957
+ # Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
1958
+ # @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1959
+ # @param body body
1960
+ # @param [Hash] opts the optional parameters
1961
+ # @return [BaseNotification]
1962
+ describe 'post_pending_points_notification test' do
1963
+ it 'should work' do
1964
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1965
+ end
1966
+ end
1967
+
1639
1968
  # unit tests for remove_loyalty_points
1640
1969
  # Deduct points from customer profile
1641
- # Deduct points from the specified loyalty program and specified customer profile. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
1970
+ # Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
1642
1971
  # @param loyalty_program_id The identifier for the loyalty program.
1643
1972
  # @param integration_id The identifier of the profile.
1644
1973
  # @param body body
@@ -1664,16 +1993,16 @@ describe 'ManagementApi' do
1664
1993
 
1665
1994
  # unit tests for search_coupons_advanced_application_wide_without_total_count
1666
1995
  # 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.
1996
+ # List the coupons whose attributes match the query criteria in all the 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
1997
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1669
1998
  # @param body body
1670
1999
  # @param [Hash] opts the optional parameters
1671
- # @option opts [Integer] :page_size The number of items in this response.
1672
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2000
+ # @option opts [Integer] :page_size The number of items in the response.
2001
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1673
2002
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1674
2003
  # @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.
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.
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.
2004
+ # @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 time zone setting. Talon.One will convert to UTC internally.
2005
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1677
2006
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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.
1678
2007
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
1679
2008
  # @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.
@@ -1681,7 +2010,7 @@ describe 'ManagementApi' do
1681
2010
  # @option opts [String] :batch_id Filter results by batches of coupons
1682
2011
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1683
2012
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
1684
- # @return [InlineResponse2008]
2013
+ # @return [InlineResponse2009]
1685
2014
  describe 'search_coupons_advanced_application_wide_without_total_count test' do
1686
2015
  it 'should work' do
1687
2016
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1695,19 +2024,19 @@ describe 'ManagementApi' do
1695
2024
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1696
2025
  # @param body body
1697
2026
  # @param [Hash] opts the optional parameters
1698
- # @option opts [Integer] :page_size The number of items in this response.
1699
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2027
+ # @option opts [Integer] :page_size The number of items in the response.
2028
+ # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
1700
2029
  # @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 &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
1701
2030
  # @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.
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.
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.
2031
+ # @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 time zone setting. Talon.One will convert to UTC internally.
2032
+ # @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 time zone setting. Talon.One will convert to UTC internally.
1704
2033
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. 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.
1705
2034
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
1706
2035
  # @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.
1707
2036
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
1708
2037
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1709
2038
  # @option opts [String] :batch_id Filter results by batches of coupons
1710
- # @return [InlineResponse2008]
2039
+ # @return [InlineResponse2009]
1711
2040
  describe 'search_coupons_advanced_without_total_count test' do
1712
2041
  it 'should work' do
1713
2042
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -1730,8 +2059,8 @@ describe 'ManagementApi' do
1730
2059
 
1731
2060
  # unit tests for update_account_collection
1732
2061
  # 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.
2062
+ # Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.
2063
+ # @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
1735
2064
  # @param body body
1736
2065
  # @param [Hash] opts the optional parameters
1737
2066
  # @return [Collection]
@@ -1741,9 +2070,24 @@ describe 'ManagementApi' do
1741
2070
  end
1742
2071
  end
1743
2072
 
2073
+ # unit tests for update_achievement
2074
+ # Update achievement
2075
+ # Update the details of a specific achievement.
2076
+ # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
2077
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
2078
+ # @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
2079
+ # @param body body
2080
+ # @param [Hash] opts the optional parameters
2081
+ # @return [Achievement]
2082
+ describe 'update_achievement test' do
2083
+ it 'should work' do
2084
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
2085
+ end
2086
+ end
2087
+
1744
2088
  # unit tests for update_additional_cost
1745
2089
  # Update additional cost
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.
2090
+ # Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the &#x60;name&#x60; property (or **API name** in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations.
1747
2091
  # @param additional_cost_id The ID of the additional cost. You can find the ID the the Campaign Manager&#39;s URL when you display the details of the cost in **Account** &gt; **Tools** &gt; **Additional costs**.
1748
2092
  # @param body body
1749
2093
  # @param [Hash] opts the optional parameters
@@ -1782,11 +2126,11 @@ describe 'ManagementApi' do
1782
2126
  end
1783
2127
 
1784
2128
  # unit tests for update_collection
1785
- # Update collection description
1786
- # Edit the description of the collection.
2129
+ # Update campaign-level collection&#39;s description
2130
+ # Edit the description of a given campaign-level collection.
1787
2131
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1788
2132
  # @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.
2133
+ # @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
1790
2134
  # @param body body
1791
2135
  # @param [Hash] opts the optional parameters
1792
2136
  # @return [Collection]
@@ -1813,7 +2157,7 @@ describe 'ManagementApi' do
1813
2157
 
1814
2158
  # unit tests for update_coupon_batch
1815
2159
  # Update coupons
1816
- # Update all coupons, or a specific batch of coupons, in a campaign. You can find the &#x60;batchId&#x60; in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt; &lt;p class&#x3D;\&quot;title\&quot;&gt;Important&lt;/p&gt; &lt;ul&gt; &lt;li&gt;Only send sequential requests to this endpoint.&lt;/li&gt; &lt;li&gt;Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.&lt;/li&gt; &lt;/ul&gt; &lt;/div&gt; To update a specific coupon, use [Update coupon](#operation/updateCoupon).
2160
+ # Update all coupons, or a specific batch of coupons in the given campaign. You can find the &#x60;batchId&#x60; in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt; &lt;p class&#x3D;\&quot;title\&quot;&gt;Important&lt;/p&gt; &lt;ul&gt; &lt;li&gt;Only send sequential requests to this endpoint.&lt;/li&gt; &lt;li&gt;Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.&lt;/li&gt; &lt;/ul&gt; &lt;/div&gt; To update a specific coupon, use [Update coupon](#operation/updateCoupon).
1817
2161
  # @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
1818
2162
  # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
1819
2163
  # @param body body
@@ -1839,30 +2183,56 @@ describe 'ManagementApi' do
1839
2183
  end
1840
2184
  end
1841
2185
 
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).
2186
+ # unit tests for update_referral
2187
+ # Update referral
2188
+ # Update the specified referral.
1845
2189
  # @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.
2190
+ # @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
2191
+ # @param referral_id The ID of the referral code.
1847
2192
  # @param body body
1848
2193
  # @param [Hash] opts the optional parameters
1849
- # @return [NotificationWebhook]
1850
- describe 'update_notification_webhook test' do
2194
+ # @return [Referral]
2195
+ describe 'update_referral test' do
1851
2196
  it 'should work' do
1852
2197
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1853
2198
  end
1854
2199
  end
1855
2200
 
1856
- # unit tests for update_referral
1857
- # Update referral
1858
- # Update the specified referral.
2201
+ # unit tests for update_role_v2
2202
+ # Update role
2203
+ # Update a specific role.
2204
+ # @param role_id The ID of role.
2205
+ # @param body body
2206
+ # @param [Hash] opts the optional parameters
2207
+ # @return [RoleV2]
2208
+ describe 'update_role_v2 test' do
2209
+ it 'should work' do
2210
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
2211
+ end
2212
+ end
2213
+
2214
+ # unit tests for update_store
2215
+ # Update store
2216
+ # Update store details for a specific store ID.
1859
2217
  # @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.
2218
+ # @param store_id The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
1862
2219
  # @param body body
1863
2220
  # @param [Hash] opts the optional parameters
1864
- # @return [Referral]
1865
- describe 'update_referral test' do
2221
+ # @return [Store]
2222
+ describe 'update_store test' do
2223
+ it 'should work' do
2224
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
2225
+ end
2226
+ end
2227
+
2228
+ # unit tests for update_user
2229
+ # Update user
2230
+ # Update the details of a specific user.
2231
+ # @param user_id The ID of the user.
2232
+ # @param body body
2233
+ # @param [Hash] opts the optional parameters
2234
+ # @return [User]
2235
+ describe 'update_user test' do
1866
2236
  it 'should work' do
1867
2237
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
1868
2238
  end