talon_one 0.1.3 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (524) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/Gemfile +4 -0
  4. data/README.md +398 -57
  5. data/Rakefile +6 -8
  6. data/docs/APIError.md +10 -0
  7. data/docs/AccessLogEntry.md +14 -0
  8. data/docs/Account.md +25 -0
  9. data/docs/AccountAnalytics.md +21 -0
  10. data/docs/AccountEntity.md +8 -0
  11. data/docs/AccountLimits.md +18 -0
  12. data/docs/Application.md +20 -0
  13. data/docs/ApplicationAPIKey.md +14 -0
  14. data/docs/ApplicationApiHealth.md +9 -0
  15. data/docs/ApplicationCustomer.md +16 -0
  16. data/docs/ApplicationCustomerEntity.md +8 -0
  17. data/docs/ApplicationCustomerSearch.md +10 -0
  18. data/docs/ApplicationEntity.md +8 -0
  19. data/docs/ApplicationEvent.md +15 -0
  20. data/docs/ApplicationSession.md +18 -0
  21. data/docs/ApplicationSessionEntity.md +8 -0
  22. data/docs/ApplicationStorage.md +15 -0
  23. data/docs/ApplicationStorageData.md +7 -0
  24. data/docs/ApplicationStorageTuple.md +13 -0
  25. data/docs/Attribute.md +20 -0
  26. data/docs/AttributeQuery.md +7 -0
  27. data/docs/Binding.md +9 -0
  28. data/docs/Campaign.md +30 -0
  29. data/docs/CampaignAnalytics.md +22 -0
  30. data/docs/CampaignCopy.md +9 -0
  31. data/docs/CampaignEntity.md +8 -0
  32. data/docs/CampaignSearch.md +8 -0
  33. data/docs/CampaignSet.md +11 -0
  34. data/docs/CampaignSetBranchNode.md +11 -0
  35. data/docs/CampaignSetLeafNode.md +9 -0
  36. data/docs/CampaignSetNode.md +8 -0
  37. data/docs/CartItem.md +19 -0
  38. data/docs/CartItemAdjustment.md +10 -0
  39. data/docs/Change.md +13 -0
  40. data/docs/CodeGeneratorSettings.md +9 -0
  41. data/docs/Coupon.md +21 -0
  42. data/docs/CouponConstraints.md +10 -0
  43. data/docs/CouponRejectionReason.md +10 -0
  44. data/docs/CouponReservations.md +8 -0
  45. data/docs/CouponSearch.md +8 -0
  46. data/docs/CouponValue.md +8 -0
  47. data/docs/CreateApplicationAPIKey.md +9 -0
  48. data/docs/CustomerActivityReport.md +20 -0
  49. data/docs/CustomerAnalytics.md +14 -0
  50. data/docs/CustomerProfile.md +15 -0
  51. data/docs/CustomerProfileSearchQuery.md +10 -0
  52. data/docs/CustomerSession.md +20 -0
  53. data/docs/EmailEntity.md +8 -0
  54. data/docs/Entity.md +9 -0
  55. data/docs/Environment.md +14 -0
  56. data/docs/ErrorResponse.md +9 -0
  57. data/docs/ErrorSource.md +10 -0
  58. data/docs/Event.md +17 -0
  59. data/docs/EventType.md +19 -0
  60. data/docs/Export.md +13 -0
  61. data/docs/FeatureFlag.md +11 -0
  62. data/docs/FeatureFlags.md +11 -0
  63. data/docs/FeaturesFeed.md +9 -0
  64. data/docs/FuncArgDef.md +9 -0
  65. data/docs/FunctionDef.md +12 -0
  66. data/docs/Import.md +13 -0
  67. data/docs/ImportCoupons.md +8 -0
  68. data/docs/InlineResponse200.md +9 -0
  69. data/docs/InlineResponse2001.md +9 -0
  70. data/docs/InlineResponse20010.md +9 -0
  71. data/docs/InlineResponse20011.md +9 -0
  72. data/docs/InlineResponse20012.md +9 -0
  73. data/docs/InlineResponse20013.md +9 -0
  74. data/docs/InlineResponse20014.md +9 -0
  75. data/docs/InlineResponse20015.md +9 -0
  76. data/docs/InlineResponse20016.md +9 -0
  77. data/docs/InlineResponse20017.md +9 -0
  78. data/docs/InlineResponse20018.md +9 -0
  79. data/docs/InlineResponse20019.md +9 -0
  80. data/docs/InlineResponse2002.md +9 -0
  81. data/docs/InlineResponse20020.md +9 -0
  82. data/docs/InlineResponse20021.md +9 -0
  83. data/docs/InlineResponse20022.md +9 -0
  84. data/docs/InlineResponse20023.md +9 -0
  85. data/docs/InlineResponse20024.md +9 -0
  86. data/docs/InlineResponse20025.md +9 -0
  87. data/docs/InlineResponse20026.md +9 -0
  88. data/docs/InlineResponse20027.md +9 -0
  89. data/docs/InlineResponse20028.md +9 -0
  90. data/docs/InlineResponse2003.md +9 -0
  91. data/docs/InlineResponse2004.md +9 -0
  92. data/docs/InlineResponse2005.md +9 -0
  93. data/docs/InlineResponse2006.md +9 -0
  94. data/docs/InlineResponse2007.md +9 -0
  95. data/docs/InlineResponse2008.md +9 -0
  96. data/docs/InlineResponse2009.md +9 -0
  97. data/docs/IntegrationApi.md +558 -0
  98. data/docs/IntegrationEntity.md +9 -0
  99. data/docs/IntegrationProfileEntity.md +8 -0
  100. data/docs/IntegrationState.md +11 -0
  101. data/docs/LedgerEntry.md +17 -0
  102. data/docs/LibraryAttribute.md +14 -0
  103. data/docs/LimitConfig.md +10 -0
  104. data/docs/LoginParams.md +9 -0
  105. data/docs/Loyalty.md +8 -0
  106. data/docs/LoyaltyLedger.md +9 -0
  107. data/docs/LoyaltyLedgerEntry.md +17 -0
  108. data/docs/LoyaltyMembership.md +9 -0
  109. data/docs/LoyaltyPoints.md +11 -0
  110. data/docs/LoyaltyProgram.md +15 -0
  111. data/docs/LoyaltyProgramBalance.md +8 -0
  112. data/docs/LoyaltyProgramLedgers.md +11 -0
  113. data/docs/LoyaltySubLedger.md +10 -0
  114. data/docs/ManagementApi.md +5067 -0
  115. data/docs/ManagerConfig.md +8 -0
  116. data/docs/Meta.md +11 -0
  117. data/docs/MiscUpdateUserLatestFeature.md +8 -0
  118. data/docs/MultiApplicationEntity.md +8 -0
  119. data/docs/MutableEntity.md +8 -0
  120. data/docs/NewAccount.md +8 -0
  121. data/docs/NewAccountSignUp.md +10 -0
  122. data/docs/NewApplication.md +15 -0
  123. data/docs/NewApplicationAPIKey.md +15 -0
  124. data/docs/NewApplicationStorage.md +10 -0
  125. data/docs/NewApplicationStorageData.md +7 -0
  126. data/docs/NewApplicationStorageTuple.md +9 -0
  127. data/docs/NewAttribute.md +15 -0
  128. data/docs/NewCampaign.md +19 -0
  129. data/docs/NewCampaignSet.md +9 -0
  130. data/docs/NewCoupons.md +16 -0
  131. data/docs/NewCustomerProfile.md +8 -0
  132. data/docs/NewCustomerSession.md +15 -0
  133. data/docs/NewEvent.md +11 -0
  134. data/docs/NewEventType.md +17 -0
  135. data/docs/NewFeatureFlags.md +10 -0
  136. data/docs/NewImport.md +8 -0
  137. data/docs/NewInvitation.md +11 -0
  138. data/docs/NewInviteEmail.md +9 -0
  139. data/docs/NewLoyaltyProgram.md +13 -0
  140. data/docs/NewPassword.md +9 -0
  141. data/docs/NewPasswordEmail.md +8 -0
  142. data/docs/NewReferral.md +12 -0
  143. data/docs/NewRole.md +11 -0
  144. data/docs/NewRuleset.md +11 -0
  145. data/docs/NewTemplateDef.md +14 -0
  146. data/docs/NewUser.md +11 -0
  147. data/docs/NewWebhook.md +15 -0
  148. data/docs/Referral.md +17 -0
  149. data/docs/Role.md +13 -0
  150. data/docs/RoleAssign.md +9 -0
  151. data/docs/RoleMembership.md +9 -0
  152. data/docs/Rule.md +12 -0
  153. data/docs/Ruleset.md +16 -0
  154. data/docs/Session.md +10 -0
  155. data/docs/SlotDef.md +13 -0
  156. data/docs/TemplateArgDef.md +11 -0
  157. data/docs/TemplateDef.md +18 -0
  158. data/docs/UpdateAccount.md +10 -0
  159. data/docs/UpdateCampaign.md +19 -0
  160. data/docs/UpdateCoupon.md +12 -0
  161. data/docs/UpdateCouponBatch.md +12 -0
  162. data/docs/UpdateLoyaltyProgram.md +12 -0
  163. data/docs/UpdateRole.md +11 -0
  164. data/docs/UpdateUser.md +16 -0
  165. data/docs/User.md +19 -0
  166. data/docs/UserEntity.md +8 -0
  167. data/docs/Webhook.md +19 -0
  168. data/docs/WebhookActivationLogEntry.md +12 -0
  169. data/docs/WebhookLogEntry.md +17 -0
  170. data/fck.rb +64 -0
  171. data/git_push.sh +55 -0
  172. data/lib/talon_one.rb +200 -4
  173. data/lib/talon_one/api/integration_api.rb +531 -0
  174. data/lib/talon_one/api/management_api.rb +5520 -0
  175. data/lib/talon_one/api_client.rb +389 -0
  176. data/lib/talon_one/api_error.rb +38 -0
  177. data/lib/talon_one/configuration.rb +223 -0
  178. data/lib/talon_one/models/access_log_entry.rb +280 -0
  179. data/lib/talon_one/models/account.rb +462 -0
  180. data/lib/talon_one/models/account_analytics.rb +384 -0
  181. data/lib/talon_one/models/account_entity.rb +189 -0
  182. data/lib/talon_one/models/account_limits.rb +341 -0
  183. data/lib/talon_one/models/api_error.rb +213 -0
  184. data/lib/talon_one/models/application.rb +482 -0
  185. data/lib/talon_one/models/application_api_health.rb +239 -0
  186. data/lib/talon_one/models/application_api_key.rb +279 -0
  187. data/lib/talon_one/models/application_customer.rb +312 -0
  188. data/lib/talon_one/models/application_customer_entity.rb +184 -0
  189. data/lib/talon_one/models/application_customer_search.rb +206 -0
  190. data/lib/talon_one/models/application_entity.rb +189 -0
  191. data/lib/talon_one/models/application_event.rb +287 -0
  192. data/lib/talon_one/models/application_session.rb +368 -0
  193. data/lib/talon_one/models/application_session_entity.rb +189 -0
  194. data/lib/talon_one/models/application_storage.rb +292 -0
  195. data/lib/talon_one/models/application_storage_data.rb +175 -0
  196. data/lib/talon_one/models/application_storage_tuple.rb +283 -0
  197. data/lib/talon_one/models/attribute.rb +416 -0
  198. data/lib/talon_one/models/attribute_query.rb +174 -0
  199. data/lib/talon_one/models/binding.rb +206 -0
  200. data/lib/talon_one/models/campaign.rb +514 -0
  201. data/lib/talon_one/models/campaign_analytics.rb +399 -0
  202. data/lib/talon_one/models/campaign_copy.rb +201 -0
  203. data/lib/talon_one/models/campaign_entity.rb +189 -0
  204. data/lib/talon_one/models/campaign_search.rb +189 -0
  205. data/lib/talon_one/models/campaign_set.rb +234 -0
  206. data/lib/talon_one/models/campaign_set_branch_node.rb +282 -0
  207. data/lib/talon_one/models/campaign_set_leaf_node.rb +238 -0
  208. data/lib/talon_one/models/campaign_set_node.rb +188 -0
  209. data/lib/talon_one/models/cart_item.rb +365 -0
  210. data/lib/talon_one/models/cart_item_adjustment.rb +248 -0
  211. data/lib/talon_one/models/change.rb +255 -0
  212. data/lib/talon_one/models/code_generator_settings.rb +225 -0
  213. data/lib/talon_one/models/coupon.rb +392 -0
  214. data/lib/talon_one/models/coupon_constraints.rb +228 -0
  215. data/lib/talon_one/models/coupon_rejection_reason.rb +251 -0
  216. data/lib/talon_one/models/coupon_reservations.rb +191 -0
  217. data/lib/talon_one/models/coupon_search.rb +189 -0
  218. data/lib/talon_one/models/coupon_value.rb +199 -0
  219. data/lib/talon_one/models/create_application_api_key.rb +204 -0
  220. data/lib/talon_one/models/customer_activity_report.rb +365 -0
  221. data/lib/talon_one/models/customer_analytics.rb +280 -0
  222. data/lib/talon_one/models/customer_profile.rb +297 -0
  223. data/lib/talon_one/models/customer_profile_search_query.rb +206 -0
  224. data/lib/talon_one/models/customer_session.rb +407 -0
  225. data/lib/talon_one/models/email_entity.rb +189 -0
  226. data/lib/talon_one/models/entity.rb +204 -0
  227. data/lib/talon_one/models/environment.rb +285 -0
  228. data/lib/talon_one/models/error_response.rb +201 -0
  229. data/lib/talon_one/models/error_source.rb +205 -0
  230. data/lib/talon_one/models/event.rb +356 -0
  231. data/lib/talon_one/models/event_type.rb +426 -0
  232. data/lib/talon_one/models/export.rb +299 -0
  233. data/lib/talon_one/models/feature_flag.rb +224 -0
  234. data/lib/talon_one/models/feature_flags.rb +220 -0
  235. data/lib/talon_one/models/features_feed.rb +193 -0
  236. data/lib/talon_one/models/func_arg_def.rb +243 -0
  237. data/lib/talon_one/models/function_def.rb +260 -0
  238. data/lib/talon_one/models/import.rb +318 -0
  239. data/lib/talon_one/models/import_coupons.rb +188 -0
  240. data/lib/talon_one/models/inline_response_200.rb +204 -0
  241. data/lib/talon_one/models/inline_response_200_1.rb +204 -0
  242. data/lib/talon_one/models/inline_response_200_10.rb +204 -0
  243. data/lib/talon_one/models/inline_response_200_11.rb +204 -0
  244. data/lib/talon_one/models/inline_response_200_12.rb +204 -0
  245. data/lib/talon_one/models/inline_response_200_13.rb +204 -0
  246. data/lib/talon_one/models/inline_response_200_14.rb +204 -0
  247. data/lib/talon_one/models/inline_response_200_15.rb +204 -0
  248. data/lib/talon_one/models/inline_response_200_16.rb +204 -0
  249. data/lib/talon_one/models/inline_response_200_17.rb +204 -0
  250. data/lib/talon_one/models/inline_response_200_18.rb +204 -0
  251. data/lib/talon_one/models/inline_response_200_19.rb +204 -0
  252. data/lib/talon_one/models/inline_response_200_2.rb +204 -0
  253. data/lib/talon_one/models/inline_response_200_20.rb +204 -0
  254. data/lib/talon_one/models/inline_response_200_21.rb +204 -0
  255. data/lib/talon_one/models/inline_response_200_22.rb +204 -0
  256. data/lib/talon_one/models/inline_response_200_23.rb +204 -0
  257. data/lib/talon_one/models/inline_response_200_24.rb +204 -0
  258. data/lib/talon_one/models/inline_response_200_25.rb +204 -0
  259. data/lib/talon_one/models/inline_response_200_26.rb +204 -0
  260. data/lib/talon_one/models/inline_response_200_27.rb +204 -0
  261. data/lib/talon_one/models/inline_response_200_28.rb +204 -0
  262. data/lib/talon_one/models/inline_response_200_3.rb +204 -0
  263. data/lib/talon_one/models/inline_response_200_4.rb +204 -0
  264. data/lib/talon_one/models/inline_response_200_5.rb +204 -0
  265. data/lib/talon_one/models/inline_response_200_6.rb +204 -0
  266. data/lib/talon_one/models/inline_response_200_7.rb +204 -0
  267. data/lib/talon_one/models/inline_response_200_8.rb +204 -0
  268. data/lib/talon_one/models/inline_response_200_9.rb +204 -0
  269. data/lib/talon_one/models/integration_entity.rb +204 -0
  270. data/lib/talon_one/models/integration_profile_entity.rb +184 -0
  271. data/lib/talon_one/models/integration_state.rb +226 -0
  272. data/lib/talon_one/models/ledger_entry.rb +320 -0
  273. data/lib/talon_one/models/library_attribute.rb +330 -0
  274. data/lib/talon_one/models/limit_config.rb +274 -0
  275. data/lib/talon_one/models/login_params.rb +205 -0
  276. data/lib/talon_one/models/loyalty.rb +192 -0
  277. data/lib/talon_one/models/loyalty_ledger.rb +202 -0
  278. data/lib/talon_one/models/loyalty_ledger_entry.rb +336 -0
  279. data/lib/talon_one/models/loyalty_membership.rb +199 -0
  280. data/lib/talon_one/models/loyalty_points.rb +220 -0
  281. data/lib/talon_one/models/loyalty_program.rb +297 -0
  282. data/lib/talon_one/models/loyalty_program_balance.rb +189 -0
  283. data/lib/talon_one/models/loyalty_program_ledgers.rb +232 -0
  284. data/lib/talon_one/models/loyalty_sub_ledger.rb +213 -0
  285. data/lib/talon_one/models/manager_config.rb +188 -0
  286. data/lib/talon_one/models/meta.rb +212 -0
  287. data/lib/talon_one/models/misc_update_user_latest_feature.rb +183 -0
  288. data/lib/talon_one/models/multi_application_entity.rb +191 -0
  289. data/lib/talon_one/models/mutable_entity.rb +189 -0
  290. data/lib/talon_one/models/new_account.rb +207 -0
  291. data/lib/talon_one/models/new_account_sign_up.rb +238 -0
  292. data/lib/talon_one/models/new_application.rb +404 -0
  293. data/lib/talon_one/models/new_application_api_key.rb +295 -0
  294. data/lib/talon_one/models/new_application_storage.rb +214 -0
  295. data/lib/talon_one/models/new_application_storage_data.rb +175 -0
  296. data/lib/talon_one/models/new_application_storage_tuple.rb +222 -0
  297. data/lib/talon_one/models/new_attribute.rb +337 -0
  298. data/lib/talon_one/models/new_campaign.rb +378 -0
  299. data/lib/talon_one/models/new_campaign_set.rb +204 -0
  300. data/lib/talon_one/models/new_coupons.rb +334 -0
  301. data/lib/talon_one/models/new_customer_profile.rb +184 -0
  302. data/lib/talon_one/models/new_customer_session.rb +295 -0
  303. data/lib/talon_one/models/new_event.rb +268 -0
  304. data/lib/talon_one/models/new_event_type.rb +396 -0
  305. data/lib/talon_one/models/new_feature_flags.rb +204 -0
  306. data/lib/talon_one/models/new_import.rb +224 -0
  307. data/lib/talon_one/models/new_invitation.rb +226 -0
  308. data/lib/talon_one/models/new_invite_email.rb +240 -0
  309. data/lib/talon_one/models/new_loyalty_program.rb +257 -0
  310. data/lib/talon_one/models/new_password.rb +222 -0
  311. data/lib/talon_one/models/new_password_email.rb +207 -0
  312. data/lib/talon_one/models/new_referral.rb +234 -0
  313. data/lib/talon_one/models/new_role.rb +232 -0
  314. data/lib/talon_one/models/new_ruleset.rb +228 -0
  315. data/lib/talon_one/models/new_template_def.rb +308 -0
  316. data/lib/talon_one/models/new_user.rb +248 -0
  317. data/lib/talon_one/models/new_webhook.rb +330 -0
  318. data/lib/talon_one/models/referral.rb +348 -0
  319. data/lib/talon_one/models/role.rb +247 -0
  320. data/lib/talon_one/models/role_assign.rb +209 -0
  321. data/lib/talon_one/models/role_membership.rb +204 -0
  322. data/lib/talon_one/models/rule.rb +245 -0
  323. data/lib/talon_one/models/ruleset.rb +299 -0
  324. data/lib/talon_one/models/session.rb +219 -0
  325. data/lib/talon_one/models/slot_def.rb +254 -0
  326. data/lib/talon_one/models/template_arg_def.rb +293 -0
  327. data/lib/talon_one/models/template_def.rb +398 -0
  328. data/lib/talon_one/models/update_account.rb +233 -0
  329. data/lib/talon_one/models/update_campaign.rb +373 -0
  330. data/lib/talon_one/models/update_coupon.rb +249 -0
  331. data/lib/talon_one/models/update_coupon_batch.rb +254 -0
  332. data/lib/talon_one/models/update_loyalty_program.rb +227 -0
  333. data/lib/talon_one/models/update_role.rb +216 -0
  334. data/lib/talon_one/models/update_user.rb +306 -0
  335. data/lib/talon_one/models/user.rb +381 -0
  336. data/lib/talon_one/models/user_entity.rb +189 -0
  337. data/lib/talon_one/models/webhook.rb +392 -0
  338. data/lib/talon_one/models/webhook_activation_log_entry.rb +250 -0
  339. data/lib/talon_one/models/webhook_log_entry.rb +305 -0
  340. data/lib/talon_one/version.rb +15 -0
  341. data/spec/api/integration_api_spec.rb +147 -0
  342. data/spec/api/management_api_spec.rb +1299 -0
  343. data/spec/api_client_spec.rb +226 -0
  344. data/spec/configuration_spec.rb +42 -0
  345. data/spec/models/access_log_entry_spec.rb +77 -0
  346. data/spec/models/account_analytics_spec.rb +119 -0
  347. data/spec/models/account_entity_spec.rb +41 -0
  348. data/spec/models/account_limits_spec.rb +101 -0
  349. data/spec/models/account_spec.rb +147 -0
  350. data/spec/models/api_error_spec.rb +53 -0
  351. data/spec/models/application_api_health_spec.rb +51 -0
  352. data/spec/models/application_api_key_spec.rb +77 -0
  353. data/spec/models/application_customer_entity_spec.rb +41 -0
  354. data/spec/models/application_customer_search_spec.rb +53 -0
  355. data/spec/models/application_customer_spec.rb +89 -0
  356. data/spec/models/application_entity_spec.rb +41 -0
  357. data/spec/models/application_event_spec.rb +83 -0
  358. data/spec/models/application_session_entity_spec.rb +41 -0
  359. data/spec/models/application_session_spec.rb +105 -0
  360. data/spec/models/application_spec.rb +117 -0
  361. data/spec/models/application_storage_data_spec.rb +35 -0
  362. data/spec/models/application_storage_spec.rb +83 -0
  363. data/spec/models/application_storage_tuple_spec.rb +71 -0
  364. data/spec/models/attribute_query_spec.rb +35 -0
  365. data/spec/models/attribute_spec.rb +121 -0
  366. data/spec/models/binding_spec.rb +47 -0
  367. data/spec/models/campaign_analytics_spec.rb +125 -0
  368. data/spec/models/campaign_copy_spec.rb +47 -0
  369. data/spec/models/campaign_entity_spec.rb +41 -0
  370. data/spec/models/campaign_search_spec.rb +41 -0
  371. data/spec/models/campaign_set_branch_node_spec.rb +67 -0
  372. data/spec/models/campaign_set_leaf_node_spec.rb +51 -0
  373. data/spec/models/campaign_set_node_spec.rb +41 -0
  374. data/spec/models/campaign_set_spec.rb +59 -0
  375. data/spec/models/campaign_spec.rb +181 -0
  376. data/spec/models/cart_item_adjustment_spec.rb +53 -0
  377. data/spec/models/cart_item_spec.rb +107 -0
  378. data/spec/models/change_spec.rb +71 -0
  379. data/spec/models/code_generator_settings_spec.rb +47 -0
  380. data/spec/models/coupon_constraints_spec.rb +53 -0
  381. data/spec/models/coupon_rejection_reason_spec.rb +57 -0
  382. data/spec/models/coupon_reservations_spec.rb +41 -0
  383. data/spec/models/coupon_search_spec.rb +41 -0
  384. data/spec/models/coupon_spec.rb +119 -0
  385. data/spec/models/coupon_value_spec.rb +41 -0
  386. data/spec/models/create_application_api_key_spec.rb +47 -0
  387. data/spec/models/customer_activity_report_spec.rb +113 -0
  388. data/spec/models/customer_analytics_spec.rb +77 -0
  389. data/spec/models/customer_profile_search_query_spec.rb +53 -0
  390. data/spec/models/customer_profile_spec.rb +83 -0
  391. data/spec/models/customer_session_spec.rb +117 -0
  392. data/spec/models/email_entity_spec.rb +41 -0
  393. data/spec/models/entity_spec.rb +47 -0
  394. data/spec/models/environment_spec.rb +77 -0
  395. data/spec/models/error_response_spec.rb +47 -0
  396. data/spec/models/error_source_spec.rb +53 -0
  397. data/spec/models/event_spec.rb +95 -0
  398. data/spec/models/event_type_spec.rb +115 -0
  399. data/spec/models/export_spec.rb +75 -0
  400. data/spec/models/feature_flag_spec.rb +59 -0
  401. data/spec/models/feature_flags_spec.rb +59 -0
  402. data/spec/models/features_feed_spec.rb +47 -0
  403. data/spec/models/func_arg_def_spec.rb +51 -0
  404. data/spec/models/function_def_spec.rb +65 -0
  405. data/spec/models/import_coupons_spec.rb +41 -0
  406. data/spec/models/import_spec.rb +75 -0
  407. data/spec/models/inline_response_200_10_spec.rb +47 -0
  408. data/spec/models/inline_response_200_11_spec.rb +47 -0
  409. data/spec/models/inline_response_200_12_spec.rb +47 -0
  410. data/spec/models/inline_response_200_13_spec.rb +47 -0
  411. data/spec/models/inline_response_200_14_spec.rb +47 -0
  412. data/spec/models/inline_response_200_15_spec.rb +47 -0
  413. data/spec/models/inline_response_200_16_spec.rb +47 -0
  414. data/spec/models/inline_response_200_17_spec.rb +47 -0
  415. data/spec/models/inline_response_200_18_spec.rb +47 -0
  416. data/spec/models/inline_response_200_19_spec.rb +47 -0
  417. data/spec/models/inline_response_200_1_spec.rb +47 -0
  418. data/spec/models/inline_response_200_20_spec.rb +47 -0
  419. data/spec/models/inline_response_200_21_spec.rb +47 -0
  420. data/spec/models/inline_response_200_22_spec.rb +47 -0
  421. data/spec/models/inline_response_200_23_spec.rb +47 -0
  422. data/spec/models/inline_response_200_24_spec.rb +47 -0
  423. data/spec/models/inline_response_200_25_spec.rb +47 -0
  424. data/spec/models/inline_response_200_26_spec.rb +47 -0
  425. data/spec/models/inline_response_200_27_spec.rb +47 -0
  426. data/spec/models/inline_response_200_28_spec.rb +47 -0
  427. data/spec/models/inline_response_200_2_spec.rb +47 -0
  428. data/spec/models/inline_response_200_3_spec.rb +47 -0
  429. data/spec/models/inline_response_200_4_spec.rb +47 -0
  430. data/spec/models/inline_response_200_5_spec.rb +47 -0
  431. data/spec/models/inline_response_200_6_spec.rb +47 -0
  432. data/spec/models/inline_response_200_7_spec.rb +47 -0
  433. data/spec/models/inline_response_200_8_spec.rb +47 -0
  434. data/spec/models/inline_response_200_9_spec.rb +47 -0
  435. data/spec/models/inline_response_200_spec.rb +47 -0
  436. data/spec/models/integration_entity_spec.rb +47 -0
  437. data/spec/models/integration_profile_entity_spec.rb +41 -0
  438. data/spec/models/integration_state_spec.rb +59 -0
  439. data/spec/models/ledger_entry_spec.rb +95 -0
  440. data/spec/models/library_attribute_spec.rb +85 -0
  441. data/spec/models/limit_config_spec.rb +61 -0
  442. data/spec/models/login_params_spec.rb +47 -0
  443. data/spec/models/loyalty_ledger_entry_spec.rb +99 -0
  444. data/spec/models/loyalty_ledger_spec.rb +47 -0
  445. data/spec/models/loyalty_membership_spec.rb +47 -0
  446. data/spec/models/loyalty_points_spec.rb +59 -0
  447. data/spec/models/loyalty_program_balance_spec.rb +41 -0
  448. data/spec/models/loyalty_program_ledgers_spec.rb +59 -0
  449. data/spec/models/loyalty_program_spec.rb +83 -0
  450. data/spec/models/loyalty_spec.rb +41 -0
  451. data/spec/models/loyalty_sub_ledger_spec.rb +53 -0
  452. data/spec/models/manager_config_spec.rb +41 -0
  453. data/spec/models/meta_spec.rb +59 -0
  454. data/spec/models/misc_update_user_latest_feature_spec.rb +41 -0
  455. data/spec/models/multi_application_entity_spec.rb +41 -0
  456. data/spec/models/mutable_entity_spec.rb +41 -0
  457. data/spec/models/new_account_sign_up_spec.rb +53 -0
  458. data/spec/models/new_account_spec.rb +41 -0
  459. data/spec/models/new_application_api_key_spec.rb +83 -0
  460. data/spec/models/new_application_spec.rb +87 -0
  461. data/spec/models/new_application_storage_data_spec.rb +35 -0
  462. data/spec/models/new_application_storage_spec.rb +53 -0
  463. data/spec/models/new_application_storage_tuple_spec.rb +47 -0
  464. data/spec/models/new_attribute_spec.rb +91 -0
  465. data/spec/models/new_campaign_set_spec.rb +47 -0
  466. data/spec/models/new_campaign_spec.rb +115 -0
  467. data/spec/models/new_coupons_spec.rb +89 -0
  468. data/spec/models/new_customer_profile_spec.rb +41 -0
  469. data/spec/models/new_customer_session_spec.rb +87 -0
  470. data/spec/models/new_event_spec.rb +59 -0
  471. data/spec/models/new_event_type_spec.rb +103 -0
  472. data/spec/models/new_feature_flags_spec.rb +53 -0
  473. data/spec/models/new_import_spec.rb +45 -0
  474. data/spec/models/new_invitation_spec.rb +59 -0
  475. data/spec/models/new_invite_email_spec.rb +47 -0
  476. data/spec/models/new_loyalty_program_spec.rb +71 -0
  477. data/spec/models/new_password_email_spec.rb +41 -0
  478. data/spec/models/new_password_spec.rb +47 -0
  479. data/spec/models/new_referral_spec.rb +65 -0
  480. data/spec/models/new_role_spec.rb +59 -0
  481. data/spec/models/new_ruleset_spec.rb +59 -0
  482. data/spec/models/new_template_def_spec.rb +77 -0
  483. data/spec/models/new_user_spec.rb +59 -0
  484. data/spec/models/new_webhook_spec.rb +87 -0
  485. data/spec/models/referral_spec.rb +95 -0
  486. data/spec/models/role_assign_spec.rb +47 -0
  487. data/spec/models/role_membership_spec.rb +47 -0
  488. data/spec/models/role_spec.rb +71 -0
  489. data/spec/models/rule_spec.rb +65 -0
  490. data/spec/models/ruleset_spec.rb +89 -0
  491. data/spec/models/session_spec.rb +53 -0
  492. data/spec/models/slot_def_spec.rb +71 -0
  493. data/spec/models/template_arg_def_spec.rb +63 -0
  494. data/spec/models/template_def_spec.rb +101 -0
  495. data/spec/models/update_account_spec.rb +53 -0
  496. data/spec/models/update_campaign_spec.rb +115 -0
  497. data/spec/models/update_coupon_batch_spec.rb +65 -0
  498. data/spec/models/update_coupon_spec.rb +65 -0
  499. data/spec/models/update_loyalty_program_spec.rb +65 -0
  500. data/spec/models/update_role_spec.rb +59 -0
  501. data/spec/models/update_user_spec.rb +93 -0
  502. data/spec/models/user_entity_spec.rb +41 -0
  503. data/spec/models/user_spec.rb +111 -0
  504. data/spec/models/webhook_activation_log_entry_spec.rb +65 -0
  505. data/spec/models/webhook_log_entry_spec.rb +95 -0
  506. data/spec/models/webhook_spec.rb +111 -0
  507. data/spec/spec_helper.rb +111 -0
  508. data/talon_one.gemspec +43 -15
  509. metadata +825 -31
  510. data/.gitignore +0 -4
  511. data/.travis.yml +0 -5
  512. data/lib/integration/client.rb +0 -95
  513. data/lib/integration/client_error.rb +0 -9
  514. data/lib/integration/customer_profile.rb +0 -21
  515. data/lib/integration/effect.rb +0 -24
  516. data/lib/integration/event.rb +0 -50
  517. data/lib/integration/meta_data.rb +0 -18
  518. data/lib/integration/referral_code.rb +0 -49
  519. data/lib/integration/rule_engine_result.rb +0 -23
  520. data/lib/integration/search_profiles_result.rb +0 -17
  521. data/lib/management/client.rb +0 -116
  522. data/test/test_helper.rb +0 -20
  523. data/test/test_integration_api_live.rb +0 -94
  524. data/test/test_integration_params.rb +0 -23
@@ -0,0 +1,8 @@
1
+ # TalonOne::ImportCoupons
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **coupons** | **String** | |
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse200
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<CustomerProfile>**](CustomerProfile.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2001
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Coupon>**](Coupon.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20010
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **has_more** | **BOOLEAN** | |
7
+ **data** | [**Array<AccessLogEntry>**](AccessLogEntry.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20011
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<CampaignAnalytics>**](CampaignAnalytics.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20012
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<ApplicationCustomer>**](ApplicationCustomer.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20013
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **has_more** | **BOOLEAN** | |
7
+ **data** | [**Array<ApplicationCustomer>**](ApplicationCustomer.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20014
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<CustomerActivityReport>**](CustomerActivityReport.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20015
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **has_more** | **BOOLEAN** | |
7
+ **data** | [**Array<CustomerActivityReport>**](CustomerActivityReport.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20016
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<ApplicationSession>**](ApplicationSession.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20017
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<ApplicationEvent>**](ApplicationEvent.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20018
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **has_more** | **BOOLEAN** | |
7
+ **data** | [**Array<ApplicationEvent>**](ApplicationEvent.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20019
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | **Array<String>** | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2002
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Application>**](Application.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20020
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Webhook>**](Webhook.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20021
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20022
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<WebhookLogEntry>**](WebhookLogEntry.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20023
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<EventType>**](EventType.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20024
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<User>**](User.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20025
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Change>**](Change.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20026
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Export>**](Export.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20027
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Import>**](Import.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse20028
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Role>**](Role.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2003
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Campaign>**](Campaign.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2004
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Ruleset>**](Ruleset.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2005
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **has_more** | **BOOLEAN** | |
7
+ **data** | [**Array<Coupon>**](Coupon.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2006
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<Referral>**](Referral.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2007
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **has_more** | **BOOLEAN** | |
7
+ **data** | [**Array<Referral>**](Referral.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2008
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # TalonOne::InlineResponse2009
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total_result_size** | **Integer** | |
7
+ **data** | [**Array<AccessLogEntry>**](AccessLogEntry.md) | |
8
+
9
+
@@ -0,0 +1,558 @@
1
+ # TalonOne::IntegrationApi
2
+
3
+ All URIs are relative to *https://localhost*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
8
+ [**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
9
+ [**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
10
+ [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
11
+ [**get_reserved_coupons**](IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
12
+ [**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
13
+ [**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
14
+ [**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
15
+ [**update_customer_session**](IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
16
+
17
+
18
+ # **create_coupon_reservation**
19
+ > Coupon create_coupon_reservation(coupon_value, body)
20
+
21
+ Create a new coupon reservation
22
+
23
+ Creates a coupon reservation for all passed customer profiles on this couponID
24
+
25
+ ### Example
26
+ ```ruby
27
+ # load the gem
28
+ require 'talon_one'
29
+ # setup authorization
30
+ TalonOne.configure do |config|
31
+ # Configure API key authorization: api_key_v1
32
+ config.api_key['Authorization'] = 'YOUR API KEY'
33
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
+ #config.api_key_prefix['Authorization'] = 'Bearer'
35
+
36
+ # Configure API key authorization: integration_auth
37
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
38
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
40
+ end
41
+
42
+ api_instance = TalonOne::IntegrationApi.new
43
+
44
+ coupon_value = 'coupon_value_example' # String | The value of a coupon
45
+
46
+ body = TalonOne::CouponReservations.new # CouponReservations |
47
+
48
+
49
+ begin
50
+ #Create a new coupon reservation
51
+ result = api_instance.create_coupon_reservation(coupon_value, body)
52
+ p result
53
+ rescue TalonOne::ApiError => e
54
+ puts "Exception when calling IntegrationApi->create_coupon_reservation: #{e}"
55
+ end
56
+ ```
57
+
58
+ ### Parameters
59
+
60
+ Name | Type | Description | Notes
61
+ ------------- | ------------- | ------------- | -------------
62
+ **coupon_value** | **String**| The value of a coupon |
63
+ **body** | [**CouponReservations**](CouponReservations.md)| |
64
+
65
+ ### Return type
66
+
67
+ [**Coupon**](Coupon.md)
68
+
69
+ ### Authorization
70
+
71
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: application/json
76
+ - **Accept**: application/json
77
+
78
+
79
+
80
+ # **create_referral**
81
+ > Referral create_referral(body)
82
+
83
+ Create a referral code for an advocate
84
+
85
+ Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
86
+
87
+ ### Example
88
+ ```ruby
89
+ # load the gem
90
+ require 'talon_one'
91
+ # setup authorization
92
+ TalonOne.configure do |config|
93
+ # Configure API key authorization: api_key_v1
94
+ config.api_key['Authorization'] = 'YOUR API KEY'
95
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
96
+ #config.api_key_prefix['Authorization'] = 'Bearer'
97
+
98
+ # Configure API key authorization: integration_auth
99
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = TalonOne::IntegrationApi.new
105
+
106
+ body = TalonOne::NewReferral.new # NewReferral |
107
+
108
+
109
+ begin
110
+ #Create a referral code for an advocate
111
+ result = api_instance.create_referral(body)
112
+ p result
113
+ rescue TalonOne::ApiError => e
114
+ puts "Exception when calling IntegrationApi->create_referral: #{e}"
115
+ end
116
+ ```
117
+
118
+ ### Parameters
119
+
120
+ Name | Type | Description | Notes
121
+ ------------- | ------------- | ------------- | -------------
122
+ **body** | [**NewReferral**](NewReferral.md)| |
123
+
124
+ ### Return type
125
+
126
+ [**Referral**](Referral.md)
127
+
128
+ ### Authorization
129
+
130
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
131
+
132
+ ### HTTP request headers
133
+
134
+ - **Content-Type**: application/json
135
+ - **Accept**: application/json
136
+
137
+
138
+
139
+ # **delete_coupon_reservation**
140
+ > delete_coupon_reservation(coupon_value, body)
141
+
142
+ Delete coupon reservations
143
+
144
+ Removes all passed customer profiles reservation from this coupon
145
+
146
+ ### Example
147
+ ```ruby
148
+ # load the gem
149
+ require 'talon_one'
150
+ # setup authorization
151
+ TalonOne.configure do |config|
152
+ # Configure API key authorization: api_key_v1
153
+ config.api_key['Authorization'] = 'YOUR API KEY'
154
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
155
+ #config.api_key_prefix['Authorization'] = 'Bearer'
156
+
157
+ # Configure API key authorization: integration_auth
158
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
159
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
160
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
161
+ end
162
+
163
+ api_instance = TalonOne::IntegrationApi.new
164
+
165
+ coupon_value = 'coupon_value_example' # String | The value of a coupon
166
+
167
+ body = TalonOne::CouponReservations.new # CouponReservations |
168
+
169
+
170
+ begin
171
+ #Delete coupon reservations
172
+ api_instance.delete_coupon_reservation(coupon_value, body)
173
+ rescue TalonOne::ApiError => e
174
+ puts "Exception when calling IntegrationApi->delete_coupon_reservation: #{e}"
175
+ end
176
+ ```
177
+
178
+ ### Parameters
179
+
180
+ Name | Type | Description | Notes
181
+ ------------- | ------------- | ------------- | -------------
182
+ **coupon_value** | **String**| The value of a coupon |
183
+ **body** | [**CouponReservations**](CouponReservations.md)| |
184
+
185
+ ### Return type
186
+
187
+ nil (empty response body)
188
+
189
+ ### Authorization
190
+
191
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
192
+
193
+ ### HTTP request headers
194
+
195
+ - **Content-Type**: application/json
196
+ - **Accept**: application/json
197
+
198
+
199
+
200
+ # **delete_customer_data**
201
+ > delete_customer_data(integration_id)
202
+
203
+ Delete the personal data of a customer.
204
+
205
+ Delete all attributes on the customer profile and on entities that reference that customer profile.
206
+
207
+ ### Example
208
+ ```ruby
209
+ # load the gem
210
+ require 'talon_one'
211
+ # setup authorization
212
+ TalonOne.configure do |config|
213
+ # Configure API key authorization: api_key_v1
214
+ config.api_key['Authorization'] = 'YOUR API KEY'
215
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
216
+ #config.api_key_prefix['Authorization'] = 'Bearer'
217
+
218
+ # Configure API key authorization: integration_auth
219
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
220
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
221
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
222
+ end
223
+
224
+ api_instance = TalonOne::IntegrationApi.new
225
+
226
+ integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
227
+
228
+
229
+ begin
230
+ #Delete the personal data of a customer.
231
+ api_instance.delete_customer_data(integration_id)
232
+ rescue TalonOne::ApiError => e
233
+ puts "Exception when calling IntegrationApi->delete_customer_data: #{e}"
234
+ end
235
+ ```
236
+
237
+ ### Parameters
238
+
239
+ Name | Type | Description | Notes
240
+ ------------- | ------------- | ------------- | -------------
241
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
242
+
243
+ ### Return type
244
+
245
+ nil (empty response body)
246
+
247
+ ### Authorization
248
+
249
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
250
+
251
+ ### HTTP request headers
252
+
253
+ - **Content-Type**: application/json
254
+ - **Accept**: application/json
255
+
256
+
257
+
258
+ # **get_reserved_coupons**
259
+ > InlineResponse2001 get_reserved_coupons(integration_id)
260
+
261
+ Get all valid reserved coupons
262
+
263
+ Returns all coupons this user is subscribed to that are valid and usable
264
+
265
+ ### Example
266
+ ```ruby
267
+ # load the gem
268
+ require 'talon_one'
269
+ # setup authorization
270
+ TalonOne.configure do |config|
271
+ # Configure API key authorization: api_key_v1
272
+ config.api_key['Authorization'] = 'YOUR API KEY'
273
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
274
+ #config.api_key_prefix['Authorization'] = 'Bearer'
275
+
276
+ # Configure API key authorization: integration_auth
277
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
278
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
279
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
280
+ end
281
+
282
+ api_instance = TalonOne::IntegrationApi.new
283
+
284
+ integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
285
+
286
+
287
+ begin
288
+ #Get all valid reserved coupons
289
+ result = api_instance.get_reserved_coupons(integration_id)
290
+ p result
291
+ rescue TalonOne::ApiError => e
292
+ puts "Exception when calling IntegrationApi->get_reserved_coupons: #{e}"
293
+ end
294
+ ```
295
+
296
+ ### Parameters
297
+
298
+ Name | Type | Description | Notes
299
+ ------------- | ------------- | ------------- | -------------
300
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
301
+
302
+ ### Return type
303
+
304
+ [**InlineResponse2001**](InlineResponse2001.md)
305
+
306
+ ### Authorization
307
+
308
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: application/json
313
+ - **Accept**: application/json
314
+
315
+
316
+
317
+ # **get_reserved_customers**
318
+ > InlineResponse200 get_reserved_customers(coupon_value)
319
+
320
+ Get the users that have this coupon reserved
321
+
322
+ Returns all users that have this coupon marked as reserved
323
+
324
+ ### Example
325
+ ```ruby
326
+ # load the gem
327
+ require 'talon_one'
328
+ # setup authorization
329
+ TalonOne.configure do |config|
330
+ # Configure API key authorization: api_key_v1
331
+ config.api_key['Authorization'] = 'YOUR API KEY'
332
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
333
+ #config.api_key_prefix['Authorization'] = 'Bearer'
334
+
335
+ # Configure API key authorization: integration_auth
336
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
337
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
338
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
339
+ end
340
+
341
+ api_instance = TalonOne::IntegrationApi.new
342
+
343
+ coupon_value = 'coupon_value_example' # String | The value of a coupon
344
+
345
+
346
+ begin
347
+ #Get the users that have this coupon reserved
348
+ result = api_instance.get_reserved_customers(coupon_value)
349
+ p result
350
+ rescue TalonOne::ApiError => e
351
+ puts "Exception when calling IntegrationApi->get_reserved_customers: #{e}"
352
+ end
353
+ ```
354
+
355
+ ### Parameters
356
+
357
+ Name | Type | Description | Notes
358
+ ------------- | ------------- | ------------- | -------------
359
+ **coupon_value** | **String**| The value of a coupon |
360
+
361
+ ### Return type
362
+
363
+ [**InlineResponse200**](InlineResponse200.md)
364
+
365
+ ### Authorization
366
+
367
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
368
+
369
+ ### HTTP request headers
370
+
371
+ - **Content-Type**: application/json
372
+ - **Accept**: application/json
373
+
374
+
375
+
376
+ # **track_event**
377
+ > IntegrationState track_event(body)
378
+
379
+ Track an Event
380
+
381
+ Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
382
+
383
+ ### Example
384
+ ```ruby
385
+ # load the gem
386
+ require 'talon_one'
387
+ # setup authorization
388
+ TalonOne.configure do |config|
389
+ # Configure API key authorization: api_key_v1
390
+ config.api_key['Authorization'] = 'YOUR API KEY'
391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
392
+ #config.api_key_prefix['Authorization'] = 'Bearer'
393
+
394
+ # Configure API key authorization: integration_auth
395
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
396
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
397
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
398
+ end
399
+
400
+ api_instance = TalonOne::IntegrationApi.new
401
+
402
+ body = TalonOne::NewEvent.new # NewEvent |
403
+
404
+
405
+ begin
406
+ #Track an Event
407
+ result = api_instance.track_event(body)
408
+ p result
409
+ rescue TalonOne::ApiError => e
410
+ puts "Exception when calling IntegrationApi->track_event: #{e}"
411
+ end
412
+ ```
413
+
414
+ ### Parameters
415
+
416
+ Name | Type | Description | Notes
417
+ ------------- | ------------- | ------------- | -------------
418
+ **body** | [**NewEvent**](NewEvent.md)| |
419
+
420
+ ### Return type
421
+
422
+ [**IntegrationState**](IntegrationState.md)
423
+
424
+ ### Authorization
425
+
426
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
427
+
428
+ ### HTTP request headers
429
+
430
+ - **Content-Type**: application/json
431
+ - **Accept**: application/json
432
+
433
+
434
+
435
+ # **update_customer_profile**
436
+ > IntegrationState update_customer_profile(integration_id, body)
437
+
438
+ Update a Customer Profile
439
+
440
+ Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
441
+
442
+ ### Example
443
+ ```ruby
444
+ # load the gem
445
+ require 'talon_one'
446
+ # setup authorization
447
+ TalonOne.configure do |config|
448
+ # Configure API key authorization: api_key_v1
449
+ config.api_key['Authorization'] = 'YOUR API KEY'
450
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
451
+ #config.api_key_prefix['Authorization'] = 'Bearer'
452
+
453
+ # Configure API key authorization: integration_auth
454
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
455
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
456
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
457
+ end
458
+
459
+ api_instance = TalonOne::IntegrationApi.new
460
+
461
+ integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
462
+
463
+ body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
464
+
465
+
466
+ begin
467
+ #Update a Customer Profile
468
+ result = api_instance.update_customer_profile(integration_id, body)
469
+ p result
470
+ rescue TalonOne::ApiError => e
471
+ puts "Exception when calling IntegrationApi->update_customer_profile: #{e}"
472
+ end
473
+ ```
474
+
475
+ ### Parameters
476
+
477
+ Name | Type | Description | Notes
478
+ ------------- | ------------- | ------------- | -------------
479
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
480
+ **body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
481
+
482
+ ### Return type
483
+
484
+ [**IntegrationState**](IntegrationState.md)
485
+
486
+ ### Authorization
487
+
488
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
489
+
490
+ ### HTTP request headers
491
+
492
+ - **Content-Type**: application/json
493
+ - **Accept**: application/json
494
+
495
+
496
+
497
+ # **update_customer_session**
498
+ > IntegrationState update_customer_session(customer_session_id, body)
499
+
500
+ Update a Customer Session
501
+
502
+ Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
503
+
504
+ ### Example
505
+ ```ruby
506
+ # load the gem
507
+ require 'talon_one'
508
+ # setup authorization
509
+ TalonOne.configure do |config|
510
+ # Configure API key authorization: api_key_v1
511
+ config.api_key['Authorization'] = 'YOUR API KEY'
512
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
513
+ #config.api_key_prefix['Authorization'] = 'Bearer'
514
+
515
+ # Configure API key authorization: integration_auth
516
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
517
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
518
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
519
+ end
520
+
521
+ api_instance = TalonOne::IntegrationApi.new
522
+
523
+ customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
524
+
525
+ body = TalonOne::NewCustomerSession.new # NewCustomerSession |
526
+
527
+
528
+ begin
529
+ #Update a Customer Session
530
+ result = api_instance.update_customer_session(customer_session_id, body)
531
+ p result
532
+ rescue TalonOne::ApiError => e
533
+ puts "Exception when calling IntegrationApi->update_customer_session: #{e}"
534
+ end
535
+ ```
536
+
537
+ ### Parameters
538
+
539
+ Name | Type | Description | Notes
540
+ ------------- | ------------- | ------------- | -------------
541
+ **customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
542
+ **body** | [**NewCustomerSession**](NewCustomerSession.md)| |
543
+
544
+ ### Return type
545
+
546
+ [**IntegrationState**](IntegrationState.md)
547
+
548
+ ### Authorization
549
+
550
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
551
+
552
+ ### HTTP request headers
553
+
554
+ - **Content-Type**: application/json
555
+ - **Accept**: application/json
556
+
557
+
558
+