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
@@ -0,0 +1,320 @@
1
+ =begin
2
+ #Talon.One API
3
+
4
+ #Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
5
+
6
+ The version of the OpenAPI document:
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module TalonOne
16
+ class CreateAchievement
17
+ # The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created.
18
+ attr_accessor :name
19
+
20
+ # The display name for the achievement in the Campaign Manager.
21
+ attr_accessor :title
22
+
23
+ # A description of the achievement.
24
+ attr_accessor :description
25
+
26
+ # The required number of actions or the transactional milestone to complete the achievement.
27
+ attr_accessor :target
28
+
29
+ # The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period.
30
+ attr_accessor :period
31
+
32
+ attr_accessor :period_end_override
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'name' => :'name',
38
+ :'title' => :'title',
39
+ :'description' => :'description',
40
+ :'target' => :'target',
41
+ :'period' => :'period',
42
+ :'period_end_override' => :'periodEndOverride'
43
+ }
44
+ end
45
+
46
+ # Attribute type mapping.
47
+ def self.openapi_types
48
+ {
49
+ :'name' => :'String',
50
+ :'title' => :'String',
51
+ :'description' => :'String',
52
+ :'target' => :'Float',
53
+ :'period' => :'String',
54
+ :'period_end_override' => :'TimePoint'
55
+ }
56
+ end
57
+
58
+ # List of attributes with nullable: true
59
+ def self.openapi_nullable
60
+ Set.new([
61
+ ])
62
+ end
63
+
64
+ # Initializes the object
65
+ # @param [Hash] attributes Model attributes in the form of hash
66
+ def initialize(attributes = {})
67
+ if (!attributes.is_a?(Hash))
68
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CreateAchievement` initialize method"
69
+ end
70
+
71
+ # check to see if the attribute exists and convert string to symbol for hash key
72
+ attributes = attributes.each_with_object({}) { |(k, v), h|
73
+ if (!self.class.attribute_map.key?(k.to_sym))
74
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::CreateAchievement`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
75
+ end
76
+ h[k.to_sym] = v
77
+ }
78
+
79
+ if attributes.key?(:'name')
80
+ self.name = attributes[:'name']
81
+ end
82
+
83
+ if attributes.key?(:'title')
84
+ self.title = attributes[:'title']
85
+ end
86
+
87
+ if attributes.key?(:'description')
88
+ self.description = attributes[:'description']
89
+ end
90
+
91
+ if attributes.key?(:'target')
92
+ self.target = attributes[:'target']
93
+ end
94
+
95
+ if attributes.key?(:'period')
96
+ self.period = attributes[:'period']
97
+ end
98
+
99
+ if attributes.key?(:'period_end_override')
100
+ self.period_end_override = attributes[:'period_end_override']
101
+ end
102
+ end
103
+
104
+ # Show invalid properties with the reasons. Usually used together with valid?
105
+ # @return Array for valid properties with the reasons
106
+ def list_invalid_properties
107
+ invalid_properties = Array.new
108
+ if @name.nil?
109
+ invalid_properties.push('invalid value for "name", name cannot be nil.')
110
+ end
111
+
112
+ if @name.to_s.length > 1000
113
+ invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 1000.')
114
+ end
115
+
116
+ if @name.to_s.length < 1
117
+ invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
118
+ end
119
+
120
+ pattern = Regexp.new(/^[a-zA-Z]\w+$/)
121
+ if @name !~ pattern
122
+ invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
123
+ end
124
+
125
+ if @title.nil?
126
+ invalid_properties.push('invalid value for "title", title cannot be nil.')
127
+ end
128
+
129
+ if @description.nil?
130
+ invalid_properties.push('invalid value for "description", description cannot be nil.')
131
+ end
132
+
133
+ if @target.nil?
134
+ invalid_properties.push('invalid value for "target", target cannot be nil.')
135
+ end
136
+
137
+ if @period.nil?
138
+ invalid_properties.push('invalid value for "period", period cannot be nil.')
139
+ end
140
+
141
+ invalid_properties
142
+ end
143
+
144
+ # Check to see if the all the properties in the model are valid
145
+ # @return true if the model is valid
146
+ def valid?
147
+ return false if @name.nil?
148
+ return false if @name.to_s.length > 1000
149
+ return false if @name.to_s.length < 1
150
+ return false if @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
151
+ return false if @title.nil?
152
+ return false if @description.nil?
153
+ return false if @target.nil?
154
+ return false if @period.nil?
155
+ true
156
+ end
157
+
158
+ # Custom attribute writer method with validation
159
+ # @param [Object] name Value to be assigned
160
+ def name=(name)
161
+ if name.nil?
162
+ fail ArgumentError, 'name cannot be nil'
163
+ end
164
+
165
+ if name.to_s.length > 1000
166
+ fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 1000.'
167
+ end
168
+
169
+ if name.to_s.length < 1
170
+ fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
171
+ end
172
+
173
+ pattern = Regexp.new(/^[a-zA-Z]\w+$/)
174
+ if name !~ pattern
175
+ fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
176
+ end
177
+
178
+ @name = name
179
+ end
180
+
181
+ # Checks equality by comparing each attribute.
182
+ # @param [Object] Object to be compared
183
+ def ==(o)
184
+ return true if self.equal?(o)
185
+ self.class == o.class &&
186
+ name == o.name &&
187
+ title == o.title &&
188
+ description == o.description &&
189
+ target == o.target &&
190
+ period == o.period &&
191
+ period_end_override == o.period_end_override
192
+ end
193
+
194
+ # @see the `==` method
195
+ # @param [Object] Object to be compared
196
+ def eql?(o)
197
+ self == o
198
+ end
199
+
200
+ # Calculates hash code according to all attributes.
201
+ # @return [Integer] Hash code
202
+ def hash
203
+ [name, title, description, target, period, period_end_override].hash
204
+ end
205
+
206
+ # Builds the object from hash
207
+ # @param [Hash] attributes Model attributes in the form of hash
208
+ # @return [Object] Returns the model itself
209
+ def self.build_from_hash(attributes)
210
+ new.build_from_hash(attributes)
211
+ end
212
+
213
+ # Builds the object from hash
214
+ # @param [Hash] attributes Model attributes in the form of hash
215
+ # @return [Object] Returns the model itself
216
+ def build_from_hash(attributes)
217
+ return nil unless attributes.is_a?(Hash)
218
+ self.class.openapi_types.each_pair do |key, type|
219
+ if type =~ /\AArray<(.*)>/i
220
+ # check to ensure the input is an array given that the attribute
221
+ # is documented as an array but the input is not
222
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
223
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
224
+ end
225
+ elsif !attributes[self.class.attribute_map[key]].nil?
226
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
227
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
228
+ end
229
+
230
+ self
231
+ end
232
+
233
+ # Deserializes the data based on type
234
+ # @param string type Data type
235
+ # @param string value Value to be deserialized
236
+ # @return [Object] Deserialized data
237
+ def _deserialize(type, value)
238
+ case type.to_sym
239
+ when :DateTime
240
+ DateTime.parse(value)
241
+ when :Date
242
+ Date.parse(value)
243
+ when :String
244
+ value.to_s
245
+ when :Integer
246
+ value.to_i
247
+ when :Float
248
+ value.to_f
249
+ when :Boolean
250
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
251
+ true
252
+ else
253
+ false
254
+ end
255
+ when :Object
256
+ # generic object (usually a Hash), return directly
257
+ value
258
+ when /\AArray<(?<inner_type>.+)>\z/
259
+ inner_type = Regexp.last_match[:inner_type]
260
+ value.map { |v| _deserialize(inner_type, v) }
261
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
262
+ k_type = Regexp.last_match[:k_type]
263
+ v_type = Regexp.last_match[:v_type]
264
+ {}.tap do |hash|
265
+ value.each do |k, v|
266
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
267
+ end
268
+ end
269
+ else # model
270
+ TalonOne.const_get(type).build_from_hash(value)
271
+ end
272
+ end
273
+
274
+ # Returns the string representation of the object
275
+ # @return [String] String presentation of the object
276
+ def to_s
277
+ to_hash.to_s
278
+ end
279
+
280
+ # to_body is an alias to to_hash (backward compatibility)
281
+ # @return [Hash] Returns the object in the form of hash
282
+ def to_body
283
+ to_hash
284
+ end
285
+
286
+ # Returns the object in the form of hash
287
+ # @return [Hash] Returns the object in the form of hash
288
+ def to_hash
289
+ hash = {}
290
+ self.class.attribute_map.each_pair do |attr, param|
291
+ value = self.send(attr)
292
+ if value.nil?
293
+ is_nullable = self.class.openapi_nullable.include?(attr)
294
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
295
+ end
296
+
297
+ hash[param] = _to_hash(value)
298
+ end
299
+ hash
300
+ end
301
+
302
+ # Outputs non-array value in the form of hash
303
+ # For object, use to_hash. Otherwise, just return the value
304
+ # @param [Object] value Any valid value
305
+ # @return [Hash] Returns the value in the form of hash
306
+ def _to_hash(value)
307
+ if value.is_a?(Array)
308
+ value.compact.map { |v| _to_hash(v) }
309
+ elsif value.is_a?(Hash)
310
+ {}.tap do |hash|
311
+ value.each { |k, v| hash[k] = _to_hash(v) }
312
+ end
313
+ elsif value.respond_to? :to_hash
314
+ value.to_hash
315
+ else
316
+ value
317
+ end
318
+ end
319
+ end
320
+ end
@@ -14,15 +14,21 @@ require 'date'
14
14
 
15
15
  module TalonOne
16
16
  class CreateApplicationAPIKey
17
- # Title for API Key.
17
+ # Title of the API key.
18
18
  attr_accessor :title
19
19
 
20
- # The date the API key expired.
20
+ # The date the API key expires.
21
21
  attr_accessor :expires
22
22
 
23
23
  # The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer.
24
24
  attr_accessor :platform
25
25
 
26
+ # The API key type. Can be empty or `staging`. Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint. When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`.
27
+ attr_accessor :type
28
+
29
+ # A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.
30
+ attr_accessor :time_offset
31
+
26
32
  class EnumAttributeValidator
27
33
  attr_reader :datatype
28
34
  attr_reader :allowable_values
@@ -50,7 +56,9 @@ module TalonOne
50
56
  {
51
57
  :'title' => :'title',
52
58
  :'expires' => :'expires',
53
- :'platform' => :'platform'
59
+ :'platform' => :'platform',
60
+ :'type' => :'type',
61
+ :'time_offset' => :'timeOffset'
54
62
  }
55
63
  end
56
64
 
@@ -59,7 +67,9 @@ module TalonOne
59
67
  {
60
68
  :'title' => :'String',
61
69
  :'expires' => :'DateTime',
62
- :'platform' => :'String'
70
+ :'platform' => :'String',
71
+ :'type' => :'String',
72
+ :'time_offset' => :'Integer'
63
73
  }
64
74
  end
65
75
 
@@ -95,6 +105,14 @@ module TalonOne
95
105
  if attributes.key?(:'platform')
96
106
  self.platform = attributes[:'platform']
97
107
  end
108
+
109
+ if attributes.key?(:'type')
110
+ self.type = attributes[:'type']
111
+ end
112
+
113
+ if attributes.key?(:'time_offset')
114
+ self.time_offset = attributes[:'time_offset']
115
+ end
98
116
  end
99
117
 
100
118
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,21 +135,33 @@ module TalonOne
117
135
  def valid?
118
136
  return false if @title.nil?
119
137
  return false if @expires.nil?
120
- platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce"])
138
+ platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce", "emarsys"])
121
139
  return false unless platform_validator.valid?(@platform)
140
+ type_validator = EnumAttributeValidator.new('String', ["staging"])
141
+ return false unless type_validator.valid?(@type)
122
142
  true
123
143
  end
124
144
 
125
145
  # Custom attribute writer method checking allowed values (enum).
126
146
  # @param [Object] platform Object to be assigned
127
147
  def platform=(platform)
128
- validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce"])
148
+ validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce", "emarsys"])
129
149
  unless validator.valid?(platform)
130
150
  fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
131
151
  end
132
152
  @platform = platform
133
153
  end
134
154
 
155
+ # Custom attribute writer method checking allowed values (enum).
156
+ # @param [Object] type Object to be assigned
157
+ def type=(type)
158
+ validator = EnumAttributeValidator.new('String', ["staging"])
159
+ unless validator.valid?(type)
160
+ fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
161
+ end
162
+ @type = type
163
+ end
164
+
135
165
  # Checks equality by comparing each attribute.
136
166
  # @param [Object] Object to be compared
137
167
  def ==(o)
@@ -139,7 +169,9 @@ module TalonOne
139
169
  self.class == o.class &&
140
170
  title == o.title &&
141
171
  expires == o.expires &&
142
- platform == o.platform
172
+ platform == o.platform &&
173
+ type == o.type &&
174
+ time_offset == o.time_offset
143
175
  end
144
176
 
145
177
  # @see the `==` method
@@ -151,7 +183,7 @@ module TalonOne
151
183
  # Calculates hash code according to all attributes.
152
184
  # @return [Integer] Hash code
153
185
  def hash
154
- [title, expires, platform].hash
186
+ [title, expires, platform, type, time_offset].hash
155
187
  end
156
188
 
157
189
  # Builds the object from hash
@@ -32,12 +32,18 @@ module TalonOne
32
32
  # Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden.
33
33
  attr_accessor :limit_overrides
34
34
 
35
- # The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.
35
+ # The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to.
36
36
  attr_accessor :campaign_groups
37
37
 
38
38
  # A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list.
39
39
  attr_accessor :tags
40
40
 
41
+ # The ID of the campaign evaluation group the campaign belongs to.
42
+ attr_accessor :evaluation_group_id
43
+
44
+ # A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store.
45
+ attr_accessor :linked_store_ids
46
+
41
47
  # Attribute mapping from ruby-style variable name to JSON key.
42
48
  def self.attribute_map
43
49
  {
@@ -48,7 +54,9 @@ module TalonOne
48
54
  :'template_param_values' => :'templateParamValues',
49
55
  :'limit_overrides' => :'limitOverrides',
50
56
  :'campaign_groups' => :'campaignGroups',
51
- :'tags' => :'tags'
57
+ :'tags' => :'tags',
58
+ :'evaluation_group_id' => :'evaluationGroupId',
59
+ :'linked_store_ids' => :'linkedStoreIds'
52
60
  }
53
61
  end
54
62
 
@@ -62,7 +70,9 @@ module TalonOne
62
70
  :'template_param_values' => :'Array<Binding>',
63
71
  :'limit_overrides' => :'Array<LimitConfig>',
64
72
  :'campaign_groups' => :'Array<Integer>',
65
- :'tags' => :'Array<String>'
73
+ :'tags' => :'Array<String>',
74
+ :'evaluation_group_id' => :'Integer',
75
+ :'linked_store_ids' => :'Array<Integer>'
66
76
  }
67
77
  end
68
78
 
@@ -126,6 +136,16 @@ module TalonOne
126
136
  self.tags = value
127
137
  end
128
138
  end
139
+
140
+ if attributes.key?(:'evaluation_group_id')
141
+ self.evaluation_group_id = attributes[:'evaluation_group_id']
142
+ end
143
+
144
+ if attributes.key?(:'linked_store_ids')
145
+ if (value = attributes[:'linked_store_ids']).is_a?(Array)
146
+ self.linked_store_ids = value
147
+ end
148
+ end
129
149
  end
130
150
 
131
151
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -182,7 +202,9 @@ module TalonOne
182
202
  template_param_values == o.template_param_values &&
183
203
  limit_overrides == o.limit_overrides &&
184
204
  campaign_groups == o.campaign_groups &&
185
- tags == o.tags
205
+ tags == o.tags &&
206
+ evaluation_group_id == o.evaluation_group_id &&
207
+ linked_store_ids == o.linked_store_ids
186
208
  end
187
209
 
188
210
  # @see the `==` method
@@ -194,7 +216,7 @@ module TalonOne
194
216
  # Calculates hash code according to all attributes.
195
217
  # @return [Integer] Hash code
196
218
  def hash
197
- [name, description, template_id, campaign_attributes_overrides, template_param_values, limit_overrides, campaign_groups, tags].hash
219
+ [name, description, template_id, campaign_attributes_overrides, template_param_values, limit_overrides, campaign_groups, tags, evaluation_group_id, linked_store_ids].hash
198
220
  end
199
221
 
200
222
  # Builds the object from hash
@@ -24,7 +24,7 @@ module TalonOne
24
24
  # The index of the item in the cart item list to which the custom effect is applied.
25
25
  attr_accessor :cart_item_position
26
26
 
27
- # When cart item flattening is enabled, the sub position indicates to which item unit the custom effect is applied, for cart items with quantity > 1.
27
+ # For cart items with quantity > 1, the sub position indicates to which item unit the custom effect is applied.
28
28
  attr_accessor :cart_item_sub_position
29
29
 
30
30
  # The position of the bundle in a list of item bundles created from the same bundle definition.
@@ -25,6 +25,8 @@ module TalonOne
25
25
 
26
26
  attr_accessor :giveaways
27
27
 
28
+ attr_accessor :achievements
29
+
28
30
  # Attribute mapping from ruby-style variable name to JSON key.
29
31
  def self.attribute_map
30
32
  {
@@ -32,7 +34,8 @@ module TalonOne
32
34
  :'loyalty' => :'loyalty',
33
35
  :'referrals' => :'referrals',
34
36
  :'coupons' => :'coupons',
35
- :'giveaways' => :'giveaways'
37
+ :'giveaways' => :'giveaways',
38
+ :'achievements' => :'achievements'
36
39
  }
37
40
  end
38
41
 
@@ -43,7 +46,8 @@ module TalonOne
43
46
  :'loyalty' => :'Loyalty',
44
47
  :'referrals' => :'Array<InventoryReferral>',
45
48
  :'coupons' => :'Array<InventoryCoupon>',
46
- :'giveaways' => :'Array<Giveaway>'
49
+ :'giveaways' => :'Array<Giveaway>',
50
+ :'achievements' => :'Array<AchievementProgress>'
47
51
  }
48
52
  end
49
53
 
@@ -93,6 +97,12 @@ module TalonOne
93
97
  self.giveaways = value
94
98
  end
95
99
  end
100
+
101
+ if attributes.key?(:'achievements')
102
+ if (value = attributes[:'achievements']).is_a?(Array)
103
+ self.achievements = value
104
+ end
105
+ end
96
106
  end
97
107
 
98
108
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +127,8 @@ module TalonOne
117
127
  loyalty == o.loyalty &&
118
128
  referrals == o.referrals &&
119
129
  coupons == o.coupons &&
120
- giveaways == o.giveaways
130
+ giveaways == o.giveaways &&
131
+ achievements == o.achievements
121
132
  end
122
133
 
123
134
  # @see the `==` method
@@ -129,7 +140,7 @@ module TalonOne
129
140
  # Calculates hash code according to all attributes.
130
141
  # @return [Integer] Hash code
131
142
  def hash
132
- [profile, loyalty, referrals, coupons, giveaways].hash
143
+ [profile, loyalty, referrals, coupons, giveaways, achievements].hash
133
144
  end
134
145
 
135
146
  # Builds the object from hash
@@ -42,10 +42,10 @@ module TalonOne
42
42
  # The audiences the customer belongs to.
43
43
  attr_accessor :audience_memberships
44
44
 
45
- # Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.
45
+ # Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field.
46
46
  attr_accessor :last_activity
47
47
 
48
- # Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).
48
+ # An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).
49
49
  attr_accessor :sandbox
50
50
 
51
51
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module TalonOne
16
16
  class CustomerProfileAudienceRequestItem
17
- # Defines the action to perform: - `add`: Adds the customer profile to the audience. - `delete`: Removes the customer profile from the audience.
17
+ # Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience.
18
18
  attr_accessor :action
19
19
 
20
20
  # The ID of this customer profile in the third-party integration.