talon_one 7.0.0 → 8.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 (315) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -7
  3. data/docs/Achievement.md +6 -4
  4. data/docs/AchievementAdditionalProperties.md +5 -3
  5. data/docs/AchievementProgress.md +3 -15
  6. data/docs/AddFreeItemEffectProps.md +3 -1
  7. data/docs/AdditionalCampaignProperties.md +4 -2
  8. data/docs/AnalyticsProduct.md +6 -6
  9. data/docs/ApplicationCIF.md +1 -1
  10. data/docs/ApplicationCIFExpression.md +1 -1
  11. data/docs/ApplicationEntity.md +1 -1
  12. data/docs/ApplicationEvent.md +1 -1
  13. data/docs/ApplicationReferee.md +1 -1
  14. data/docs/ApplicationSession.md +2 -2
  15. data/docs/Audience.md +1 -1
  16. data/docs/BaseLoyaltyProgram.md +1 -1
  17. data/docs/Binding.md +1 -1
  18. data/docs/Campaign.md +4 -2
  19. data/docs/CampaignEvaluationGroup.md +1 -1
  20. data/docs/CampaignNotificationPolicy.md +3 -1
  21. data/docs/CampaignSet.md +1 -1
  22. data/docs/CampaignStoreBudget.md +1 -1
  23. data/docs/CardExpiringPointsNotificationPolicy.md +3 -1
  24. data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
  25. data/docs/CouponCreationJob.md +1 -1
  26. data/docs/CouponDeletionJob.md +1 -1
  27. data/docs/CouponsNotificationPolicy.md +5 -1
  28. data/docs/CreateAchievement.md +1 -1
  29. data/docs/CustomerInventory.md +1 -1
  30. data/docs/CustomerSession.md +1 -1
  31. data/docs/CustomerSessionV2.md +2 -4
  32. data/docs/Environment.md +1 -1
  33. data/docs/Event.md +1 -1
  34. data/docs/ExpiringCouponsNotificationPolicy.md +3 -1
  35. data/docs/ExpiringPointsNotificationPolicy.md +3 -1
  36. data/docs/InlineResponse2001.md +3 -3
  37. data/docs/InlineResponse20010.md +3 -3
  38. data/docs/InlineResponse20011.md +3 -3
  39. data/docs/InlineResponse20012.md +1 -1
  40. data/docs/InlineResponse20013.md +1 -1
  41. data/docs/InlineResponse20014.md +1 -1
  42. data/docs/InlineResponse20015.md +3 -3
  43. data/docs/InlineResponse20016.md +3 -3
  44. data/docs/InlineResponse20017.md +3 -5
  45. data/docs/InlineResponse20018.md +2 -2
  46. data/docs/InlineResponse20019.md +3 -3
  47. data/docs/InlineResponse2002.md +3 -3
  48. data/docs/InlineResponse20020.md +5 -3
  49. data/docs/InlineResponse20021.md +3 -5
  50. data/docs/InlineResponse20022.md +2 -4
  51. data/docs/InlineResponse20023.md +3 -5
  52. data/docs/InlineResponse20024.md +5 -3
  53. data/docs/InlineResponse20025.md +4 -2
  54. data/docs/InlineResponse20026.md +3 -1
  55. data/docs/InlineResponse20027.md +1 -1
  56. data/docs/InlineResponse20028.md +3 -3
  57. data/docs/InlineResponse20029.md +1 -3
  58. data/docs/InlineResponse2003.md +1 -1
  59. data/docs/InlineResponse20030.md +2 -2
  60. data/docs/InlineResponse20031.md +3 -3
  61. data/docs/InlineResponse20032.md +1 -1
  62. data/docs/InlineResponse20033.md +3 -3
  63. data/docs/InlineResponse20034.md +1 -3
  64. data/docs/InlineResponse20035.md +5 -3
  65. data/docs/InlineResponse20036.md +1 -1
  66. data/docs/InlineResponse20037.md +5 -3
  67. data/docs/InlineResponse20038.md +1 -1
  68. data/docs/InlineResponse20039.md +1 -1
  69. data/docs/InlineResponse2004.md +1 -1
  70. data/docs/InlineResponse20040.md +1 -1
  71. data/docs/InlineResponse20041.md +2 -4
  72. data/docs/InlineResponse20042.md +1 -1
  73. data/docs/InlineResponse20043.md +1 -1
  74. data/docs/InlineResponse20044.md +4 -4
  75. data/docs/InlineResponse20045.md +3 -3
  76. data/docs/InlineResponse20046.md +3 -3
  77. data/docs/InlineResponse20047.md +5 -3
  78. data/docs/InlineResponse2005.md +3 -3
  79. data/docs/InlineResponse2006.md +3 -3
  80. data/docs/InlineResponse2007.md +1 -1
  81. data/docs/InlineResponse2008.md +1 -1
  82. data/docs/InlineResponse2009.md +3 -3
  83. data/docs/IntegrationApi.md +156 -18
  84. data/docs/LedgerInfo.md +4 -0
  85. data/docs/LimitCounter.md +1 -1
  86. data/docs/LoyaltyBalance.md +3 -1
  87. data/docs/LoyaltyBalanceWithTier.md +2 -0
  88. data/docs/LoyaltyBalances.md +1 -1
  89. data/docs/LoyaltyBalancesWithTiers.md +1 -1
  90. data/docs/LoyaltyCardBalances.md +1 -1
  91. data/docs/LoyaltyLedger.md +1 -1
  92. data/docs/LoyaltyLedgerEntry.md +3 -1
  93. data/docs/LoyaltyProgram.md +1 -1
  94. data/docs/LoyaltyProgramBalance.md +5 -1
  95. data/docs/LoyaltySubLedger.md +2 -0
  96. data/docs/ManagementApi.md +184 -116
  97. data/docs/ManagementKey.md +3 -1
  98. data/docs/ModelReturn.md +1 -1
  99. data/docs/NewAudience.md +1 -1
  100. data/docs/NewCampaignSet.md +1 -1
  101. data/docs/NewLoyaltyProgram.md +1 -1
  102. data/docs/NewManagementKey.md +2 -0
  103. data/docs/PendingPointsNotificationPolicy.md +3 -1
  104. data/docs/ProductSearchMatch.md +2 -2
  105. data/docs/ProductUnitAnalytics.md +4 -10
  106. data/docs/Store.md +1 -1
  107. data/docs/StrikethroughEffect.md +5 -1
  108. data/docs/StrikethroughLabelingNotification.md +4 -2
  109. data/docs/SummaryCampaignStoreBudget.md +3 -1
  110. data/docs/TemplateDef.md +1 -1
  111. data/docs/TierDowngradeNotificationPolicy.md +3 -1
  112. data/docs/TierUpgradeNotificationPolicy.md +3 -1
  113. data/docs/TierWillDowngradeNotificationPolicy.md +2 -0
  114. data/docs/UpdateAchievement.md +2 -2
  115. data/docs/UpdateLoyaltyProgram.md +1 -1
  116. data/lib/talon_one/api/integration_api.rb +220 -29
  117. data/lib/talon_one/api/management_api.rb +248 -169
  118. data/lib/talon_one/models/achievement.rb +27 -15
  119. data/lib/talon_one/models/achievement_additional_properties.rb +49 -10
  120. data/lib/talon_one/models/achievement_progress.rb +4 -137
  121. data/lib/talon_one/models/add_free_item_effect_props.rb +14 -4
  122. data/lib/talon_one/models/additional_campaign_properties.rb +16 -9
  123. data/lib/talon_one/models/analytics_product.rb +20 -21
  124. data/lib/talon_one/models/application_api_key.rb +2 -2
  125. data/lib/talon_one/models/application_cif.rb +1 -1
  126. data/lib/talon_one/models/application_cif_expression.rb +1 -1
  127. data/lib/talon_one/models/application_entity.rb +1 -1
  128. data/lib/talon_one/models/application_event.rb +1 -1
  129. data/lib/talon_one/models/application_referee.rb +1 -1
  130. data/lib/talon_one/models/application_session.rb +2 -2
  131. data/lib/talon_one/models/audience.rb +1 -1
  132. data/lib/talon_one/models/base_loyalty_program.rb +3 -3
  133. data/lib/talon_one/models/campaign.rb +14 -7
  134. data/lib/talon_one/models/campaign_evaluation_group.rb +1 -1
  135. data/lib/talon_one/models/campaign_notification_policy.rb +14 -4
  136. data/lib/talon_one/models/campaign_set.rb +1 -1
  137. data/lib/talon_one/models/campaign_store_budget.rb +1 -1
  138. data/lib/talon_one/models/card_expiring_points_notification_policy.rb +14 -4
  139. data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +38 -4
  140. data/lib/talon_one/models/coupon_creation_job.rb +1 -1
  141. data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
  142. data/lib/talon_one/models/coupons_notification_policy.rb +24 -4
  143. data/lib/talon_one/models/create_achievement.rb +0 -5
  144. data/lib/talon_one/models/create_application_api_key.rb +2 -2
  145. data/lib/talon_one/models/customer_inventory.rb +1 -1
  146. data/lib/talon_one/models/customer_session.rb +1 -1
  147. data/lib/talon_one/models/customer_session_v2.rb +5 -15
  148. data/lib/talon_one/models/environment.rb +1 -1
  149. data/lib/talon_one/models/event.rb +1 -1
  150. data/lib/talon_one/models/expiring_coupons_notification_policy.rb +14 -4
  151. data/lib/talon_one/models/expiring_points_notification_policy.rb +14 -4
  152. data/lib/talon_one/models/inline_response2001.rb +11 -11
  153. data/lib/talon_one/models/inline_response20010.rb +11 -11
  154. data/lib/talon_one/models/inline_response20011.rb +11 -11
  155. data/lib/talon_one/models/inline_response20012.rb +1 -1
  156. data/lib/talon_one/models/inline_response20013.rb +1 -1
  157. data/lib/talon_one/models/inline_response20014.rb +1 -1
  158. data/lib/talon_one/models/inline_response20015.rb +11 -11
  159. data/lib/talon_one/models/inline_response20016.rb +11 -13
  160. data/lib/talon_one/models/inline_response20017.rb +7 -11
  161. data/lib/talon_one/models/inline_response20018.rb +1 -1
  162. data/lib/talon_one/models/inline_response20019.rb +3 -1
  163. data/lib/talon_one/models/inline_response2002.rb +11 -11
  164. data/lib/talon_one/models/inline_response20020.rb +11 -7
  165. data/lib/talon_one/models/inline_response20021.rb +7 -11
  166. data/lib/talon_one/models/inline_response20022.rb +7 -11
  167. data/lib/talon_one/models/inline_response20023.rb +7 -11
  168. data/lib/talon_one/models/inline_response20024.rb +11 -7
  169. data/lib/talon_one/models/inline_response20025.rb +11 -7
  170. data/lib/talon_one/models/inline_response20026.rb +11 -2
  171. data/lib/talon_one/models/inline_response20027.rb +1 -1
  172. data/lib/talon_one/models/inline_response20028.rb +11 -11
  173. data/lib/talon_one/models/inline_response20029.rb +2 -11
  174. data/lib/talon_one/models/inline_response2003.rb +1 -1
  175. data/lib/talon_one/models/inline_response20030.rb +6 -1
  176. data/lib/talon_one/models/inline_response20031.rb +13 -8
  177. data/lib/talon_one/models/inline_response20032.rb +1 -1
  178. data/lib/talon_one/models/inline_response20033.rb +8 -13
  179. data/lib/talon_one/models/inline_response20034.rb +2 -11
  180. data/lib/talon_one/models/inline_response20035.rb +11 -7
  181. data/lib/talon_one/models/inline_response20036.rb +1 -1
  182. data/lib/talon_one/models/inline_response20037.rb +11 -7
  183. data/lib/talon_one/models/inline_response20038.rb +1 -1
  184. data/lib/talon_one/models/inline_response20039.rb +1 -1
  185. data/lib/talon_one/models/inline_response2004.rb +1 -1
  186. data/lib/talon_one/models/inline_response20040.rb +1 -1
  187. data/lib/talon_one/models/inline_response20041.rb +7 -11
  188. data/lib/talon_one/models/inline_response20042.rb +1 -1
  189. data/lib/talon_one/models/inline_response20043.rb +1 -1
  190. data/lib/talon_one/models/inline_response20044.rb +11 -11
  191. data/lib/talon_one/models/inline_response20045.rb +13 -8
  192. data/lib/talon_one/models/inline_response20046.rb +11 -11
  193. data/lib/talon_one/models/inline_response20047.rb +11 -7
  194. data/lib/talon_one/models/inline_response2005.rb +11 -11
  195. data/lib/talon_one/models/inline_response2006.rb +11 -11
  196. data/lib/talon_one/models/inline_response2007.rb +1 -1
  197. data/lib/talon_one/models/inline_response2008.rb +1 -1
  198. data/lib/talon_one/models/inline_response2009.rb +11 -11
  199. data/lib/talon_one/models/ledger_info.rb +31 -1
  200. data/lib/talon_one/models/limit_counter.rb +1 -1
  201. data/lib/talon_one/models/loyalty_balance.rb +14 -4
  202. data/lib/talon_one/models/loyalty_balance_with_tier.rb +11 -1
  203. data/lib/talon_one/models/loyalty_ledger_entry.rb +13 -4
  204. data/lib/talon_one/models/loyalty_program.rb +3 -3
  205. data/lib/talon_one/models/loyalty_program_balance.rb +34 -4
  206. data/lib/talon_one/models/loyalty_sub_ledger.rb +16 -1
  207. data/lib/talon_one/models/management_key.rb +14 -4
  208. data/lib/talon_one/models/model_return.rb +1 -1
  209. data/lib/talon_one/models/new_application_api_key.rb +2 -2
  210. data/lib/talon_one/models/new_audience.rb +1 -1
  211. data/lib/talon_one/models/new_campaign_set.rb +1 -1
  212. data/lib/talon_one/models/new_loyalty_program.rb +3 -3
  213. data/lib/talon_one/models/new_management_key.rb +11 -1
  214. data/lib/talon_one/models/pending_points_notification_policy.rb +14 -4
  215. data/lib/talon_one/models/product.rb +0 -19
  216. data/lib/talon_one/models/product_search_match.rb +1 -6
  217. data/lib/talon_one/models/product_unit_analytics.rb +21 -65
  218. data/lib/talon_one/models/store.rb +1 -1
  219. data/lib/talon_one/models/strikethrough_effect.rb +24 -4
  220. data/lib/talon_one/models/strikethrough_labeling_notification.rb +46 -2
  221. data/lib/talon_one/models/summary_campaign_store_budget.rb +18 -4
  222. data/lib/talon_one/models/template_def.rb +1 -1
  223. data/lib/talon_one/models/tier_downgrade_notification_policy.rb +14 -4
  224. data/lib/talon_one/models/tier_upgrade_notification_policy.rb +14 -4
  225. data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +11 -1
  226. data/lib/talon_one/models/update_achievement.rb +2 -2
  227. data/lib/talon_one/models/update_loyalty_program.rb +3 -3
  228. data/lib/talon_one/version.rb +1 -1
  229. data/lib/talon_one.rb +18 -4
  230. data/spec/api/integration_api_spec.rb +45 -9
  231. data/spec/api/management_api_spec.rb +75 -60
  232. data/spec/models/achievement_additional_properties_spec.rb +10 -0
  233. data/spec/models/achievement_base_spec.rb +103 -0
  234. data/spec/models/achievement_progress_spec.rb +1 -37
  235. data/spec/models/achievement_progress_with_definition_spec.rb +137 -0
  236. data/spec/models/achievement_spec.rb +10 -0
  237. data/spec/models/achievement_status_entry_spec.rb +137 -0
  238. data/spec/models/add_free_item_effect_props_spec.rb +6 -0
  239. data/spec/models/additional_campaign_properties_spec.rb +6 -0
  240. data/spec/models/analytics_product_spec.rb +3 -3
  241. data/spec/models/analytics_sku_spec.rb +59 -0
  242. data/spec/models/application_api_key_spec.rb +1 -1
  243. data/spec/models/application_cif_references_spec.rb +47 -0
  244. data/spec/models/base_loyalty_program_spec.rb +1 -1
  245. data/spec/models/campaign_detail_spec.rb +47 -0
  246. data/spec/models/campaign_notification_policy_spec.rb +6 -0
  247. data/spec/models/campaign_spec.rb +6 -0
  248. data/spec/models/campaign_store_budget_limit_config_spec.rb +73 -0
  249. data/spec/models/card_expiring_points_notification_policy_spec.rb +6 -0
  250. data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
  251. data/spec/models/coupons_notification_policy_spec.rb +12 -0
  252. data/spec/models/create_application_api_key_spec.rb +1 -1
  253. data/spec/models/customer_session_v2_spec.rb +0 -6
  254. data/spec/models/expiring_coupons_notification_policy_spec.rb +6 -0
  255. data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
  256. data/spec/models/hidden_conditions_effects_spec.rb +59 -0
  257. data/spec/models/inline_response20010_spec.rb +1 -1
  258. data/spec/models/inline_response20011_spec.rb +1 -1
  259. data/spec/models/inline_response20015_spec.rb +1 -1
  260. data/spec/models/inline_response20016_spec.rb +1 -1
  261. data/spec/models/inline_response20017_spec.rb +0 -6
  262. data/spec/models/inline_response2001_spec.rb +1 -1
  263. data/spec/models/inline_response20020_spec.rb +6 -0
  264. data/spec/models/inline_response20021_spec.rb +0 -6
  265. data/spec/models/inline_response20022_spec.rb +0 -6
  266. data/spec/models/inline_response20023_spec.rb +0 -6
  267. data/spec/models/inline_response20024_spec.rb +6 -0
  268. data/spec/models/inline_response20025_spec.rb +6 -0
  269. data/spec/models/inline_response20026_spec.rb +6 -0
  270. data/spec/models/inline_response20028_spec.rb +1 -1
  271. data/spec/models/inline_response20029_spec.rb +0 -6
  272. data/spec/models/inline_response2002_spec.rb +1 -1
  273. data/spec/models/inline_response20031_spec.rb +1 -1
  274. data/spec/models/inline_response20033_spec.rb +1 -1
  275. data/spec/models/inline_response20034_spec.rb +0 -6
  276. data/spec/models/inline_response20035_spec.rb +6 -0
  277. data/spec/models/inline_response20037_spec.rb +6 -0
  278. data/spec/models/inline_response20041_spec.rb +0 -6
  279. data/spec/models/inline_response20044_spec.rb +2 -2
  280. data/spec/models/inline_response20045_spec.rb +1 -1
  281. data/spec/models/inline_response20046_spec.rb +1 -1
  282. data/spec/models/inline_response20047_spec.rb +6 -0
  283. data/spec/models/inline_response20048_spec.rb +47 -0
  284. data/spec/models/inline_response20049_spec.rb +47 -0
  285. data/spec/models/inline_response2005_spec.rb +1 -1
  286. data/spec/models/inline_response2006_spec.rb +1 -1
  287. data/spec/models/inline_response2009_spec.rb +1 -1
  288. data/spec/models/ledger_info_spec.rb +12 -0
  289. data/spec/models/loyalty_balance_spec.rb +6 -0
  290. data/spec/models/loyalty_balance_with_tier_spec.rb +6 -0
  291. data/spec/models/loyalty_ledger_entry_flags_spec.rb +41 -0
  292. data/spec/models/loyalty_ledger_entry_spec.rb +6 -0
  293. data/spec/models/loyalty_program_balance_spec.rb +12 -0
  294. data/spec/models/loyalty_program_spec.rb +1 -1
  295. data/spec/models/loyalty_sub_ledger_spec.rb +6 -0
  296. data/spec/models/management_key_spec.rb +6 -0
  297. data/spec/models/message_test_spec.rb +47 -0
  298. data/spec/models/new_application_api_key_spec.rb +1 -1
  299. data/spec/models/new_loyalty_program_spec.rb +1 -1
  300. data/spec/models/new_management_key_spec.rb +6 -0
  301. data/spec/models/new_message_test_spec.rb +79 -0
  302. data/spec/models/pending_points_notification_policy_spec.rb +6 -0
  303. data/spec/models/product_unit_analytics_data_point_spec.rb +65 -0
  304. data/spec/models/product_unit_analytics_spec.rb +2 -20
  305. data/spec/models/product_unit_analytics_totals_spec.rb +41 -0
  306. data/spec/models/sku_unit_analytics_data_point_spec.rb +59 -0
  307. data/spec/models/sku_unit_analytics_spec.rb +47 -0
  308. data/spec/models/strikethrough_effect_spec.rb +12 -0
  309. data/spec/models/strikethrough_labeling_notification_spec.rb +10 -0
  310. data/spec/models/summary_campaign_store_budget_spec.rb +6 -0
  311. data/spec/models/tier_downgrade_notification_policy_spec.rb +6 -0
  312. data/spec/models/tier_upgrade_notification_policy_spec.rb +6 -0
  313. data/spec/models/tier_will_downgrade_notification_policy_spec.rb +6 -0
  314. data/spec/models/update_loyalty_program_spec.rb +1 -1
  315. metadata +37 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ac51b11122c2ed813f4e68669a5528b5e2cf12a9194235a22b743b24fe38f1f1
4
- data.tar.gz: e029dab6166dcb56464990fbda7ffa0bc73f97f7d35f12b4608daaa06608e5b1
3
+ metadata.gz: 5c9bac44344f39390c03fe97443722f5fe78db2dcf011a416da102376c9a3832
4
+ data.tar.gz: 52fd9a3bae399412d124da791f94dc9bb16a850e216e8ba5f33171a03d7155bb
5
5
  SHA512:
6
- metadata.gz: 760bcb7a9b623c8e54ec02196eb467bf48a0cbb58143169a0795addf62677ade0103a135fa255599d515100916ca2c467a795e9d10e510e72307e2ebcd80b722
7
- data.tar.gz: c3512d70a8d90a401e2f05a8cb7b37f1dbe20779509186e2e55b672e81c402cb90ddaae3cbc0283a95896559f7236583be33cfd61f60165cd6968e9327eeb333
6
+ metadata.gz: 737d5da757fcf1ad1769ad4c508a043a3dca0c9c4773d181da46617aef8bb21021969cd45480cfc8a2374295a65456251f2baf26dae60a340b4069146deab630
7
+ data.tar.gz: 3d7e31de9a8421814012f4a0253c2e32f444e7a9e60a36dd37c95bf40d3ac267b5aa5705a02c711b7a4a97a4a3652d30fea4af6f9c1e98a664f19fb495aa94f1
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', '~> 8.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-8.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-8.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
@@ -387,7 +390,10 @@ Class | Method | HTTP request | Description
387
390
  - [TalonOne::AccountLimits](docs/AccountLimits.md)
388
391
  - [TalonOne::Achievement](docs/Achievement.md)
389
392
  - [TalonOne::AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md)
393
+ - [TalonOne::AchievementBase](docs/AchievementBase.md)
390
394
  - [TalonOne::AchievementProgress](docs/AchievementProgress.md)
395
+ - [TalonOne::AchievementProgressWithDefinition](docs/AchievementProgressWithDefinition.md)
396
+ - [TalonOne::AchievementStatusEntry](docs/AchievementStatusEntry.md)
391
397
  - [TalonOne::AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md)
392
398
  - [TalonOne::AddItemCatalogAction](docs/AddItemCatalogAction.md)
393
399
  - [TalonOne::AddLoyaltyPoints](docs/AddLoyaltyPoints.md)
@@ -401,13 +407,14 @@ Class | Method | HTTP request | Description
401
407
  - [TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate](docs/AnalyticsDataPointWithTrendAndInfluencedRate.md)
402
408
  - [TalonOne::AnalyticsDataPointWithTrendAndUplift](docs/AnalyticsDataPointWithTrendAndUplift.md)
403
409
  - [TalonOne::AnalyticsProduct](docs/AnalyticsProduct.md)
404
- - [TalonOne::AnalyticsProductSKU](docs/AnalyticsProductSKU.md)
410
+ - [TalonOne::AnalyticsSKU](docs/AnalyticsSKU.md)
405
411
  - [TalonOne::Application](docs/Application.md)
406
412
  - [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md)
407
413
  - [TalonOne::ApplicationAnalyticsDataPoint](docs/ApplicationAnalyticsDataPoint.md)
408
414
  - [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md)
409
415
  - [TalonOne::ApplicationCIF](docs/ApplicationCIF.md)
410
416
  - [TalonOne::ApplicationCIFExpression](docs/ApplicationCIFExpression.md)
417
+ - [TalonOne::ApplicationCIFReferences](docs/ApplicationCIFReferences.md)
411
418
  - [TalonOne::ApplicationCampaignAnalytics](docs/ApplicationCampaignAnalytics.md)
412
419
  - [TalonOne::ApplicationCampaignStats](docs/ApplicationCampaignStats.md)
413
420
  - [TalonOne::ApplicationCustomer](docs/ApplicationCustomer.md)
@@ -451,6 +458,7 @@ Class | Method | HTTP request | Description
451
458
  - [TalonOne::CampaignCopy](docs/CampaignCopy.md)
452
459
  - [TalonOne::CampaignCreatedNotification](docs/CampaignCreatedNotification.md)
453
460
  - [TalonOne::CampaignDeletedNotification](docs/CampaignDeletedNotification.md)
461
+ - [TalonOne::CampaignDetail](docs/CampaignDetail.md)
454
462
  - [TalonOne::CampaignEditedNotification](docs/CampaignEditedNotification.md)
455
463
  - [TalonOne::CampaignEntity](docs/CampaignEntity.md)
456
464
  - [TalonOne::CampaignEvaluationGroup](docs/CampaignEvaluationGroup.md)
@@ -468,6 +476,7 @@ Class | Method | HTTP request | Description
468
476
  - [TalonOne::CampaignSetNode](docs/CampaignSetNode.md)
469
477
  - [TalonOne::CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md)
470
478
  - [TalonOne::CampaignStoreBudget](docs/CampaignStoreBudget.md)
479
+ - [TalonOne::CampaignStoreBudgetLimitConfig](docs/CampaignStoreBudgetLimitConfig.md)
471
480
  - [TalonOne::CampaignTemplate](docs/CampaignTemplate.md)
472
481
  - [TalonOne::CampaignTemplateCollection](docs/CampaignTemplateCollection.md)
473
482
  - [TalonOne::CampaignTemplateCouponReservationSettings](docs/CampaignTemplateCouponReservationSettings.md)
@@ -560,6 +569,7 @@ Class | Method | HTTP request | Description
560
569
  - [TalonOne::GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md)
561
570
  - [TalonOne::Giveaway](docs/Giveaway.md)
562
571
  - [TalonOne::GiveawaysPool](docs/GiveawaysPool.md)
572
+ - [TalonOne::HiddenConditionsEffects](docs/HiddenConditionsEffects.md)
563
573
  - [TalonOne::IdentifiableEntity](docs/IdentifiableEntity.md)
564
574
  - [TalonOne::Import](docs/Import.md)
565
575
  - [TalonOne::ImportEntity](docs/ImportEntity.md)
@@ -606,6 +616,9 @@ Class | Method | HTTP request | Description
606
616
  - [TalonOne::InlineResponse20044](docs/InlineResponse20044.md)
607
617
  - [TalonOne::InlineResponse20045](docs/InlineResponse20045.md)
608
618
  - [TalonOne::InlineResponse20046](docs/InlineResponse20046.md)
619
+ - [TalonOne::InlineResponse20047](docs/InlineResponse20047.md)
620
+ - [TalonOne::InlineResponse20048](docs/InlineResponse20048.md)
621
+ - [TalonOne::InlineResponse20049](docs/InlineResponse20049.md)
609
622
  - [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
610
623
  - [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
611
624
  - [TalonOne::InlineResponse2007](docs/InlineResponse2007.md)
@@ -650,6 +663,7 @@ Class | Method | HTTP request | Description
650
663
  - [TalonOne::LoyaltyDashboardPointsBreakdown](docs/LoyaltyDashboardPointsBreakdown.md)
651
664
  - [TalonOne::LoyaltyLedger](docs/LoyaltyLedger.md)
652
665
  - [TalonOne::LoyaltyLedgerEntry](docs/LoyaltyLedgerEntry.md)
666
+ - [TalonOne::LoyaltyLedgerEntryFlags](docs/LoyaltyLedgerEntryFlags.md)
653
667
  - [TalonOne::LoyaltyLedgerTransactions](docs/LoyaltyLedgerTransactions.md)
654
668
  - [TalonOne::LoyaltyMembership](docs/LoyaltyMembership.md)
655
669
  - [TalonOne::LoyaltyProgram](docs/LoyaltyProgram.md)
@@ -665,6 +679,7 @@ Class | Method | HTTP request | Description
665
679
  - [TalonOne::MessageLogEntry](docs/MessageLogEntry.md)
666
680
  - [TalonOne::MessageLogRequest](docs/MessageLogRequest.md)
667
681
  - [TalonOne::MessageLogResponse](docs/MessageLogResponse.md)
682
+ - [TalonOne::MessageTest](docs/MessageTest.md)
668
683
  - [TalonOne::Meta](docs/Meta.md)
669
684
  - [TalonOne::ModelReturn](docs/ModelReturn.md)
670
685
  - [TalonOne::MultiApplicationEntity](docs/MultiApplicationEntity.md)
@@ -716,8 +731,8 @@ Class | Method | HTTP request | Description
716
731
  - [TalonOne::NewLoyaltyProgram](docs/NewLoyaltyProgram.md)
717
732
  - [TalonOne::NewLoyaltyTier](docs/NewLoyaltyTier.md)
718
733
  - [TalonOne::NewManagementKey](docs/NewManagementKey.md)
734
+ - [TalonOne::NewMessageTest](docs/NewMessageTest.md)
719
735
  - [TalonOne::NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md)
720
- - [TalonOne::NewNotificationTest](docs/NewNotificationTest.md)
721
736
  - [TalonOne::NewNotificationWebhook](docs/NewNotificationWebhook.md)
722
737
  - [TalonOne::NewOutgoingIntegrationWebhook](docs/NewOutgoingIntegrationWebhook.md)
723
738
  - [TalonOne::NewPassword](docs/NewPassword.md)
@@ -738,7 +753,6 @@ Class | Method | HTTP request | Description
738
753
  - [TalonOne::Notification](docs/Notification.md)
739
754
  - [TalonOne::NotificationActivation](docs/NotificationActivation.md)
740
755
  - [TalonOne::NotificationListItem](docs/NotificationListItem.md)
741
- - [TalonOne::NotificationTest](docs/NotificationTest.md)
742
756
  - [TalonOne::OktaEvent](docs/OktaEvent.md)
743
757
  - [TalonOne::OktaEventPayload](docs/OktaEventPayload.md)
744
758
  - [TalonOne::OktaEventPayloadData](docs/OktaEventPayloadData.md)
@@ -760,8 +774,9 @@ Class | Method | HTTP request | Description
760
774
  - [TalonOne::Picklist](docs/Picklist.md)
761
775
  - [TalonOne::Product](docs/Product.md)
762
776
  - [TalonOne::ProductSearchMatch](docs/ProductSearchMatch.md)
763
- - [TalonOne::ProductSkuUnitAnalytics](docs/ProductSkuUnitAnalytics.md)
764
777
  - [TalonOne::ProductUnitAnalytics](docs/ProductUnitAnalytics.md)
778
+ - [TalonOne::ProductUnitAnalyticsDataPoint](docs/ProductUnitAnalyticsDataPoint.md)
779
+ - [TalonOne::ProductUnitAnalyticsTotals](docs/ProductUnitAnalyticsTotals.md)
765
780
  - [TalonOne::ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
766
781
  - [TalonOne::ProjectedTier](docs/ProjectedTier.md)
767
782
  - [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
@@ -828,6 +843,8 @@ Class | Method | HTTP request | Description
828
843
  - [TalonOne::SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md)
829
844
  - [TalonOne::ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md)
830
845
  - [TalonOne::ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md)
846
+ - [TalonOne::SkuUnitAnalytics](docs/SkuUnitAnalytics.md)
847
+ - [TalonOne::SkuUnitAnalyticsDataPoint](docs/SkuUnitAnalyticsDataPoint.md)
831
848
  - [TalonOne::SlotDef](docs/SlotDef.md)
832
849
  - [TalonOne::Store](docs/Store.md)
833
850
  - [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/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/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/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/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
 
data/docs/Audience.md CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **name** | **String** | The human-friendly display name for this audience. |
11
11
  **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
12
12
  **description** | **String** | A description of the audience. | [optional]
13
- **integration** | **String** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. | [optional]
13
+ **integration** | **String** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Shopify`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. | [optional]
14
14
  **integration_id** | **String** | The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. | [optional]
15
15
  **created_in3rd_party** | **Boolean** | Determines if this audience is a 3rd party audience or not. | [optional]
16
16
  **last_update** | **DateTime** | The last time that the audience memberships changed. | [optional]
data/docs/BaseLoyaltyProgram.md CHANGED
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
18
18
  **tiers_expire_in** | **String** | The amount of time after which the tier expires and is reevaluated. 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]
19
19
  **tiers_downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional]
20
20
  **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
21
- **return_policy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional]
21
+ **return_policy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit. | [optional]
22
22
 
23
23
  ## Code Sample
24
24
 
data/docs/Binding.md CHANGED
@@ -16,7 +16,7 @@ require 'TalonOne'
16
16
 
17
17
  instance = TalonOne::Binding.new(name: my property,
18
18
  type: templateParameter,
19
- expression: null,
19
+ expression: [string1, string2],
20
20
  value_type: string)
21
21
  ```
22
22
 
data/docs/Campaign.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **id** | **Integer** | Unique ID for this entity. |
8
8
  **created** | **DateTime** | The exact moment 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
  **user_id** | **Integer** | The ID of the user associated with this entity. |
11
11
  **name** | **String** | A user-facing name for this campaign. |
12
12
  **description** | **String** | A detailed description of the campaign. |
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
23
23
  **campaign_groups** | **Array<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
24
24
  **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. | [default to 'advanced']
25
25
  **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]
26
- **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. |
26
+ **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]
27
27
  **coupon_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
28
28
  **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]
29
29
  **discount_count** | **Float** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional]
@@ -46,6 +46,7 @@ Name | Type | Description | Notes
46
46
  **template_id** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
47
47
  **frontend_state** | **String** | The campaign state displayed in the Campaign Manager. |
48
48
  **stores_imported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |
49
+ **value_maps_ids** | **Array<Integer>** | A list of value map IDs for the campaign. | [optional]
49
50
  **revision_frontend_state** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional]
50
51
  **active_revision_id** | **Integer** | ID of the revision that was last activated on this campaign. | [optional]
51
52
  **active_revision_version_id** | **Integer** | ID of the revision version that is active on the campaign. | [optional]
@@ -101,6 +102,7 @@ instance = TalonOne::Campaign.new(id: 4,
101
102
  template_id: 3,
102
103
  frontend_state: running,
103
104
  stores_imported: true,
105
+ value_maps_ids: [100, 215],
104
106
  revision_frontend_state: revised,
105
107
  active_revision_id: 6,
106
108
  active_revision_version_id: 6,
data/docs/CampaignEvaluationGroup.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
  **name** | **String** | The name of the campaign evaluation group. |
9
9
  **parent_id** | **Integer** | The ID of the parent group that contains the campaign evaluation group. |
10
10
  **description** | **String** | A description of the campaign evaluation group. | [optional]
data/docs/CampaignNotificationPolicy.md CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | Notification name. |
8
8
  **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
9
+ **batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [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::CampaignNotificationPolicy.new(name: Christmas Sale,
16
- batching_enabled: false)
17
+ batching_enabled: false,
18
+ batch_size: 5)
17
19
  ```
18
20
 
19
21
 
data/docs/CampaignSet.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
  **id** | **Integer** | Internal ID of this entity. |
9
9
  **version** | **Integer** | Version of the campaign set. |
10
10
  **set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) | |
data/docs/CampaignStoreBudget.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
10
10
  **store_id** | **Integer** | The ID of the store. |
11
- **limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of budget limits for stores linked to the campaign. |
11
+ **limits** | [**Array<CampaignStoreBudgetLimitConfig>**](CampaignStoreBudgetLimitConfig.md) | The set of budget limits for stores linked to the campaign. |
12
12
 
13
13
  ## Code Sample
14
14
 
data/docs/CardExpiringPointsNotificationPolicy.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | Notification name. |
8
8
  **triggers** | [**Array<CardExpiringPointsNotificationTrigger>**](CardExpiringPointsNotificationTrigger.md) | |
9
9
  **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
10
+ **batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
10
11
 
11
12
  ## Code Sample
12
13
 
@@ -15,7 +16,8 @@ require 'TalonOne'
15
16
 
16
17
  instance = TalonOne::CardExpiringPointsNotificationPolicy.new(name: Notification to Google,
17
18
  triggers: null,
18
- batching_enabled: true)
19
+ batching_enabled: true,
20
+ batch_size: 1000)
19
21
  ```
20
22
 
21
23
 
data/docs/CatalogsStrikethroughNotificationPolicy.md CHANGED
@@ -5,13 +5,15 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | Notification name. |
8
+ **ahead_of_days_trigger** | **Integer** | The number of days in advance that strikethrough pricing updates should be sent. | [optional]
8
9
 
9
10
  ## Code Sample
10
11
 
11
12
  ```ruby
12
13
  require 'TalonOne'
13
14
 
14
- instance = TalonOne::CatalogsStrikethroughNotificationPolicy.new(name: Christmas Sale)
15
+ instance = TalonOne::CatalogsStrikethroughNotificationPolicy.new(name: Christmas Sale,
16
+ ahead_of_days_trigger: null)
15
17
  ```
16
18
 
17
19
 
data/docs/CouponCreationJob.md CHANGED
@@ -7,7 +7,7 @@ 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
  **campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
10
- **application_id** | **Integer** | The ID of the application that owns this entity. |
10
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
11
11
  **account_id** | **Integer** | The ID of the account that owns this entity. |
12
12
  **usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
13
13
  **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
data/docs/CouponDeletionJob.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
  **account_id** | **Integer** | The ID of the account that owns this entity. |
11
11
  **filters** | [**CouponDeletionFilters**](CouponDeletionFilters.md) | |
12
12
  **status** | **String** | The current status of this request. Possible values: - `not_ready` - `pending` - `completed` - `failed` |
data/docs/CouponsNotificationPolicy.md CHANGED
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | Notification name. |
8
8
  **scopes** | **Array<String>** | |
9
9
  **batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
10
+ **include_data** | **Boolean** | Indicates whether to include all generated coupons. If `false`, only the `batchId` of the generated coupons is included. | [optional]
11
+ **batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
10
12
 
11
13
  ## Code Sample
12
14
 
@@ -15,7 +17,9 @@ require 'TalonOne'
15
17
 
16
18
  instance = TalonOne::CouponsNotificationPolicy.new(name: Christmas Sale,
17
19
  scopes: null,
18
- batching_enabled: true)
20
+ batching_enabled: true,
21
+ include_data: true,
22
+ batch_size: 1000)
19
23
  ```
20
24
 
21
25