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
@@ -21,7 +21,7 @@ module TalonOne
21
21
  end
22
22
  # Enable user by email address
23
23
  # Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
24
- # @param body [DeactivateUserRequest] body
24
+ # @param body [DeleteUserRequest] body
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [nil]
27
27
  def activate_user_by_email(body, opts = {})
@@ -31,7 +31,7 @@ module TalonOne
31
31
 
32
32
  # Enable user by email address
33
33
  # Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
34
- # @param body [DeactivateUserRequest] body
34
+ # @param body [DeleteUserRequest] body
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
37
  def activate_user_by_email_with_http_info(body, opts = {})
@@ -164,7 +164,7 @@ module TalonOne
164
164
  # Add points to customer profile
165
165
  # Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
166
166
  # @param loyalty_program_id [String] The identifier for the loyalty program.
167
- # @param integration_id [String] The identifier of the profile.
167
+ # @param 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.
168
168
  # @param body [AddLoyaltyPoints] body
169
169
  # @param [Hash] opts the optional parameters
170
170
  # @return [nil]
@@ -176,7 +176,7 @@ module TalonOne
176
176
  # Add points to customer profile
177
177
  # Add points in the specified loyalty program for the given customer. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
178
178
  # @param loyalty_program_id [String] The identifier for the loyalty program.
179
- # @param integration_id [String] The identifier of the profile.
179
+ # @param 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.
180
180
  # @param body [AddLoyaltyPoints] body
181
181
  # @param [Hash] opts the optional parameters
182
182
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -243,7 +243,7 @@ module TalonOne
243
243
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
244
244
  # @param body [CampaignCopy] body
245
245
  # @param [Hash] opts the optional parameters
246
- # @return [InlineResponse2006]
246
+ # @return [InlineResponse2008]
247
247
  def copy_campaign_to_applications(application_id, campaign_id, body, opts = {})
248
248
  data, _status_code, _headers = copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts)
249
249
  data
@@ -255,7 +255,7 @@ module TalonOne
255
255
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
256
256
  # @param body [CampaignCopy] body
257
257
  # @param [Hash] opts the optional parameters
258
- # @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
258
+ # @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
259
259
  def copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {})
260
260
  if @api_client.config.debugging
261
261
  @api_client.config.logger.debug 'Calling API: ManagementApi.copy_campaign_to_applications ...'
@@ -292,7 +292,7 @@ module TalonOne
292
292
  post_body = opts[:body] || @api_client.object_to_http_body(body)
293
293
 
294
294
  # return_type
295
- return_type = opts[:return_type] || 'InlineResponse2006'
295
+ return_type = opts[:return_type] || 'InlineResponse2008'
296
296
 
297
297
  # auth_names
298
298
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -803,8 +803,8 @@ module TalonOne
803
803
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
804
804
  # @param body [NewCoupons] body
805
805
  # @param [Hash] opts the optional parameters
806
- # @option opts [String] :silent 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. (default to 'yes')
807
- # @return [InlineResponse2008]
806
+ # @option opts [String] :silent 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. (default to 'yes')
807
+ # @return [InlineResponse20010]
808
808
  def create_coupons(application_id, campaign_id, body, opts = {})
809
809
  data, _status_code, _headers = create_coupons_with_http_info(application_id, campaign_id, body, opts)
810
810
  data
@@ -816,8 +816,8 @@ module TalonOne
816
816
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
817
817
  # @param body [NewCoupons] body
818
818
  # @param [Hash] opts the optional parameters
819
- # @option opts [String] :silent 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.
820
- # @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
819
+ # @option opts [String] :silent 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.
820
+ # @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
821
821
  def create_coupons_with_http_info(application_id, campaign_id, body, opts = {})
822
822
  if @api_client.config.debugging
823
823
  @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons ...'
@@ -855,7 +855,7 @@ module TalonOne
855
855
  post_body = opts[:body] || @api_client.object_to_http_body(body)
856
856
 
857
857
  # return_type
858
- return_type = opts[:return_type] || 'InlineResponse2008'
858
+ return_type = opts[:return_type] || 'InlineResponse20010'
859
859
 
860
860
  # auth_names
861
861
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -1034,8 +1034,8 @@ module TalonOne
1034
1034
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
1035
1035
  # @param body [NewCouponsForMultipleRecipients] body
1036
1036
  # @param [Hash] opts the optional parameters
1037
- # @option opts [String] :silent 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. (default to 'yes')
1038
- # @return [InlineResponse2008]
1037
+ # @option opts [String] :silent 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. (default to 'yes')
1038
+ # @return [InlineResponse20010]
1039
1039
  def create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {})
1040
1040
  data, _status_code, _headers = create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts)
1041
1041
  data
@@ -1047,8 +1047,8 @@ module TalonOne
1047
1047
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
1048
1048
  # @param body [NewCouponsForMultipleRecipients] body
1049
1049
  # @param [Hash] opts the optional parameters
1050
- # @option opts [String] :silent 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.
1051
- # @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
1050
+ # @option opts [String] :silent 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.
1051
+ # @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
1052
1052
  def create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {})
1053
1053
  if @api_client.config.debugging
1054
1054
  @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_for_multiple_recipients ...'
@@ -1086,7 +1086,7 @@ module TalonOne
1086
1086
  post_body = opts[:body] || @api_client.object_to_http_body(body)
1087
1087
 
1088
1088
  # return_type
1089
- return_type = opts[:return_type] || 'InlineResponse2008'
1089
+ return_type = opts[:return_type] || 'InlineResponse20010'
1090
1090
 
1091
1091
  # auth_names
1092
1092
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -1435,7 +1435,7 @@ module TalonOne
1435
1435
 
1436
1436
  # Disable user by email address
1437
1437
  # [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
1438
- # @param body [DeactivateUserRequest] body
1438
+ # @param body [DeleteUserRequest] body
1439
1439
  # @param [Hash] opts the optional parameters
1440
1440
  # @return [nil]
1441
1441
  def deactivate_user_by_email(body, opts = {})
@@ -1445,7 +1445,7 @@ module TalonOne
1445
1445
 
1446
1446
  # Disable user by email address
1447
1447
  # [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
1448
- # @param body [DeactivateUserRequest] body
1448
+ # @param body [DeleteUserRequest] body
1449
1449
  # @param [Hash] opts the optional parameters
1450
1450
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1451
1451
  def deactivate_user_by_email_with_http_info(body, opts = {})
@@ -2310,7 +2310,7 @@ module TalonOne
2310
2310
 
2311
2311
  # Delete user by email address
2312
2312
  # [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
2313
- # @param body [DeactivateUserRequest] body
2313
+ # @param body [DeleteUserRequest] body
2314
2314
  # @param [Hash] opts the optional parameters
2315
2315
  # @return [nil]
2316
2316
  def delete_user_by_email(body, opts = {})
@@ -2320,7 +2320,7 @@ module TalonOne
2320
2320
 
2321
2321
  # Delete user by email address
2322
2322
  # [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
2323
- # @param body [DeactivateUserRequest] body
2323
+ # @param body [DeleteUserRequest] body
2324
2324
  # @param [Hash] opts the optional parameters
2325
2325
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2326
2326
  def delete_user_by_email_with_http_info(body, opts = {})
@@ -2837,7 +2837,7 @@ module TalonOne
2837
2837
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2838
2838
  # @param [Hash] opts the optional parameters
2839
2839
  # @option opts [Float] :campaign_id Filter results by campaign ID.
2840
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
2840
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
2841
2841
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
2842
2842
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
2843
2843
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -2861,7 +2861,7 @@ module TalonOne
2861
2861
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2862
2862
  # @param [Hash] opts the optional parameters
2863
2863
  # @option opts [Float] :campaign_id Filter results by campaign ID.
2864
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
2864
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
2865
2865
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
2866
2866
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
2867
2867
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -3544,11 +3544,11 @@ module TalonOne
3544
3544
  end
3545
3545
 
3546
3546
  # Export customer's transaction logs
3547
- # Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
3547
+ # Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
3548
3548
  # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This 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.
3549
3549
  # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This 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.
3550
3550
  # @param loyalty_program_id [String] The identifier for the loyalty program.
3551
- # @param integration_id [String] The identifier of the profile.
3551
+ # @param 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.
3552
3552
  # @param [Hash] opts the optional parameters
3553
3553
  # @option opts [String] :date_format Determines the format of dates in the export document.
3554
3554
  # @return [String]
@@ -3558,11 +3558,11 @@ module TalonOne
3558
3558
  end
3559
3559
 
3560
3560
  # Export customer&#39;s transaction logs
3561
- # Download a CSV file containing a customer&#39;s transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - &#x60;customerprofileid&#x60;: The ID of the profile. - &#x60;customersessionid&#x60;: The ID of the customer session. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;rulename&#x60;: The name of the rule. - &#x60;programid&#x60;: The ID of the loyalty program. - &#x60;type&#x60;: The transaction type, such as &#x60;addition&#x60; or &#x60;subtraction&#x60;. - &#x60;name&#x60;: The reason for the transaction. - &#x60;subledgerid&#x60;: The ID of the subledger, when applicable. - &#x60;startdate&#x60;: The start date of the program. - &#x60;expirydate&#x60;: The expiration date of the program. - &#x60;id&#x60;: The ID of the transaction. - &#x60;created&#x60;: The timestamp of the creation of the loyalty program. - &#x60;amount&#x60;: The number of points in that transaction. - &#x60;archived&#x60;: Whether the session related to the transaction is archived. - &#x60;campaignid&#x60;: The ID of the campaign.
3561
+ # Download a CSV file containing a customer&#39;s transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - &#x60;customerprofileid&#x60;: The ID of the profile. - &#x60;customersessionid&#x60;: The ID of the customer session. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;rulename&#x60;: The name of the rule. - &#x60;programid&#x60;: The ID of the loyalty program. - &#x60;type&#x60;: The transaction type, such as &#x60;addition&#x60; or &#x60;subtraction&#x60;. - &#x60;name&#x60;: The reason for the transaction. - &#x60;subledgerid&#x60;: The ID of the subledger, when applicable. - &#x60;startdate&#x60;: The start date of the program. - &#x60;expirydate&#x60;: The expiration date of the program. - &#x60;id&#x60;: The ID of the transaction. - &#x60;created&#x60;: The timestamp of the creation of the loyalty program. - &#x60;amount&#x60;: The number of points in that transaction. - &#x60;archived&#x60;: Whether the session related to the transaction is archived. - &#x60;campaignid&#x60;: The ID of the campaign. - &#x60;flags&#x60;: The flags of the transaction, when applicable. The &#x60;createsNegativeBalance&#x60; flag indicates whether the transaction results in a negative balance.
3562
3562
  # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This 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.
3563
3563
  # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This 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.
3564
3564
  # @param loyalty_program_id [String] The identifier for the loyalty program.
3565
- # @param integration_id [String] The identifier of the profile.
3565
+ # @param 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.
3566
3566
  # @param [Hash] opts the optional parameters
3567
3567
  # @option opts [String] :date_format Determines the format of dates in the export document.
3568
3568
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
@@ -3806,8 +3806,8 @@ module TalonOne
3806
3806
  # @option opts [String] :status Filter results by HTTP status codes.
3807
3807
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
3808
3808
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
3809
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
3810
- # @return [InlineResponse20019]
3809
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
3810
+ # @return [InlineResponse20022]
3811
3811
  def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
3812
3812
  data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
3813
3813
  data
@@ -3824,8 +3824,8 @@ module TalonOne
3824
3824
  # @option opts [String] :status Filter results by HTTP status codes.
3825
3825
  # @option opts [Integer] :page_size The number of items in the response.
3826
3826
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
3827
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
3828
- # @return [Array<(InlineResponse20019, Integer, Hash)>] InlineResponse20019 data, response status code and response headers
3827
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
3828
+ # @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
3829
3829
  def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
3830
3830
  if @api_client.config.debugging
3831
3831
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs_without_total_count ...'
@@ -3884,7 +3884,7 @@ module TalonOne
3884
3884
  post_body = opts[:body]
3885
3885
 
3886
3886
  # return_type
3887
- return_type = opts[:return_type] || 'InlineResponse20019'
3887
+ return_type = opts[:return_type] || 'InlineResponse20022'
3888
3888
 
3889
3889
  # auth_names
3890
3890
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -4232,8 +4232,8 @@ module TalonOne
4232
4232
  # @param [Hash] opts the optional parameters
4233
4233
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4234
4234
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4235
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4236
- # @return [InlineResponse20035]
4235
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4236
+ # @return [InlineResponse20038]
4237
4237
  def get_additional_costs(opts = {})
4238
4238
  data, _status_code, _headers = get_additional_costs_with_http_info(opts)
4239
4239
  data
@@ -4244,8 +4244,8 @@ module TalonOne
4244
4244
  # @param [Hash] opts the optional parameters
4245
4245
  # @option opts [Integer] :page_size The number of items in the response.
4246
4246
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4247
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4248
- # @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
4247
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4248
+ # @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
4249
4249
  def get_additional_costs_with_http_info(opts = {})
4250
4250
  if @api_client.config.debugging
4251
4251
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
@@ -4279,7 +4279,7 @@ module TalonOne
4279
4279
  post_body = opts[:body]
4280
4280
 
4281
4281
  # return_type
4282
- return_type = opts[:return_type] || 'InlineResponse20035'
4282
+ return_type = opts[:return_type] || 'InlineResponse20038'
4283
4283
 
4284
4284
  # auth_names
4285
4285
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -4499,9 +4499,9 @@ module TalonOne
4499
4499
  # @param [Hash] opts the optional parameters
4500
4500
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4501
4501
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4502
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4502
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4503
4503
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4504
- # @return [InlineResponse20032]
4504
+ # @return [InlineResponse20035]
4505
4505
  def get_application_customer_friends(application_id, integration_id, opts = {})
4506
4506
  data, _status_code, _headers = get_application_customer_friends_with_http_info(application_id, integration_id, opts)
4507
4507
  data
@@ -4514,9 +4514,9 @@ module TalonOne
4514
4514
  # @param [Hash] opts the optional parameters
4515
4515
  # @option opts [Integer] :page_size The number of items in the response.
4516
4516
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4517
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4517
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4518
4518
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4519
- # @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
4519
+ # @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
4520
4520
  def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
4521
4521
  if @api_client.config.debugging
4522
4522
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer_friends ...'
@@ -4559,7 +4559,7 @@ module TalonOne
4559
4559
  post_body = opts[:body]
4560
4560
 
4561
4561
  # return_type
4562
- return_type = opts[:return_type] || 'InlineResponse20032'
4562
+ return_type = opts[:return_type] || 'InlineResponse20035'
4563
4563
 
4564
4564
  # auth_names
4565
4565
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -4588,7 +4588,7 @@ module TalonOne
4588
4588
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4589
4589
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4590
4590
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4591
- # @return [InlineResponse20021]
4591
+ # @return [InlineResponse20024]
4592
4592
  def get_application_customers(application_id, opts = {})
4593
4593
  data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts)
4594
4594
  data
@@ -4602,7 +4602,7 @@ module TalonOne
4602
4602
  # @option opts [Integer] :page_size The number of items in the response.
4603
4603
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4604
4604
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4605
- # @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
4605
+ # @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
4606
4606
  def get_application_customers_with_http_info(application_id, opts = {})
4607
4607
  if @api_client.config.debugging
4608
4608
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...'
@@ -4641,7 +4641,7 @@ module TalonOne
4641
4641
  post_body = opts[:body]
4642
4642
 
4643
4643
  # return_type
4644
- return_type = opts[:return_type] || 'InlineResponse20021'
4644
+ return_type = opts[:return_type] || 'InlineResponse20024'
4645
4645
 
4646
4646
  # auth_names
4647
4647
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -4670,7 +4670,7 @@ module TalonOne
4670
4670
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4671
4671
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4672
4672
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4673
- # @return [InlineResponse20022]
4673
+ # @return [InlineResponse20025]
4674
4674
  def get_application_customers_by_attributes(application_id, body, opts = {})
4675
4675
  data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(application_id, body, opts)
4676
4676
  data
@@ -4684,7 +4684,7 @@ module TalonOne
4684
4684
  # @option opts [Integer] :page_size The number of items in the response.
4685
4685
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4686
4686
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4687
- # @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
4687
+ # @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
4688
4688
  def get_application_customers_by_attributes_with_http_info(application_id, body, opts = {})
4689
4689
  if @api_client.config.debugging
4690
4690
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...'
@@ -4728,7 +4728,7 @@ module TalonOne
4728
4728
  post_body = opts[:body] || @api_client.object_to_http_body(body)
4729
4729
 
4730
4730
  # return_type
4731
- return_type = opts[:return_type] || 'InlineResponse20022'
4731
+ return_type = opts[:return_type] || 'InlineResponse20025'
4732
4732
 
4733
4733
  # auth_names
4734
4734
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -4755,8 +4755,8 @@ module TalonOne
4755
4755
  # @param [Hash] opts the optional parameters
4756
4756
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4757
4757
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4758
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4759
- # @return [InlineResponse20028]
4758
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4759
+ # @return [InlineResponse20031]
4760
4760
  def get_application_event_types(application_id, opts = {})
4761
4761
  data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
4762
4762
  data
@@ -4768,8 +4768,8 @@ module TalonOne
4768
4768
  # @param [Hash] opts the optional parameters
4769
4769
  # @option opts [Integer] :page_size The number of items in the response.
4770
4770
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4771
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4772
- # @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
4771
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4772
+ # @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
4773
4773
  def get_application_event_types_with_http_info(application_id, opts = {})
4774
4774
  if @api_client.config.debugging
4775
4775
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...'
@@ -4807,7 +4807,7 @@ module TalonOne
4807
4807
  post_body = opts[:body]
4808
4808
 
4809
4809
  # return_type
4810
- return_type = opts[:return_type] || 'InlineResponse20028'
4810
+ return_type = opts[:return_type] || 'InlineResponse20031'
4811
4811
 
4812
4812
  # auth_names
4813
4813
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -4834,7 +4834,7 @@ module TalonOne
4834
4834
  # @param [Hash] opts the optional parameters
4835
4835
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4836
4836
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4837
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4837
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4838
4838
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
4839
4839
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
4840
4840
  # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -4846,7 +4846,7 @@ module TalonOne
4846
4846
  # @option opts [String] :referral_code Referral code
4847
4847
  # @option opts [String] :rule_query Rule name filter for events
4848
4848
  # @option opts [String] :campaign_query Campaign name filter for events
4849
- # @return [InlineResponse20027]
4849
+ # @return [InlineResponse20030]
4850
4850
  def get_application_events_without_total_count(application_id, opts = {})
4851
4851
  data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
4852
4852
  data
@@ -4858,7 +4858,7 @@ module TalonOne
4858
4858
  # @param [Hash] opts the optional parameters
4859
4859
  # @option opts [Integer] :page_size The number of items in the response.
4860
4860
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4861
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
4861
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4862
4862
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
4863
4863
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
4864
4864
  # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -4870,7 +4870,7 @@ module TalonOne
4870
4870
  # @option opts [String] :referral_code Referral code
4871
4871
  # @option opts [String] :rule_query Rule name filter for events
4872
4872
  # @option opts [String] :campaign_query Campaign name filter for events
4873
- # @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
4873
+ # @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
4874
4874
  def get_application_events_without_total_count_with_http_info(application_id, opts = {})
4875
4875
  if @api_client.config.debugging
4876
4876
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...'
@@ -4927,7 +4927,7 @@ module TalonOne
4927
4927
  post_body = opts[:body]
4928
4928
 
4929
4929
  # return_type
4930
- return_type = opts[:return_type] || 'InlineResponse20027'
4930
+ return_type = opts[:return_type] || 'InlineResponse20030'
4931
4931
 
4932
4932
  # auth_names
4933
4933
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5022,7 +5022,7 @@ module TalonOne
5022
5022
  # @param [Hash] opts the optional parameters
5023
5023
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5024
5024
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5025
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5025
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5026
5026
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
5027
5027
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
5028
5028
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -5031,7 +5031,7 @@ module TalonOne
5031
5031
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
5032
5032
  # @option opts [String] :integration_id Filter by sessions with this integration ID. Must be exact match.
5033
5033
  # @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
5034
- # @return [InlineResponse20026]
5034
+ # @return [InlineResponse20029]
5035
5035
  def get_application_sessions(application_id, opts = {})
5036
5036
  data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts)
5037
5037
  data
@@ -5043,7 +5043,7 @@ module TalonOne
5043
5043
  # @param [Hash] opts the optional parameters
5044
5044
  # @option opts [Integer] :page_size The number of items in the response.
5045
5045
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5046
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5046
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5047
5047
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
5048
5048
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
5049
5049
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -5052,7 +5052,7 @@ module TalonOne
5052
5052
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
5053
5053
  # @option opts [String] :integration_id Filter by sessions with this integration ID. Must be exact match.
5054
5054
  # @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
5055
- # @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
5055
+ # @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
5056
5056
  def get_application_sessions_with_http_info(application_id, opts = {})
5057
5057
  if @api_client.config.debugging
5058
5058
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...'
@@ -5102,7 +5102,7 @@ module TalonOne
5102
5102
  post_body = opts[:body]
5103
5103
 
5104
5104
  # return_type
5105
- return_type = opts[:return_type] || 'InlineResponse20026'
5105
+ return_type = opts[:return_type] || 'InlineResponse20029'
5106
5106
 
5107
5107
  # auth_names
5108
5108
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5128,8 +5128,8 @@ module TalonOne
5128
5128
  # @param [Hash] opts the optional parameters
5129
5129
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5130
5130
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5131
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5132
- # @return [InlineResponse2005]
5131
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5132
+ # @return [InlineResponse2007]
5133
5133
  def get_applications(opts = {})
5134
5134
  data, _status_code, _headers = get_applications_with_http_info(opts)
5135
5135
  data
@@ -5140,8 +5140,8 @@ module TalonOne
5140
5140
  # @param [Hash] opts the optional parameters
5141
5141
  # @option opts [Integer] :page_size The number of items in the response.
5142
5142
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5143
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5144
- # @return [Array<(InlineResponse2005, Integer, Hash)>] InlineResponse2005 data, response status code and response headers
5143
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5144
+ # @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
5145
5145
  def get_applications_with_http_info(opts = {})
5146
5146
  if @api_client.config.debugging
5147
5147
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_applications ...'
@@ -5175,7 +5175,7 @@ module TalonOne
5175
5175
  post_body = opts[:body]
5176
5176
 
5177
5177
  # return_type
5178
- return_type = opts[:return_type] || 'InlineResponse2005'
5178
+ return_type = opts[:return_type] || 'InlineResponse2007'
5179
5179
 
5180
5180
  # auth_names
5181
5181
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5263,9 +5263,9 @@ module TalonOne
5263
5263
  # @param [Hash] opts the optional parameters
5264
5264
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5265
5265
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5266
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5266
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5267
5267
  # @option opts [String] :entity Returned attributes will be filtered by supplied entity.
5268
- # @return [InlineResponse20033]
5268
+ # @return [InlineResponse20036]
5269
5269
  def get_attributes(opts = {})
5270
5270
  data, _status_code, _headers = get_attributes_with_http_info(opts)
5271
5271
  data
@@ -5276,9 +5276,9 @@ module TalonOne
5276
5276
  # @param [Hash] opts the optional parameters
5277
5277
  # @option opts [Integer] :page_size The number of items in the response.
5278
5278
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5279
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5279
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5280
5280
  # @option opts [String] :entity Returned attributes will be filtered by supplied entity.
5281
- # @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
5281
+ # @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
5282
5282
  def get_attributes_with_http_info(opts = {})
5283
5283
  if @api_client.config.debugging
5284
5284
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
@@ -5313,7 +5313,7 @@ module TalonOne
5313
5313
  post_body = opts[:body]
5314
5314
 
5315
5315
  # return_type
5316
- return_type = opts[:return_type] || 'InlineResponse20033'
5316
+ return_type = opts[:return_type] || 'InlineResponse20036'
5317
5317
 
5318
5318
  # auth_names
5319
5319
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5340,9 +5340,9 @@ module TalonOne
5340
5340
  # @param [Hash] opts the optional parameters
5341
5341
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5342
5342
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5343
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5343
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5344
5344
  # @option opts [String] :profile_query The filter to select a profile.
5345
- # @return [InlineResponse20031]
5345
+ # @return [InlineResponse20034]
5346
5346
  def get_audience_memberships(audience_id, opts = {})
5347
5347
  data, _status_code, _headers = get_audience_memberships_with_http_info(audience_id, opts)
5348
5348
  data
@@ -5354,9 +5354,9 @@ module TalonOne
5354
5354
  # @param [Hash] opts the optional parameters
5355
5355
  # @option opts [Integer] :page_size The number of items in the response.
5356
5356
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5357
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5357
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5358
5358
  # @option opts [String] :profile_query The filter to select a profile.
5359
- # @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
5359
+ # @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
5360
5360
  def get_audience_memberships_with_http_info(audience_id, opts = {})
5361
5361
  if @api_client.config.debugging
5362
5362
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_audience_memberships ...'
@@ -5395,7 +5395,7 @@ module TalonOne
5395
5395
  post_body = opts[:body]
5396
5396
 
5397
5397
  # return_type
5398
- return_type = opts[:return_type] || 'InlineResponse20031'
5398
+ return_type = opts[:return_type] || 'InlineResponse20034'
5399
5399
 
5400
5400
  # auth_names
5401
5401
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5421,9 +5421,9 @@ module TalonOne
5421
5421
  # @param [Hash] opts the optional parameters
5422
5422
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5423
5423
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5424
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5424
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5425
5425
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
5426
- # @return [InlineResponse20029]
5426
+ # @return [InlineResponse20032]
5427
5427
  def get_audiences(opts = {})
5428
5428
  data, _status_code, _headers = get_audiences_with_http_info(opts)
5429
5429
  data
@@ -5434,9 +5434,9 @@ module TalonOne
5434
5434
  # @param [Hash] opts the optional parameters
5435
5435
  # @option opts [Integer] :page_size The number of items in the response.
5436
5436
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5437
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5437
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5438
5438
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
5439
- # @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
5439
+ # @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
5440
5440
  def get_audiences_with_http_info(opts = {})
5441
5441
  if @api_client.config.debugging
5442
5442
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
@@ -5471,7 +5471,7 @@ module TalonOne
5471
5471
  post_body = opts[:body]
5472
5472
 
5473
5473
  # return_type
5474
- return_type = opts[:return_type] || 'InlineResponse20029'
5474
+ return_type = opts[:return_type] || 'InlineResponse20032'
5475
5475
 
5476
5476
  # auth_names
5477
5477
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5496,8 +5496,8 @@ module TalonOne
5496
5496
  # Get a list of audience IDs and their member count.
5497
5497
  # @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
5498
5498
  # @param [Hash] opts the optional parameters
5499
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5500
- # @return [InlineResponse20030]
5499
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5500
+ # @return [InlineResponse20033]
5501
5501
  def get_audiences_analytics(audience_ids, opts = {})
5502
5502
  data, _status_code, _headers = get_audiences_analytics_with_http_info(audience_ids, opts)
5503
5503
  data
@@ -5507,8 +5507,8 @@ module TalonOne
5507
5507
  # Get a list of audience IDs and their member count.
5508
5508
  # @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
5509
5509
  # @param [Hash] opts the optional parameters
5510
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5511
- # @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
5510
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5511
+ # @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
5512
5512
  def get_audiences_analytics_with_http_info(audience_ids, opts = {})
5513
5513
  if @api_client.config.debugging
5514
5514
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences_analytics ...'
@@ -5537,7 +5537,7 @@ module TalonOne
5537
5537
  post_body = opts[:body]
5538
5538
 
5539
5539
  # return_type
5540
- return_type = opts[:return_type] || 'InlineResponse20030'
5540
+ return_type = opts[:return_type] || 'InlineResponse20033'
5541
5541
 
5542
5542
  # auth_names
5543
5543
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5634,7 +5634,7 @@ module TalonOne
5634
5634
  # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This 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.
5635
5635
  # @param [Hash] opts the optional parameters
5636
5636
  # @option opts [String] :granularity The time interval between the results in the returned time-series.
5637
- # @return [InlineResponse20020]
5637
+ # @return [InlineResponse20023]
5638
5638
  def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {})
5639
5639
  data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts)
5640
5640
  data
@@ -5648,7 +5648,7 @@ module TalonOne
5648
5648
  # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This 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.
5649
5649
  # @param [Hash] opts the optional parameters
5650
5650
  # @option opts [String] :granularity The time interval between the results in the returned time-series.
5651
- # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
5651
+ # @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
5652
5652
  def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {})
5653
5653
  if @api_client.config.debugging
5654
5654
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...'
@@ -5694,7 +5694,7 @@ module TalonOne
5694
5694
  post_body = opts[:body]
5695
5695
 
5696
5696
  # return_type
5697
- return_type = opts[:return_type] || 'InlineResponse20020'
5697
+ return_type = opts[:return_type] || 'InlineResponse20023'
5698
5698
 
5699
5699
  # auth_names
5700
5700
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5722,9 +5722,9 @@ module TalonOne
5722
5722
  # @param [Hash] opts the optional parameters
5723
5723
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5724
5724
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5725
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5725
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5726
5726
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
5727
- # @return [InlineResponse2006]
5727
+ # @return [InlineResponse2008]
5728
5728
  def get_campaign_by_attributes(application_id, body, opts = {})
5729
5729
  data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts)
5730
5730
  data
@@ -5737,9 +5737,9 @@ module TalonOne
5737
5737
  # @param [Hash] opts the optional parameters
5738
5738
  # @option opts [Integer] :page_size The number of items in the response.
5739
5739
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5740
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5740
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5741
5741
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
5742
- # @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
5742
+ # @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
5743
5743
  def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
5744
5744
  if @api_client.config.debugging
5745
5745
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_by_attributes ...'
@@ -5788,7 +5788,7 @@ module TalonOne
5788
5788
  post_body = opts[:body] || @api_client.object_to_http_body(body)
5789
5789
 
5790
5790
  # return_type
5791
- return_type = opts[:return_type] || 'InlineResponse2006'
5791
+ return_type = opts[:return_type] || 'InlineResponse2008'
5792
5792
 
5793
5793
  # auth_names
5794
5794
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5876,8 +5876,8 @@ module TalonOne
5876
5876
  # @param [Hash] opts the optional parameters
5877
5877
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5878
5878
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5879
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5880
- # @return [InlineResponse20011]
5879
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5880
+ # @return [InlineResponse20013]
5881
5881
  def get_campaign_groups(opts = {})
5882
5882
  data, _status_code, _headers = get_campaign_groups_with_http_info(opts)
5883
5883
  data
@@ -5888,8 +5888,8 @@ module TalonOne
5888
5888
  # @param [Hash] opts the optional parameters
5889
5889
  # @option opts [Integer] :page_size The number of items in the response.
5890
5890
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5891
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5892
- # @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
5891
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5892
+ # @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
5893
5893
  def get_campaign_groups_with_http_info(opts = {})
5894
5894
  if @api_client.config.debugging
5895
5895
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_groups ...'
@@ -5923,7 +5923,7 @@ module TalonOne
5923
5923
  post_body = opts[:body]
5924
5924
 
5925
5925
  # return_type
5926
- return_type = opts[:return_type] || 'InlineResponse20011'
5926
+ return_type = opts[:return_type] || 'InlineResponse20013'
5927
5927
 
5928
5928
  # auth_names
5929
5929
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -5949,12 +5949,12 @@ module TalonOne
5949
5949
  # @param [Hash] opts the optional parameters
5950
5950
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5951
5951
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5952
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5952
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5953
5953
  # @option opts [String] :state Filter results by the state of the campaign template.
5954
5954
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
5955
5955
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values.
5956
5956
  # @option opts [Integer] :user_id Filter results by user ID.
5957
- # @return [InlineResponse20012]
5957
+ # @return [InlineResponse20014]
5958
5958
  def get_campaign_templates(opts = {})
5959
5959
  data, _status_code, _headers = get_campaign_templates_with_http_info(opts)
5960
5960
  data
@@ -5965,12 +5965,12 @@ module TalonOne
5965
5965
  # @param [Hash] opts the optional parameters
5966
5966
  # @option opts [Integer] :page_size The number of items in the response.
5967
5967
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5968
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5968
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5969
5969
  # @option opts [String] :state Filter results by the state of the campaign template.
5970
5970
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
5971
5971
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values.
5972
5972
  # @option opts [Integer] :user_id Filter results by user ID.
5973
- # @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
5973
+ # @return [Array<(InlineResponse20014, Integer, Hash)>] InlineResponse20014 data, response status code and response headers
5974
5974
  def get_campaign_templates_with_http_info(opts = {})
5975
5975
  if @api_client.config.debugging
5976
5976
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_templates ...'
@@ -6012,7 +6012,7 @@ module TalonOne
6012
6012
  post_body = opts[:body]
6013
6013
 
6014
6014
  # return_type
6015
- return_type = opts[:return_type] || 'InlineResponse20012'
6015
+ return_type = opts[:return_type] || 'InlineResponse20014'
6016
6016
 
6017
6017
  # auth_names
6018
6018
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -6039,7 +6039,7 @@ module TalonOne
6039
6039
  # @param [Hash] opts the optional parameters
6040
6040
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6041
6041
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6042
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6042
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6043
6043
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
6044
6044
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
6045
6045
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values
@@ -6048,7 +6048,7 @@ module TalonOne
6048
6048
  # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
6049
6049
  # @option opts [Integer] :template_id The ID of the campaign template this campaign was created from.
6050
6050
  # @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
6051
- # @return [InlineResponse2006]
6051
+ # @return [InlineResponse2008]
6052
6052
  def get_campaigns(application_id, opts = {})
6053
6053
  data, _status_code, _headers = get_campaigns_with_http_info(application_id, opts)
6054
6054
  data
@@ -6060,7 +6060,7 @@ module TalonOne
6060
6060
  # @param [Hash] opts the optional parameters
6061
6061
  # @option opts [Integer] :page_size The number of items in the response.
6062
6062
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6063
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6063
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6064
6064
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
6065
6065
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
6066
6066
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values
@@ -6069,7 +6069,7 @@ module TalonOne
6069
6069
  # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
6070
6070
  # @option opts [Integer] :template_id The ID of the campaign template this campaign was created from.
6071
6071
  # @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
6072
- # @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
6072
+ # @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
6073
6073
  def get_campaigns_with_http_info(application_id, opts = {})
6074
6074
  if @api_client.config.debugging
6075
6075
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaigns ...'
@@ -6119,7 +6119,7 @@ module TalonOne
6119
6119
  post_body = opts[:body]
6120
6120
 
6121
6121
  # return_type
6122
- return_type = opts[:return_type] || 'InlineResponse2006'
6122
+ return_type = opts[:return_type] || 'InlineResponse2008'
6123
6123
 
6124
6124
  # auth_names
6125
6125
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -6145,7 +6145,7 @@ module TalonOne
6145
6145
  # @param [Hash] opts the optional parameters
6146
6146
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6147
6147
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6148
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6148
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6149
6149
  # @option opts [Float] :application_id Filter results by Application ID.
6150
6150
  # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
6151
6151
  # @option opts [Integer] :user_id Filter results by user ID.
@@ -6154,7 +6154,7 @@ module TalonOne
6154
6154
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
6155
6155
  # @option opts [Integer] :management_key_id Filter results that match the given management key ID.
6156
6156
  # @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
6157
- # @return [InlineResponse20041]
6157
+ # @return [InlineResponse20044]
6158
6158
  def get_changes(opts = {})
6159
6159
  data, _status_code, _headers = get_changes_with_http_info(opts)
6160
6160
  data
@@ -6165,7 +6165,7 @@ module TalonOne
6165
6165
  # @param [Hash] opts the optional parameters
6166
6166
  # @option opts [Integer] :page_size The number of items in the response.
6167
6167
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6168
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6168
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6169
6169
  # @option opts [Float] :application_id Filter results by Application ID.
6170
6170
  # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
6171
6171
  # @option opts [Integer] :user_id Filter results by user ID.
@@ -6174,7 +6174,7 @@ module TalonOne
6174
6174
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
6175
6175
  # @option opts [Integer] :management_key_id Filter results that match the given management key ID.
6176
6176
  # @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
6177
- # @return [Array<(InlineResponse20041, Integer, Hash)>] InlineResponse20041 data, response status code and response headers
6177
+ # @return [Array<(InlineResponse20044, Integer, Hash)>] InlineResponse20044 data, response status code and response headers
6178
6178
  def get_changes_with_http_info(opts = {})
6179
6179
  if @api_client.config.debugging
6180
6180
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
@@ -6216,7 +6216,7 @@ module TalonOne
6216
6216
  post_body = opts[:body]
6217
6217
 
6218
6218
  # return_type
6219
- return_type = opts[:return_type] || 'InlineResponse20041'
6219
+ return_type = opts[:return_type] || 'InlineResponse20044'
6220
6220
 
6221
6221
  # auth_names
6222
6222
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -6317,7 +6317,7 @@ module TalonOne
6317
6317
  # @param [Hash] opts the optional parameters
6318
6318
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6319
6319
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6320
- # @return [InlineResponse20018]
6320
+ # @return [InlineResponse20021]
6321
6321
  def get_collection_items(collection_id, opts = {})
6322
6322
  data, _status_code, _headers = get_collection_items_with_http_info(collection_id, opts)
6323
6323
  data
@@ -6329,7 +6329,7 @@ module TalonOne
6329
6329
  # @param [Hash] opts the optional parameters
6330
6330
  # @option opts [Integer] :page_size The number of items in the response.
6331
6331
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6332
- # @return [Array<(InlineResponse20018, Integer, Hash)>] InlineResponse20018 data, response status code and response headers
6332
+ # @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
6333
6333
  def get_collection_items_with_http_info(collection_id, opts = {})
6334
6334
  if @api_client.config.debugging
6335
6335
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_collection_items ...'
@@ -6366,7 +6366,7 @@ module TalonOne
6366
6366
  post_body = opts[:body]
6367
6367
 
6368
6368
  # return_type
6369
- return_type = opts[:return_type] || 'InlineResponse20018'
6369
+ return_type = opts[:return_type] || 'InlineResponse20021'
6370
6370
 
6371
6371
  # auth_names
6372
6372
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -6394,7 +6394,7 @@ module TalonOne
6394
6394
  # @param [Hash] opts the optional parameters
6395
6395
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6396
6396
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6397
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6397
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6398
6398
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
6399
6399
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6400
6400
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -6410,7 +6410,7 @@ module TalonOne
6410
6410
  # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6411
6411
  # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6412
6412
  # @option opts [Boolean] :values_only Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data. (default to false)
6413
- # @return [InlineResponse2009]
6413
+ # @return [InlineResponse20011]
6414
6414
  def get_coupons_without_total_count(application_id, campaign_id, opts = {})
6415
6415
  data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts)
6416
6416
  data
@@ -6423,7 +6423,7 @@ module TalonOne
6423
6423
  # @param [Hash] opts the optional parameters
6424
6424
  # @option opts [Integer] :page_size The number of items in the response.
6425
6425
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6426
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6426
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6427
6427
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
6428
6428
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6429
6429
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -6439,7 +6439,7 @@ module TalonOne
6439
6439
  # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6440
6440
  # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6441
6441
  # @option opts [Boolean] :values_only Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data.
6442
- # @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
6442
+ # @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
6443
6443
  def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {})
6444
6444
  if @api_client.config.debugging
6445
6445
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_without_total_count ...'
@@ -6508,7 +6508,7 @@ module TalonOne
6508
6508
  post_body = opts[:body]
6509
6509
 
6510
6510
  # return_type
6511
- return_type = opts[:return_type] || 'InlineResponse2009'
6511
+ return_type = opts[:return_type] || 'InlineResponse20011'
6512
6512
 
6513
6513
  # auth_names
6514
6514
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -6633,12 +6633,12 @@ module TalonOne
6633
6633
  # @param [Hash] opts the optional parameters
6634
6634
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6635
6635
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6636
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6636
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6637
6637
  # @option opts [String] :name Only return reports matching the customer name.
6638
6638
  # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
6639
6639
  # @option opts [String] :campaign_name Only return reports matching the campaign name.
6640
6640
  # @option opts [String] :advocate_name Only return reports matching the current customer referrer name.
6641
- # @return [InlineResponse20025]
6641
+ # @return [InlineResponse20028]
6642
6642
  def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {})
6643
6643
  data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts)
6644
6644
  data
@@ -6652,12 +6652,12 @@ module TalonOne
6652
6652
  # @param [Hash] opts the optional parameters
6653
6653
  # @option opts [Integer] :page_size The number of items in the response.
6654
6654
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6655
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6655
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6656
6656
  # @option opts [String] :name Only return reports matching the customer name.
6657
6657
  # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
6658
6658
  # @option opts [String] :campaign_name Only return reports matching the campaign name.
6659
6659
  # @option opts [String] :advocate_name Only return reports matching the current customer referrer name.
6660
- # @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
6660
+ # @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
6661
6661
  def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {})
6662
6662
  if @api_client.config.debugging
6663
6663
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...'
@@ -6709,7 +6709,7 @@ module TalonOne
6709
6709
  post_body = opts[:body]
6710
6710
 
6711
6711
  # return_type
6712
- return_type = opts[:return_type] || 'InlineResponse20025'
6712
+ return_type = opts[:return_type] || 'InlineResponse20028'
6713
6713
 
6714
6714
  # auth_names
6715
6715
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -6737,7 +6737,7 @@ module TalonOne
6737
6737
  # @param [Hash] opts the optional parameters
6738
6738
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6739
6739
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6740
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6740
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6741
6741
  # @return [CustomerAnalytics]
6742
6742
  def get_customer_analytics(application_id, customer_id, opts = {})
6743
6743
  data, _status_code, _headers = get_customer_analytics_with_http_info(application_id, customer_id, opts)
@@ -6751,7 +6751,7 @@ module TalonOne
6751
6751
  # @param [Hash] opts the optional parameters
6752
6752
  # @option opts [Integer] :page_size The number of items in the response.
6753
6753
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6754
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
6754
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6755
6755
  # @return [Array<(CustomerAnalytics, Integer, Hash)>] CustomerAnalytics data, response status code and response headers
6756
6756
  def get_customer_analytics_with_http_info(application_id, customer_id, opts = {})
6757
6757
  if @api_client.config.debugging
@@ -6880,13 +6880,13 @@ module TalonOne
6880
6880
  # List customer achievements
6881
6881
  # For the given customer profile, list all the achievements that match your filter criteria.
6882
6882
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
6883
- # @param integration_id [String] The identifier of the profile.
6883
+ # @param 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.
6884
6884
  # @param [Hash] opts the optional parameters
6885
6885
  # @option opts [Integer] :page_size The number of items in the response. (default to 50)
6886
6886
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6887
6887
  # @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
6888
6888
  # @option opts [String] :title Filter results by the &#x60;title&#x60; of an achievement.
6889
- # @return [InlineResponse20046]
6889
+ # @return [InlineResponse20049]
6890
6890
  def get_customer_profile_achievement_progress(application_id, integration_id, opts = {})
6891
6891
  data, _status_code, _headers = get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts)
6892
6892
  data
@@ -6895,13 +6895,13 @@ module TalonOne
6895
6895
  # List customer achievements
6896
6896
  # For the given customer profile, list all the achievements that match your filter criteria.
6897
6897
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
6898
- # @param integration_id [String] The identifier of the profile.
6898
+ # @param 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.
6899
6899
  # @param [Hash] opts the optional parameters
6900
6900
  # @option opts [Integer] :page_size The number of items in the response.
6901
6901
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6902
6902
  # @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
6903
6903
  # @option opts [String] :title Filter results by the &#x60;title&#x60; of an achievement.
6904
- # @return [Array<(InlineResponse20046, Integer, Hash)>] InlineResponse20046 data, response status code and response headers
6904
+ # @return [Array<(InlineResponse20049, Integer, Hash)>] InlineResponse20049 data, response status code and response headers
6905
6905
  def get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts = {})
6906
6906
  if @api_client.config.debugging
6907
6907
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile_achievement_progress ...'
@@ -6944,7 +6944,7 @@ module TalonOne
6944
6944
  post_body = opts[:body]
6945
6945
 
6946
6946
  # return_type
6947
- return_type = opts[:return_type] || 'InlineResponse20046'
6947
+ return_type = opts[:return_type] || 'InlineResponse20049'
6948
6948
 
6949
6949
  # auth_names
6950
6950
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -6971,7 +6971,7 @@ module TalonOne
6971
6971
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6972
6972
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6973
6973
  # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
6974
- # @return [InlineResponse20024]
6974
+ # @return [InlineResponse20027]
6975
6975
  def get_customer_profiles(opts = {})
6976
6976
  data, _status_code, _headers = get_customer_profiles_with_http_info(opts)
6977
6977
  data
@@ -6983,7 +6983,7 @@ module TalonOne
6983
6983
  # @option opts [Integer] :page_size The number of items in the response.
6984
6984
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6985
6985
  # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
6986
- # @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
6986
+ # @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
6987
6987
  def get_customer_profiles_with_http_info(opts = {})
6988
6988
  if @api_client.config.debugging
6989
6989
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...'
@@ -7017,7 +7017,7 @@ module TalonOne
7017
7017
  post_body = opts[:body]
7018
7018
 
7019
7019
  # return_type
7020
- return_type = opts[:return_type] || 'InlineResponse20024'
7020
+ return_type = opts[:return_type] || 'InlineResponse20027'
7021
7021
 
7022
7022
  # auth_names
7023
7023
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7045,7 +7045,7 @@ module TalonOne
7045
7045
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7046
7046
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7047
7047
  # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
7048
- # @return [InlineResponse20023]
7048
+ # @return [InlineResponse20026]
7049
7049
  def get_customers_by_attributes(body, opts = {})
7050
7050
  data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts)
7051
7051
  data
@@ -7058,7 +7058,7 @@ module TalonOne
7058
7058
  # @option opts [Integer] :page_size The number of items in the response.
7059
7059
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7060
7060
  # @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
7061
- # @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
7061
+ # @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
7062
7062
  def get_customers_by_attributes_with_http_info(body, opts = {})
7063
7063
  if @api_client.config.debugging
7064
7064
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...'
@@ -7098,7 +7098,7 @@ module TalonOne
7098
7098
  post_body = opts[:body] || @api_client.object_to_http_body(body)
7099
7099
 
7100
7100
  # return_type
7101
- return_type = opts[:return_type] || 'InlineResponse20023'
7101
+ return_type = opts[:return_type] || 'InlineResponse20026'
7102
7102
 
7103
7103
  # auth_names
7104
7104
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7119,6 +7119,85 @@ module TalonOne
7119
7119
  return data, status_code, headers
7120
7120
  end
7121
7121
 
7122
+ # Get statistics for loyalty dashboard
7123
+ # Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
7124
+ # @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
7125
+ # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This 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.
7126
+ # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This 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.
7127
+ # @param [Hash] opts the optional parameters
7128
+ # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
7129
+ # @return [InlineResponse20016]
7130
+ def get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts = {})
7131
+ data, _status_code, _headers = get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts)
7132
+ data
7133
+ end
7134
+
7135
+ # Get statistics for loyalty dashboard
7136
+ # Retrieve the statistics displayed on the specified loyalty program&#39;s dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
7137
+ # @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
7138
+ # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This 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.
7139
+ # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This 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.
7140
+ # @param [Hash] opts the optional parameters
7141
+ # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
7142
+ # @return [Array<(InlineResponse20016, Integer, Hash)>] InlineResponse20016 data, response status code and response headers
7143
+ def get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts = {})
7144
+ if @api_client.config.debugging
7145
+ @api_client.config.logger.debug 'Calling API: ManagementApi.get_dashboard_statistics ...'
7146
+ end
7147
+ # verify the required parameter 'loyalty_program_id' is set
7148
+ if @api_client.config.client_side_validation && loyalty_program_id.nil?
7149
+ fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_dashboard_statistics"
7150
+ end
7151
+ # verify the required parameter 'range_start' is set
7152
+ if @api_client.config.client_side_validation && range_start.nil?
7153
+ fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_dashboard_statistics"
7154
+ end
7155
+ # verify the required parameter 'range_end' is set
7156
+ if @api_client.config.client_side_validation && range_end.nil?
7157
+ fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_dashboard_statistics"
7158
+ end
7159
+ # resource path
7160
+ local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/dashboard'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
7161
+
7162
+ # query parameters
7163
+ query_params = opts[:query_params] || {}
7164
+ query_params[:'rangeStart'] = range_start
7165
+ query_params[:'rangeEnd'] = range_end
7166
+ query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?
7167
+
7168
+ # header parameters
7169
+ header_params = opts[:header_params] || {}
7170
+ # HTTP header 'Accept' (if needed)
7171
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7172
+
7173
+ # form parameters
7174
+ form_params = opts[:form_params] || {}
7175
+
7176
+ # http body (model)
7177
+ post_body = opts[:body]
7178
+
7179
+ # return_type
7180
+ return_type = opts[:return_type] || 'InlineResponse20016'
7181
+
7182
+ # auth_names
7183
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
7184
+
7185
+ new_options = opts.merge(
7186
+ :header_params => header_params,
7187
+ :query_params => query_params,
7188
+ :form_params => form_params,
7189
+ :body => post_body,
7190
+ :auth_names => auth_names,
7191
+ :return_type => return_type
7192
+ )
7193
+
7194
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
7195
+ if @api_client.config.debugging
7196
+ @api_client.config.logger.debug "API called: ManagementApi#get_dashboard_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7197
+ end
7198
+ return data, status_code, headers
7199
+ end
7200
+
7122
7201
  # List event types
7123
7202
  # Fetch all event type definitions for your account.
7124
7203
  # @param [Hash] opts the optional parameters
@@ -7126,8 +7205,8 @@ module TalonOne
7126
7205
  # @option opts [Boolean] :include_old_versions Include all versions of every event type. (default to false)
7127
7206
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7128
7207
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7129
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
7130
- # @return [InlineResponse20039]
7208
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7209
+ # @return [InlineResponse20042]
7131
7210
  def get_event_types(opts = {})
7132
7211
  data, _status_code, _headers = get_event_types_with_http_info(opts)
7133
7212
  data
@@ -7140,8 +7219,8 @@ module TalonOne
7140
7219
  # @option opts [Boolean] :include_old_versions Include all versions of every event type.
7141
7220
  # @option opts [Integer] :page_size The number of items in the response.
7142
7221
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7143
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
7144
- # @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
7222
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7223
+ # @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
7145
7224
  def get_event_types_with_http_info(opts = {})
7146
7225
  if @api_client.config.debugging
7147
7226
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
@@ -7177,7 +7256,7 @@ module TalonOne
7177
7256
  post_body = opts[:body]
7178
7257
 
7179
7258
  # return_type
7180
- return_type = opts[:return_type] || 'InlineResponse20039'
7259
+ return_type = opts[:return_type] || 'InlineResponse20042'
7181
7260
 
7182
7261
  # auth_names
7183
7262
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7206,7 +7285,7 @@ module TalonOne
7206
7285
  # @option opts [Float] :application_id Filter results by Application ID.
7207
7286
  # @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
7208
7287
  # @option opts [String] :entity The name of the entity type that was exported.
7209
- # @return [InlineResponse20042]
7288
+ # @return [InlineResponse20045]
7210
7289
  def get_exports(opts = {})
7211
7290
  data, _status_code, _headers = get_exports_with_http_info(opts)
7212
7291
  data
@@ -7220,7 +7299,7 @@ module TalonOne
7220
7299
  # @option opts [Float] :application_id Filter results by Application ID.
7221
7300
  # @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
7222
7301
  # @option opts [String] :entity The name of the entity type that was exported.
7223
- # @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
7302
+ # @return [Array<(InlineResponse20045, Integer, Hash)>] InlineResponse20045 data, response status code and response headers
7224
7303
  def get_exports_with_http_info(opts = {})
7225
7304
  if @api_client.config.debugging
7226
7305
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
@@ -7260,7 +7339,7 @@ module TalonOne
7260
7339
  post_body = opts[:body]
7261
7340
 
7262
7341
  # return_type
7263
- return_type = opts[:return_type] || 'InlineResponse20042'
7342
+ return_type = opts[:return_type] || 'InlineResponse20045'
7264
7343
 
7265
7344
  # auth_names
7266
7345
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7363,7 +7442,7 @@ module TalonOne
7363
7442
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7364
7443
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7365
7444
  # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
7366
- # @return [InlineResponse20016]
7445
+ # @return [InlineResponse20019]
7367
7446
  def get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts = {})
7368
7447
  data, _status_code, _headers = get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts)
7369
7448
  data
@@ -7379,7 +7458,7 @@ module TalonOne
7379
7458
  # @option opts [Integer] :page_size The number of items in the response.
7380
7459
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7381
7460
  # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
7382
- # @return [Array<(InlineResponse20016, Integer, Hash)>] InlineResponse20016 data, response status code and response headers
7461
+ # @return [Array<(InlineResponse20019, Integer, Hash)>] InlineResponse20019 data, response status code and response headers
7383
7462
  def get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
7384
7463
  if @api_client.config.debugging
7385
7464
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_card_transaction_logs ...'
@@ -7427,7 +7506,7 @@ module TalonOne
7427
7506
  post_body = opts[:body]
7428
7507
 
7429
7508
  # return_type
7430
- return_type = opts[:return_type] || 'InlineResponse20016'
7509
+ return_type = opts[:return_type] || 'InlineResponse20019'
7431
7510
 
7432
7511
  # auth_names
7433
7512
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7454,11 +7533,11 @@ module TalonOne
7454
7533
  # @param [Hash] opts the optional parameters
7455
7534
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7456
7535
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7457
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
7536
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7458
7537
  # @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
7459
7538
  # @option opts [Integer] :profile_id Filter results by customer profile ID.
7460
7539
  # @option opts [String] :batch_id Filter results by loyalty card batch ID.
7461
- # @return [InlineResponse20015]
7540
+ # @return [InlineResponse20018]
7462
7541
  def get_loyalty_cards(loyalty_program_id, opts = {})
7463
7542
  data, _status_code, _headers = get_loyalty_cards_with_http_info(loyalty_program_id, opts)
7464
7543
  data
@@ -7470,11 +7549,11 @@ module TalonOne
7470
7549
  # @param [Hash] opts the optional parameters
7471
7550
  # @option opts [Integer] :page_size The number of items in the response.
7472
7551
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7473
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
7552
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7474
7553
  # @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
7475
7554
  # @option opts [Integer] :profile_id Filter results by customer profile ID.
7476
7555
  # @option opts [String] :batch_id Filter results by loyalty card batch ID.
7477
- # @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
7556
+ # @return [Array<(InlineResponse20018, Integer, Hash)>] InlineResponse20018 data, response status code and response headers
7478
7557
  def get_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
7479
7558
  if @api_client.config.debugging
7480
7559
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_cards ...'
@@ -7523,7 +7602,7 @@ module TalonOne
7523
7602
  post_body = opts[:body]
7524
7603
 
7525
7604
  # return_type
7526
- return_type = opts[:return_type] || 'InlineResponse20015'
7605
+ return_type = opts[:return_type] || 'InlineResponse20018'
7527
7606
 
7528
7607
  # auth_names
7529
7608
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7547,7 +7626,7 @@ module TalonOne
7547
7626
  # Get customer's full loyalty ledger
7548
7627
  # Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
7549
7628
  # @param loyalty_program_id [String] The identifier for the loyalty program.
7550
- # @param integration_id [String] The identifier of the profile.
7629
+ # @param 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.
7551
7630
  # @param [Hash] opts the optional parameters
7552
7631
  # @return [LoyaltyLedger]
7553
7632
  def get_loyalty_points(loyalty_program_id, integration_id, opts = {})
@@ -7558,7 +7637,7 @@ module TalonOne
7558
7637
  # Get customer&#39;s full loyalty ledger
7559
7638
  # Get the loyalty ledger for this profile integration ID. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API&#39;s [Get customer&#39;s loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
7560
7639
  # @param loyalty_program_id [String] The identifier for the loyalty program.
7561
- # @param integration_id [String] The identifier of the profile.
7640
+ # @param 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.
7562
7641
  # @param [Hash] opts the optional parameters
7563
7642
  # @return [Array<(LoyaltyLedger, Integer, Hash)>] LoyaltyLedger data, response status code and response headers
7564
7643
  def get_loyalty_points_with_http_info(loyalty_program_id, integration_id, opts = {})
@@ -7684,7 +7763,7 @@ module TalonOne
7684
7763
  # @option opts [DateTime] :end_date 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.
7685
7764
  # @option opts [Integer] :page_size The number of items in the response. (default to 50)
7686
7765
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7687
- # @return [InlineResponse20014]
7766
+ # @return [InlineResponse20017]
7688
7767
  def get_loyalty_program_transactions(loyalty_program_id, opts = {})
7689
7768
  data, _status_code, _headers = get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts)
7690
7769
  data
@@ -7700,7 +7779,7 @@ module TalonOne
7700
7779
  # @option opts [DateTime] :end_date 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.
7701
7780
  # @option opts [Integer] :page_size The number of items in the response.
7702
7781
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7703
- # @return [Array<(InlineResponse20014, Integer, Hash)>] InlineResponse20014 data, response status code and response headers
7782
+ # @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
7704
7783
  def get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts = {})
7705
7784
  if @api_client.config.debugging
7706
7785
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_program_transactions ...'
@@ -7745,7 +7824,7 @@ module TalonOne
7745
7824
  post_body = opts[:body]
7746
7825
 
7747
7826
  # return_type
7748
- return_type = opts[:return_type] || 'InlineResponse20014'
7827
+ return_type = opts[:return_type] || 'InlineResponse20017'
7749
7828
 
7750
7829
  # auth_names
7751
7830
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7769,7 +7848,7 @@ module TalonOne
7769
7848
  # List loyalty programs
7770
7849
  # List the loyalty programs of the account.
7771
7850
  # @param [Hash] opts the optional parameters
7772
- # @return [InlineResponse20013]
7851
+ # @return [InlineResponse20015]
7773
7852
  def get_loyalty_programs(opts = {})
7774
7853
  data, _status_code, _headers = get_loyalty_programs_with_http_info(opts)
7775
7854
  data
@@ -7778,7 +7857,7 @@ module TalonOne
7778
7857
  # List loyalty programs
7779
7858
  # List the loyalty programs of the account.
7780
7859
  # @param [Hash] opts the optional parameters
7781
- # @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
7860
+ # @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
7782
7861
  def get_loyalty_programs_with_http_info(opts = {})
7783
7862
  if @api_client.config.debugging
7784
7863
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_programs ...'
@@ -7801,7 +7880,7 @@ module TalonOne
7801
7880
  post_body = opts[:body]
7802
7881
 
7803
7882
  # return_type
7804
- return_type = opts[:return_type] || 'InlineResponse20013'
7883
+ return_type = opts[:return_type] || 'InlineResponse20015'
7805
7884
 
7806
7885
  # auth_names
7807
7886
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7823,7 +7902,7 @@ module TalonOne
7823
7902
  end
7824
7903
 
7825
7904
  # Get loyalty program statistics
7826
- # Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
7905
+ # ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
7827
7906
  # @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
7828
7907
  # @param [Hash] opts the optional parameters
7829
7908
  # @return [LoyaltyDashboardData]
@@ -7833,7 +7912,7 @@ module TalonOne
7833
7912
  end
7834
7913
 
7835
7914
  # Get loyalty program statistics
7836
- # Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
7915
+ # ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
7837
7916
  # @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
7838
7917
  # @param [Hash] opts the optional parameters
7839
7918
  # @return [Array<(LoyaltyDashboardData, Integer, Hash)>] LoyaltyDashboardData data, response status code and response headers
@@ -7884,21 +7963,136 @@ module TalonOne
7884
7963
  return data, status_code, headers
7885
7964
  end
7886
7965
 
7887
- # List referrals
7966
+ # List message log entries
7967
+ # Retrieve all message log entries.
7968
+ # @param entity_type [String] The entity type the log is related to.
7969
+ # @param [Hash] opts the optional parameters
7970
+ # @option opts [String] :message_id Filter results by message ID.
7971
+ # @option opts [String] :change_type Filter results by change type.
7972
+ # @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
7973
+ # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
7974
+ # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
7975
+ # @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
7976
+ # @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
7977
+ # @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to&#x60;true&#x60;, only log entries with &#x60;2xx&#x60; response codes are returned. When set to &#x60;false&#x60;, only log entries with &#x60;4xx&#x60; and &#x60;5xx&#x60; response codes are returned.
7978
+ # @option opts [Float] :application_id Filter results by Application ID.
7979
+ # @option opts [Float] :campaign_id Filter results by campaign ID.
7980
+ # @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
7981
+ # @option opts [Integer] :response_code Filter results by response status code.
7982
+ # @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
7983
+ # @return [MessageLogEntries]
7984
+ def get_message_logs(entity_type, opts = {})
7985
+ data, _status_code, _headers = get_message_logs_with_http_info(entity_type, opts)
7986
+ data
7987
+ end
7988
+
7989
+ # List message log entries
7990
+ # Retrieve all message log entries.
7991
+ # @param entity_type [String] The entity type the log is related to.
7992
+ # @param [Hash] opts the optional parameters
7993
+ # @option opts [String] :message_id Filter results by message ID.
7994
+ # @option opts [String] :change_type Filter results by change type.
7995
+ # @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
7996
+ # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
7997
+ # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
7998
+ # @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
7999
+ # @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
8000
+ # @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to&#x60;true&#x60;, only log entries with &#x60;2xx&#x60; response codes are returned. When set to &#x60;false&#x60;, only log entries with &#x60;4xx&#x60; and &#x60;5xx&#x60; response codes are returned.
8001
+ # @option opts [Float] :application_id Filter results by Application ID.
8002
+ # @option opts [Float] :campaign_id Filter results by campaign ID.
8003
+ # @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
8004
+ # @option opts [Integer] :response_code Filter results by response status code.
8005
+ # @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
8006
+ # @return [Array<(MessageLogEntries, Integer, Hash)>] MessageLogEntries data, response status code and response headers
8007
+ def get_message_logs_with_http_info(entity_type, opts = {})
8008
+ if @api_client.config.debugging
8009
+ @api_client.config.logger.debug 'Calling API: ManagementApi.get_message_logs ...'
8010
+ end
8011
+ # verify the required parameter 'entity_type' is set
8012
+ if @api_client.config.client_side_validation && entity_type.nil?
8013
+ fail ArgumentError, "Missing the required parameter 'entity_type' when calling ManagementApi.get_message_logs"
8014
+ end
8015
+ # verify enum value
8016
+ allowable_values = ["application", "loyalty_program", "webhook"]
8017
+ if @api_client.config.client_side_validation && !allowable_values.include?(entity_type)
8018
+ fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
8019
+ end
8020
+ allowable_values = ["CampaignEvaluationTreeChanged", "CampaignNotification", "CouponCreated", "CouponUpdated", "CouponDeleted", "AsyncCouponsCreated", "CouponsDeleted", "CouponsUpdated", "CouponCodeExpiring", "StrikethroughPrice", "LoyaltyPointsAdded", "LoyaltyPointsDeducted", "LoyaltyPointsExpiring", "LoyaltyPointsPendingToActive", "TierWillDowngrade", "TierUpgrade", "TierDowngrade", "LoyaltyCardPointsAdded", "LoyaltyCardPointsDeducted", "LoyaltyCardPointsExpiring"]
8021
+ if @api_client.config.client_side_validation && opts[:'change_type'] && !allowable_values.include?(opts[:'change_type'])
8022
+ fail ArgumentError, "invalid value for \"change_type\", must be one of #{allowable_values}"
8023
+ end
8024
+ allowable_values = ["15m", "30m", "1h", "4h", "1d", "2d"]
8025
+ if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
8026
+ fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
8027
+ end
8028
+ # resource path
8029
+ local_var_path = '/v1/message_logs'
8030
+
8031
+ # query parameters
8032
+ query_params = opts[:query_params] || {}
8033
+ query_params[:'entityType'] = entity_type
8034
+ query_params[:'messageID'] = opts[:'message_id'] if !opts[:'message_id'].nil?
8035
+ query_params[:'changeType'] = opts[:'change_type'] if !opts[:'change_type'].nil?
8036
+ query_params[:'notificationIDs'] = opts[:'notification_i_ds'] if !opts[:'notification_i_ds'].nil?
8037
+ query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
8038
+ query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
8039
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
8040
+ query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
8041
+ query_params[:'isSuccessful'] = opts[:'is_successful'] if !opts[:'is_successful'].nil?
8042
+ query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
8043
+ query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
8044
+ query_params[:'loyaltyProgramId'] = opts[:'loyalty_program_id'] if !opts[:'loyalty_program_id'].nil?
8045
+ query_params[:'responseCode'] = opts[:'response_code'] if !opts[:'response_code'].nil?
8046
+ query_params[:'webhookIDs'] = opts[:'webhook_i_ds'] if !opts[:'webhook_i_ds'].nil?
8047
+
8048
+ # header parameters
8049
+ header_params = opts[:header_params] || {}
8050
+ # HTTP header 'Accept' (if needed)
8051
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8052
+
8053
+ # form parameters
8054
+ form_params = opts[:form_params] || {}
8055
+
8056
+ # http body (model)
8057
+ post_body = opts[:body]
8058
+
8059
+ # return_type
8060
+ return_type = opts[:return_type] || 'MessageLogEntries'
8061
+
8062
+ # auth_names
8063
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
8064
+
8065
+ new_options = opts.merge(
8066
+ :header_params => header_params,
8067
+ :query_params => query_params,
8068
+ :form_params => form_params,
8069
+ :body => post_body,
8070
+ :auth_names => auth_names,
8071
+ :return_type => return_type
8072
+ )
8073
+
8074
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
8075
+ if @api_client.config.debugging
8076
+ @api_client.config.logger.debug "API called: ManagementApi#get_message_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8077
+ end
8078
+ return data, status_code, headers
8079
+ end
8080
+
8081
+ # List referrals
7888
8082
  # List all referrals of the specified campaign.
7889
8083
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
7890
8084
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
7891
8085
  # @param [Hash] opts the optional parameters
7892
8086
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7893
8087
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7894
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8088
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7895
8089
  # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
7896
8090
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
7897
8091
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
7898
8092
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
7899
8093
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
7900
8094
  # @option opts [String] :advocate Filter results by match with a profile ID specified in the referral&#39;s AdvocateProfileIntegrationId field.
7901
- # @return [InlineResponse20010]
8095
+ # @return [InlineResponse20012]
7902
8096
  def get_referrals_without_total_count(application_id, campaign_id, opts = {})
7903
8097
  data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts)
7904
8098
  data
@@ -7911,14 +8105,14 @@ module TalonOne
7911
8105
  # @param [Hash] opts the optional parameters
7912
8106
  # @option opts [Integer] :page_size The number of items in the response.
7913
8107
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7914
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8108
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7915
8109
  # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
7916
8110
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
7917
8111
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
7918
8112
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
7919
8113
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
7920
8114
  # @option opts [String] :advocate Filter results by match with a profile ID specified in the referral&#39;s AdvocateProfileIntegrationId field.
7921
- # @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
8115
+ # @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
7922
8116
  def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {})
7923
8117
  if @api_client.config.debugging
7924
8118
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals_without_total_count ...'
@@ -7974,7 +8168,7 @@ module TalonOne
7974
8168
  post_body = opts[:body]
7975
8169
 
7976
8170
  # return_type
7977
- return_type = opts[:return_type] || 'InlineResponse20010'
8171
+ return_type = opts[:return_type] || 'InlineResponse20012'
7978
8172
 
7979
8173
  # auth_names
7980
8174
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -8138,8 +8332,8 @@ module TalonOne
8138
8332
  # @param [Hash] opts the optional parameters
8139
8333
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8140
8334
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8141
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8142
- # @return [InlineResponse2007]
8335
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8336
+ # @return [InlineResponse2009]
8143
8337
  def get_rulesets(application_id, campaign_id, opts = {})
8144
8338
  data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts)
8145
8339
  data
@@ -8152,8 +8346,8 @@ module TalonOne
8152
8346
  # @param [Hash] opts the optional parameters
8153
8347
  # @option opts [Integer] :page_size The number of items in the response.
8154
8348
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8155
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8156
- # @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
8349
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8350
+ # @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
8157
8351
  def get_rulesets_with_http_info(application_id, campaign_id, opts = {})
8158
8352
  if @api_client.config.debugging
8159
8353
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_rulesets ...'
@@ -8195,7 +8389,7 @@ module TalonOne
8195
8389
  post_body = opts[:body]
8196
8390
 
8197
8391
  # return_type
8198
- return_type = opts[:return_type] || 'InlineResponse2007'
8392
+ return_type = opts[:return_type] || 'InlineResponse2009'
8199
8393
 
8200
8394
  # auth_names
8201
8395
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -8351,8 +8545,8 @@ module TalonOne
8351
8545
  # @param [Hash] opts the optional parameters
8352
8546
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8353
8547
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8354
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8355
- # @return [InlineResponse20040]
8548
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8549
+ # @return [InlineResponse20043]
8356
8550
  def get_users(opts = {})
8357
8551
  data, _status_code, _headers = get_users_with_http_info(opts)
8358
8552
  data
@@ -8363,8 +8557,8 @@ module TalonOne
8363
8557
  # @param [Hash] opts the optional parameters
8364
8558
  # @option opts [Integer] :page_size The number of items in the response.
8365
8559
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8366
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8367
- # @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
8560
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8561
+ # @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
8368
8562
  def get_users_with_http_info(opts = {})
8369
8563
  if @api_client.config.debugging
8370
8564
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
@@ -8398,7 +8592,7 @@ module TalonOne
8398
8592
  post_body = opts[:body]
8399
8593
 
8400
8594
  # return_type
8401
- return_type = opts[:return_type] || 'InlineResponse20040'
8595
+ return_type = opts[:return_type] || 'InlineResponse20043'
8402
8596
 
8403
8597
  # auth_names
8404
8598
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -8486,14 +8680,14 @@ module TalonOne
8486
8680
  # @param [Hash] opts the optional parameters
8487
8681
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8488
8682
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8489
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8683
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8490
8684
  # @option opts [String] :integration_request_uuid Filter results by integration request UUID.
8491
8685
  # @option opts [Float] :webhook_id Filter results by webhook id.
8492
8686
  # @option opts [Float] :application_id Filter results by Application ID.
8493
8687
  # @option opts [Float] :campaign_id Filter results by campaign ID.
8494
8688
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
8495
8689
  # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
8496
- # @return [InlineResponse20037]
8690
+ # @return [InlineResponse20040]
8497
8691
  def get_webhook_activation_logs(opts = {})
8498
8692
  data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
8499
8693
  data
@@ -8504,14 +8698,14 @@ module TalonOne
8504
8698
  # @param [Hash] opts the optional parameters
8505
8699
  # @option opts [Integer] :page_size The number of items in the response.
8506
8700
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8507
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8701
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8508
8702
  # @option opts [String] :integration_request_uuid Filter results by integration request UUID.
8509
8703
  # @option opts [Float] :webhook_id Filter results by webhook id.
8510
8704
  # @option opts [Float] :application_id Filter results by Application ID.
8511
8705
  # @option opts [Float] :campaign_id Filter results by campaign ID.
8512
8706
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
8513
8707
  # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
8514
- # @return [Array<(InlineResponse20037, Integer, Hash)>] InlineResponse20037 data, response status code and response headers
8708
+ # @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
8515
8709
  def get_webhook_activation_logs_with_http_info(opts = {})
8516
8710
  if @api_client.config.debugging
8517
8711
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
@@ -8551,7 +8745,7 @@ module TalonOne
8551
8745
  post_body = opts[:body]
8552
8746
 
8553
8747
  # return_type
8554
- return_type = opts[:return_type] || 'InlineResponse20037'
8748
+ return_type = opts[:return_type] || 'InlineResponse20040'
8555
8749
 
8556
8750
  # auth_names
8557
8751
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -8577,7 +8771,7 @@ module TalonOne
8577
8771
  # @param [Hash] opts the optional parameters
8578
8772
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8579
8773
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8580
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8774
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8581
8775
  # @option opts [String] :status Filter results by HTTP status codes.
8582
8776
  # @option opts [Float] :webhook_id Filter results by webhook id.
8583
8777
  # @option opts [Float] :application_id Filter results by Application ID.
@@ -8585,7 +8779,7 @@ module TalonOne
8585
8779
  # @option opts [String] :request_uuid Filter results by request UUID.
8586
8780
  # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8587
8781
  # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8588
- # @return [InlineResponse20038]
8782
+ # @return [InlineResponse20041]
8589
8783
  def get_webhook_logs(opts = {})
8590
8784
  data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
8591
8785
  data
@@ -8596,7 +8790,7 @@ module TalonOne
8596
8790
  # @param [Hash] opts the optional parameters
8597
8791
  # @option opts [Integer] :page_size The number of items in the response.
8598
8792
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8599
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8793
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8600
8794
  # @option opts [String] :status Filter results by HTTP status codes.
8601
8795
  # @option opts [Float] :webhook_id Filter results by webhook id.
8602
8796
  # @option opts [Float] :application_id Filter results by Application ID.
@@ -8604,7 +8798,7 @@ module TalonOne
8604
8798
  # @option opts [String] :request_uuid Filter results by request UUID.
8605
8799
  # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8606
8800
  # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8607
- # @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
8801
+ # @return [Array<(InlineResponse20041, Integer, Hash)>] InlineResponse20041 data, response status code and response headers
8608
8802
  def get_webhook_logs_with_http_info(opts = {})
8609
8803
  if @api_client.config.debugging
8610
8804
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
@@ -8649,7 +8843,7 @@ module TalonOne
8649
8843
  post_body = opts[:body]
8650
8844
 
8651
8845
  # return_type
8652
- return_type = opts[:return_type] || 'InlineResponse20038'
8846
+ return_type = opts[:return_type] || 'InlineResponse20041'
8653
8847
 
8654
8848
  # auth_names
8655
8849
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -8674,14 +8868,14 @@ module TalonOne
8674
8868
  # List all webhooks.
8675
8869
  # @param [Hash] opts the optional parameters
8676
8870
  # @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
8677
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8871
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8678
8872
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8679
8873
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8680
8874
  # @option opts [String] :creation_type Filter results by creation type.
8681
8875
  # @option opts [String] :visibility Filter results by visibility.
8682
8876
  # @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
8683
8877
  # @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
8684
- # @return [InlineResponse20036]
8878
+ # @return [InlineResponse20039]
8685
8879
  def get_webhooks(opts = {})
8686
8880
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
8687
8881
  data
@@ -8691,14 +8885,14 @@ module TalonOne
8691
8885
  # List all webhooks.
8692
8886
  # @param [Hash] opts the optional parameters
8693
8887
  # @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
8694
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8888
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8695
8889
  # @option opts [Integer] :page_size The number of items in the response.
8696
8890
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8697
8891
  # @option opts [String] :creation_type Filter results by creation type.
8698
8892
  # @option opts [String] :visibility Filter results by visibility.
8699
8893
  # @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
8700
8894
  # @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
8701
- # @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
8895
+ # @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
8702
8896
  def get_webhooks_with_http_info(opts = {})
8703
8897
  if @api_client.config.debugging
8704
8898
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
@@ -8745,7 +8939,7 @@ module TalonOne
8745
8939
  post_body = opts[:body]
8746
8940
 
8747
8941
  # return_type
8748
- return_type = opts[:return_type] || 'InlineResponse20036'
8942
+ return_type = opts[:return_type] || 'InlineResponse20039'
8749
8943
 
8750
8944
  # auth_names
8751
8945
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -9603,10 +9797,10 @@ module TalonOne
9603
9797
  # @param [Hash] opts the optional parameters
9604
9798
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
9605
9799
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9606
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
9800
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
9607
9801
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9608
9802
  # @option opts [String] :name Filter by collection name.
9609
- # @return [InlineResponse20017]
9803
+ # @return [InlineResponse20020]
9610
9804
  def list_account_collections(opts = {})
9611
9805
  data, _status_code, _headers = list_account_collections_with_http_info(opts)
9612
9806
  data
@@ -9617,10 +9811,10 @@ module TalonOne
9617
9811
  # @param [Hash] opts the optional parameters
9618
9812
  # @option opts [Integer] :page_size The number of items in the response.
9619
9813
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9620
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
9814
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
9621
9815
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9622
9816
  # @option opts [String] :name Filter by collection name.
9623
- # @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
9817
+ # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
9624
9818
  def list_account_collections_with_http_info(opts = {})
9625
9819
  if @api_client.config.debugging
9626
9820
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_account_collections ...'
@@ -9656,7 +9850,7 @@ module TalonOne
9656
9850
  post_body = opts[:body]
9657
9851
 
9658
9852
  # return_type
9659
- return_type = opts[:return_type] || 'InlineResponse20017'
9853
+ return_type = opts[:return_type] || 'InlineResponse20020'
9660
9854
 
9661
9855
  # auth_names
9662
9856
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -9685,7 +9879,7 @@ module TalonOne
9685
9879
  # @option opts [Integer] :page_size The number of items in the response. (default to 50)
9686
9880
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9687
9881
  # @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no &#x60;title&#x60; is provided, all the achievements from the campaign are returned.
9688
- # @return [InlineResponse20045]
9882
+ # @return [InlineResponse20048]
9689
9883
  def list_achievements(application_id, campaign_id, opts = {})
9690
9884
  data, _status_code, _headers = list_achievements_with_http_info(application_id, campaign_id, opts)
9691
9885
  data
@@ -9699,7 +9893,7 @@ module TalonOne
9699
9893
  # @option opts [Integer] :page_size The number of items in the response.
9700
9894
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9701
9895
  # @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no &#x60;title&#x60; is provided, all the achievements from the campaign are returned.
9702
- # @return [Array<(InlineResponse20045, Integer, Hash)>] InlineResponse20045 data, response status code and response headers
9896
+ # @return [Array<(InlineResponse20048, Integer, Hash)>] InlineResponse20048 data, response status code and response headers
9703
9897
  def list_achievements_with_http_info(application_id, campaign_id, opts = {})
9704
9898
  if @api_client.config.debugging
9705
9899
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_achievements ...'
@@ -9741,7 +9935,7 @@ module TalonOne
9741
9935
  post_body = opts[:body]
9742
9936
 
9743
9937
  # return_type
9744
- return_type = opts[:return_type] || 'InlineResponse20045'
9938
+ return_type = opts[:return_type] || 'InlineResponse20048'
9745
9939
 
9746
9940
  # auth_names
9747
9941
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -9765,7 +9959,7 @@ module TalonOne
9765
9959
  # List roles
9766
9960
  # List all roles.
9767
9961
  # @param [Hash] opts the optional parameters
9768
- # @return [InlineResponse20043]
9962
+ # @return [InlineResponse20046]
9769
9963
  def list_all_roles_v2(opts = {})
9770
9964
  data, _status_code, _headers = list_all_roles_v2_with_http_info(opts)
9771
9965
  data
@@ -9774,7 +9968,7 @@ module TalonOne
9774
9968
  # List roles
9775
9969
  # List all roles.
9776
9970
  # @param [Hash] opts the optional parameters
9777
- # @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
9971
+ # @return [Array<(InlineResponse20046, Integer, Hash)>] InlineResponse20046 data, response status code and response headers
9778
9972
  def list_all_roles_v2_with_http_info(opts = {})
9779
9973
  if @api_client.config.debugging
9780
9974
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_all_roles_v2 ...'
@@ -9797,7 +9991,7 @@ module TalonOne
9797
9991
  post_body = opts[:body]
9798
9992
 
9799
9993
  # return_type
9800
- return_type = opts[:return_type] || 'InlineResponse20043'
9994
+ return_type = opts[:return_type] || 'InlineResponse20046'
9801
9995
 
9802
9996
  # auth_names
9803
9997
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -9827,7 +10021,7 @@ module TalonOne
9827
10021
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9828
10022
  # @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
9829
10023
  # @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
9830
- # @return [InlineResponse20034]
10024
+ # @return [InlineResponse20037]
9831
10025
  def list_catalog_items(catalog_id, opts = {})
9832
10026
  data, _status_code, _headers = list_catalog_items_with_http_info(catalog_id, opts)
9833
10027
  data
@@ -9842,7 +10036,7 @@ module TalonOne
9842
10036
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9843
10037
  # @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
9844
10038
  # @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
9845
- # @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
10039
+ # @return [Array<(InlineResponse20037, Integer, Hash)>] InlineResponse20037 data, response status code and response headers
9846
10040
  def list_catalog_items_with_http_info(catalog_id, opts = {})
9847
10041
  if @api_client.config.debugging
9848
10042
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_catalog_items ...'
@@ -9882,7 +10076,7 @@ module TalonOne
9882
10076
  post_body = opts[:body]
9883
10077
 
9884
10078
  # return_type
9885
- return_type = opts[:return_type] || 'InlineResponse20034'
10079
+ return_type = opts[:return_type] || 'InlineResponse20037'
9886
10080
 
9887
10081
  # auth_names
9888
10082
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -9910,10 +10104,10 @@ module TalonOne
9910
10104
  # @param [Hash] opts the optional parameters
9911
10105
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
9912
10106
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9913
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
10107
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
9914
10108
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9915
10109
  # @option opts [String] :name Filter by collection name.
9916
- # @return [InlineResponse20017]
10110
+ # @return [InlineResponse20020]
9917
10111
  def list_collections(application_id, campaign_id, opts = {})
9918
10112
  data, _status_code, _headers = list_collections_with_http_info(application_id, campaign_id, opts)
9919
10113
  data
@@ -9926,10 +10120,10 @@ module TalonOne
9926
10120
  # @param [Hash] opts the optional parameters
9927
10121
  # @option opts [Integer] :page_size The number of items in the response.
9928
10122
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9929
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
10123
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
9930
10124
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9931
10125
  # @option opts [String] :name Filter by collection name.
9932
- # @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
10126
+ # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
9933
10127
  def list_collections_with_http_info(application_id, campaign_id, opts = {})
9934
10128
  if @api_client.config.debugging
9935
10129
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_collections ...'
@@ -9973,7 +10167,7 @@ module TalonOne
9973
10167
  post_body = opts[:body]
9974
10168
 
9975
10169
  # return_type
9976
- return_type = opts[:return_type] || 'InlineResponse20017'
10170
+ return_type = opts[:return_type] || 'InlineResponse20020'
9977
10171
 
9978
10172
  # auth_names
9979
10173
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10000,10 +10194,10 @@ module TalonOne
10000
10194
  # @param [Hash] opts the optional parameters
10001
10195
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
10002
10196
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10003
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
10197
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
10004
10198
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10005
10199
  # @option opts [String] :name Filter by collection name.
10006
- # @return [InlineResponse20017]
10200
+ # @return [InlineResponse20020]
10007
10201
  def list_collections_in_application(application_id, opts = {})
10008
10202
  data, _status_code, _headers = list_collections_in_application_with_http_info(application_id, opts)
10009
10203
  data
@@ -10015,10 +10209,10 @@ module TalonOne
10015
10209
  # @param [Hash] opts the optional parameters
10016
10210
  # @option opts [Integer] :page_size The number of items in the response.
10017
10211
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10018
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
10212
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
10019
10213
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10020
10214
  # @option opts [String] :name Filter by collection name.
10021
- # @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
10215
+ # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
10022
10216
  def list_collections_in_application_with_http_info(application_id, opts = {})
10023
10217
  if @api_client.config.debugging
10024
10218
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_collections_in_application ...'
@@ -10058,7 +10252,7 @@ module TalonOne
10058
10252
  post_body = opts[:body]
10059
10253
 
10060
10254
  # return_type
10061
- return_type = opts[:return_type] || 'InlineResponse20017'
10255
+ return_type = opts[:return_type] || 'InlineResponse20020'
10062
10256
 
10063
10257
  # auth_names
10064
10258
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10085,13 +10279,13 @@ module TalonOne
10085
10279
  # @param [Hash] opts the optional parameters
10086
10280
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
10087
10281
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10088
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
10282
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
10089
10283
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10090
10284
  # @option opts [Float] :campaign_id Filter results by campaign ID.
10091
10285
  # @option opts [String] :name The name of the store.
10092
10286
  # @option opts [String] :integration_id The integration ID of the store.
10093
10287
  # @option opts [String] :query Filter results by &#x60;name&#x60; or &#x60;integrationId&#x60;.
10094
- # @return [InlineResponse20044]
10288
+ # @return [InlineResponse20047]
10095
10289
  def list_stores(application_id, opts = {})
10096
10290
  data, _status_code, _headers = list_stores_with_http_info(application_id, opts)
10097
10291
  data
@@ -10103,13 +10297,13 @@ module TalonOne
10103
10297
  # @param [Hash] opts the optional parameters
10104
10298
  # @option opts [Integer] :page_size The number of items in the response.
10105
10299
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10106
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
10300
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
10107
10301
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10108
10302
  # @option opts [Float] :campaign_id Filter results by campaign ID.
10109
10303
  # @option opts [String] :name The name of the store.
10110
10304
  # @option opts [String] :integration_id The integration ID of the store.
10111
10305
  # @option opts [String] :query Filter results by &#x60;name&#x60; or &#x60;integrationId&#x60;.
10112
- # @return [Array<(InlineResponse20044, Integer, Hash)>] InlineResponse20044 data, response status code and response headers
10306
+ # @return [Array<(InlineResponse20047, Integer, Hash)>] InlineResponse20047 data, response status code and response headers
10113
10307
  def list_stores_with_http_info(application_id, opts = {})
10114
10308
  if @api_client.config.debugging
10115
10309
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_stores ...'
@@ -10152,7 +10346,7 @@ module TalonOne
10152
10346
  post_body = opts[:body]
10153
10347
 
10154
10348
  # return_type
10155
- return_type = opts[:return_type] || 'InlineResponse20044'
10349
+ return_type = opts[:return_type] || 'InlineResponse20047'
10156
10350
 
10157
10351
  # auth_names
10158
10352
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10173,74 +10367,6 @@ module TalonOne
10173
10367
  return data, status_code, headers
10174
10368
  end
10175
10369
 
10176
- # Activate or deactivate notification
10177
- # Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
10178
- # @param notification_id [Integer] The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
10179
- # @param body [NotificationActivation] body
10180
- # @param [Hash] opts the optional parameters
10181
- # @return [nil]
10182
- def notification_activation(notification_id, body, opts = {})
10183
- notification_activation_with_http_info(notification_id, body, opts)
10184
- nil
10185
- end
10186
-
10187
- # Activate or deactivate notification
10188
- # Activate or deactivate the given notification. When &#x60;enabled&#x60; is false, updates will no longer be sent for the given notification.
10189
- # @param notification_id [Integer] The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
10190
- # @param body [NotificationActivation] body
10191
- # @param [Hash] opts the optional parameters
10192
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
10193
- def notification_activation_with_http_info(notification_id, body, opts = {})
10194
- if @api_client.config.debugging
10195
- @api_client.config.logger.debug 'Calling API: ManagementApi.notification_activation ...'
10196
- end
10197
- # verify the required parameter 'notification_id' is set
10198
- if @api_client.config.client_side_validation && notification_id.nil?
10199
- fail ArgumentError, "Missing the required parameter 'notification_id' when calling ManagementApi.notification_activation"
10200
- end
10201
- # verify the required parameter 'body' is set
10202
- if @api_client.config.client_side_validation && body.nil?
10203
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.notification_activation"
10204
- end
10205
- # resource path
10206
- local_var_path = '/v1/notifications/{notificationId}/activation'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s))
10207
-
10208
- # query parameters
10209
- query_params = opts[:query_params] || {}
10210
-
10211
- # header parameters
10212
- header_params = opts[:header_params] || {}
10213
- # HTTP header 'Content-Type'
10214
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10215
-
10216
- # form parameters
10217
- form_params = opts[:form_params] || {}
10218
-
10219
- # http body (model)
10220
- post_body = opts[:body] || @api_client.object_to_http_body(body)
10221
-
10222
- # return_type
10223
- return_type = opts[:return_type]
10224
-
10225
- # auth_names
10226
- auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10227
-
10228
- new_options = opts.merge(
10229
- :header_params => header_params,
10230
- :query_params => query_params,
10231
- :form_params => form_params,
10232
- :body => post_body,
10233
- :auth_names => auth_names,
10234
- :return_type => return_type
10235
- )
10236
-
10237
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
10238
- if @api_client.config.debugging
10239
- @api_client.config.logger.debug "API called: ManagementApi#notification_activation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10240
- end
10241
- return data, status_code, headers
10242
- end
10243
-
10244
10370
  # Validate Okta API ownership
10245
10371
  # Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
10246
10372
  # @param [Hash] opts the optional parameters
@@ -10295,220 +10421,10 @@ module TalonOne
10295
10421
  return data, status_code, headers
10296
10422
  end
10297
10423
 
10298
- # Create notification about added or deducted loyalty points
10299
- # Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
10300
- # @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
10301
- # @param body [NewBaseNotification] body
10302
- # @param [Hash] opts the optional parameters
10303
- # @return [BaseNotification]
10304
- def post_added_deducted_points_notification(loyalty_program_id, body, opts = {})
10305
- data, _status_code, _headers = post_added_deducted_points_notification_with_http_info(loyalty_program_id, body, opts)
10306
- data
10307
- end
10308
-
10309
- # Create notification about added or deducted loyalty points
10310
- # Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
10311
- # @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
10312
- # @param body [NewBaseNotification] body
10313
- # @param [Hash] opts the optional parameters
10314
- # @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
10315
- def post_added_deducted_points_notification_with_http_info(loyalty_program_id, body, opts = {})
10316
- if @api_client.config.debugging
10317
- @api_client.config.logger.debug 'Calling API: ManagementApi.post_added_deducted_points_notification ...'
10318
- end
10319
- # verify the required parameter 'loyalty_program_id' is set
10320
- if @api_client.config.client_side_validation && loyalty_program_id.nil?
10321
- fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.post_added_deducted_points_notification"
10322
- end
10323
- # verify the required parameter 'body' is set
10324
- if @api_client.config.client_side_validation && body.nil?
10325
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_added_deducted_points_notification"
10326
- end
10327
- # resource path
10328
- local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
10329
-
10330
- # query parameters
10331
- query_params = opts[:query_params] || {}
10332
-
10333
- # header parameters
10334
- header_params = opts[:header_params] || {}
10335
- # HTTP header 'Accept' (if needed)
10336
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10337
- # HTTP header 'Content-Type'
10338
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10339
-
10340
- # form parameters
10341
- form_params = opts[:form_params] || {}
10342
-
10343
- # http body (model)
10344
- post_body = opts[:body] || @api_client.object_to_http_body(body)
10345
-
10346
- # return_type
10347
- return_type = opts[:return_type] || 'BaseNotification'
10348
-
10349
- # auth_names
10350
- auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10351
-
10352
- new_options = opts.merge(
10353
- :header_params => header_params,
10354
- :query_params => query_params,
10355
- :form_params => form_params,
10356
- :body => post_body,
10357
- :auth_names => auth_names,
10358
- :return_type => return_type
10359
- )
10360
-
10361
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10362
- if @api_client.config.debugging
10363
- @api_client.config.logger.debug "API called: ManagementApi#post_added_deducted_points_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10364
- end
10365
- return data, status_code, headers
10366
- end
10367
-
10368
- # Create strikethrough notification
10369
- # Create a notification for the in the given Application. For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
10370
- # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
10371
- # @param body [NewBaseNotification] body
10372
- # @param [Hash] opts the optional parameters
10373
- # @return [BaseNotification]
10374
- def post_catalogs_strikethrough_notification(application_id, body, opts = {})
10375
- data, _status_code, _headers = post_catalogs_strikethrough_notification_with_http_info(application_id, body, opts)
10376
- data
10377
- end
10378
-
10379
- # Create strikethrough notification
10380
- # Create a notification for the in the given Application. For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
10381
- # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
10382
- # @param body [NewBaseNotification] body
10383
- # @param [Hash] opts the optional parameters
10384
- # @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
10385
- def post_catalogs_strikethrough_notification_with_http_info(application_id, body, opts = {})
10386
- if @api_client.config.debugging
10387
- @api_client.config.logger.debug 'Calling API: ManagementApi.post_catalogs_strikethrough_notification ...'
10388
- end
10389
- # verify the required parameter 'application_id' is set
10390
- if @api_client.config.client_side_validation && application_id.nil?
10391
- fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.post_catalogs_strikethrough_notification"
10392
- end
10393
- # verify the required parameter 'body' is set
10394
- if @api_client.config.client_side_validation && body.nil?
10395
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_catalogs_strikethrough_notification"
10396
- end
10397
- # resource path
10398
- local_var_path = '/v1/applications/{applicationId}/catalogs/notifications/strikethrough'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))
10399
-
10400
- # query parameters
10401
- query_params = opts[:query_params] || {}
10402
-
10403
- # header parameters
10404
- header_params = opts[:header_params] || {}
10405
- # HTTP header 'Accept' (if needed)
10406
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10407
- # HTTP header 'Content-Type'
10408
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10409
-
10410
- # form parameters
10411
- form_params = opts[:form_params] || {}
10412
-
10413
- # http body (model)
10414
- post_body = opts[:body] || @api_client.object_to_http_body(body)
10415
-
10416
- # return_type
10417
- return_type = opts[:return_type] || 'BaseNotification'
10418
-
10419
- # auth_names
10420
- auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10421
-
10422
- new_options = opts.merge(
10423
- :header_params => header_params,
10424
- :query_params => query_params,
10425
- :form_params => form_params,
10426
- :body => post_body,
10427
- :auth_names => auth_names,
10428
- :return_type => return_type
10429
- )
10430
-
10431
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10432
- if @api_client.config.debugging
10433
- @api_client.config.logger.debug "API called: ManagementApi#post_catalogs_strikethrough_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10434
- end
10435
- return data, status_code, headers
10436
- end
10437
-
10438
- # Create notification about pending loyalty points
10439
- # Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
10440
- # @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
10441
- # @param body [NewBaseNotification] body
10442
- # @param [Hash] opts the optional parameters
10443
- # @return [BaseNotification]
10444
- def post_pending_points_notification(loyalty_program_id, body, opts = {})
10445
- data, _status_code, _headers = post_pending_points_notification_with_http_info(loyalty_program_id, body, opts)
10446
- data
10447
- end
10448
-
10449
- # Create notification about pending loyalty points
10450
- # Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
10451
- # @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
10452
- # @param body [NewBaseNotification] body
10453
- # @param [Hash] opts the optional parameters
10454
- # @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
10455
- def post_pending_points_notification_with_http_info(loyalty_program_id, body, opts = {})
10456
- if @api_client.config.debugging
10457
- @api_client.config.logger.debug 'Calling API: ManagementApi.post_pending_points_notification ...'
10458
- end
10459
- # verify the required parameter 'loyalty_program_id' is set
10460
- if @api_client.config.client_side_validation && loyalty_program_id.nil?
10461
- fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.post_pending_points_notification"
10462
- end
10463
- # verify the required parameter 'body' is set
10464
- if @api_client.config.client_side_validation && body.nil?
10465
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_pending_points_notification"
10466
- end
10467
- # resource path
10468
- local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
10469
-
10470
- # query parameters
10471
- query_params = opts[:query_params] || {}
10472
-
10473
- # header parameters
10474
- header_params = opts[:header_params] || {}
10475
- # HTTP header 'Accept' (if needed)
10476
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10477
- # HTTP header 'Content-Type'
10478
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10479
-
10480
- # form parameters
10481
- form_params = opts[:form_params] || {}
10482
-
10483
- # http body (model)
10484
- post_body = opts[:body] || @api_client.object_to_http_body(body)
10485
-
10486
- # return_type
10487
- return_type = opts[:return_type] || 'BaseNotification'
10488
-
10489
- # auth_names
10490
- auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10491
-
10492
- new_options = opts.merge(
10493
- :header_params => header_params,
10494
- :query_params => query_params,
10495
- :form_params => form_params,
10496
- :body => post_body,
10497
- :auth_names => auth_names,
10498
- :return_type => return_type
10499
- )
10500
-
10501
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10502
- if @api_client.config.debugging
10503
- @api_client.config.logger.debug "API called: ManagementApi#post_pending_points_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10504
- end
10505
- return data, status_code, headers
10506
- end
10507
-
10508
10424
  # Deduct points from customer profile
10509
10425
  # Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
10510
10426
  # @param loyalty_program_id [String] The identifier for the loyalty program.
10511
- # @param integration_id [String] The identifier of the profile.
10427
+ # @param 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.
10512
10428
  # @param body [DeductLoyaltyPoints] body
10513
10429
  # @param [Hash] opts the optional parameters
10514
10430
  # @return [nil]
@@ -10520,7 +10436,7 @@ module TalonOne
10520
10436
  # Deduct points from customer profile
10521
10437
  # Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
10522
10438
  # @param loyalty_program_id [String] The identifier for the loyalty program.
10523
- # @param integration_id [String] The identifier of the profile.
10439
+ # @param 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.
10524
10440
  # @param body [DeductLoyaltyPoints] body
10525
10441
  # @param [Hash] opts the optional parameters
10526
10442
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -11202,7 +11118,7 @@ module TalonOne
11202
11118
  # @param [Hash] opts the optional parameters
11203
11119
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
11204
11120
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11205
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
11121
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
11206
11122
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
11207
11123
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
11208
11124
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -11213,7 +11129,7 @@ module TalonOne
11213
11129
  # @option opts [String] :batch_id Filter results by batches of coupons
11214
11130
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
11215
11131
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
11216
- # @return [InlineResponse2009]
11132
+ # @return [InlineResponse20011]
11217
11133
  def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
11218
11134
  data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
11219
11135
  data
@@ -11226,7 +11142,7 @@ module TalonOne
11226
11142
  # @param [Hash] opts the optional parameters
11227
11143
  # @option opts [Integer] :page_size The number of items in the response.
11228
11144
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11229
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
11145
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
11230
11146
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
11231
11147
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
11232
11148
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -11237,7 +11153,7 @@ module TalonOne
11237
11153
  # @option opts [String] :batch_id Filter results by batches of coupons
11238
11154
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
11239
11155
  # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
11240
- # @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
11156
+ # @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
11241
11157
  def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
11242
11158
  if @api_client.config.debugging
11243
11159
  @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide_without_total_count ...'
@@ -11303,7 +11219,7 @@ module TalonOne
11303
11219
  post_body = opts[:body] || @api_client.object_to_http_body(body)
11304
11220
 
11305
11221
  # return_type
11306
- return_type = opts[:return_type] || 'InlineResponse2009'
11222
+ return_type = opts[:return_type] || 'InlineResponse20011'
11307
11223
 
11308
11224
  # auth_names
11309
11225
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -11332,7 +11248,7 @@ module TalonOne
11332
11248
  # @param [Hash] opts the optional parameters
11333
11249
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
11334
11250
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11335
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
11251
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
11336
11252
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
11337
11253
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
11338
11254
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -11342,7 +11258,7 @@ module TalonOne
11342
11258
  # @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.
11343
11259
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
11344
11260
  # @option opts [String] :batch_id Filter results by batches of coupons
11345
- # @return [InlineResponse2009]
11261
+ # @return [InlineResponse20011]
11346
11262
  def search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {})
11347
11263
  data, _status_code, _headers = search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts)
11348
11264
  data
@@ -11356,7 +11272,7 @@ module TalonOne
11356
11272
  # @param [Hash] opts the optional parameters
11357
11273
  # @option opts [Integer] :page_size The number of items in the response.
11358
11274
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11359
- # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
11275
+ # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
11360
11276
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
11361
11277
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
11362
11278
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -11366,7 +11282,7 @@ module TalonOne
11366
11282
  # @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon&#39;s RecipientIntegrationId field.
11367
11283
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
11368
11284
  # @option opts [String] :batch_id Filter results by batches of coupons
11369
- # @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
11285
+ # @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
11370
11286
  def search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {})
11371
11287
  if @api_client.config.debugging
11372
11288
  @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_without_total_count ...'
@@ -11431,7 +11347,7 @@ module TalonOne
11431
11347
  post_body = opts[:body] || @api_client.object_to_http_body(body)
11432
11348
 
11433
11349
  # return_type
11434
- return_type = opts[:return_type] || 'InlineResponse2009'
11350
+ return_type = opts[:return_type] || 'InlineResponse20011'
11435
11351
 
11436
11352
  # auth_names
11437
11353
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']