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,400 @@
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
+ # Loyalty profile points with start and expiry dates.
17
+ class LedgerPointsEntryIntegrationAPI
18
+ # ID of the transaction that adds loyalty points.
19
+ attr_accessor :id
20
+
21
+ # Date and time the loyalty points were added.
22
+ attr_accessor :created
23
+
24
+ # ID of the loyalty program.
25
+ attr_accessor :program_id
26
+
27
+ # ID of the customer session where points were added.
28
+ attr_accessor :customer_session_id
29
+
30
+ # Name or reason of the transaction that adds loyalty points.
31
+ attr_accessor :name
32
+
33
+ # When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time.
34
+ attr_accessor :start_date
35
+
36
+ # Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time.
37
+ attr_accessor :expiry_date
38
+
39
+ # ID of the subledger.
40
+ attr_accessor :subledger_id
41
+
42
+ # Amount of loyalty points added in the transaction.
43
+ attr_accessor :amount
44
+
45
+ # Attribute mapping from ruby-style variable name to JSON key.
46
+ def self.attribute_map
47
+ {
48
+ :'id' => :'id',
49
+ :'created' => :'created',
50
+ :'program_id' => :'programId',
51
+ :'customer_session_id' => :'customerSessionId',
52
+ :'name' => :'name',
53
+ :'start_date' => :'startDate',
54
+ :'expiry_date' => :'expiryDate',
55
+ :'subledger_id' => :'subledgerId',
56
+ :'amount' => :'amount'
57
+ }
58
+ end
59
+
60
+ # Attribute type mapping.
61
+ def self.openapi_types
62
+ {
63
+ :'id' => :'Integer',
64
+ :'created' => :'DateTime',
65
+ :'program_id' => :'Integer',
66
+ :'customer_session_id' => :'String',
67
+ :'name' => :'String',
68
+ :'start_date' => :'String',
69
+ :'expiry_date' => :'String',
70
+ :'subledger_id' => :'String',
71
+ :'amount' => :'Float'
72
+ }
73
+ end
74
+
75
+ # List of attributes with nullable: true
76
+ def self.openapi_nullable
77
+ Set.new([
78
+ ])
79
+ end
80
+
81
+ # Initializes the object
82
+ # @param [Hash] attributes Model attributes in the form of hash
83
+ def initialize(attributes = {})
84
+ if (!attributes.is_a?(Hash))
85
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::LedgerPointsEntryIntegrationAPI` initialize method"
86
+ end
87
+
88
+ # check to see if the attribute exists and convert string to symbol for hash key
89
+ attributes = attributes.each_with_object({}) { |(k, v), h|
90
+ if (!self.class.attribute_map.key?(k.to_sym))
91
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::LedgerPointsEntryIntegrationAPI`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
92
+ end
93
+ h[k.to_sym] = v
94
+ }
95
+
96
+ if attributes.key?(:'id')
97
+ self.id = attributes[:'id']
98
+ end
99
+
100
+ if attributes.key?(:'created')
101
+ self.created = attributes[:'created']
102
+ end
103
+
104
+ if attributes.key?(:'program_id')
105
+ self.program_id = attributes[:'program_id']
106
+ end
107
+
108
+ if attributes.key?(:'customer_session_id')
109
+ self.customer_session_id = attributes[:'customer_session_id']
110
+ end
111
+
112
+ if attributes.key?(:'name')
113
+ self.name = attributes[:'name']
114
+ end
115
+
116
+ if attributes.key?(:'start_date')
117
+ self.start_date = attributes[:'start_date']
118
+ end
119
+
120
+ if attributes.key?(:'expiry_date')
121
+ self.expiry_date = attributes[:'expiry_date']
122
+ end
123
+
124
+ if attributes.key?(:'subledger_id')
125
+ self.subledger_id = attributes[:'subledger_id']
126
+ end
127
+
128
+ if attributes.key?(:'amount')
129
+ self.amount = attributes[:'amount']
130
+ end
131
+ end
132
+
133
+ # Show invalid properties with the reasons. Usually used together with valid?
134
+ # @return Array for valid properties with the reasons
135
+ def list_invalid_properties
136
+ invalid_properties = Array.new
137
+ if @id.nil?
138
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
139
+ end
140
+
141
+ if @created.nil?
142
+ invalid_properties.push('invalid value for "created", created cannot be nil.')
143
+ end
144
+
145
+ if @program_id.nil?
146
+ invalid_properties.push('invalid value for "program_id", program_id cannot be nil.')
147
+ end
148
+
149
+ if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
150
+ invalid_properties.push('invalid value for "customer_session_id", the character length must be smaller than or equal to 255.')
151
+ end
152
+
153
+ if @name.nil?
154
+ invalid_properties.push('invalid value for "name", name cannot be nil.')
155
+ end
156
+
157
+ if @name.to_s.length > 255
158
+ invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
159
+ end
160
+
161
+ if @start_date.nil?
162
+ invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
163
+ end
164
+
165
+ if @start_date.to_s.length > 64
166
+ invalid_properties.push('invalid value for "start_date", the character length must be smaller than or equal to 64.')
167
+ end
168
+
169
+ if @expiry_date.nil?
170
+ invalid_properties.push('invalid value for "expiry_date", expiry_date cannot be nil.')
171
+ end
172
+
173
+ if @subledger_id.nil?
174
+ invalid_properties.push('invalid value for "subledger_id", subledger_id cannot be nil.')
175
+ end
176
+
177
+ if @subledger_id.to_s.length > 64
178
+ invalid_properties.push('invalid value for "subledger_id", the character length must be smaller than or equal to 64.')
179
+ end
180
+
181
+ if @amount.nil?
182
+ invalid_properties.push('invalid value for "amount", amount cannot be nil.')
183
+ end
184
+
185
+ invalid_properties
186
+ end
187
+
188
+ # Check to see if the all the properties in the model are valid
189
+ # @return true if the model is valid
190
+ def valid?
191
+ return false if @id.nil?
192
+ return false if @created.nil?
193
+ return false if @program_id.nil?
194
+ return false if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
195
+ return false if @name.nil?
196
+ return false if @name.to_s.length > 255
197
+ return false if @start_date.nil?
198
+ return false if @start_date.to_s.length > 64
199
+ return false if @expiry_date.nil?
200
+ return false if @subledger_id.nil?
201
+ return false if @subledger_id.to_s.length > 64
202
+ return false if @amount.nil?
203
+ true
204
+ end
205
+
206
+ # Custom attribute writer method with validation
207
+ # @param [Object] customer_session_id Value to be assigned
208
+ def customer_session_id=(customer_session_id)
209
+ if !customer_session_id.nil? && customer_session_id.to_s.length > 255
210
+ fail ArgumentError, 'invalid value for "customer_session_id", the character length must be smaller than or equal to 255.'
211
+ end
212
+
213
+ @customer_session_id = customer_session_id
214
+ end
215
+
216
+ # Custom attribute writer method with validation
217
+ # @param [Object] name Value to be assigned
218
+ def name=(name)
219
+ if name.nil?
220
+ fail ArgumentError, 'name cannot be nil'
221
+ end
222
+
223
+ if name.to_s.length > 255
224
+ fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
225
+ end
226
+
227
+ @name = name
228
+ end
229
+
230
+ # Custom attribute writer method with validation
231
+ # @param [Object] start_date Value to be assigned
232
+ def start_date=(start_date)
233
+ if start_date.nil?
234
+ fail ArgumentError, 'start_date cannot be nil'
235
+ end
236
+
237
+ if start_date.to_s.length > 64
238
+ fail ArgumentError, 'invalid value for "start_date", the character length must be smaller than or equal to 64.'
239
+ end
240
+
241
+ @start_date = start_date
242
+ end
243
+
244
+ # Custom attribute writer method with validation
245
+ # @param [Object] subledger_id Value to be assigned
246
+ def subledger_id=(subledger_id)
247
+ if subledger_id.nil?
248
+ fail ArgumentError, 'subledger_id cannot be nil'
249
+ end
250
+
251
+ if subledger_id.to_s.length > 64
252
+ fail ArgumentError, 'invalid value for "subledger_id", the character length must be smaller than or equal to 64.'
253
+ end
254
+
255
+ @subledger_id = subledger_id
256
+ end
257
+
258
+ # Checks equality by comparing each attribute.
259
+ # @param [Object] Object to be compared
260
+ def ==(o)
261
+ return true if self.equal?(o)
262
+ self.class == o.class &&
263
+ id == o.id &&
264
+ created == o.created &&
265
+ program_id == o.program_id &&
266
+ customer_session_id == o.customer_session_id &&
267
+ name == o.name &&
268
+ start_date == o.start_date &&
269
+ expiry_date == o.expiry_date &&
270
+ subledger_id == o.subledger_id &&
271
+ amount == o.amount
272
+ end
273
+
274
+ # @see the `==` method
275
+ # @param [Object] Object to be compared
276
+ def eql?(o)
277
+ self == o
278
+ end
279
+
280
+ # Calculates hash code according to all attributes.
281
+ # @return [Integer] Hash code
282
+ def hash
283
+ [id, created, program_id, customer_session_id, name, start_date, expiry_date, subledger_id, amount].hash
284
+ end
285
+
286
+ # Builds the object from hash
287
+ # @param [Hash] attributes Model attributes in the form of hash
288
+ # @return [Object] Returns the model itself
289
+ def self.build_from_hash(attributes)
290
+ new.build_from_hash(attributes)
291
+ end
292
+
293
+ # Builds the object from hash
294
+ # @param [Hash] attributes Model attributes in the form of hash
295
+ # @return [Object] Returns the model itself
296
+ def build_from_hash(attributes)
297
+ return nil unless attributes.is_a?(Hash)
298
+ self.class.openapi_types.each_pair do |key, type|
299
+ if type =~ /\AArray<(.*)>/i
300
+ # check to ensure the input is an array given that the attribute
301
+ # is documented as an array but the input is not
302
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
303
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
304
+ end
305
+ elsif !attributes[self.class.attribute_map[key]].nil?
306
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
307
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
308
+ end
309
+
310
+ self
311
+ end
312
+
313
+ # Deserializes the data based on type
314
+ # @param string type Data type
315
+ # @param string value Value to be deserialized
316
+ # @return [Object] Deserialized data
317
+ def _deserialize(type, value)
318
+ case type.to_sym
319
+ when :DateTime
320
+ DateTime.parse(value)
321
+ when :Date
322
+ Date.parse(value)
323
+ when :String
324
+ value.to_s
325
+ when :Integer
326
+ value.to_i
327
+ when :Float
328
+ value.to_f
329
+ when :Boolean
330
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
331
+ true
332
+ else
333
+ false
334
+ end
335
+ when :Object
336
+ # generic object (usually a Hash), return directly
337
+ value
338
+ when /\AArray<(?<inner_type>.+)>\z/
339
+ inner_type = Regexp.last_match[:inner_type]
340
+ value.map { |v| _deserialize(inner_type, v) }
341
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
342
+ k_type = Regexp.last_match[:k_type]
343
+ v_type = Regexp.last_match[:v_type]
344
+ {}.tap do |hash|
345
+ value.each do |k, v|
346
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
347
+ end
348
+ end
349
+ else # model
350
+ TalonOne.const_get(type).build_from_hash(value)
351
+ end
352
+ end
353
+
354
+ # Returns the string representation of the object
355
+ # @return [String] String presentation of the object
356
+ def to_s
357
+ to_hash.to_s
358
+ end
359
+
360
+ # to_body is an alias to to_hash (backward compatibility)
361
+ # @return [Hash] Returns the object in the form of hash
362
+ def to_body
363
+ to_hash
364
+ end
365
+
366
+ # Returns the object in the form of hash
367
+ # @return [Hash] Returns the object in the form of hash
368
+ def to_hash
369
+ hash = {}
370
+ self.class.attribute_map.each_pair do |attr, param|
371
+ value = self.send(attr)
372
+ if value.nil?
373
+ is_nullable = self.class.openapi_nullable.include?(attr)
374
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
375
+ end
376
+
377
+ hash[param] = _to_hash(value)
378
+ end
379
+ hash
380
+ end
381
+
382
+ # Outputs non-array value in the form of hash
383
+ # For object, use to_hash. Otherwise, just return the value
384
+ # @param [Object] value Any valid value
385
+ # @return [Hash] Returns the value in the form of hash
386
+ def _to_hash(value)
387
+ if value.is_a?(Array)
388
+ value.compact.map { |v| _to_hash(v) }
389
+ elsif value.is_a?(Hash)
390
+ {}.tap do |hash|
391
+ value.each { |k, v| hash[k] = _to_hash(v) }
392
+ end
393
+ elsif value.respond_to? :to_hash
394
+ value.to_hash
395
+ else
396
+ value
397
+ end
398
+ end
399
+ end
400
+ end
@@ -15,7 +15,7 @@ require 'date'
15
15
  module TalonOne
16
16
  #
17
17
  class LoginParams
18
- # The email address associated with your account.
18
+ # The email address associated with the user profile.
19
19
  attr_accessor :email
20
20
 
21
21
  # The password for your account.
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
13
13
  require 'date'
14
14
 
15
15
  module TalonOne
16
- # Customer specific information about loyalty points.
16
+ # Customer-specific information about loyalty points.
17
17
  class Loyalty
18
18
  # Displays information about the balances of the loyalty cards.
19
19
  attr_accessor :cards
@@ -15,7 +15,7 @@ require 'date'
15
15
  module TalonOne
16
16
  # List of loyalty ledger transactions.
17
17
  class LoyaltyLedgerTransactions
18
- # true means there is more data in the source collection to request.
18
+ # If `true`, it means that there is more data to request in the source collection.
19
19
  attr_accessor :has_more
20
20
 
21
21
  # List of transaction entries from a loyalty ledger.
@@ -45,6 +45,18 @@ module TalonOne
45
45
  # Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.
46
46
  attr_accessor :sandbox
47
47
 
48
+ # The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.
49
+ attr_accessor :tiers_expiration_policy
50
+
51
+ # The amount of time after which the tier expires. The time format is an **integer** 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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.
52
+ attr_accessor :tiers_expire_in
53
+
54
+ # Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.
55
+ attr_accessor :tiers_downgrade_policy
56
+
57
+ # The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.
58
+ attr_accessor :program_join_policy
59
+
48
60
  # The ID of the Talon.One account that owns this program.
49
61
  attr_accessor :account_id
50
62
 
@@ -60,6 +72,37 @@ module TalonOne
60
72
  # Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based.
61
73
  attr_accessor :card_based
62
74
 
75
+ # `True` if the tier definitions can be updated.
76
+ attr_accessor :can_update_tiers
77
+
78
+ # Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`.
79
+ attr_accessor :can_update_join_policy
80
+
81
+ # `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties.
82
+ attr_accessor :can_upgrade_to_advanced_tiers
83
+
84
+ class EnumAttributeValidator
85
+ attr_reader :datatype
86
+ attr_reader :allowable_values
87
+
88
+ def initialize(datatype, allowable_values)
89
+ @allowable_values = allowable_values.map do |value|
90
+ case datatype.to_s
91
+ when /Integer/i
92
+ value.to_i
93
+ when /Float/i
94
+ value.to_f
95
+ else
96
+ value
97
+ end
98
+ end
99
+ end
100
+
101
+ def valid?(value)
102
+ !value || allowable_values.include?(value)
103
+ end
104
+ end
105
+
63
106
  # Attribute mapping from ruby-style variable name to JSON key.
64
107
  def self.attribute_map
65
108
  {
@@ -73,11 +116,18 @@ module TalonOne
73
116
  :'allow_subledger' => :'allowSubledger',
74
117
  :'users_per_card_limit' => :'usersPerCardLimit',
75
118
  :'sandbox' => :'sandbox',
119
+ :'tiers_expiration_policy' => :'tiersExpirationPolicy',
120
+ :'tiers_expire_in' => :'tiersExpireIn',
121
+ :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
122
+ :'program_join_policy' => :'programJoinPolicy',
76
123
  :'account_id' => :'accountID',
77
124
  :'name' => :'name',
78
125
  :'tiers' => :'tiers',
79
126
  :'timezone' => :'timezone',
80
- :'card_based' => :'cardBased'
127
+ :'card_based' => :'cardBased',
128
+ :'can_update_tiers' => :'canUpdateTiers',
129
+ :'can_update_join_policy' => :'canUpdateJoinPolicy',
130
+ :'can_upgrade_to_advanced_tiers' => :'canUpgradeToAdvancedTiers'
81
131
  }
82
132
  end
83
133
 
@@ -94,11 +144,18 @@ module TalonOne
94
144
  :'allow_subledger' => :'Boolean',
95
145
  :'users_per_card_limit' => :'Integer',
96
146
  :'sandbox' => :'Boolean',
147
+ :'tiers_expiration_policy' => :'String',
148
+ :'tiers_expire_in' => :'String',
149
+ :'tiers_downgrade_policy' => :'String',
150
+ :'program_join_policy' => :'String',
97
151
  :'account_id' => :'Integer',
98
152
  :'name' => :'String',
99
153
  :'tiers' => :'Array<LoyaltyTier>',
100
154
  :'timezone' => :'String',
101
- :'card_based' => :'Boolean'
155
+ :'card_based' => :'Boolean',
156
+ :'can_update_tiers' => :'Boolean',
157
+ :'can_update_join_policy' => :'Boolean',
158
+ :'can_upgrade_to_advanced_tiers' => :'Boolean'
102
159
  }
103
160
  end
104
161
 
@@ -165,6 +222,22 @@ module TalonOne
165
222
  self.sandbox = attributes[:'sandbox']
166
223
  end
167
224
 
225
+ if attributes.key?(:'tiers_expiration_policy')
226
+ self.tiers_expiration_policy = attributes[:'tiers_expiration_policy']
227
+ end
228
+
229
+ if attributes.key?(:'tiers_expire_in')
230
+ self.tiers_expire_in = attributes[:'tiers_expire_in']
231
+ end
232
+
233
+ if attributes.key?(:'tiers_downgrade_policy')
234
+ self.tiers_downgrade_policy = attributes[:'tiers_downgrade_policy']
235
+ end
236
+
237
+ if attributes.key?(:'program_join_policy')
238
+ self.program_join_policy = attributes[:'program_join_policy']
239
+ end
240
+
168
241
  if attributes.key?(:'account_id')
169
242
  self.account_id = attributes[:'account_id']
170
243
  end
@@ -188,6 +261,22 @@ module TalonOne
188
261
  else
189
262
  self.card_based = false
190
263
  end
264
+
265
+ if attributes.key?(:'can_update_tiers')
266
+ self.can_update_tiers = attributes[:'can_update_tiers']
267
+ else
268
+ self.can_update_tiers = false
269
+ end
270
+
271
+ if attributes.key?(:'can_update_join_policy')
272
+ self.can_update_join_policy = attributes[:'can_update_join_policy']
273
+ end
274
+
275
+ if attributes.key?(:'can_upgrade_to_advanced_tiers')
276
+ self.can_upgrade_to_advanced_tiers = attributes[:'can_upgrade_to_advanced_tiers']
277
+ else
278
+ self.can_upgrade_to_advanced_tiers = false
279
+ end
191
280
  end
192
281
 
193
282
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -270,6 +359,12 @@ module TalonOne
270
359
  return false if @allow_subledger.nil?
271
360
  return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
272
361
  return false if @sandbox.nil?
362
+ tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
363
+ return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
364
+ tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
365
+ return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
366
+ program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
367
+ return false unless program_join_policy_validator.valid?(@program_join_policy)
273
368
  return false if @account_id.nil?
274
369
  return false if @name.nil?
275
370
  return false if @timezone.nil?
@@ -288,6 +383,36 @@ module TalonOne
288
383
  @users_per_card_limit = users_per_card_limit
289
384
  end
290
385
 
386
+ # Custom attribute writer method checking allowed values (enum).
387
+ # @param [Object] tiers_expiration_policy Object to be assigned
388
+ def tiers_expiration_policy=(tiers_expiration_policy)
389
+ validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
390
+ unless validator.valid?(tiers_expiration_policy)
391
+ fail ArgumentError, "invalid value for \"tiers_expiration_policy\", must be one of #{validator.allowable_values}."
392
+ end
393
+ @tiers_expiration_policy = tiers_expiration_policy
394
+ end
395
+
396
+ # Custom attribute writer method checking allowed values (enum).
397
+ # @param [Object] tiers_downgrade_policy Object to be assigned
398
+ def tiers_downgrade_policy=(tiers_downgrade_policy)
399
+ validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
400
+ unless validator.valid?(tiers_downgrade_policy)
401
+ fail ArgumentError, "invalid value for \"tiers_downgrade_policy\", must be one of #{validator.allowable_values}."
402
+ end
403
+ @tiers_downgrade_policy = tiers_downgrade_policy
404
+ end
405
+
406
+ # Custom attribute writer method checking allowed values (enum).
407
+ # @param [Object] program_join_policy Object to be assigned
408
+ def program_join_policy=(program_join_policy)
409
+ validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
410
+ unless validator.valid?(program_join_policy)
411
+ fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
412
+ end
413
+ @program_join_policy = program_join_policy
414
+ end
415
+
291
416
  # Custom attribute writer method with validation
292
417
  # @param [Object] timezone Value to be assigned
293
418
  def timezone=(timezone)
@@ -317,11 +442,18 @@ module TalonOne
317
442
  allow_subledger == o.allow_subledger &&
318
443
  users_per_card_limit == o.users_per_card_limit &&
319
444
  sandbox == o.sandbox &&
445
+ tiers_expiration_policy == o.tiers_expiration_policy &&
446
+ tiers_expire_in == o.tiers_expire_in &&
447
+ tiers_downgrade_policy == o.tiers_downgrade_policy &&
448
+ program_join_policy == o.program_join_policy &&
320
449
  account_id == o.account_id &&
321
450
  name == o.name &&
322
451
  tiers == o.tiers &&
323
452
  timezone == o.timezone &&
324
- card_based == o.card_based
453
+ card_based == o.card_based &&
454
+ can_update_tiers == o.can_update_tiers &&
455
+ can_update_join_policy == o.can_update_join_policy &&
456
+ can_upgrade_to_advanced_tiers == o.can_upgrade_to_advanced_tiers
325
457
  end
326
458
 
327
459
  # @see the `==` method
@@ -333,7 +465,7 @@ module TalonOne
333
465
  # Calculates hash code according to all attributes.
334
466
  # @return [Integer] Hash code
335
467
  def hash
336
- [id, created, title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, account_id, name, tiers, timezone, card_based].hash
468
+ [id, created, title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, tiers_expiration_policy, tiers_expire_in, tiers_downgrade_policy, program_join_policy, account_id, name, tiers, timezone, card_based, can_update_tiers, can_update_join_policy, can_upgrade_to_advanced_tiers].hash
337
469
  end
338
470
 
339
471
  # Builds the object from hash