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
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **total_result_size** | **Integer** | |
8
- **data** | [**Array<WebhookWithOutgoingIntegrationDetails>**](WebhookWithOutgoingIntegrationDetails.md) | |
8
+ **data** | [**Array<Attribute>**](Attribute.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -4,15 +4,17 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total_result_size** | **Integer** | |
8
- **data** | [**Array<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
7
+ **has_more** | **Boolean** | | [optional]
8
+ **total_result_size** | **Integer** | | [optional]
9
+ **data** | [**Array<CatalogItem>**](CatalogItem.md) | |
9
10
 
10
11
  ## Code Sample
11
12
 
12
13
  ```ruby
13
14
  require 'TalonOne'
14
15
 
15
- instance = TalonOne::InlineResponse20037.new(total_result_size: 1,
16
+ instance = TalonOne::InlineResponse20037.new(has_more: null,
17
+ total_result_size: 1,
16
18
  data: null)
17
19
  ```
18
20
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **total_result_size** | **Integer** | |
8
- **data** | [**Array<WebhookLogEntry>**](WebhookLogEntry.md) | |
8
+ **data** | [**Array<AccountAdditionalCost>**](AccountAdditionalCost.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<EventType>**](EventType.md) | |
8
+ **data** | [**Array<WebhookWithOutgoingIntegrationDetails>**](WebhookWithOutgoingIntegrationDetails.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<LedgerPointsEntryIntegrationAPI>**](LedgerPointsEntryIntegrationAPI.md) | |
8
+ **data** | [**Array<LedgerTransactionLogEntryIntegrationAPI>**](LedgerTransactionLogEntryIntegrationAPI.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<User>**](User.md) | |
8
+ **data** | [**Array<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -4,9 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total_result_size** | **Integer** | | [optional]
8
- **has_more** | **Boolean** | | [optional]
9
- **data** | [**Array<Change>**](Change.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<WebhookLogEntry>**](WebhookLogEntry.md) | |
10
9
 
11
10
  ## Code Sample
12
11
 
@@ -14,7 +13,6 @@ Name | Type | Description | Notes
14
13
  require 'TalonOne'
15
14
 
16
15
  instance = TalonOne::InlineResponse20041.new(total_result_size: 1,
17
- has_more: null,
18
16
  data: null)
19
17
  ```
20
18
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **total_result_size** | **Integer** | |
8
- **data** | [**Array<Export>**](Export.md) | |
8
+ **data** | [**Array<EventType>**](EventType.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<RoleV2>**](RoleV2.md) | |
8
+ **data** | [**Array<User>**](User.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -4,17 +4,17 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | | [optional]
8
7
  **total_result_size** | **Integer** | | [optional]
9
- **data** | [**Array<Store>**](Store.md) | |
8
+ **has_more** | **Boolean** | | [optional]
9
+ **data** | [**Array<Change>**](Change.md) | |
10
10
 
11
11
  ## Code Sample
12
12
 
13
13
  ```ruby
14
14
  require 'TalonOne'
15
15
 
16
- instance = TalonOne::InlineResponse20044.new(has_more: null,
17
- total_result_size: 1,
16
+ instance = TalonOne::InlineResponse20044.new(total_result_size: 1,
17
+ has_more: null,
18
18
  data: null)
19
19
  ```
20
20
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | | [optional]
8
- **data** | [**Array<Achievement>**](Achievement.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<Export>**](Export.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20045.new(has_more: null,
15
+ instance = TalonOne::InlineResponse20045.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<AchievementProgress>**](AchievementProgress.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<RoleV2>**](RoleV2.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse20046.new(has_more: true,
15
+ instance = TalonOne::InlineResponse20046.new(total_result_size: 1,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -4,15 +4,17 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **has_more** | **Boolean** | |
8
- **data** | [**Array<AchievementProgress>**](AchievementProgress.md) | |
7
+ **has_more** | **Boolean** | | [optional]
8
+ **total_result_size** | **Integer** | | [optional]
9
+ **data** | [**Array<Store>**](Store.md) | |
9
10
 
10
11
  ## Code Sample
11
12
 
12
13
  ```ruby
13
14
  require 'TalonOne'
14
15
 
15
- instance = TalonOne::InlineResponse20047.new(has_more: true,
16
+ instance = TalonOne::InlineResponse20047.new(has_more: null,
17
+ total_result_size: 1,
16
18
  data: null)
17
19
  ```
18
20
 
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **total_result_size** | **Integer** | |
8
- **data** | [**Array<Application>**](Application.md) | |
7
+ **has_more** | **Boolean** | |
8
+ **data** | [**Array<CardLedgerPointsEntryIntegrationAPI>**](CardLedgerPointsEntryIntegrationAPI.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse2005.new(total_result_size: 1,
15
+ instance = TalonOne::InlineResponse2005.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
- **total_result_size** | **Integer** | |
8
- **data** | [**Array<Campaign>**](Campaign.md) | |
7
+ **has_more** | **Boolean** | |
8
+ **data** | [**Array<LedgerPointsEntryIntegrationAPI>**](LedgerPointsEntryIntegrationAPI.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse2006.new(total_result_size: 1,
15
+ instance = TalonOne::InlineResponse2006.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
  **total_result_size** | **Integer** | |
8
- **data** | [**Array<Ruleset>**](Ruleset.md) | |
8
+ **data** | [**Array<Application>**](Application.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<Coupon>**](Coupon.md) | |
8
+ **data** | [**Array<Campaign>**](Campaign.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<Coupon>**](Coupon.md) | |
7
+ **total_result_size** | **Integer** | |
8
+ **data** | [**Array<Ruleset>**](Ruleset.md) | |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'TalonOne'
14
14
 
15
- instance = TalonOne::InlineResponse2009.new(has_more: true,
15
+ instance = TalonOne::InlineResponse2009.new(total_result_size: 1,
16
16
  data: null)
17
17
  ```
18
18
 
@@ -13,6 +13,8 @@ Method | HTTP request | Description
13
13
  [**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
14
14
  [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data
15
15
  [**generate_loyalty_card**](IntegrationApi.md#generate_loyalty_card) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card
16
+ [**get_customer_achievement_history**](IntegrationApi.md#get_customer_achievement_history) | **GET** /v1/customer_profiles/{integrationId}/achievements/{achievementId} | List customer's achievement history
17
+ [**get_customer_achievements**](IntegrationApi.md#get_customer_achievements) | **GET** /v1/customer_profiles/{integrationId}/achievements | List customer's available achievements
16
18
  [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
17
19
  [**get_customer_session**](IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
18
20
  [**get_loyalty_balances**](IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances
@@ -152,7 +154,7 @@ Name | Type | Description | Notes
152
154
 
153
155
  Create referral code for an advocate
154
156
 
155
- Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
157
+ Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
156
158
 
157
159
  ### Example
158
160
 
@@ -206,7 +208,7 @@ Name | Type | Description | Notes
206
208
 
207
209
  Create referral codes for multiple advocates
208
210
 
209
- Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
211
+ Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
210
212
 
211
213
  ### Example
212
214
 
@@ -224,7 +226,7 @@ end
224
226
  api_instance = TalonOne::IntegrationApi.new
225
227
  body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates | body
226
228
  opts = {
227
- silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
229
+ silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
228
230
  }
229
231
 
230
232
  begin
@@ -242,7 +244,7 @@ end
242
244
  Name | Type | Description | Notes
243
245
  ------------- | ------------- | ------------- | -------------
244
246
  **body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md)| body |
245
- **silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [optional] [default to 'yes']
247
+ **silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [optional] [default to 'yes']
246
248
 
247
249
  ### Return type
248
250
 
@@ -528,6 +530,142 @@ Name | Type | Description | Notes
528
530
  - **Accept**: application/json
529
531
 
530
532
 
533
+ ## get_customer_achievement_history
534
+
535
+ > InlineResponse2002 get_customer_achievement_history(integration_id, achievement_id, opts)
536
+
537
+ List customer's achievement history
538
+
539
+ Retrieve all progress history of a given customer in the given achievement.
540
+
541
+ ### Example
542
+
543
+ ```ruby
544
+ # load the gem
545
+ require 'talon_one'
546
+ # setup authorization
547
+ TalonOne.configure do |config|
548
+ # Configure API key authorization: api_key_v1
549
+ config.api_key['Authorization'] = 'YOUR API KEY'
550
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
551
+ #config.api_key_prefix['Authorization'] = 'Bearer'
552
+ end
553
+
554
+ api_instance = TalonOne::IntegrationApi.new
555
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
556
+ achievement_id = 56 # Integer | The achievement identifier.
557
+ opts = {
558
+ progress_status: ['progress_status_example'], # Array<String> | Filter by customer progress status in the achievement.
559
+ start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Timestamp that filters the results to only contain achievements created on or after the start date.
560
+ end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Timestamp that filters the results to only contain achievements created before or on the end date.
561
+ page_size: 1000, # Integer | The number of items in the response.
562
+ skip: 56 # Integer | The number of items to skip when paging through large result sets.
563
+ }
564
+
565
+ begin
566
+ #List customer's achievement history
567
+ result = api_instance.get_customer_achievement_history(integration_id, achievement_id, opts)
568
+ p result
569
+ rescue TalonOne::ApiError => e
570
+ puts "Exception when calling IntegrationApi->get_customer_achievement_history: #{e}"
571
+ end
572
+ ```
573
+
574
+ ### Parameters
575
+
576
+
577
+ Name | Type | Description | Notes
578
+ ------------- | ------------- | ------------- | -------------
579
+ **integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
580
+ **achievement_id** | **Integer**| The achievement identifier. |
581
+ **progress_status** | [**Array&lt;String&gt;**](String.md)| Filter by customer progress status in the achievement. | [optional]
582
+ **start_date** | **DateTime**| Timestamp that filters the results to only contain achievements created on or after the start date. | [optional]
583
+ **end_date** | **DateTime**| Timestamp that filters the results to only contain achievements created before or on the end date. | [optional]
584
+ **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
585
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
586
+
587
+ ### Return type
588
+
589
+ [**InlineResponse2002**](InlineResponse2002.md)
590
+
591
+ ### Authorization
592
+
593
+ [api_key_v1](../README.md#api_key_v1)
594
+
595
+ ### HTTP request headers
596
+
597
+ - **Content-Type**: Not defined
598
+ - **Accept**: application/json
599
+
600
+
601
+ ## get_customer_achievements
602
+
603
+ > InlineResponse2001 get_customer_achievements(integration_id, opts)
604
+
605
+ List customer's available achievements
606
+
607
+ Retrieve all the achievements available to a given customer and their progress in them.
608
+
609
+ ### Example
610
+
611
+ ```ruby
612
+ # load the gem
613
+ require 'talon_one'
614
+ # setup authorization
615
+ TalonOne.configure do |config|
616
+ # Configure API key authorization: api_key_v1
617
+ config.api_key['Authorization'] = 'YOUR API KEY'
618
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
619
+ #config.api_key_prefix['Authorization'] = 'Bearer'
620
+ end
621
+
622
+ api_instance = TalonOne::IntegrationApi.new
623
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
624
+ opts = {
625
+ campaign_ids: ['campaign_ids_example'], # Array<String> | Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned.
626
+ achievement_ids: ['achievement_ids_example'], # Array<String> | Filter by one or more Achievement IDs, separated by a comma. **Note:** If no achievements are specified, data for all the achievements in the Application is returned.
627
+ achievement_status: ['achievement_status_example'], # Array<String> | Filter by status of the achievement. **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned.
628
+ current_progress_status: ['current_progress_status_example'], # Array<String> | Filter by customer progress status in the achievement.
629
+ page_size: 1000, # Integer | The number of items in the response.
630
+ skip: 56 # Integer | The number of items to skip when paging through large result sets.
631
+ }
632
+
633
+ begin
634
+ #List customer's available achievements
635
+ result = api_instance.get_customer_achievements(integration_id, opts)
636
+ p result
637
+ rescue TalonOne::ApiError => e
638
+ puts "Exception when calling IntegrationApi->get_customer_achievements: #{e}"
639
+ end
640
+ ```
641
+
642
+ ### Parameters
643
+
644
+
645
+ Name | Type | Description | Notes
646
+ ------------- | ------------- | ------------- | -------------
647
+ **integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
648
+ **campaign_ids** | [**Array&lt;String&gt;**](String.md)| Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. | [optional]
649
+ **achievement_ids** | [**Array&lt;String&gt;**](String.md)| Filter by one or more Achievement IDs, separated by a comma. **Note:** If no achievements are specified, data for all the achievements in the Application is returned. | [optional]
650
+ **achievement_status** | [**Array&lt;String&gt;**](String.md)| Filter by status of the achievement. **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned. | [optional]
651
+ **current_progress_status** | [**Array&lt;String&gt;**](String.md)| Filter by customer progress status in the achievement. | [optional]
652
+ **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
653
+ **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
654
+
655
+ ### Return type
656
+
657
+ [**InlineResponse2001**](InlineResponse2001.md)
658
+
659
+ ### Authorization
660
+
661
+ [api_key_v1](../README.md#api_key_v1)
662
+
663
+ ### HTTP request headers
664
+
665
+ - **Content-Type**: Not defined
666
+ - **Accept**: application/json
667
+
668
+
531
669
  ## get_customer_inventory
532
670
 
533
671
  > CustomerInventory get_customer_inventory(integration_id, opts)
@@ -780,7 +918,7 @@ Name | Type | Description | Notes
780
918
 
781
919
  ## get_loyalty_card_points
782
920
 
783
- > InlineResponse2003 get_loyalty_card_points(loyalty_program_id, loyalty_card_id, opts)
921
+ > InlineResponse2005 get_loyalty_card_points(loyalty_program_id, loyalty_card_id, opts)
784
922
 
785
923
  List card's unused loyalty points
786
924
 
@@ -832,7 +970,7 @@ Name | Type | Description | Notes
832
970
 
833
971
  ### Return type
834
972
 
835
- [**InlineResponse2003**](InlineResponse2003.md)
973
+ [**InlineResponse2005**](InlineResponse2005.md)
836
974
 
837
975
  ### Authorization
838
976
 
@@ -846,7 +984,7 @@ Name | Type | Description | Notes
846
984
 
847
985
  ## get_loyalty_card_transactions
848
986
 
849
- > InlineResponse2001 get_loyalty_card_transactions(loyalty_program_id, loyalty_card_id, opts)
987
+ > InlineResponse2003 get_loyalty_card_transactions(loyalty_program_id, loyalty_card_id, opts)
850
988
 
851
989
  List card's transactions
852
990
 
@@ -873,7 +1011,7 @@ opts = {
873
1011
  loyalty_transaction_type: 'loyalty_transaction_type_example', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
874
1012
  start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
875
1013
  end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
876
- page_size: 1000, # Integer | The number of items in the response.
1014
+ page_size: 50, # Integer | The number of items in the response.
877
1015
  skip: 56 # Integer | The number of items to skip when paging through large result sets.
878
1016
  }
879
1017
 
@@ -897,12 +1035,12 @@ Name | Type | Description | Notes
897
1035
  **loyalty_transaction_type** | **String**| Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file. | [optional]
898
1036
  **start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional]
899
1037
  **end_date** | **DateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional]
900
- **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
1038
+ **page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
901
1039
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
902
1040
 
903
1041
  ### Return type
904
1042
 
905
- [**InlineResponse2001**](InlineResponse2001.md)
1043
+ [**InlineResponse2003**](InlineResponse2003.md)
906
1044
 
907
1045
  ### Authorization
908
1046
 
@@ -916,7 +1054,7 @@ Name | Type | Description | Notes
916
1054
 
917
1055
  ## get_loyalty_program_profile_points
918
1056
 
919
- > InlineResponse2004 get_loyalty_program_profile_points(loyalty_program_id, integration_id, opts)
1057
+ > InlineResponse2006 get_loyalty_program_profile_points(loyalty_program_id, integration_id, opts)
920
1058
 
921
1059
  List customer's unused loyalty points
922
1060
 
@@ -968,7 +1106,7 @@ Name | Type | Description | Notes
968
1106
 
969
1107
  ### Return type
970
1108
 
971
- [**InlineResponse2004**](InlineResponse2004.md)
1109
+ [**InlineResponse2006**](InlineResponse2006.md)
972
1110
 
973
1111
  ### Authorization
974
1112
 
@@ -982,7 +1120,7 @@ Name | Type | Description | Notes
982
1120
 
983
1121
  ## get_loyalty_program_profile_transactions
984
1122
 
985
- > InlineResponse2002 get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
1123
+ > InlineResponse2004 get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
986
1124
 
987
1125
  List customer's loyalty transactions
988
1126
 
@@ -1038,7 +1176,7 @@ Name | Type | Description | Notes
1038
1176
 
1039
1177
  ### Return type
1040
1178
 
1041
- [**InlineResponse2002**](InlineResponse2002.md)
1179
+ [**InlineResponse2004**](InlineResponse2004.md)
1042
1180
 
1043
1181
  ### Authorization
1044
1182
 
@@ -1356,7 +1494,7 @@ end
1356
1494
  api_instance = TalonOne::IntegrationApi.new
1357
1495
  body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request | body
1358
1496
  opts = {
1359
- silent: 'yes', # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
1497
+ silent: 'yes', # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
1360
1498
  dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
1361
1499
  }
1362
1500
 
@@ -1375,7 +1513,7 @@ end
1375
1513
  Name | Type | Description | Notes
1376
1514
  ------------- | ------------- | ------------- | -------------
1377
1515
  **body** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md)| body |
1378
- **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. | [optional] [default to &#39;yes&#39;]
1516
+ **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. | [optional] [default to &#39;yes&#39;]
1379
1517
  **dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;. | [optional]
1380
1518
 
1381
1519
  ### Return type
@@ -1642,7 +1780,7 @@ end
1642
1780
  api_instance = TalonOne::IntegrationApi.new
1643
1781
  body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest | body
1644
1782
  opts = {
1645
- silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
1783
+ silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
1646
1784
  }
1647
1785
 
1648
1786
  begin
@@ -1660,7 +1798,7 @@ end
1660
1798
  Name | Type | Description | Notes
1661
1799
  ------------- | ------------- | ------------- | -------------
1662
1800
  **body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| body |
1663
- **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the perfomance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. | [optional] [default to &#39;yes&#39;]
1801
+ **silent** | **String**| Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. | [optional] [default to &#39;yes&#39;]
1664
1802
 
1665
1803
  ### Return type
1666
1804
 
data/docs/LedgerInfo.md CHANGED
@@ -6,10 +6,12 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **current_balance** | **Float** | Sum of currently active points. |
8
8
  **pending_balance** | **Float** | Sum of pending points. |
9
+ **negative_balance** | **Float** | Sum of negative points. This implies that &#x60;currentBalance&#x60; is &#x60;0&#x60;. |
9
10
  **expired_balance** | **Float** | **DEPRECATED** Value is shown as 0. |
10
11
  **spent_balance** | **Float** | **DEPRECATED** Value is shown as 0. |
11
12
  **tentative_current_balance** | **Float** | The tentative points balance, reflecting the &#x60;currentBalance&#x60; and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the &#x60;currentBalance&#x60; is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. |
12
13
  **tentative_pending_balance** | **Float** | The tentative points balance, reflecting the &#x60;pendingBalance&#x60; and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the &#x60;pendingBalance&#x60; is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. | [optional]
14
+ **tentative_negative_balance** | **Float** | The tentative negative balance after all additions and deductions from the current customer session are applied to &#x60;negativeBalance&#x60;. When the session is closed, the tentative effects are applied and &#x60;negativeBalance&#x60; is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. |
13
15
  **current_tier** | [**Tier**](Tier.md) | | [optional]
14
16
  **points_to_next_tier** | **Float** | Points required to move up a tier. | [optional]
15
17
 
@@ -20,10 +22,12 @@ require 'TalonOne'
20
22
 
21
23
  instance = TalonOne::LedgerInfo.new(current_balance: 100.0,
22
24
  pending_balance: 10.0,
25
+ negative_balance: 10.0,
23
26
  expired_balance: 0.0,
24
27
  spent_balance: 0.0,
25
28
  tentative_current_balance: 100.0,
26
29
  tentative_pending_balance: 20.0,
30
+ tentative_negative_balance: 100.0,
27
31
  current_tier: null,
28
32
  points_to_next_tier: 20.0)
29
33
  ```
data/docs/LimitCounter.md CHANGED
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
8
- **application_id** | **Integer** | The ID of the application that owns this entity. |
8
+ **application_id** | **Integer** | The ID of the Application that owns this entity. |
9
9
  **account_id** | **Integer** | The ID of the account that owns this entity. |
10
10
  **id** | **Integer** | Unique ID for this entity. |
11
11
  **action** | **String** | The limitable action of the limit counter. |
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **pending_points** | **Float** | Total amount of points awarded to this customer but not available until their start date. | [optional]
9
9
  **spent_points** | **Float** | Total amount of points already spent by this customer. | [optional]
10
10
  **expired_points** | **Float** | Total amount of points awarded but never redeemed. They cannot be used anymore. | [optional]
11
+ **negative_points** | **Float** | Total amount of negative points. This implies that &#x60;activePoints&#x60; is &#x60;0&#x60;. | [optional]
11
12
 
12
13
  ## Code Sample
13
14
 
@@ -17,7 +18,8 @@ require 'TalonOne'
17
18
  instance = TalonOne::LoyaltyBalance.new(active_points: 286.0,
18
19
  pending_points: 50.0,
19
20
  spent_points: 150.0,
20
- expired_points: 286.0)
21
+ expired_points: 286.0,
22
+ negative_points: 286.0)
21
23
  ```
22
24
 
23
25