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
@@ -7,13 +7,15 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property. |
8
8
  **value** | **Float** | The total monetary value of the discount. |
9
9
  **position** | **Float** | The index of the item in the cart items list on which this discount should be applied. |
10
- **sub_position** | **Float** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1. | [optional]
10
+ **sub_position** | **Float** | For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. | [optional]
11
11
  **desired_value** | **Float** | The original value of the discount. | [optional]
12
12
  **scope** | **String** | The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item. | [optional]
13
13
  **total_discount** | **Float** | The total discount given if this effect is a result of a prorated discount. | [optional]
14
14
  **desired_total_discount** | **Float** | The original total discount to give if this effect is a result of a prorated discount. | [optional]
15
15
  **bundle_index** | **Integer** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional]
16
16
  **bundle_name** | **String** | The name of the bundle definition. | [optional]
17
+ **targeted_item_position** | **Float** | The index of the targeted bundle item on which the applied discount is based. | [optional]
18
+ **targeted_item_sub_position** | **Float** | The sub-position of the targeted bundle item on which the applied discount is based. | [optional]
17
19
 
18
20
  ## Code Sample
19
21
 
@@ -29,7 +31,9 @@ instance = TalonOne::SetDiscountPerItemEffectProps.new(name: null,
29
31
  total_discount: null,
30
32
  desired_total_discount: null,
31
33
  bundle_index: null,
32
- bundle_name: null)
34
+ bundle_name: null,
35
+ targeted_item_position: null,
36
+ targeted_item_sub_position: null)
33
37
  ```
34
38
 
35
39
 
data/docs/Store.md ADDED
@@ -0,0 +1,33 @@
1
+ # TalonOne::Store
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | Internal ID of this entity. |
8
+ **created** | **DateTime** | The time this entity was created. The time this entity was created. |
9
+ **name** | **String** | The name of the store. |
10
+ **description** | **String** | The description of the store. |
11
+ **attributes** | [**Object**](.md) | The attributes of the store. | [optional]
12
+ **integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. **Note**: You cannot edit the `integrationId` after the store has been created. |
13
+ **application_id** | **Integer** | The ID of the application that owns this entity. |
14
+ **updated** | **DateTime** | Timestamp of the most recent update on this entity. |
15
+ **linked_campaign_ids** | **Array<Integer>** | A list of IDs of the campaigns that are linked with current store. | [optional]
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'TalonOne'
21
+
22
+ instance = TalonOne::Store.new(id: 6,
23
+ created: null,
24
+ name: South US store,
25
+ description: This is the description of the store in south US.,
26
+ attributes: {"country":"USA","code":1234},
27
+ integration_id: STORE-001,
28
+ application_id: 322,
29
+ updated: 2021-09-23T10:12:42Z,
30
+ linked_campaign_ids: [4, 6, 8])
31
+ ```
32
+
33
+
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **type** | **String** | The type of value this argument expects. |
8
- **description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. |
8
+ **description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. | [optional]
9
9
  **title** | **String** | A campaigner friendly name for the argument, this will be shown in the rule editor. |
10
10
  **ui** | [**Object**](.md) | Arbitrary metadata that may be used to render an input for this argument. |
11
11
  **picklist_id** | **Integer** | ID of the picklist linked to a template. | [optional]
data/docs/Tier.md CHANGED
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **id** | **Integer** | The internal ID of the tier. |
8
8
  **name** | **String** | The name of the tier. |
9
+ **expiry_date** | **DateTime** | Date when tier level expires in the RFC3339 format (in the Loyalty Program's timezone). | [optional]
10
+ **downgrade_policy** | **String** | 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. | [optional]
9
11
 
10
12
  ## Code Sample
11
13
 
@@ -13,7 +15,9 @@ Name | Type | Description | Notes
13
15
  require 'TalonOne'
14
16
 
15
17
  instance = TalonOne::Tier.new(id: 11,
16
- name: bronze)
18
+ name: bronze,
19
+ expiry_date: null,
20
+ downgrade_policy: null)
17
21
  ```
18
22
 
19
23
 
@@ -0,0 +1,19 @@
1
+ # TalonOne::TierDowngradeNotificationPolicy
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The name of the notification. |
8
+ **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::TierDowngradeNotificationPolicy.new(name: Christmas Sale,
16
+ batching_enabled: false)
17
+ ```
18
+
19
+
@@ -0,0 +1,19 @@
1
+ # TalonOne::TierUpgradeNotificationPolicy
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | Notification name. |
8
+ **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::TierUpgradeNotificationPolicy.new(name: Christmas Sale,
16
+ batching_enabled: false)
17
+ ```
18
+
19
+
@@ -0,0 +1,21 @@
1
+ # TalonOne::TierWillDowngradeNotificationPolicy
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The name of the notification. |
8
+ **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
9
+ **triggers** | [**Array<TierWillDowngradeNotificationTrigger>**](TierWillDowngradeNotificationTrigger.md) | |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'TalonOne'
15
+
16
+ instance = TalonOne::TierWillDowngradeNotificationPolicy.new(name: Notification to Google,
17
+ batching_enabled: false,
18
+ triggers: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,19 @@
1
+ # TalonOne::TierWillDowngradeNotificationTrigger
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **amount** | **Integer** | The amount of period. |
8
+ **period** | **String** | Notification period indicated by a letter; \"w\" means week, \"d\" means day. |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::TierWillDowngradeNotificationTrigger.new(amount: null,
16
+ period: null)
17
+ ```
18
+
19
+
data/docs/TimePoint.md ADDED
@@ -0,0 +1,27 @@
1
+ # TalonOne::TimePoint
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **month** | **Integer** | The achievement ends and resets in this month. **Note**: Only applicable if the period is set to `Y`. | [optional]
8
+ **day_of_month** | **Integer** | The achievement ends and resets on this day of the month. **Note**: Only applicable if the period is set to `Y` or `M`. | [optional]
9
+ **day_of_week** | **Integer** | The achievement ends and resets on this day of the week. `1` represents `Monday` and `7` represents `Sunday`. **Note**: Only applicable if the period is set to `W`. | [optional]
10
+ **hour** | **Integer** | The achievement ends and resets at this hour. |
11
+ **minute** | **Integer** | The achievement ends and resets at this minute. |
12
+ **second** | **Integer** | The achievement ends and resets at this second. |
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'TalonOne'
18
+
19
+ instance = TalonOne::TimePoint.new(month: 11,
20
+ day_of_month: 23,
21
+ day_of_week: null,
22
+ hour: 23,
23
+ minute: 59,
24
+ second: 59)
25
+ ```
26
+
27
+
@@ -0,0 +1,33 @@
1
+ # TalonOne::TrackEventV2Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **customer_profile** | [**CustomerProfile**](CustomerProfile.md) | | [optional]
8
+ **event** | [**Event**](Event.md) | | [optional]
9
+ **loyalty** | [**Loyalty**](Loyalty.md) | | [optional]
10
+ **triggered_campaigns** | [**Array<Campaign>**](Campaign.md) | | [optional]
11
+ **rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | | [optional]
12
+ **awarded_giveaways** | [**Array<Giveaway>**](Giveaway.md) | | [optional]
13
+ **effects** | [**Array<Effect>**](Effect.md) | The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
14
+ **created_coupons** | [**Array<Coupon>**](Coupon.md) | |
15
+ **created_referrals** | [**Array<Referral>**](Referral.md) | |
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'TalonOne'
21
+
22
+ instance = TalonOne::TrackEventV2Response.new(customer_profile: null,
23
+ event: null,
24
+ loyalty: null,
25
+ triggered_campaigns: null,
26
+ rule_failure_reasons: null,
27
+ awarded_giveaways: null,
28
+ effects: null,
29
+ created_coupons: null,
30
+ created_referrals: null)
31
+ ```
32
+
33
+
@@ -0,0 +1,19 @@
1
+ # TalonOne::TwoFAConfig
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **enabled** | **Boolean** | An indication of whether two-factor authentication is enabled for the account. |
8
+ **require_every_sign_in** | **Boolean** | Can be `true` or `false`. - `true`: Two-factor authentication is required each time a user signs in to their Talon.One account. - `false`: Two-factor authentication is only required when a user signs in to their Talon.One account on a new device, and every 30 days after that. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::TwoFAConfig.new(enabled: true,
16
+ require_every_sign_in: true)
17
+ ```
18
+
19
+
@@ -0,0 +1,27 @@
1
+ # TalonOne::UpdateAchievement
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The internal name of the achievement used in API requests. | [optional]
8
+ **title** | **String** | The display name for the achievement in the Campaign Manager. | [optional]
9
+ **description** | **String** | A description of the achievement. | [optional]
10
+ **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
11
+ **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. | [optional]
12
+ **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'TalonOne'
18
+
19
+ instance = TalonOne::UpdateAchievement.new(name: Order50Discount,
20
+ title: 50% off on 50th purchase.,
21
+ description: 50% off for every 50th purchase in a year.,
22
+ target: 50.0,
23
+ period: 1Y,
24
+ period_end_override: null)
25
+ ```
26
+
27
+
@@ -11,15 +11,14 @@ Name | Type | Description | Notes
11
11
  **case_sensitivity** | **String** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional]
12
12
  **attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
13
13
  **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional]
14
- **campaign_priority** | **String** | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. | [optional] [default to 'universal']
15
- **exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation. | [optional] [default to 'listOrder']
16
14
  **default_discount_scope** | **String** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional]
17
15
  **enable_cascading_discounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional]
18
- **enable_flattened_cart_items** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening). | [optional]
16
+ **enable_flattened_cart_items** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. | [optional]
19
17
  **attributes_settings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
20
18
  **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
21
19
  **enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional]
22
20
  **default_discount_additional_cost_per_item_scope** | **String** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional]
21
+ **default_evaluation_group_id** | **Integer** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional]
23
22
 
24
23
  ## Code Sample
25
24
 
@@ -33,15 +32,14 @@ instance = TalonOne::UpdateApplication.new(name: My Application,
33
32
  case_sensitivity: sensitive,
34
33
  attributes: null,
35
34
  limits: null,
36
- campaign_priority: universal,
37
- exclusive_campaigns_strategy: listOrder,
38
35
  default_discount_scope: sessionTotal,
39
36
  enable_cascading_discounts: true,
40
37
  enable_flattened_cart_items: true,
41
38
  attributes_settings: null,
42
39
  sandbox: true,
43
40
  enable_partial_discounts: false,
44
- default_discount_additional_cost_per_item_scope: price)
41
+ default_discount_additional_cost_per_item_scope: price,
42
+ default_evaluation_group_id: 3)
45
43
  ```
46
44
 
47
45
 
@@ -0,0 +1,17 @@
1
+ # TalonOne::UpdateApplicationAPIKey
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **time_offset** | **Integer** | 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. |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'TalonOne'
13
+
14
+ instance = TalonOne::UpdateApplicationAPIKey.new(time_offset: 100000)
15
+ ```
16
+
17
+
@@ -10,13 +10,16 @@ Name | Type | Description | Notes
10
10
  **end_time** | **DateTime** | Timestamp when the campaign will become inactive. | [optional]
11
11
  **attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
12
12
  **state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [optional] [default to 'enabled']
13
- **active_ruleset_id** | **Integer** | ID of Ruleset this campaign applies on customer session evaluation. | [optional]
13
+ **active_ruleset_id** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
14
14
  **tags** | **Array<String>** | A list of tags for the campaign. |
15
15
  **features** | **Array<String>** | A list of features for the campaign. |
16
16
  **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
17
17
  **referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
18
18
  **limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign. |
19
- **campaign_groups** | **Array<Integer>** | The IDs of the campaign groups that own this entity. | [optional]
19
+ **campaign_groups** | **Array<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional]
20
+ **evaluation_group_id** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
21
+ **type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced']
22
+ **linked_store_ids** | **Array<Integer>** | A list of store IDs that you want to link 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. | [optional]
20
23
 
21
24
  ## Code Sample
22
25
 
@@ -35,7 +38,10 @@ instance = TalonOne::UpdateCampaign.new(name: Summer promotions,
35
38
  coupon_settings: null,
36
39
  referral_settings: null,
37
40
  limits: null,
38
- campaign_groups: [4, 5])
41
+ campaign_groups: [1, 3],
42
+ evaluation_group_id: 2,
43
+ type: advanced,
44
+ linked_store_ids: [1, 2, 3])
39
45
  ```
40
46
 
41
47
 
@@ -0,0 +1,27 @@
1
+ # TalonOne::UpdateCampaignEvaluationGroup
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The name of the campaign evaluation group. |
8
+ **parent_id** | **Integer** | The ID of the parent group that contains the campaign evaluation group. |
9
+ **description** | **String** | A description of the campaign evaluation group. | [optional]
10
+ **evaluation_mode** | **String** | The mode by which campaigns in the campaign evaluation group are evaluated. |
11
+ **evaluation_scope** | **String** | The evaluation scope of the campaign evaluation group. |
12
+ **locked** | **Boolean** | An indicator of whether the campaign evaluation group is locked for modification. |
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'TalonOne'
18
+
19
+ instance = TalonOne::UpdateCampaignEvaluationGroup.new(name: Summer campaigns,
20
+ parent_id: 2,
21
+ description: This campaign evaluation group contains all campaigns that are running in the summer.,
22
+ evaluation_mode: null,
23
+ evaluation_scope: null,
24
+ locked: false)
25
+ ```
26
+
27
+
@@ -4,18 +4,18 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | The name of this campaign group. |
8
- **description** | **String** | A longer description of the campaign group. | [optional]
9
- **subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this campaign group is enabled for. | [optional]
10
- **campaign_ids** | **Array<Integer>** | A list of the IDs of the campaigns that this campaign group owns. | [optional]
7
+ **name** | **String** | The name of the campaign access group. |
8
+ **description** | **String** | A longer description of the campaign access group. | [optional]
9
+ **subscribed_applications_ids** | **Array<Integer>** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional]
10
+ **campaign_ids** | **Array<Integer>** | A list of IDs of the campaigns that are part of the campaign access group. | [optional]
11
11
 
12
12
  ## Code Sample
13
13
 
14
14
  ```ruby
15
15
  require 'TalonOne'
16
16
 
17
- instance = TalonOne::UpdateCampaignGroup.new(name: null,
18
- description: My campaign group.,
17
+ instance = TalonOne::UpdateCampaignGroup.new(name: Europe access group,
18
+ description: A group that gives access to all the campaigns for the Europe market.,
19
19
  subscribed_applications_ids: [1, 2, 3],
20
20
  campaign_ids: [4, 6, 8])
21
21
  ```
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
20
20
  **applications_ids** | **Array<Integer>** | A list of IDs of the Applications that are subscribed to this campaign template. |
21
21
  **campaign_collections** | [**Array<CampaignTemplateCollection>**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional]
22
22
  **default_campaign_group_id** | **Integer** | The default campaign group ID. | [optional]
23
+ **campaign_type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced']
23
24
 
24
25
  ## Code Sample
25
26
 
@@ -41,7 +42,8 @@ instance = TalonOne::UpdateCampaignTemplate.new(name: Discount campaign,
41
42
  template_params: null,
42
43
  applications_ids: [1, 2, 3],
43
44
  campaign_collections: null,
44
- default_campaign_group_id: 42)
45
+ default_campaign_group_id: 42,
46
+ campaign_type: advanced)
45
47
  ```
46
48
 
47
49
 
data/docs/UpdateCoupon.md CHANGED
@@ -12,7 +12,8 @@ Name | Type | Description | Notes
12
12
  **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
13
13
  **recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional]
14
14
  **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
15
- **is_reservation_mandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true]
15
+ **is_reservation_mandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to false]
16
+ **implicitly_reserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional]
16
17
 
17
18
  ## Code Sample
18
19
 
@@ -27,7 +28,8 @@ instance = TalonOne::UpdateCoupon.new(usage_limit: 100,
27
28
  limits: null,
28
29
  recipient_integration_id: URNGV8294NV,
29
30
  attributes: null,
30
- is_reservation_mandatory: false)
31
+ is_reservation_mandatory: false,
32
+ implicitly_reserved: false)
31
33
  ```
32
34
 
33
35
 
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
9
9
  **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
10
10
  **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
11
11
  **expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
12
- **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
13
- **batch_id** | **String** | The id of the batch the coupon belongs to. | [optional]
12
+ **attributes** | [**Object**](.md) | Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. | [optional]
13
+ **batch_id** | **String** | The ID of the batch the coupon(s) belong to. | [optional]
14
14
 
15
15
  ## Code Sample
16
16
 
@@ -12,6 +12,10 @@ Name | Type | Description | Notes
12
12
  **allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
13
13
  **users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
14
14
  **sandbox** | **Boolean** | 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. | [optional]
15
+ **tiers_expiration_policy** | **String** | 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. | [optional]
16
+ **tiers_expire_in** | **String** | 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. | [optional]
17
+ **tiers_downgrade_policy** | **String** | 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. | [optional]
18
+ **program_join_policy** | **String** | 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. | [optional]
15
19
  **tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional]
16
20
 
17
21
  ## Code Sample
@@ -27,6 +31,10 @@ instance = TalonOne::UpdateLoyaltyProgram.new(title: Point collection,
27
31
  allow_subledger: false,
28
32
  users_per_card_limit: 111,
29
33
  sandbox: true,
34
+ tiers_expiration_policy: null,
35
+ tiers_expire_in: 27W_U,
36
+ tiers_downgrade_policy: null,
37
+ program_join_policy: null,
30
38
  tiers: null)
31
39
  ```
32
40
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **type** | **String** | The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. |
7
+ **type** | **String** | The type of allowed values in the picklist. If the type `time` is chosen, it must be an RFC3339 timestamp string. |
8
8
  **values** | **Array<String>** | The list of allowed values provided by this picklist. |
9
9
 
10
10
  ## Code Sample
@@ -0,0 +1,21 @@
1
+ # TalonOne::UpdateStore
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The name of the store. |
8
+ **description** | **String** | The description of the store. |
9
+ **attributes** | [**Object**](.md) | The attributes of the store. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'TalonOne'
15
+
16
+ instance = TalonOne::UpdateStore.new(name: South US store,
17
+ description: This is the description of the store in south US.,
18
+ attributes: {"country":"USA","code":1234})
19
+ ```
20
+
21
+
data/docs/UpdateUser.md CHANGED
@@ -4,11 +4,12 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | The user name. | [optional]
8
- **policy** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. | [optional]
9
- **state** | **String** | New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. | [optional]
10
- **roles** | **Array<Integer>** | List of roles to assign to the user. | [optional]
11
- **application_notification_subscriptions** | [**Object**](.md) | | [optional]
7
+ **name** | **String** | Name of the user. | [optional]
8
+ **state** | **String** | The state of the user. - `deactivated`: The user has been deactivated. - `active`: The user is active. **Note**: Only `admin` users can update the state of another user. | [optional]
9
+ **is_admin** | **Boolean** | Indicates whether the user is an `admin`. | [optional]
10
+ **policy** | **String** | Indicates the access level of the user. | [optional]
11
+ **roles** | **Array<Integer>** | A list of the IDs of the roles assigned to the user. **Note**: Use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint to find the ID of a role. | [optional]
12
+ **application_notification_subscriptions** | [**Object**](.md) | Application notifications that the user is subscribed to. | [optional]
12
13
 
13
14
  ## Code Sample
14
15
 
@@ -16,8 +17,9 @@ Name | Type | Description | Notes
16
17
  require 'TalonOne'
17
18
 
18
19
  instance = TalonOne::UpdateUser.new(name: John Doe,
19
- policy: ,
20
20
  state: deactivated,
21
+ is_admin: false,
22
+ policy: ,
21
23
  roles: [1, 3],
22
24
  application_notification_subscriptions: null)
23
25
  ```
data/docs/User.md CHANGED
@@ -7,16 +7,19 @@ Name | Type | Description | Notes
7
7
  **id** | **Integer** | Internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **modified** | **DateTime** | The time this entity was last modified. |
10
- **email** | **String** | The email address associated with your account. |
10
+ **email** | **String** | The email address associated with the user profile. |
11
11
  **account_id** | **Integer** | The ID of the account that owns this entity. |
12
- **invite_token** | **String** | Invite token, empty if the user as already accepted their invite. |
13
- **state** | **String** | Current user state. |
14
- **name** | **String** | Full name |
15
- **policy** | [**Object**](.md) | User ACL Policy |
16
- **latest_feed_timestamp** | **DateTime** | Latest timestamp the user has been notified for feed. | [optional]
17
- **roles** | **Array<Integer>** | Contains a list of all roles the user is a member of. | [optional]
18
- **application_notification_subscriptions** | [**Object**](.md) | | [optional]
19
- **auth_method** | **String** | The Authentication method for this user. | [optional]
12
+ **name** | **String** | Name of the user. |
13
+ **state** | **String** | State of the user. |
14
+ **invite_token** | **String** | Invitation token of the user. **Note**: If the user has already accepted their invitation, this is `null`. |
15
+ **is_admin** | **Boolean** | Indicates whether the user is an `admin`. | [optional]
16
+ **policy** | [**Object**](.md) | Access level of the user. |
17
+ **roles** | **Array<Integer>** | A list of the IDs of the roles assigned to the user. | [optional]
18
+ **auth_method** | **String** | Authentication method for this user. | [optional]
19
+ **application_notification_subscriptions** | [**Object**](.md) | Application notifications that the user is subscribed to. | [optional]
20
+ **last_signed_in** | **DateTime** | Timestamp when the user last signed in to Talon.One. | [optional]
21
+ **last_accessed** | **DateTime** | Timestamp of the user's last activity after signing in to Talon.One. | [optional]
22
+ **latest_feed_timestamp** | **DateTime** | Timestamp when the user was notified for feed. | [optional]
20
23
 
21
24
  ## Code Sample
22
25
 
@@ -28,14 +31,17 @@ instance = TalonOne::User.new(id: 6,
28
31
  modified: 2021-09-12T10:12:42Z,
29
32
  email: john.doe@example.com,
30
33
  account_id: 3886,
31
- invite_token: Gy9b8w1irmQtEPo5RmbMmSPheL5h4,
32
- state: invited,
33
34
  name: John Doe,
35
+ state: invited,
36
+ invite_token: Gy9b8w1irmQtEPo5RmbMmSPheL5h4,
37
+ is_admin: false,
34
38
  policy: {"Role":127},
35
- latest_feed_timestamp: 2020-06-01T00:00Z,
36
39
  roles: [71],
40
+ auth_method: basic_auth,
37
41
  application_notification_subscriptions: null,
38
- auth_method: basic_auth)
42
+ last_signed_in: 2021-09-12T10:12:42Z,
43
+ last_accessed: 2021-09-12T10:14:42Z,
44
+ latest_feed_timestamp: 2020-06-01T00:00Z)
39
45
  ```
40
46
 
41
47