talon_one 7.0.0 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (360) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -12
  3. data/docs/Achievement.md +6 -4
  4. data/docs/AchievementAdditionalProperties.md +5 -3
  5. data/docs/AchievementBase.md +35 -0
  6. data/docs/AchievementProgress.md +3 -15
  7. data/docs/AchievementProgressWithDefinition.md +45 -0
  8. data/docs/AchievementStatusEntry.md +45 -0
  9. data/docs/AddFreeItemEffectProps.md +3 -1
  10. data/docs/AdditionalCampaignProperties.md +4 -2
  11. data/docs/AnalyticsProduct.md +6 -6
  12. data/docs/AnalyticsSKU.md +23 -0
  13. data/docs/ApplicationCIF.md +1 -1
  14. data/docs/ApplicationCIFExpression.md +1 -1
  15. data/docs/ApplicationCIFReferences.md +19 -0
  16. data/docs/ApplicationEntity.md +1 -1
  17. data/docs/ApplicationEvent.md +1 -1
  18. data/docs/ApplicationReferee.md +1 -1
  19. data/docs/ApplicationSession.md +2 -2
  20. data/docs/Audience.md +1 -1
  21. data/docs/BaseLoyaltyProgram.md +1 -1
  22. data/docs/Binding.md +1 -1
  23. data/docs/Campaign.md +4 -2
  24. data/docs/CampaignDetail.md +19 -0
  25. data/docs/CampaignEvaluationGroup.md +1 -1
  26. data/docs/CampaignNotificationPolicy.md +3 -1
  27. data/docs/CampaignSet.md +1 -1
  28. data/docs/CampaignStoreBudget.md +1 -1
  29. data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
  30. data/docs/CampaignTemplate.md +3 -1
  31. data/docs/CardExpiringPointsNotificationPolicy.md +3 -1
  32. data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
  33. data/docs/CouponCreationJob.md +1 -1
  34. data/docs/CouponDeletionJob.md +1 -1
  35. data/docs/CouponsNotificationPolicy.md +5 -1
  36. data/docs/CreateAchievement.md +1 -1
  37. data/docs/CustomerInventory.md +1 -1
  38. data/docs/CustomerSession.md +1 -1
  39. data/docs/CustomerSessionV2.md +2 -4
  40. data/docs/Environment.md +1 -1
  41. data/docs/Event.md +1 -1
  42. data/docs/ExpiringCouponsNotificationPolicy.md +3 -1
  43. data/docs/ExpiringPointsNotificationPolicy.md +3 -1
  44. data/docs/HiddenConditionsEffects.md +23 -0
  45. data/docs/InlineResponse2001.md +3 -3
  46. data/docs/InlineResponse20010.md +3 -3
  47. data/docs/InlineResponse20011.md +3 -3
  48. data/docs/InlineResponse20012.md +1 -1
  49. data/docs/InlineResponse20013.md +1 -1
  50. data/docs/InlineResponse20014.md +1 -1
  51. data/docs/InlineResponse20015.md +3 -3
  52. data/docs/InlineResponse20016.md +3 -3
  53. data/docs/InlineResponse20017.md +3 -5
  54. data/docs/InlineResponse20018.md +2 -2
  55. data/docs/InlineResponse20019.md +3 -3
  56. data/docs/InlineResponse2002.md +3 -3
  57. data/docs/InlineResponse20020.md +5 -3
  58. data/docs/InlineResponse20021.md +3 -5
  59. data/docs/InlineResponse20022.md +2 -4
  60. data/docs/InlineResponse20023.md +3 -5
  61. data/docs/InlineResponse20024.md +5 -3
  62. data/docs/InlineResponse20025.md +4 -2
  63. data/docs/InlineResponse20026.md +3 -1
  64. data/docs/InlineResponse20027.md +1 -1
  65. data/docs/InlineResponse20028.md +3 -3
  66. data/docs/InlineResponse20029.md +1 -3
  67. data/docs/InlineResponse2003.md +1 -1
  68. data/docs/InlineResponse20030.md +2 -2
  69. data/docs/InlineResponse20031.md +3 -3
  70. data/docs/InlineResponse20032.md +1 -1
  71. data/docs/InlineResponse20033.md +3 -3
  72. data/docs/InlineResponse20034.md +1 -3
  73. data/docs/InlineResponse20035.md +5 -3
  74. data/docs/InlineResponse20036.md +1 -1
  75. data/docs/InlineResponse20037.md +5 -3
  76. data/docs/InlineResponse20038.md +1 -1
  77. data/docs/InlineResponse20039.md +1 -1
  78. data/docs/InlineResponse2004.md +1 -1
  79. data/docs/InlineResponse20040.md +1 -1
  80. data/docs/InlineResponse20041.md +2 -4
  81. data/docs/InlineResponse20042.md +1 -1
  82. data/docs/InlineResponse20043.md +1 -1
  83. data/docs/InlineResponse20044.md +4 -4
  84. data/docs/InlineResponse20045.md +3 -3
  85. data/docs/InlineResponse20046.md +3 -3
  86. data/docs/InlineResponse20047.md +5 -3
  87. data/docs/InlineResponse20048.md +19 -0
  88. data/docs/InlineResponse20049.md +19 -0
  89. data/docs/InlineResponse2005.md +3 -3
  90. data/docs/InlineResponse2006.md +3 -3
  91. data/docs/InlineResponse2007.md +1 -1
  92. data/docs/InlineResponse2008.md +1 -1
  93. data/docs/InlineResponse2009.md +3 -3
  94. data/docs/IntegrationApi.md +159 -19
  95. data/docs/LedgerInfo.md +4 -0
  96. data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
  97. data/docs/LimitCounter.md +1 -1
  98. data/docs/LoyaltyBalance.md +3 -1
  99. data/docs/LoyaltyBalanceWithTier.md +2 -0
  100. data/docs/LoyaltyBalances.md +1 -1
  101. data/docs/LoyaltyBalancesWithTiers.md +1 -1
  102. data/docs/LoyaltyCardBalances.md +1 -1
  103. data/docs/LoyaltyLedger.md +1 -1
  104. data/docs/LoyaltyLedgerEntry.md +3 -1
  105. data/docs/LoyaltyLedgerEntryFlags.md +17 -0
  106. data/docs/LoyaltyProgram.md +1 -1
  107. data/docs/LoyaltyProgramBalance.md +5 -1
  108. data/docs/LoyaltyProgramTransaction.md +3 -1
  109. data/docs/LoyaltySubLedger.md +2 -0
  110. data/docs/ManagementApi.md +345 -436
  111. data/docs/ManagementKey.md +3 -1
  112. data/docs/MessageTest.md +27 -0
  113. data/docs/ModelReturn.md +1 -1
  114. data/docs/NewAudience.md +1 -1
  115. data/docs/NewCampaignSet.md +1 -1
  116. data/docs/NewLoyaltyProgram.md +1 -1
  117. data/docs/NewManagementKey.md +2 -0
  118. data/docs/NewMessageTest.md +29 -0
  119. data/docs/PendingPointsNotificationPolicy.md +3 -1
  120. data/docs/ProductSearchMatch.md +2 -2
  121. data/docs/ProductUnitAnalytics.md +4 -10
  122. data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
  123. data/docs/ProductUnitAnalyticsTotals.md +17 -0
  124. data/docs/SkuUnitAnalytics.md +19 -0
  125. data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
  126. data/docs/Store.md +1 -1
  127. data/docs/StrikethroughEffect.md +5 -1
  128. data/docs/StrikethroughLabelingNotification.md +6 -2
  129. data/docs/SummaryCampaignStoreBudget.md +3 -1
  130. data/docs/TemplateDef.md +1 -1
  131. data/docs/TierDowngradeNotificationPolicy.md +3 -1
  132. data/docs/TierUpgradeNotificationPolicy.md +3 -1
  133. data/docs/TierWillDowngradeNotificationPolicy.md +2 -0
  134. data/docs/UpdateAchievement.md +2 -2
  135. data/docs/UpdateLoyaltyProgram.md +1 -1
  136. data/lib/talon_one/api/integration_api.rb +223 -29
  137. data/lib/talon_one/api/management_api.rb +434 -518
  138. data/lib/talon_one/models/achievement.rb +27 -15
  139. data/lib/talon_one/models/achievement_additional_properties.rb +49 -10
  140. data/lib/talon_one/models/achievement_base.rb +377 -0
  141. data/lib/talon_one/models/achievement_progress.rb +4 -137
  142. data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
  143. data/lib/talon_one/models/achievement_status_entry.rb +472 -0
  144. data/lib/talon_one/models/add_free_item_effect_props.rb +14 -4
  145. data/lib/talon_one/models/additional_campaign_properties.rb +16 -9
  146. data/lib/talon_one/models/analytics_product.rb +20 -21
  147. data/lib/talon_one/models/analytics_sku.rb +246 -0
  148. data/lib/talon_one/models/application_api_key.rb +2 -2
  149. data/lib/talon_one/models/application_cif.rb +1 -1
  150. data/lib/talon_one/models/application_cif_expression.rb +1 -1
  151. data/lib/talon_one/models/application_cif_references.rb +219 -0
  152. data/lib/talon_one/models/application_entity.rb +1 -1
  153. data/lib/talon_one/models/application_event.rb +1 -1
  154. data/lib/talon_one/models/application_referee.rb +1 -1
  155. data/lib/talon_one/models/application_session.rb +2 -2
  156. data/lib/talon_one/models/audience.rb +1 -1
  157. data/lib/talon_one/models/base_loyalty_program.rb +3 -3
  158. data/lib/talon_one/models/campaign.rb +14 -7
  159. data/lib/talon_one/models/campaign_detail.rb +232 -0
  160. data/lib/talon_one/models/campaign_evaluation_group.rb +1 -1
  161. data/lib/talon_one/models/campaign_notification_policy.rb +14 -4
  162. data/lib/talon_one/models/campaign_set.rb +1 -1
  163. data/lib/talon_one/models/campaign_store_budget.rb +1 -1
  164. data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
  165. data/lib/talon_one/models/campaign_template.rb +16 -4
  166. data/lib/talon_one/models/card_expiring_points_notification_policy.rb +14 -4
  167. data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +38 -4
  168. data/lib/talon_one/models/coupon_creation_job.rb +1 -1
  169. data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
  170. data/lib/talon_one/models/coupons_notification_policy.rb +24 -4
  171. data/lib/talon_one/models/create_achievement.rb +0 -5
  172. data/lib/talon_one/models/create_application_api_key.rb +2 -2
  173. data/lib/talon_one/models/customer_inventory.rb +1 -1
  174. data/lib/talon_one/models/customer_session.rb +1 -1
  175. data/lib/talon_one/models/customer_session_v2.rb +5 -15
  176. data/lib/talon_one/models/delete_user_request.rb +0 -1
  177. data/lib/talon_one/models/environment.rb +1 -1
  178. data/lib/talon_one/models/event.rb +1 -1
  179. data/lib/talon_one/models/expiring_coupons_notification_policy.rb +14 -4
  180. data/lib/talon_one/models/expiring_points_notification_policy.rb +14 -4
  181. data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
  182. data/lib/talon_one/models/inline_response2001.rb +11 -11
  183. data/lib/talon_one/models/inline_response20010.rb +11 -11
  184. data/lib/talon_one/models/inline_response20011.rb +11 -11
  185. data/lib/talon_one/models/inline_response20012.rb +1 -1
  186. data/lib/talon_one/models/inline_response20013.rb +1 -1
  187. data/lib/talon_one/models/inline_response20014.rb +1 -1
  188. data/lib/talon_one/models/inline_response20015.rb +11 -11
  189. data/lib/talon_one/models/inline_response20016.rb +11 -13
  190. data/lib/talon_one/models/inline_response20017.rb +7 -11
  191. data/lib/talon_one/models/inline_response20018.rb +1 -1
  192. data/lib/talon_one/models/inline_response20019.rb +3 -1
  193. data/lib/talon_one/models/inline_response2002.rb +11 -11
  194. data/lib/talon_one/models/inline_response20020.rb +11 -7
  195. data/lib/talon_one/models/inline_response20021.rb +7 -11
  196. data/lib/talon_one/models/inline_response20022.rb +7 -11
  197. data/lib/talon_one/models/inline_response20023.rb +7 -11
  198. data/lib/talon_one/models/inline_response20024.rb +11 -7
  199. data/lib/talon_one/models/inline_response20025.rb +11 -7
  200. data/lib/talon_one/models/inline_response20026.rb +11 -2
  201. data/lib/talon_one/models/inline_response20027.rb +1 -1
  202. data/lib/talon_one/models/inline_response20028.rb +11 -11
  203. data/lib/talon_one/models/inline_response20029.rb +2 -11
  204. data/lib/talon_one/models/inline_response2003.rb +1 -1
  205. data/lib/talon_one/models/inline_response20030.rb +6 -1
  206. data/lib/talon_one/models/inline_response20031.rb +13 -8
  207. data/lib/talon_one/models/inline_response20032.rb +1 -1
  208. data/lib/talon_one/models/inline_response20033.rb +8 -13
  209. data/lib/talon_one/models/inline_response20034.rb +2 -11
  210. data/lib/talon_one/models/inline_response20035.rb +11 -7
  211. data/lib/talon_one/models/inline_response20036.rb +1 -1
  212. data/lib/talon_one/models/inline_response20037.rb +11 -7
  213. data/lib/talon_one/models/inline_response20038.rb +1 -1
  214. data/lib/talon_one/models/inline_response20039.rb +1 -1
  215. data/lib/talon_one/models/inline_response2004.rb +1 -1
  216. data/lib/talon_one/models/inline_response20040.rb +1 -1
  217. data/lib/talon_one/models/inline_response20041.rb +7 -11
  218. data/lib/talon_one/models/inline_response20042.rb +1 -1
  219. data/lib/talon_one/models/inline_response20043.rb +1 -1
  220. data/lib/talon_one/models/inline_response20044.rb +11 -11
  221. data/lib/talon_one/models/inline_response20045.rb +13 -8
  222. data/lib/talon_one/models/inline_response20046.rb +11 -11
  223. data/lib/talon_one/models/inline_response20047.rb +11 -7
  224. data/lib/talon_one/models/inline_response20048.rb +222 -0
  225. data/lib/talon_one/models/inline_response20049.rb +227 -0
  226. data/lib/talon_one/models/inline_response2005.rb +11 -11
  227. data/lib/talon_one/models/inline_response2006.rb +11 -11
  228. data/lib/talon_one/models/inline_response2007.rb +1 -1
  229. data/lib/talon_one/models/inline_response2008.rb +1 -1
  230. data/lib/talon_one/models/inline_response2009.rb +11 -11
  231. data/lib/talon_one/models/ledger_info.rb +31 -1
  232. data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
  233. data/lib/talon_one/models/limit_counter.rb +1 -1
  234. data/lib/talon_one/models/loyalty_balance.rb +14 -4
  235. data/lib/talon_one/models/loyalty_balance_with_tier.rb +11 -1
  236. data/lib/talon_one/models/loyalty_ledger_entry.rb +13 -4
  237. data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
  238. data/lib/talon_one/models/loyalty_program.rb +3 -3
  239. data/lib/talon_one/models/loyalty_program_balance.rb +34 -4
  240. data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
  241. data/lib/talon_one/models/loyalty_sub_ledger.rb +16 -1
  242. data/lib/talon_one/models/management_key.rb +14 -4
  243. data/lib/talon_one/models/message_test.rb +227 -0
  244. data/lib/talon_one/models/model_return.rb +1 -1
  245. data/lib/talon_one/models/new_application_api_key.rb +2 -2
  246. data/lib/talon_one/models/new_audience.rb +1 -1
  247. data/lib/talon_one/models/new_campaign_set.rb +1 -1
  248. data/lib/talon_one/models/new_loyalty_program.rb +3 -3
  249. data/lib/talon_one/models/new_management_key.rb +11 -1
  250. data/lib/talon_one/models/new_message_test.rb +322 -0
  251. data/lib/talon_one/models/pending_points_notification_policy.rb +14 -4
  252. data/lib/talon_one/models/product.rb +0 -19
  253. data/lib/talon_one/models/product_search_match.rb +1 -6
  254. data/lib/talon_one/models/product_unit_analytics.rb +21 -65
  255. data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
  256. data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
  257. data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
  258. data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
  259. data/lib/talon_one/models/store.rb +1 -1
  260. data/lib/talon_one/models/strikethrough_effect.rb +24 -4
  261. data/lib/talon_one/models/strikethrough_labeling_notification.rb +56 -2
  262. data/lib/talon_one/models/summary_campaign_store_budget.rb +18 -4
  263. data/lib/talon_one/models/template_def.rb +1 -1
  264. data/lib/talon_one/models/tier_downgrade_notification_policy.rb +14 -4
  265. data/lib/talon_one/models/tier_upgrade_notification_policy.rb +14 -4
  266. data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +11 -1
  267. data/lib/talon_one/models/update_achievement.rb +2 -2
  268. data/lib/talon_one/models/update_loyalty_program.rb +3 -3
  269. data/lib/talon_one/version.rb +1 -1
  270. data/lib/talon_one.rb +20 -5
  271. data/spec/api/integration_api_spec.rb +46 -9
  272. data/spec/api/management_api_spec.rb +132 -144
  273. data/spec/models/achievement_additional_properties_spec.rb +10 -0
  274. data/spec/models/achievement_base_spec.rb +103 -0
  275. data/spec/models/achievement_progress_spec.rb +1 -37
  276. data/spec/models/achievement_progress_with_definition_spec.rb +137 -0
  277. data/spec/models/achievement_spec.rb +10 -0
  278. data/spec/models/achievement_status_entry_spec.rb +137 -0
  279. data/spec/models/add_free_item_effect_props_spec.rb +6 -0
  280. data/spec/models/additional_campaign_properties_spec.rb +6 -0
  281. data/spec/models/analytics_product_spec.rb +3 -3
  282. data/spec/models/analytics_sku_spec.rb +59 -0
  283. data/spec/models/application_api_key_spec.rb +1 -1
  284. data/spec/models/application_cif_references_spec.rb +47 -0
  285. data/spec/models/base_loyalty_program_spec.rb +1 -1
  286. data/spec/models/campaign_detail_spec.rb +47 -0
  287. data/spec/models/campaign_notification_policy_spec.rb +6 -0
  288. data/spec/models/campaign_spec.rb +6 -0
  289. data/spec/models/campaign_store_budget_limit_config_spec.rb +73 -0
  290. data/spec/models/campaign_template_spec.rb +6 -0
  291. data/spec/models/card_expiring_points_notification_policy_spec.rb +6 -0
  292. data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
  293. data/spec/models/coupons_notification_policy_spec.rb +12 -0
  294. data/spec/models/create_application_api_key_spec.rb +1 -1
  295. data/spec/models/customer_session_v2_spec.rb +0 -6
  296. data/spec/models/expiring_coupons_notification_policy_spec.rb +6 -0
  297. data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
  298. data/spec/models/hidden_conditions_effects_spec.rb +59 -0
  299. data/spec/models/inline_response20010_spec.rb +1 -1
  300. data/spec/models/inline_response20011_spec.rb +1 -1
  301. data/spec/models/inline_response20015_spec.rb +1 -1
  302. data/spec/models/inline_response20016_spec.rb +1 -1
  303. data/spec/models/inline_response20017_spec.rb +0 -6
  304. data/spec/models/inline_response2001_spec.rb +1 -1
  305. data/spec/models/inline_response20020_spec.rb +6 -0
  306. data/spec/models/inline_response20021_spec.rb +0 -6
  307. data/spec/models/inline_response20022_spec.rb +0 -6
  308. data/spec/models/inline_response20023_spec.rb +0 -6
  309. data/spec/models/inline_response20024_spec.rb +6 -0
  310. data/spec/models/inline_response20025_spec.rb +6 -0
  311. data/spec/models/inline_response20026_spec.rb +6 -0
  312. data/spec/models/inline_response20028_spec.rb +1 -1
  313. data/spec/models/inline_response20029_spec.rb +0 -6
  314. data/spec/models/inline_response2002_spec.rb +1 -1
  315. data/spec/models/inline_response20031_spec.rb +1 -1
  316. data/spec/models/inline_response20033_spec.rb +1 -1
  317. data/spec/models/inline_response20034_spec.rb +0 -6
  318. data/spec/models/inline_response20035_spec.rb +6 -0
  319. data/spec/models/inline_response20037_spec.rb +6 -0
  320. data/spec/models/inline_response20041_spec.rb +0 -6
  321. data/spec/models/inline_response20044_spec.rb +2 -2
  322. data/spec/models/inline_response20045_spec.rb +1 -1
  323. data/spec/models/inline_response20046_spec.rb +1 -1
  324. data/spec/models/inline_response20047_spec.rb +6 -0
  325. data/spec/models/inline_response20048_spec.rb +47 -0
  326. data/spec/models/inline_response20049_spec.rb +47 -0
  327. data/spec/models/inline_response2005_spec.rb +1 -1
  328. data/spec/models/inline_response2006_spec.rb +1 -1
  329. data/spec/models/inline_response2009_spec.rb +1 -1
  330. data/spec/models/ledger_info_spec.rb +12 -0
  331. data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
  332. data/spec/models/loyalty_balance_spec.rb +6 -0
  333. data/spec/models/loyalty_balance_with_tier_spec.rb +6 -0
  334. data/spec/models/loyalty_ledger_entry_flags_spec.rb +41 -0
  335. data/spec/models/loyalty_ledger_entry_spec.rb +6 -0
  336. data/spec/models/loyalty_program_balance_spec.rb +12 -0
  337. data/spec/models/loyalty_program_spec.rb +1 -1
  338. data/spec/models/loyalty_program_transaction_spec.rb +6 -0
  339. data/spec/models/loyalty_sub_ledger_spec.rb +6 -0
  340. data/spec/models/management_key_spec.rb +6 -0
  341. data/spec/models/message_test_spec.rb +47 -0
  342. data/spec/models/new_application_api_key_spec.rb +1 -1
  343. data/spec/models/new_loyalty_program_spec.rb +1 -1
  344. data/spec/models/new_management_key_spec.rb +6 -0
  345. data/spec/models/new_message_test_spec.rb +79 -0
  346. data/spec/models/pending_points_notification_policy_spec.rb +6 -0
  347. data/spec/models/product_unit_analytics_data_point_spec.rb +65 -0
  348. data/spec/models/product_unit_analytics_spec.rb +2 -20
  349. data/spec/models/product_unit_analytics_totals_spec.rb +41 -0
  350. data/spec/models/revision_activation_request_spec.rb +47 -0
  351. data/spec/models/sku_unit_analytics_data_point_spec.rb +59 -0
  352. data/spec/models/sku_unit_analytics_spec.rb +47 -0
  353. data/spec/models/strikethrough_effect_spec.rb +12 -0
  354. data/spec/models/strikethrough_labeling_notification_spec.rb +16 -0
  355. data/spec/models/summary_campaign_store_budget_spec.rb +6 -0
  356. data/spec/models/tier_downgrade_notification_policy_spec.rb +6 -0
  357. data/spec/models/tier_upgrade_notification_policy_spec.rb +6 -0
  358. data/spec/models/tier_will_downgrade_notification_policy_spec.rb +6 -0
  359. data/spec/models/update_loyalty_program_spec.rb +1 -1
  360. metadata +578 -508
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ac51b11122c2ed813f4e68669a5528b5e2cf12a9194235a22b743b24fe38f1f1
4
- data.tar.gz: e029dab6166dcb56464990fbda7ffa0bc73f97f7d35f12b4608daaa06608e5b1
3
+ metadata.gz: 1d35e72926d5a93c5ed6c2227584ccdac124132a669318106b4855af180e46e0
4
+ data.tar.gz: bc9801a5b3f49dc36088b916509be5c544179c7826b0b1585287463b981a07a7
5
5
  SHA512:
6
- metadata.gz: 760bcb7a9b623c8e54ec02196eb467bf48a0cbb58143169a0795addf62677ade0103a135fa255599d515100916ca2c467a795e9d10e510e72307e2ebcd80b722
7
- data.tar.gz: c3512d70a8d90a401e2f05a8cb7b37f1dbe20779509186e2e55b672e81c402cb90ddaae3cbc0283a95896559f7236583be33cfd61f60165cd6968e9327eeb333
6
+ metadata.gz: 722ce13ea2285cba0eaa3696098a9d4af557da4eb86f5896ed2a07b4ffe9a29f9950ec71b241089bc833c19767d714b3321e50c27ab3197169719eaf524a590c
7
+ data.tar.gz: 2eee4833dda82e73638015297df148b29f16a6c84a12147e0a4bf6ab74945d7b217b806bcd30b2d9bb0d80439d83f4ed2de97d63023395c8ac47faf655e1768e
data/README.md CHANGED
@@ -9,7 +9,7 @@ This SDK supports all of the operations of Talon.One's Integration API and Manag
9
9
  Add this to the Gemfile:
10
10
 
11
11
  ```shell
12
- gem 'talon_one', '~> 7.0.0'
12
+ gem 'talon_one', '~> 9.0.0'
13
13
  ```
14
14
 
15
15
  ### Build a gem
@@ -25,10 +25,10 @@ gem build talon_one.gemspec
25
25
  To install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./talon_one-7.0.0.gem
28
+ gem install ./talon_one-9.0.0.gem
29
29
  ```
30
30
 
31
- For development, run `gem install --dev ./talon_one-7.0.0.gem` to install the development dependencies.
31
+ For development, run `gem install --dev ./talon_one-9.0.0.gem` to install the development dependencies.
32
32
 
33
33
  ### RubyGems
34
34
 
@@ -182,6 +182,8 @@ Class | Method | HTTP request | Description
182
182
  *TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
183
183
  *TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data
184
184
  *TalonOne::IntegrationApi* | [**generate_loyalty_card**](docs/IntegrationApi.md#generate_loyalty_card) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card
185
+ *TalonOne::IntegrationApi* | [**get_customer_achievement_history**](docs/IntegrationApi.md#get_customer_achievement_history) | **GET** /v1/customer_profiles/{integrationId}/achievements/{achievementId} | List customer's achievement history
186
+ *TalonOne::IntegrationApi* | [**get_customer_achievements**](docs/IntegrationApi.md#get_customer_achievements) | **GET** /v1/customer_profiles/{integrationId}/achievements | List customer's available achievements
185
187
  *TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
186
188
  *TalonOne::IntegrationApi* | [**get_customer_session**](docs/IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
187
189
  *TalonOne::IntegrationApi* | [**get_loyalty_balances**](docs/IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances
@@ -295,6 +297,7 @@ Class | Method | HTTP request | Description
295
297
  *TalonOne::ManagementApi* | [**get_customer_profile_achievement_progress**](docs/ManagementApi.md#get_customer_profile_achievement_progress) | **GET** /v1/applications/{applicationId}/achievement_progress/{integrationId} | List customer achievements
296
298
  *TalonOne::ManagementApi* | [**get_customer_profiles**](docs/ManagementApi.md#get_customer_profiles) | **GET** /v1/customers/no_total | List customer profiles
297
299
  *TalonOne::ManagementApi* | [**get_customers_by_attributes**](docs/ManagementApi.md#get_customers_by_attributes) | **POST** /v1/customer_search/no_total | List customer profiles matching the given attributes
300
+ *TalonOne::ManagementApi* | [**get_dashboard_statistics**](docs/ManagementApi.md#get_dashboard_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/dashboard | Get statistics for loyalty dashboard
298
301
  *TalonOne::ManagementApi* | [**get_event_types**](docs/ManagementApi.md#get_event_types) | **GET** /v1/event_types | List event types
299
302
  *TalonOne::ManagementApi* | [**get_exports**](docs/ManagementApi.md#get_exports) | **GET** /v1/exports | Get exports
300
303
  *TalonOne::ManagementApi* | [**get_loyalty_card**](docs/ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card
@@ -305,6 +308,7 @@ Class | Method | HTTP request | Description
305
308
  *TalonOne::ManagementApi* | [**get_loyalty_program_transactions**](docs/ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions
306
309
  *TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
307
310
  *TalonOne::ManagementApi* | [**get_loyalty_statistics**](docs/ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
311
+ *TalonOne::ManagementApi* | [**get_message_logs**](docs/ManagementApi.md#get_message_logs) | **GET** /v1/message_logs | List message log entries
308
312
  *TalonOne::ManagementApi* | [**get_referrals_without_total_count**](docs/ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
309
313
  *TalonOne::ManagementApi* | [**get_role_v2**](docs/ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
310
314
  *TalonOne::ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
@@ -335,11 +339,7 @@ Class | Method | HTTP request | Description
335
339
  *TalonOne::ManagementApi* | [**list_collections**](docs/ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
336
340
  *TalonOne::ManagementApi* | [**list_collections_in_application**](docs/ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
337
341
  *TalonOne::ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
338
- *TalonOne::ManagementApi* | [**notification_activation**](docs/ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
339
342
  *TalonOne::ManagementApi* | [**okta_event_handler_challenge**](docs/ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
340
- *TalonOne::ManagementApi* | [**post_added_deducted_points_notification**](docs/ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
341
- *TalonOne::ManagementApi* | [**post_catalogs_strikethrough_notification**](docs/ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
342
- *TalonOne::ManagementApi* | [**post_pending_points_notification**](docs/ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
343
343
  *TalonOne::ManagementApi* | [**remove_loyalty_points**](docs/ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
344
344
  *TalonOne::ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
345
345
  *TalonOne::ManagementApi* | [**scim_create_user**](docs/ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
@@ -387,7 +387,10 @@ Class | Method | HTTP request | Description
387
387
  - [TalonOne::AccountLimits](docs/AccountLimits.md)
388
388
  - [TalonOne::Achievement](docs/Achievement.md)
389
389
  - [TalonOne::AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md)
390
+ - [TalonOne::AchievementBase](docs/AchievementBase.md)
390
391
  - [TalonOne::AchievementProgress](docs/AchievementProgress.md)
392
+ - [TalonOne::AchievementProgressWithDefinition](docs/AchievementProgressWithDefinition.md)
393
+ - [TalonOne::AchievementStatusEntry](docs/AchievementStatusEntry.md)
391
394
  - [TalonOne::AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md)
392
395
  - [TalonOne::AddItemCatalogAction](docs/AddItemCatalogAction.md)
393
396
  - [TalonOne::AddLoyaltyPoints](docs/AddLoyaltyPoints.md)
@@ -401,13 +404,14 @@ Class | Method | HTTP request | Description
401
404
  - [TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate](docs/AnalyticsDataPointWithTrendAndInfluencedRate.md)
402
405
  - [TalonOne::AnalyticsDataPointWithTrendAndUplift](docs/AnalyticsDataPointWithTrendAndUplift.md)
403
406
  - [TalonOne::AnalyticsProduct](docs/AnalyticsProduct.md)
404
- - [TalonOne::AnalyticsProductSKU](docs/AnalyticsProductSKU.md)
407
+ - [TalonOne::AnalyticsSKU](docs/AnalyticsSKU.md)
405
408
  - [TalonOne::Application](docs/Application.md)
406
409
  - [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md)
407
410
  - [TalonOne::ApplicationAnalyticsDataPoint](docs/ApplicationAnalyticsDataPoint.md)
408
411
  - [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md)
409
412
  - [TalonOne::ApplicationCIF](docs/ApplicationCIF.md)
410
413
  - [TalonOne::ApplicationCIFExpression](docs/ApplicationCIFExpression.md)
414
+ - [TalonOne::ApplicationCIFReferences](docs/ApplicationCIFReferences.md)
411
415
  - [TalonOne::ApplicationCampaignAnalytics](docs/ApplicationCampaignAnalytics.md)
412
416
  - [TalonOne::ApplicationCampaignStats](docs/ApplicationCampaignStats.md)
413
417
  - [TalonOne::ApplicationCustomer](docs/ApplicationCustomer.md)
@@ -451,6 +455,7 @@ Class | Method | HTTP request | Description
451
455
  - [TalonOne::CampaignCopy](docs/CampaignCopy.md)
452
456
  - [TalonOne::CampaignCreatedNotification](docs/CampaignCreatedNotification.md)
453
457
  - [TalonOne::CampaignDeletedNotification](docs/CampaignDeletedNotification.md)
458
+ - [TalonOne::CampaignDetail](docs/CampaignDetail.md)
454
459
  - [TalonOne::CampaignEditedNotification](docs/CampaignEditedNotification.md)
455
460
  - [TalonOne::CampaignEntity](docs/CampaignEntity.md)
456
461
  - [TalonOne::CampaignEvaluationGroup](docs/CampaignEvaluationGroup.md)
@@ -468,6 +473,7 @@ Class | Method | HTTP request | Description
468
473
  - [TalonOne::CampaignSetNode](docs/CampaignSetNode.md)
469
474
  - [TalonOne::CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md)
470
475
  - [TalonOne::CampaignStoreBudget](docs/CampaignStoreBudget.md)
476
+ - [TalonOne::CampaignStoreBudgetLimitConfig](docs/CampaignStoreBudgetLimitConfig.md)
471
477
  - [TalonOne::CampaignTemplate](docs/CampaignTemplate.md)
472
478
  - [TalonOne::CampaignTemplateCollection](docs/CampaignTemplateCollection.md)
473
479
  - [TalonOne::CampaignTemplateCouponReservationSettings](docs/CampaignTemplateCouponReservationSettings.md)
@@ -524,9 +530,9 @@ Class | Method | HTTP request | Description
524
530
  - [TalonOne::CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md)
525
531
  - [TalonOne::CustomerSession](docs/CustomerSession.md)
526
532
  - [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
527
- - [TalonOne::DeactivateUserRequest](docs/DeactivateUserRequest.md)
528
533
  - [TalonOne::DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md)
529
534
  - [TalonOne::DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
535
+ - [TalonOne::DeleteUserRequest](docs/DeleteUserRequest.md)
530
536
  - [TalonOne::Effect](docs/Effect.md)
531
537
  - [TalonOne::EffectEntity](docs/EffectEntity.md)
532
538
  - [TalonOne::EmailEntity](docs/EmailEntity.md)
@@ -560,6 +566,7 @@ Class | Method | HTTP request | Description
560
566
  - [TalonOne::GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md)
561
567
  - [TalonOne::Giveaway](docs/Giveaway.md)
562
568
  - [TalonOne::GiveawaysPool](docs/GiveawaysPool.md)
569
+ - [TalonOne::HiddenConditionsEffects](docs/HiddenConditionsEffects.md)
563
570
  - [TalonOne::IdentifiableEntity](docs/IdentifiableEntity.md)
564
571
  - [TalonOne::Import](docs/Import.md)
565
572
  - [TalonOne::ImportEntity](docs/ImportEntity.md)
@@ -606,6 +613,9 @@ Class | Method | HTTP request | Description
606
613
  - [TalonOne::InlineResponse20044](docs/InlineResponse20044.md)
607
614
  - [TalonOne::InlineResponse20045](docs/InlineResponse20045.md)
608
615
  - [TalonOne::InlineResponse20046](docs/InlineResponse20046.md)
616
+ - [TalonOne::InlineResponse20047](docs/InlineResponse20047.md)
617
+ - [TalonOne::InlineResponse20048](docs/InlineResponse20048.md)
618
+ - [TalonOne::InlineResponse20049](docs/InlineResponse20049.md)
609
619
  - [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
610
620
  - [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
611
621
  - [TalonOne::InlineResponse2007](docs/InlineResponse2007.md)
@@ -650,6 +660,7 @@ Class | Method | HTTP request | Description
650
660
  - [TalonOne::LoyaltyDashboardPointsBreakdown](docs/LoyaltyDashboardPointsBreakdown.md)
651
661
  - [TalonOne::LoyaltyLedger](docs/LoyaltyLedger.md)
652
662
  - [TalonOne::LoyaltyLedgerEntry](docs/LoyaltyLedgerEntry.md)
663
+ - [TalonOne::LoyaltyLedgerEntryFlags](docs/LoyaltyLedgerEntryFlags.md)
653
664
  - [TalonOne::LoyaltyLedgerTransactions](docs/LoyaltyLedgerTransactions.md)
654
665
  - [TalonOne::LoyaltyMembership](docs/LoyaltyMembership.md)
655
666
  - [TalonOne::LoyaltyProgram](docs/LoyaltyProgram.md)
@@ -665,6 +676,7 @@ Class | Method | HTTP request | Description
665
676
  - [TalonOne::MessageLogEntry](docs/MessageLogEntry.md)
666
677
  - [TalonOne::MessageLogRequest](docs/MessageLogRequest.md)
667
678
  - [TalonOne::MessageLogResponse](docs/MessageLogResponse.md)
679
+ - [TalonOne::MessageTest](docs/MessageTest.md)
668
680
  - [TalonOne::Meta](docs/Meta.md)
669
681
  - [TalonOne::ModelReturn](docs/ModelReturn.md)
670
682
  - [TalonOne::MultiApplicationEntity](docs/MultiApplicationEntity.md)
@@ -716,8 +728,8 @@ Class | Method | HTTP request | Description
716
728
  - [TalonOne::NewLoyaltyProgram](docs/NewLoyaltyProgram.md)
717
729
  - [TalonOne::NewLoyaltyTier](docs/NewLoyaltyTier.md)
718
730
  - [TalonOne::NewManagementKey](docs/NewManagementKey.md)
731
+ - [TalonOne::NewMessageTest](docs/NewMessageTest.md)
719
732
  - [TalonOne::NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md)
720
- - [TalonOne::NewNotificationTest](docs/NewNotificationTest.md)
721
733
  - [TalonOne::NewNotificationWebhook](docs/NewNotificationWebhook.md)
722
734
  - [TalonOne::NewOutgoingIntegrationWebhook](docs/NewOutgoingIntegrationWebhook.md)
723
735
  - [TalonOne::NewPassword](docs/NewPassword.md)
@@ -738,7 +750,6 @@ Class | Method | HTTP request | Description
738
750
  - [TalonOne::Notification](docs/Notification.md)
739
751
  - [TalonOne::NotificationActivation](docs/NotificationActivation.md)
740
752
  - [TalonOne::NotificationListItem](docs/NotificationListItem.md)
741
- - [TalonOne::NotificationTest](docs/NotificationTest.md)
742
753
  - [TalonOne::OktaEvent](docs/OktaEvent.md)
743
754
  - [TalonOne::OktaEventPayload](docs/OktaEventPayload.md)
744
755
  - [TalonOne::OktaEventPayloadData](docs/OktaEventPayloadData.md)
@@ -760,8 +771,9 @@ Class | Method | HTTP request | Description
760
771
  - [TalonOne::Picklist](docs/Picklist.md)
761
772
  - [TalonOne::Product](docs/Product.md)
762
773
  - [TalonOne::ProductSearchMatch](docs/ProductSearchMatch.md)
763
- - [TalonOne::ProductSkuUnitAnalytics](docs/ProductSkuUnitAnalytics.md)
764
774
  - [TalonOne::ProductUnitAnalytics](docs/ProductUnitAnalytics.md)
775
+ - [TalonOne::ProductUnitAnalyticsDataPoint](docs/ProductUnitAnalyticsDataPoint.md)
776
+ - [TalonOne::ProductUnitAnalyticsTotals](docs/ProductUnitAnalyticsTotals.md)
765
777
  - [TalonOne::ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
766
778
  - [TalonOne::ProjectedTier](docs/ProjectedTier.md)
767
779
  - [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
@@ -780,6 +792,7 @@ Class | Method | HTTP request | Description
780
792
  - [TalonOne::ReturnedCartItem](docs/ReturnedCartItem.md)
781
793
  - [TalonOne::Revision](docs/Revision.md)
782
794
  - [TalonOne::RevisionActivation](docs/RevisionActivation.md)
795
+ - [TalonOne::RevisionActivationRequest](docs/RevisionActivationRequest.md)
783
796
  - [TalonOne::RevisionVersion](docs/RevisionVersion.md)
784
797
  - [TalonOne::Role](docs/Role.md)
785
798
  - [TalonOne::RoleAssign](docs/RoleAssign.md)
@@ -828,6 +841,8 @@ Class | Method | HTTP request | Description
828
841
  - [TalonOne::SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md)
829
842
  - [TalonOne::ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md)
830
843
  - [TalonOne::ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md)
844
+ - [TalonOne::SkuUnitAnalytics](docs/SkuUnitAnalytics.md)
845
+ - [TalonOne::SkuUnitAnalyticsDataPoint](docs/SkuUnitAnalyticsDataPoint.md)
831
846
  - [TalonOne::SlotDef](docs/SlotDef.md)
832
847
  - [TalonOne::Store](docs/Store.md)
833
848
  - [TalonOne::StrikethroughChangedItem](docs/StrikethroughChangedItem.md)
data/docs/Achievement.md CHANGED
@@ -10,16 +10,17 @@ Name | Type | Description | Notes
10
10
  **title** | **String** | The display name for the achievement in the Campaign Manager. |
11
11
  **description** | **String** | A description of the achievement. |
12
12
  **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
13
- **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. |
13
+ **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
14
14
  **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
15
15
  **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
16
16
  **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
17
17
  **fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
18
18
  **end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
19
- **campaign_id** | **Integer** | ID of the campaign, to which the achievement belongs to |
19
+ **campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
20
20
  **user_id** | **Integer** | ID of the user that created this achievement. |
21
- **created_by** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
21
+ **created_by** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional]
22
22
  **has_progress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
23
+ **status** | **String** | The status of the achievement. | [optional]
23
24
 
24
25
  ## Code Sample
25
26
 
@@ -41,7 +42,8 @@ instance = TalonOne::Achievement.new(id: 6,
41
42
  campaign_id: 1,
42
43
  user_id: 1234,
43
44
  created_by: John Doe,
44
- has_progress: null)
45
+ has_progress: null,
46
+ status: inprogress)
45
47
  ```
46
48
 
47
49
 
data/docs/AchievementAdditionalProperties.md CHANGED
@@ -4,10 +4,11 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **campaign_id** | **Integer** | ID of the campaign, to which the achievement belongs to |
7
+ **campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
8
8
  **user_id** | **Integer** | ID of the user that created this achievement. |
9
- **created_by** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. |
9
+ **created_by** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional]
10
10
  **has_progress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional]
11
+ **status** | **String** | The status of the achievement. | [optional]
11
12
 
12
13
  ## Code Sample
13
14
 
@@ -17,7 +18,8 @@ require 'TalonOne'
17
18
  instance = TalonOne::AchievementAdditionalProperties.new(campaign_id: 1,
18
19
  user_id: 1234,
19
20
  created_by: John Doe,
20
- has_progress: null)
21
+ has_progress: null,
22
+ status: inprogress)
21
23
  ```
22
24
 
23
25
 
data/docs/AchievementBase.md ADDED
@@ -0,0 +1,35 @@
1
+ # TalonOne::AchievementBase
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. | [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. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
12
+ **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
13
+ **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
14
+ **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
15
+ **fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
16
+ **end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'TalonOne'
22
+
23
+ instance = TalonOne::AchievementBase.new(name: Order50Discount,
24
+ title: 50% off on 50th purchase.,
25
+ description: 50% off for every 50th purchase in a year.,
26
+ target: 50.0,
27
+ period: 1Y,
28
+ period_end_override: null,
29
+ recurrence_policy: no_recurrence,
30
+ activation_policy: fixed_schedule,
31
+ fixed_start_date: null,
32
+ end_date: null)
33
+ ```
34
+
35
+
data/docs/AchievementProgress.md CHANGED
@@ -4,30 +4,18 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **achievement_id** | **Integer** | The internal ID of the achievement. |
8
- **name** | **String** | The internal name of the achievement used in API requests. |
9
- **title** | **String** | The display name of the achievement in the Campaign Manager. |
10
- **description** | **String** | The description of the achievement in the Campaign Manager. |
11
- **campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
12
7
  **status** | **String** | The status of the achievement. |
13
- **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
14
8
  **progress** | **Float** | The current progress of the customer in the achievement. |
15
- **start_date** | **DateTime** | Timestamp at which the customer started the achievement. |
9
+ **start_date** | **DateTime** | Timestamp at which the customer started the achievement. | [optional]
16
10
  **completion_date** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional]
17
- **end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. |
11
+ **end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | [optional]
18
12
 
19
13
  ## Code Sample
20
14
 
21
15
  ```ruby
22
16
  require 'TalonOne'
23
17
 
24
- instance = TalonOne::AchievementProgress.new(achievement_id: 3,
25
- name: FreeCoffee10Orders,
26
- title: 50% off on 50th purchase.,
27
- description: 50% off for every 50th purchase in a year.,
28
- campaign_id: 3,
29
- status: completed,
30
- target: 10.0,
18
+ instance = TalonOne::AchievementProgress.new(status: completed,
31
19
  progress: 10.0,
32
20
  start_date: null,
33
21
  completion_date: null,
data/docs/AchievementProgressWithDefinition.md ADDED
@@ -0,0 +1,45 @@
1
+ # TalonOne::AchievementProgressWithDefinition
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **status** | **String** | The status of the achievement. |
8
+ **progress** | **Float** | The current progress of the customer in the achievement. |
9
+ **start_date** | **DateTime** | Timestamp at which the customer started the achievement. | [optional]
10
+ **completion_date** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional]
11
+ **end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | [optional]
12
+ **achievement_id** | **Integer** | The internal ID of the achievement. |
13
+ **name** | **String** | The internal name of the achievement used in API requests. |
14
+ **title** | **String** | The display name of the achievement in the Campaign Manager. |
15
+ **description** | **String** | The description of the achievement in the Campaign Manager. |
16
+ **campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
17
+ **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
18
+ **achievement_recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. |
19
+ **achievement_activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
20
+ **achievement_fixed_start_date** | **DateTime** | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
21
+ **achievement_end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
22
+
23
+ ## Code Sample
24
+
25
+ ```ruby
26
+ require 'TalonOne'
27
+
28
+ instance = TalonOne::AchievementProgressWithDefinition.new(status: completed,
29
+ progress: 10.0,
30
+ start_date: null,
31
+ completion_date: null,
32
+ end_date: null,
33
+ achievement_id: 3,
34
+ name: FreeCoffee10Orders,
35
+ title: 50% off on 50th purchase.,
36
+ description: 50% off for every 50th purchase in a year.,
37
+ campaign_id: 3,
38
+ target: 10.0,
39
+ achievement_recurrence_policy: no_recurrence,
40
+ achievement_activation_policy: fixed_schedule,
41
+ achievement_fixed_start_date: null,
42
+ achievement_end_date: null)
43
+ ```
44
+
45
+
data/docs/AchievementStatusEntry.md ADDED
@@ -0,0 +1,45 @@
1
+ # TalonOne::AchievementStatusEntry
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. |
9
+ **name** | **String** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
10
+ **title** | **String** | The display name for the achievement in the Campaign Manager. |
11
+ **description** | **String** | A description of the achievement. |
12
+ **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
13
+ **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
14
+ **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
15
+ **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
16
+ **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
17
+ **fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
18
+ **end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
19
+ **campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. | [optional]
20
+ **status** | **String** | The status of the achievement. | [optional]
21
+ **current_progress** | [**AchievementProgress**](AchievementProgress.md) | | [optional]
22
+
23
+ ## Code Sample
24
+
25
+ ```ruby
26
+ require 'TalonOne'
27
+
28
+ instance = TalonOne::AchievementStatusEntry.new(id: 6,
29
+ created: 2020-06-10T09:05:27.993483Z,
30
+ name: Order50Discount,
31
+ title: 50% off on 50th purchase.,
32
+ description: 50% off for every 50th purchase in a year.,
33
+ target: 50.0,
34
+ period: 1Y,
35
+ period_end_override: null,
36
+ recurrence_policy: no_recurrence,
37
+ activation_policy: fixed_schedule,
38
+ fixed_start_date: null,
39
+ end_date: null,
40
+ campaign_id: 1,
41
+ status: active,
42
+ current_progress: null)
43
+ ```
44
+
45
+
data/docs/AddFreeItemEffectProps.md CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **sku** | **String** | SKU of the item that needs to be added. |
8
8
  **name** | **String** | The name / description of the effect |
9
+ **desired_quantity** | **Integer** | The original quantity in case a partial reward was applied. | [optional]
9
10
 
10
11
  ## Code Sample
11
12
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
13
14
  require 'TalonOne'
14
15
 
15
16
  instance = TalonOne::AddFreeItemEffectProps.new(sku: SKU1241028,
16
- name: null)
17
+ name: null,
18
+ desired_quantity: null)
17
19
  ```
18
20
 
19
21
 
data/docs/AdditionalCampaignProperties.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **budgets** | [**Array<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. |
7
+ **budgets** | [**Array<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | [optional]
8
8
  **coupon_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
9
9
  **referral_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional]
10
10
  **discount_count** | **Float** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional]
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
27
27
  **template_id** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
28
28
  **frontend_state** | **String** | The campaign state displayed in the Campaign Manager. |
29
29
  **stores_imported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |
30
+ **value_maps_ids** | **Array<Integer>** | A list of value map IDs for the campaign. | [optional]
30
31
 
31
32
  ## Code Sample
32
33
 
@@ -55,7 +56,8 @@ instance = TalonOne::AdditionalCampaignProperties.new(budgets: null,
55
56
  updated_by: Jane Doe,
56
57
  template_id: 3,
57
58
  frontend_state: running,
58
- stores_imported: true)
59
+ stores_imported: true,
60
+ value_maps_ids: [100, 215])
59
61
  ```
60
62
 
61
63
 
data/docs/AnalyticsProduct.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | The ID of the analytics-level product. |
8
- **is_preliminary** | **Boolean** | Indicates whether the analytics-level product is connected to a catalog and also has a product name. |
9
- **name** | **String** | The name of the analytics-level product. |
10
- **catalog_id** | **Integer** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. | [optional]
7
+ **id** | **Integer** | The ID of the product. |
8
+ **name** | **String** | The name of the product. |
9
+ **catalog_id** | **Integer** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. |
10
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
11
11
 
12
12
  ## Code Sample
13
13
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
15
15
  require 'TalonOne'
16
16
 
17
17
  instance = TalonOne::AnalyticsProduct.new(id: 1,
18
- is_preliminary: false,
19
18
  name: MyProduct,
20
- catalog_id: 1)
19
+ catalog_id: 1,
20
+ units_sold: null)
21
21
  ```
22
22
 
23
23
 
data/docs/AnalyticsSKU.md ADDED
@@ -0,0 +1,23 @@
1
+ # TalonOne::AnalyticsSKU
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | The ID of the SKU linked to the application. |
8
+ **sku** | **String** | The SKU linked to the application. |
9
+ **last_updated** | **DateTime** | Values in UTC for the date the SKU linked to the product was last updated. | [optional]
10
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TalonOne'
16
+
17
+ instance = TalonOne::AnalyticsSKU.new(id: 1,
18
+ sku: SKU-123,
19
+ last_updated: 2024-02-01T00:00Z,
20
+ units_sold: null)
21
+ ```
22
+
23
+
data/docs/ApplicationCIF.md CHANGED
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
  **modified_by** | **Integer** | The ID of the user who last updated the Application cart item filter. | [optional]
13
13
  **created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
14
14
  **modified** | **DateTime** | Timestamp of the most recent update to the Application cart item filter. | [optional]
15
- **application_id** | **Integer** | The ID of the application that owns this entity. |
15
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
16
16
 
17
17
  ## Code Sample
18
18
 
data/docs/ApplicationCIFExpression.md CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **cart_item_filter_id** | **Integer** | The ID of the Application cart item filter. | [optional]
10
10
  **created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
11
11
  **expression** | **Array<Object>** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional]
12
- **application_id** | **Integer** | The ID of the application that owns this entity. |
12
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
13
13
 
14
14
  ## Code Sample
15
15
 
data/docs/ApplicationCIFReferences.md ADDED
@@ -0,0 +1,19 @@
1
+ # TalonOne::ApplicationCIFReferences
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **application_cart_item_filter_id** | **Integer** | The ID of the Application Cart Item Filter that is referenced by a campaign. | [optional]
8
+ **campaigns** | [**Array<CampaignDetail>**](CampaignDetail.md) | Campaigns that reference a speciifc Application Cart Item Filter. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::ApplicationCIFReferences.new(application_cart_item_filter_id: 322,
16
+ campaigns: null)
17
+ ```
18
+
19
+
data/docs/ApplicationEntity.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **application_id** | **Integer** | The ID of the application that owns this entity. |
7
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
8
8
 
9
9
  ## Code Sample
10
10
 
data/docs/ApplicationEvent.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **id** | **Integer** | Internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
- **application_id** | **Integer** | The ID of the application that owns this entity. |
9
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
10
10
  **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
11
11
  **store_id** | **Integer** | The ID of the store. | [optional]
12
12
  **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
data/docs/ApplicationReferee.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **application_id** | **Integer** | The ID of the application that owns this entity. |
7
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
8
8
  **session_id** | **String** | Integration ID of the session in which the customer redeemed the referral. |
9
9
  **advocate_integration_id** | **String** | Integration ID of the Advocate's Profile. |
10
10
  **friend_integration_id** | **String** | Integration ID of the Friend's Profile. |
data/docs/ApplicationSession.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **integration_id** | **String** | The integration ID set by your integration layer. |
10
10
  **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
11
- **application_id** | **Integer** | The ID of the application that owns this entity. |
11
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
12
12
  **profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
13
13
  **profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional]
14
14
  **coupon** | **String** | Any coupon code entered. |
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
16
16
  **state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). |
17
17
  **cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. |
18
18
  **discounts** | **Hash<String, Float>** | **API V1 only.** A map of labeled discount values, in the same currency as the session. If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. |
19
- **total_discounts** | **Float** | The total sum of the discounts applied to this session. |
19
+ **total_discounts** | **Float** | The total sum of the discounts applied to this session. **Note:** If more than one session is returned, this value is displayed as `0`. |
20
20
  **total** | **Float** | The total sum of the session before any discounts applied. |
21
21
  **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
22
22