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
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]
@@ -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,
@@ -0,0 +1,19 @@
1
+ # TalonOne::CampaignDetail
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **campaign_id** | **Integer** | The ID of the campaign that references the application cart item filter. | [optional]
8
+ **campaign_name** | **String** | A user-facing name for this campaign. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::CampaignDetail.new(campaign_id: 1,
16
+ campaign_name: Summer promotions)
17
+ ```
18
+
19
+
@@ -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]
@@ -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) | |
@@ -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
 
@@ -0,0 +1,25 @@
1
+ # TalonOne::CampaignStoreBudgetLimitConfig
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **action** | **String** | The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` |
8
+ **limit** | **Float** | The value to set for the limit. |
9
+ **period** | **String** | The period on which the budget limit recurs. | [optional]
10
+ **entities** | **Array<String>** | The entity that this limit applies to. |
11
+ **imported** | **Boolean** | Indicates whether this limit configuration is managed via a CSV file. |
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'TalonOne'
17
+
18
+ instance = TalonOne::CampaignStoreBudgetLimitConfig.new(action: createCoupon,
19
+ limit: 1000.0,
20
+ period: yearly,
21
+ entities: [Coupon],
22
+ imported: null)
23
+ ```
24
+
25
+
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
29
29
  **updated** | **DateTime** | Timestamp of the most recent update to the campaign template or any of its elements. | [optional]
30
30
  **updated_by** | **String** | Name of the user who last updated this campaign template, if available. | [optional]
31
31
  **valid_application_ids** | **Array<Integer>** | The IDs of the Applications that are related to this entity. |
32
+ **is_user_favorite** | **Boolean** | A flag indicating whether the user marked the template as a favorite. | [optional] [default to false]
32
33
 
33
34
  ## Code Sample
34
35
 
@@ -59,7 +60,8 @@ instance = TalonOne::CampaignTemplate.new(id: 6,
59
60
  campaign_type: advanced,
60
61
  updated: 2022-08-24T14:15:22Z,
61
62
  updated_by: Jane Doe,
62
- valid_application_ids: [1, 2, 3])
63
+ valid_application_ids: [1, 2, 3],
64
+ is_user_favorite: false)
63
65
  ```
64
66
 
65
67
 
@@ -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
 
@@ -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
 
@@ -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]
@@ -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` |
@@ -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
 
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **title** | **String** | The display name for the achievement in the Campaign Manager. |
9
9
  **description** | **String** | A description of the achievement. |
10
10
  **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
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. |
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
12
  **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
13
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
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]
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **referrals** | [**Array<InventoryReferral>**](InventoryReferral.md) | | [optional]
10
10
  **coupons** | [**Array<InventoryCoupon>**](InventoryCoupon.md) | The coupons reserved by this profile. This array includes hard and soft reservations. | [optional]
11
11
  **giveaways** | [**Array<Giveaway>**](Giveaway.md) | | [optional]
12
- **achievements** | [**Array<AchievementProgress>**](AchievementProgress.md) | | [optional]
12
+ **achievements** | [**Array<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) | | [optional]
13
13
 
14
14
  ## Code Sample
15
15
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **integration_id** | **String** | The integration ID set by your integration layer. |
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** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. |
11
11
  **coupon** | **String** | Any coupon code entered. |
12
12
  **referral** | **String** | Any referral code entered. |
@@ -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
  **integration_id** | **String** | The integration ID set by your integration layer. |
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
  **profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. |
12
12
  **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
13
13
  **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
@@ -24,7 +24,6 @@ Name | Type | Description | Notes
24
24
  **cart_item_total** | **Float** | The total value of cart items, before any discounts are applied. |
25
25
  **additional_cost_total** | **Float** | The total value of additional costs, before any discounts are applied. |
26
26
  **updated** | **DateTime** | Timestamp of the most recent event received on this session. |
27
- **closure_prediction** | **Float** | The likelihood of the customer session closing based on predictive modeling, expressed as a decimal between `0` and `1`. | [optional]
28
27
 
29
28
  ## Code Sample
30
29
 
@@ -50,8 +49,7 @@ instance = TalonOne::CustomerSessionV2.new(id: 6,
50
49
  total: 119.99,
51
50
  cart_item_total: 99.99,
52
51
  additional_cost_total: 20.0,
53
- updated: 2020-02-08T14:15:22Z,
54
- closure_prediction: 0.283)
52
+ updated: 2020-02-08T14:15:22Z)
55
53
  ```
56
54
 
57
55
 
data/docs/Environment.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
  **slots** | [**Array<SlotDef>**](SlotDef.md) | The slots defined for this application. |
11
11
  **functions** | [**Array<FunctionDef>**](FunctionDef.md) | The functions defined for this application. |
12
12
  **templates** | [**Array<TemplateDef>**](TemplateDef.md) | The templates defined for this application. |
data/docs/Event.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** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
11
11
  **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
12
12
  **type** | **String** | A string representing the event. Must not be a reserved event name. |
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | Notification name. |
8
8
  **triggers** | [**Array<ExpiringCouponsNotificationTrigger>**](ExpiringCouponsNotificationTrigger.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::ExpiringCouponsNotificationPolicy.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
 
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | Notification name. |
8
8
  **triggers** | [**Array<ExpiringPointsNotificationTrigger>**](ExpiringPointsNotificationTrigger.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::ExpiringPointsNotificationPolicy.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
 
@@ -0,0 +1,23 @@
1
+ # TalonOne::HiddenConditionsEffects
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **built_in_effects** | **Array<String>** | List of hidden built-in effects. | [optional]
8
+ **conditions** | **Array<String>** | List of hidden conditions. | [optional]
9
+ **custom_effects** | **Array<Integer>** | List of the IDs of hidden custom effects. | [optional]
10
+ **webhooks** | **Array<Integer>** | List of the IDs of hidden webhooks. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TalonOne'
16
+
17
+ instance = TalonOne::HiddenConditionsEffects.new(built_in_effects: [addFreeItem, createNotification],
18
+ conditions: [checkAttributeValue, couponCodeIsValid],
19
+ custom_effects: [1, 2],
20
+ webhooks: [3, 4])
21
+ ```
22
+
23
+
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | |
8
- **data** | [**Array<CardLedgerTransactionLogEntryIntegrationAPI>**](CardLedgerTransactionLogEntryIntegrationAPI.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<AchievementStatusEntry>**](AchievementStatusEntry.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse2001.new(has_more: true,
15
+ instance = TalonOne::InlineResponse2001.new(total_result_size: 1,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | |
8
- **data** | [**Array<Referral>**](Referral.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<Coupon>**](Coupon.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20010.new(has_more: true,
15
+ instance = TalonOne::InlineResponse20010.new(total_result_size: 1,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total_result_size** | **Integer** | |
8
- **data** | [**Array<CampaignGroup>**](CampaignGroup.md) | |
7
+ **has_more** | **Boolean** | |
8
+ **data** | [**Array<Coupon>**](Coupon.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20011.new(total_result_size: 1,
15
+ instance = TalonOne::InlineResponse20011.new(has_more: true,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **has_more** | **Boolean** | |
8
- **data** | [**Array<CampaignTemplate>**](CampaignTemplate.md) | |
8
+ **data** | [**Array<Referral>**](Referral.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **total_result_size** | **Integer** | |
8
- **data** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | |
8
+ **data** | [**Array<CampaignGroup>**](CampaignGroup.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **has_more** | **Boolean** | |
8
- **data** | [**Array<LoyaltyProgramTransaction>**](LoyaltyProgramTransaction.md) | |
8
+ **data** | [**Array<CampaignTemplate>**](CampaignTemplate.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | |
8
- **data** | [**Array<LoyaltyCard>**](LoyaltyCard.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20015.new(has_more: true,
15
+ instance = TalonOne::InlineResponse20015.new(total_result_size: 1,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | true means there is more data in the source collection to request.. |
8
- **data** | [**Array<CardLedgerTransactionLogEntry>**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<LoyaltyDashboardData>**](LoyaltyDashboardData.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20016.new(has_more: true,
15
+ instance = TalonOne::InlineResponse20016.new(total_result_size: 1,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -4,17 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | | [optional]
8
- **total_result_size** | **Integer** | | [optional]
9
- **data** | [**Array<CollectionWithoutPayload>**](CollectionWithoutPayload.md) | |
7
+ **has_more** | **Boolean** | |
8
+ **data** | [**Array<LoyaltyProgramTransaction>**](LoyaltyProgramTransaction.md) | |
10
9
 
11
10
  ## Code Sample
12
11
 
13
12
  ```ruby
14
13
  require 'TalonOne'
15
14
 
16
- instance = TalonOne::InlineResponse20017.new(has_more: null,
17
- total_result_size: 1,
15
+ instance = TalonOne::InlineResponse20017.new(has_more: true,
18
16
  data: null)
19
17
  ```
20
18
 
@@ -5,14 +5,14 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **has_more** | **Boolean** | |
8
- **data** | [**Array<CollectionItem>**](CollectionItem.md) | |
8
+ **data** | [**Array<LoyaltyCard>**](LoyaltyCard.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20018.new(has_more: null,
15
+ instance = TalonOne::InlineResponse20018.new(has_more: true,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | |
8
- **data** | [**Array<AccessLogEntry>**](AccessLogEntry.md) | |
7
+ **has_more** | **Boolean** | true means there is more data in the source collection to request.. |
8
+ **data** | [**Array<CardLedgerTransactionLogEntry>**](CardLedgerTransactionLogEntry.md) | List of loyalty card transaction logs. |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20019.new(has_more: null,
15
+ instance = TalonOne::InlineResponse20019.new(has_more: true,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | |
8
- **data** | [**Array<LedgerTransactionLogEntryIntegrationAPI>**](LedgerTransactionLogEntryIntegrationAPI.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<AchievementProgress>**](AchievementProgress.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse2002.new(has_more: true,
15
+ instance = TalonOne::InlineResponse2002.new(total_result_size: 1,
16
16
  data: null)
17
17
  ```
18
18