talon_one_sdk 26.01

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 (1911) hide show
  1. checksums.yaml +7 -0
  2. data/.github/.example/Gemfile +6 -0
  3. data/.github/.example/Gemfile.lock +47 -0
  4. data/.github/.example/example.rb +85 -0
  5. data/.github/workflows/autorelease.yml +135 -0
  6. data/.github/workflows/test.yml +75 -0
  7. data/.gitlab-ci.yml +26 -0
  8. data/.rspec +2 -0
  9. data/Gemfile +9 -0
  10. data/README.md +1038 -0
  11. data/Rakefile +10 -0
  12. data/docker-compose.yml +47 -0
  13. data/docs/APIError.md +22 -0
  14. data/docs/AcceptCouponEffectProps.md +18 -0
  15. data/docs/AcceptReferralEffectProps.md +18 -0
  16. data/docs/AccessLogEntry.md +35 -0
  17. data/docs/Account.md +52 -0
  18. data/docs/AccountAdditionalCost.md +32 -0
  19. data/docs/AccountAnalytics.md +56 -0
  20. data/docs/AccountDashboardStatistic.md +26 -0
  21. data/docs/AccountDashboardStatisticCampaigns.md +22 -0
  22. data/docs/AccountDashboardStatisticDiscount.md +22 -0
  23. data/docs/AccountDashboardStatisticLoyaltyPoints.md +20 -0
  24. data/docs/AccountDashboardStatisticReferrals.md +20 -0
  25. data/docs/AccountDashboardStatisticRevenue.md +22 -0
  26. data/docs/AccountEntity.md +18 -0
  27. data/docs/AccountLimits.md +44 -0
  28. data/docs/Achievement.md +52 -0
  29. data/docs/AchievementAdditionalProperties.md +26 -0
  30. data/docs/AchievementBase.md +38 -0
  31. data/docs/AchievementProgress.md +26 -0
  32. data/docs/AchievementProgressWithDefinition.md +48 -0
  33. data/docs/AchievementStatusEntry.md +48 -0
  34. data/docs/ActivateLoyaltyPoints.md +20 -0
  35. data/docs/ActivateLoyaltyPointsResponse.md +18 -0
  36. data/docs/ActivateUserRequest.md +18 -0
  37. data/docs/AddFreeItemEffectProps.md +22 -0
  38. data/docs/AddItemCatalogAction.md +26 -0
  39. data/docs/AddLoyaltyPoints.md +32 -0
  40. data/docs/AddLoyaltyPointsEffectProps.md +48 -0
  41. data/docs/AddPriceAdjustmentCatalogAction.md +20 -0
  42. data/docs/AddToAudienceEffectProps.md +24 -0
  43. data/docs/AddedDeductedPointsBalancesAction.md +26 -0
  44. data/docs/AddedDeductedPointsBalancesNotification.md +36 -0
  45. data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +20 -0
  46. data/docs/AddedDeductedPointsNotification.md +42 -0
  47. data/docs/AddedDeductedPointsNotificationPolicy.md +20 -0
  48. data/docs/AdditionalCampaignProperties.md +64 -0
  49. data/docs/AdditionalCost.md +18 -0
  50. data/docs/AnalyticsDataPoint.md +20 -0
  51. data/docs/AnalyticsDataPointWithTrend.md +20 -0
  52. data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +22 -0
  53. data/docs/AnalyticsDataPointWithTrendAndUplift.md +22 -0
  54. data/docs/AnalyticsProduct.md +24 -0
  55. data/docs/AnalyticsSKU.md +28 -0
  56. data/docs/Application.md +60 -0
  57. data/docs/ApplicationAPIKey.md +36 -0
  58. data/docs/ApplicationAnalyticsDataPoint.md +32 -0
  59. data/docs/ApplicationApiHealth.md +20 -0
  60. data/docs/ApplicationCIF.md +34 -0
  61. data/docs/ApplicationCIFExpression.md +28 -0
  62. data/docs/ApplicationCIFReferences.md +20 -0
  63. data/docs/ApplicationCampaignAnalytics.md +40 -0
  64. data/docs/ApplicationCampaignStats.md +28 -0
  65. data/docs/ApplicationCustomer.md +40 -0
  66. data/docs/ApplicationCustomerEntity.md +18 -0
  67. data/docs/ApplicationEntity.md +18 -0
  68. data/docs/ApplicationEvent.md +38 -0
  69. data/docs/ApplicationNotification.md +18 -0
  70. data/docs/ApplicationReferee.md +28 -0
  71. data/docs/ApplicationSession.md +46 -0
  72. data/docs/ApplicationSessionEntity.md +18 -0
  73. data/docs/ApplicationStoreEntity.md +18 -0
  74. data/docs/AsyncCouponCreationResponse.md +18 -0
  75. data/docs/AsyncCouponDeletionJobResponse.md +18 -0
  76. data/docs/AsyncCouponsData.md +26 -0
  77. data/docs/Attribute.md +50 -0
  78. data/docs/AttributesMandatory.md +20 -0
  79. data/docs/AttributesSettings.md +18 -0
  80. data/docs/Audience.md +36 -0
  81. data/docs/AudienceAnalytics.md +20 -0
  82. data/docs/AudienceCustomer.md +42 -0
  83. data/docs/AudienceIntegrationID.md +18 -0
  84. data/docs/AudienceMembership.md +20 -0
  85. data/docs/AudienceReference.md +22 -0
  86. data/docs/AwardGiveawayEffectProps.md +26 -0
  87. data/docs/BaseCampaign.md +46 -0
  88. data/docs/BaseLoyaltyProgram.md +46 -0
  89. data/docs/BaseNotification.md +26 -0
  90. data/docs/BaseNotificationEntity.md +20 -0
  91. data/docs/BaseNotificationWebhook.md +28 -0
  92. data/docs/BaseNotifications.md +18 -0
  93. data/docs/BaseSamlConnection.md +32 -0
  94. data/docs/BestPriorPrice.md +28 -0
  95. data/docs/BestPriorPriceMetadata.md +20 -0
  96. data/docs/BestPriorPriceRequest.md +26 -0
  97. data/docs/BestPriorPriceRequestTarget.md +20 -0
  98. data/docs/Binding.md +32 -0
  99. data/docs/BulkApplicationNotification.md +20 -0
  100. data/docs/BulkOperationOnCampaigns.md +22 -0
  101. data/docs/Campaign.md +116 -0
  102. data/docs/CampaignActivationRequest.md +18 -0
  103. data/docs/CampaignAnalytics.md +66 -0
  104. data/docs/CampaignBudget.md +22 -0
  105. data/docs/CampaignCollection.md +38 -0
  106. data/docs/CampaignCollectionEditedNotification.md +22 -0
  107. data/docs/CampaignCollectionEditedNotificationItem.md +24 -0
  108. data/docs/CampaignCollectionWithoutPayload.md +36 -0
  109. data/docs/CampaignCopy.md +30 -0
  110. data/docs/CampaignCreatedNotification.md +22 -0
  111. data/docs/CampaignCreatedNotificationItem.md +24 -0
  112. data/docs/CampaignDeactivationRequest.md +18 -0
  113. data/docs/CampaignDeletedNotification.md +22 -0
  114. data/docs/CampaignDeletedNotificationItem.md +22 -0
  115. data/docs/CampaignDetail.md +20 -0
  116. data/docs/CampaignEditedNotification.md +22 -0
  117. data/docs/CampaignEditedNotificationItem.md +24 -0
  118. data/docs/CampaignEntity.md +18 -0
  119. data/docs/CampaignEvaluationGroup.md +32 -0
  120. data/docs/CampaignEvaluationPosition.md +22 -0
  121. data/docs/CampaignEvaluationTreeChangedMessage.md +22 -0
  122. data/docs/CampaignEvaluationTreeChangedNotification.md +22 -0
  123. data/docs/CampaignGroup.md +32 -0
  124. data/docs/CampaignGroupEntity.md +18 -0
  125. data/docs/CampaignLogSummary.md +26 -0
  126. data/docs/CampaignNotificationBase.md +20 -0
  127. data/docs/CampaignNotificationGeneric.md +22 -0
  128. data/docs/CampaignNotificationItemBase.md +18 -0
  129. data/docs/CampaignNotificationPolicy.md +22 -0
  130. data/docs/CampaignRulesetChangedNotification.md +22 -0
  131. data/docs/CampaignRulesetChangedNotificationItem.md +24 -0
  132. data/docs/CampaignSearch.md +18 -0
  133. data/docs/CampaignSet.md +26 -0
  134. data/docs/CampaignSetBranchNode.md +34 -0
  135. data/docs/CampaignSetLeafNode.md +20 -0
  136. data/docs/CampaignSetNode.md +18 -0
  137. data/docs/CampaignStateChangedNotification.md +22 -0
  138. data/docs/CampaignStateChangedNotificationItem.md +26 -0
  139. data/docs/CampaignStoreBudget.md +26 -0
  140. data/docs/CampaignStoreBudgetLimitConfig.md +26 -0
  141. data/docs/CampaignTemplate.md +70 -0
  142. data/docs/CampaignTemplateCollection.md +20 -0
  143. data/docs/CampaignTemplateCouponReservationSettings.md +20 -0
  144. data/docs/CampaignTemplateParams.md +24 -0
  145. data/docs/CampaignVersions.md +30 -0
  146. data/docs/CardAddedDeductedPointsBalancesNotification.md +40 -0
  147. data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +20 -0
  148. data/docs/CardAddedDeductedPointsNotification.md +46 -0
  149. data/docs/CardAddedDeductedPointsNotificationPolicy.md +20 -0
  150. data/docs/CardExpiringPointsNotificationPolicy.md +24 -0
  151. data/docs/CardExpiringPointsNotificationTrigger.md +20 -0
  152. data/docs/CardLedgerPointsEntryIntegrationAPI.md +38 -0
  153. data/docs/CardLedgerTransactionLogEntry.md +44 -0
  154. data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +44 -0
  155. data/docs/CartItem.md +58 -0
  156. data/docs/Catalog.md +34 -0
  157. data/docs/CatalogActionFilter.md +22 -0
  158. data/docs/CatalogItem.md +32 -0
  159. data/docs/CatalogSyncRequest.md +20 -0
  160. data/docs/CatalogsStrikethroughNotificationPolicy.md +22 -0
  161. data/docs/Change.md +32 -0
  162. data/docs/ChangeLoyaltyTierLevelEffectProps.md +28 -0
  163. data/docs/ChangeProfilePassword.md +20 -0
  164. data/docs/CodeGeneratorSettings.md +20 -0
  165. data/docs/Collection.md +40 -0
  166. data/docs/CollectionItem.md +18 -0
  167. data/docs/CollectionWithoutPayload.md +38 -0
  168. data/docs/Coupon.md +60 -0
  169. data/docs/CouponConstraints.md +26 -0
  170. data/docs/CouponCreatedEffectProps.md +20 -0
  171. data/docs/CouponCreationJob.md +60 -0
  172. data/docs/CouponDeletionFilters.md +44 -0
  173. data/docs/CouponDeletionJob.md +40 -0
  174. data/docs/CouponEntity.md +20 -0
  175. data/docs/CouponFailureSummary.md +38 -0
  176. data/docs/CouponLimitConfigs.md +18 -0
  177. data/docs/CouponRejectionReason.md +22 -0
  178. data/docs/CouponRejections.md +22 -0
  179. data/docs/CouponReservations.md +18 -0
  180. data/docs/CouponSearch.md +18 -0
  181. data/docs/CouponValue.md +18 -0
  182. data/docs/CouponsNotificationData.md +28 -0
  183. data/docs/CouponsNotificationPolicy.md +26 -0
  184. data/docs/CreateAchievement.md +38 -0
  185. data/docs/CreateApplicationAPIKey.md +26 -0
  186. data/docs/CreateCouponData.md +30 -0
  187. data/docs/CreateCoupons200Response.md +20 -0
  188. data/docs/CreateManagementKey.md +24 -0
  189. data/docs/CreateReferralsForMultipleAdvocates201Response.md +20 -0
  190. data/docs/CreateTemplateCampaign.md +36 -0
  191. data/docs/CreateTemplateCampaignResponse.md +22 -0
  192. data/docs/CustomEffect.md +44 -0
  193. data/docs/CustomEffectProps.md +30 -0
  194. data/docs/CustomerActivityReport.md +42 -0
  195. data/docs/CustomerAnalytics.md +30 -0
  196. data/docs/CustomerInventory.md +28 -0
  197. data/docs/CustomerProfile.md +38 -0
  198. data/docs/CustomerProfileAudienceRequest.md +18 -0
  199. data/docs/CustomerProfileAudienceRequestItem.md +22 -0
  200. data/docs/CustomerProfileEntity.md +20 -0
  201. data/docs/CustomerProfileIntegrationRequestV2.md +24 -0
  202. data/docs/CustomerProfileIntegrationResponseV2.md +34 -0
  203. data/docs/CustomerProfileSearchQuery.md +22 -0
  204. data/docs/CustomerProfileUpdateV2Response.md +18 -0
  205. data/docs/CustomerSession.md +46 -0
  206. data/docs/CustomerSessionV2.md +58 -0
  207. data/docs/DeactivateUserRequest.md +18 -0
  208. data/docs/DeductLoyaltyPoints.md +24 -0
  209. data/docs/DeductLoyaltyPointsEffectProps.md +30 -0
  210. data/docs/DeleteCouponsData.md +32 -0
  211. data/docs/DeleteUserRequest.md +18 -0
  212. data/docs/Effect.md +48 -0
  213. data/docs/EffectEntity.md +46 -0
  214. data/docs/EmailEntity.md +18 -0
  215. data/docs/Endpoint.md +18 -0
  216. data/docs/Entity.md +20 -0
  217. data/docs/EntityWithTalangVisibleID.md +20 -0
  218. data/docs/Environment.md +48 -0
  219. data/docs/ErrorEffectProps.md +18 -0
  220. data/docs/ErrorResponse.md +20 -0
  221. data/docs/ErrorResponseWithStatus.md +22 -0
  222. data/docs/ErrorSource.md +24 -0
  223. data/docs/EvaluableCampaignIds.md +18 -0
  224. data/docs/Event.md +38 -0
  225. data/docs/EventType.md +26 -0
  226. data/docs/EventV2.md +26 -0
  227. data/docs/EventV3.md +32 -0
  228. data/docs/ExpiringCardPointsData.md +30 -0
  229. data/docs/ExpiringCardPointsNotification.md +22 -0
  230. data/docs/ExpiringCouponsData.md +36 -0
  231. data/docs/ExpiringCouponsNotification.md +22 -0
  232. data/docs/ExpiringCouponsNotificationPolicy.md +24 -0
  233. data/docs/ExpiringCouponsNotificationTrigger.md +20 -0
  234. data/docs/ExpiringPointsData.md +26 -0
  235. data/docs/ExpiringPointsNotification.md +22 -0
  236. data/docs/ExpiringPointsNotificationPolicy.md +24 -0
  237. data/docs/ExpiringPointsNotificationTrigger.md +20 -0
  238. data/docs/Export.md +28 -0
  239. data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +24 -0
  240. data/docs/ExtendedCoupon.md +62 -0
  241. data/docs/FeatureFlag.md +24 -0
  242. data/docs/FeaturesFeed.md +20 -0
  243. data/docs/FuncArgDef.md +20 -0
  244. data/docs/FunctionDef.md +26 -0
  245. data/docs/GenerateAuditLogSummary.md +18 -0
  246. data/docs/GenerateCampaignDescription.md +22 -0
  247. data/docs/GenerateCampaignSummary.md +22 -0
  248. data/docs/GenerateCampaignTags.md +18 -0
  249. data/docs/GenerateCouponFailureDetailedSummary.md +26 -0
  250. data/docs/GenerateCouponFailureSummary.md +20 -0
  251. data/docs/GenerateItemFilterDescription.md +18 -0
  252. data/docs/GenerateLoyaltyCard.md +22 -0
  253. data/docs/GenerateRuleTitle.md +20 -0
  254. data/docs/GenerateRuleTitleRule.md +20 -0
  255. data/docs/GenerateUserSessionSummary.md +20 -0
  256. data/docs/GetAccessLogsWithoutTotalCount200Response.md +20 -0
  257. data/docs/GetAdditionalCosts200Response.md +20 -0
  258. data/docs/GetApplicationCustomerFriends200Response.md +22 -0
  259. data/docs/GetApplicationCustomers200Response.md +22 -0
  260. data/docs/GetApplicationCustomersByAttributes200Response.md +22 -0
  261. data/docs/GetApplicationEventTypes200Response.md +20 -0
  262. data/docs/GetApplicationEventsWithoutTotalCount200Response.md +20 -0
  263. data/docs/GetApplicationSessions200Response.md +20 -0
  264. data/docs/GetApplications200Response.md +20 -0
  265. data/docs/GetAttributes200Response.md +20 -0
  266. data/docs/GetAudienceMemberships200Response.md +20 -0
  267. data/docs/GetAudiences200Response.md +22 -0
  268. data/docs/GetAudiencesAnalytics200Response.md +20 -0
  269. data/docs/GetCampaignAnalytics200Response.md +20 -0
  270. data/docs/GetCampaignGroups200Response.md +20 -0
  271. data/docs/GetCampaignTemplates200Response.md +20 -0
  272. data/docs/GetCampaigns200Response.md +20 -0
  273. data/docs/GetChanges200Response.md +22 -0
  274. data/docs/GetCollectionItems200Response.md +20 -0
  275. data/docs/GetCouponsWithoutTotalCount200Response.md +20 -0
  276. data/docs/GetCustomerAchievementHistory200Response.md +20 -0
  277. data/docs/GetCustomerAchievements200Response.md +20 -0
  278. data/docs/GetCustomerActivityReportsWithoutTotalCount200Response.md +20 -0
  279. data/docs/GetCustomerProfileAchievementProgress200Response.md +20 -0
  280. data/docs/GetCustomerProfiles200Response.md +20 -0
  281. data/docs/GetCustomersByAttributes200Response.md +22 -0
  282. data/docs/GetDashboardStatistics200Response.md +20 -0
  283. data/docs/GetEventTypes200Response.md +20 -0
  284. data/docs/GetExports200Response.md +20 -0
  285. data/docs/GetIntegrationCouponRequest.md +20 -0
  286. data/docs/GetLoyaltyCardPoints200Response.md +20 -0
  287. data/docs/GetLoyaltyCardTransactionLogs200Response.md +20 -0
  288. data/docs/GetLoyaltyCardTransactions200Response.md +20 -0
  289. data/docs/GetLoyaltyCards200Response.md +20 -0
  290. data/docs/GetLoyaltyProgramProfilePoints200Response.md +20 -0
  291. data/docs/GetLoyaltyProgramProfileTransactions200Response.md +20 -0
  292. data/docs/GetLoyaltyProgramTransactions200Response.md +20 -0
  293. data/docs/GetLoyaltyPrograms200Response.md +20 -0
  294. data/docs/GetReferralsWithoutTotalCount200Response.md +20 -0
  295. data/docs/GetReservedCustomers200Response.md +20 -0
  296. data/docs/GetRulesets200Response.md +20 -0
  297. data/docs/GetUsers200Response.md +20 -0
  298. data/docs/GetWebhooks200Response.md +20 -0
  299. data/docs/Giveaway.md +38 -0
  300. data/docs/GiveawaysPool.md +36 -0
  301. data/docs/HiddenConditionsEffects.md +24 -0
  302. data/docs/IdentifiableEntity.md +18 -0
  303. data/docs/Import.md +28 -0
  304. data/docs/ImportEntity.md +18 -0
  305. data/docs/IncreaseAchievementProgressEffectProps.md +30 -0
  306. data/docs/IntegrationApi.md +2507 -0
  307. data/docs/IntegrationCoupon.md +62 -0
  308. data/docs/IntegrationCustomerProfileAudienceRequest.md +18 -0
  309. data/docs/IntegrationCustomerProfileAudienceRequestItem.md +22 -0
  310. data/docs/IntegrationCustomerSessionResponse.md +20 -0
  311. data/docs/IntegrationEntity.md +20 -0
  312. data/docs/IntegrationEvent.md +24 -0
  313. data/docs/IntegrationEventV2Request.md +30 -0
  314. data/docs/IntegrationEventV3Request.md +36 -0
  315. data/docs/IntegrationEventV3Response.md +34 -0
  316. data/docs/IntegrationProfileEntity.md +18 -0
  317. data/docs/IntegrationProfileEntityV3.md +18 -0
  318. data/docs/IntegrationRequest.md +20 -0
  319. data/docs/IntegrationState.md +26 -0
  320. data/docs/IntegrationStateV2.md +44 -0
  321. data/docs/IntegrationStoreEntity.md +18 -0
  322. data/docs/InventoryCoupon.md +64 -0
  323. data/docs/InventoryReferral.md +44 -0
  324. data/docs/ItemAttribute.md +22 -0
  325. data/docs/LabelTargetAudience.md +20 -0
  326. data/docs/LabelTargetNone.md +18 -0
  327. data/docs/LedgerEntry.md +36 -0
  328. data/docs/LedgerInfo.md +36 -0
  329. data/docs/LedgerPointsEntryIntegrationAPI.md +36 -0
  330. data/docs/LedgerTransactionLogEntryIntegrationAPI.md +44 -0
  331. data/docs/LibraryAttribute.md +30 -0
  332. data/docs/LimitConfig.md +24 -0
  333. data/docs/LimitCounter.md +46 -0
  334. data/docs/ListAccountCollections200Response.md +22 -0
  335. data/docs/ListAchievements200Response.md +20 -0
  336. data/docs/ListAllRolesV2200Response.md +20 -0
  337. data/docs/ListCampaignStoreBudgetLimits200Response.md +18 -0
  338. data/docs/ListCampaignStoreBudgets.md +24 -0
  339. data/docs/ListCampaignStoreBudgetsStore.md +22 -0
  340. data/docs/ListCatalogItems200Response.md +22 -0
  341. data/docs/ListStores200Response.md +22 -0
  342. data/docs/LoginParams.md +20 -0
  343. data/docs/Loyalty.md +20 -0
  344. data/docs/LoyaltyBalance.md +26 -0
  345. data/docs/LoyaltyBalanceWithTier.md +34 -0
  346. data/docs/LoyaltyBalances.md +20 -0
  347. data/docs/LoyaltyBalancesWithTiers.md +20 -0
  348. data/docs/LoyaltyCard.md +48 -0
  349. data/docs/LoyaltyCardBalances.md +22 -0
  350. data/docs/LoyaltyCardBatch.md +24 -0
  351. data/docs/LoyaltyCardBatchResponse.md +20 -0
  352. data/docs/LoyaltyCardProfileRegistration.md +20 -0
  353. data/docs/LoyaltyCardRegistration.md +18 -0
  354. data/docs/LoyaltyDashboardData.md +36 -0
  355. data/docs/LoyaltyDashboardPointsBreakdown.md +20 -0
  356. data/docs/LoyaltyLedger.md +20 -0
  357. data/docs/LoyaltyLedgerEntry.md +46 -0
  358. data/docs/LoyaltyLedgerEntryExpiryDateChange.md +22 -0
  359. data/docs/LoyaltyLedgerEntryFlags.md +18 -0
  360. data/docs/LoyaltyLedgerTransactions.md +20 -0
  361. data/docs/LoyaltyMembership.md +20 -0
  362. data/docs/LoyaltyProgram.md +68 -0
  363. data/docs/LoyaltyProgramBalance.md +32 -0
  364. data/docs/LoyaltyProgramEntity.md +22 -0
  365. data/docs/LoyaltyProgramLedgers.md +28 -0
  366. data/docs/LoyaltyProgramTransaction.md +56 -0
  367. data/docs/LoyaltySubLedger.md +40 -0
  368. data/docs/LoyaltyTier.md +30 -0
  369. data/docs/ManagementApi.md +15237 -0
  370. data/docs/ManagementKey.md +36 -0
  371. data/docs/ManagerConfig.md +18 -0
  372. data/docs/MessageLogEntries.md +20 -0
  373. data/docs/MessageLogEntry.md +46 -0
  374. data/docs/MessageLogRequest.md +20 -0
  375. data/docs/MessageLogResponse.md +22 -0
  376. data/docs/MessageTest.md +28 -0
  377. data/docs/Meta.md +26 -0
  378. data/docs/ModelReturn.md +38 -0
  379. data/docs/MultiApplicationEntity.md +18 -0
  380. data/docs/MultipleAttribute.md +18 -0
  381. data/docs/MultipleAudiences.md +20 -0
  382. data/docs/MultipleAudiencesItem.md +26 -0
  383. data/docs/MultipleCustomerProfileIntegrationRequest.md +18 -0
  384. data/docs/MultipleCustomerProfileIntegrationRequestItem.md +20 -0
  385. data/docs/MultipleCustomerProfileIntegrationResponseV2.md +18 -0
  386. data/docs/MultipleNewAttribute.md +18 -0
  387. data/docs/MultipleNewAudiences.md +18 -0
  388. data/docs/MutableEntity.md +18 -0
  389. data/docs/NewAccount.md +18 -0
  390. data/docs/NewAccountSignUp.md +22 -0
  391. data/docs/NewAdditionalCost.md +26 -0
  392. data/docs/NewAppWideCouponDeletionJob.md +20 -0
  393. data/docs/NewApplication.md +48 -0
  394. data/docs/NewApplicationAPIKey.md +38 -0
  395. data/docs/NewApplicationCIF.md +28 -0
  396. data/docs/NewApplicationCIFExpression.md +22 -0
  397. data/docs/NewAttribute.md +42 -0
  398. data/docs/NewAudience.md +30 -0
  399. data/docs/NewBaseNotification.md +22 -0
  400. data/docs/NewCampaign.md +48 -0
  401. data/docs/NewCampaignCollection.md +20 -0
  402. data/docs/NewCampaignEvaluationGroup.md +28 -0
  403. data/docs/NewCampaignGroup.md +24 -0
  404. data/docs/NewCampaignSet.md +22 -0
  405. data/docs/NewCampaignStoreBudget.md +22 -0
  406. data/docs/NewCampaignStoreBudgetStoreLimit.md +20 -0
  407. data/docs/NewCampaignTemplate.md +48 -0
  408. data/docs/NewCatalog.md +22 -0
  409. data/docs/NewCollection.md +22 -0
  410. data/docs/NewCouponCreationJob.md +32 -0
  411. data/docs/NewCouponDeletionJob.md +18 -0
  412. data/docs/NewCoupons.md +44 -0
  413. data/docs/NewCouponsForMultipleRecipients.md +34 -0
  414. data/docs/NewCustomEffect.md +32 -0
  415. data/docs/NewCustomerProfile.md +18 -0
  416. data/docs/NewCustomerSession.md +32 -0
  417. data/docs/NewCustomerSessionV2.md +38 -0
  418. data/docs/NewEvent.md +26 -0
  419. data/docs/NewEventType.md +22 -0
  420. data/docs/NewExternalInvitation.md +22 -0
  421. data/docs/NewGiveawaysPool.md +24 -0
  422. data/docs/NewInternalAudience.md +22 -0
  423. data/docs/NewInvitation.md +26 -0
  424. data/docs/NewInviteEmail.md +20 -0
  425. data/docs/NewLoyaltyProgram.md +54 -0
  426. data/docs/NewLoyaltyTier.md +20 -0
  427. data/docs/NewManagementKey.md +38 -0
  428. data/docs/NewMessageTest.md +32 -0
  429. data/docs/NewMultipleAudiencesItem.md +20 -0
  430. data/docs/NewNotificationWebhook.md +22 -0
  431. data/docs/NewOutgoingIntegrationWebhook.md +22 -0
  432. data/docs/NewPassword.md +20 -0
  433. data/docs/NewPasswordEmail.md +18 -0
  434. data/docs/NewPicklist.md +20 -0
  435. data/docs/NewPriceAdjustment.md +30 -0
  436. data/docs/NewPriceType.md +24 -0
  437. data/docs/NewReferral.md +30 -0
  438. data/docs/NewReferralsForMultipleAdvocates.md +32 -0
  439. data/docs/NewReturn.md +18 -0
  440. data/docs/NewRevisionVersion.md +38 -0
  441. data/docs/NewRole.md +24 -0
  442. data/docs/NewRoleV2.md +24 -0
  443. data/docs/NewRuleset.md +26 -0
  444. data/docs/NewSamlConnection.md +34 -0
  445. data/docs/NewSecondaryDeployment.md +18 -0
  446. data/docs/NewStore.md +24 -0
  447. data/docs/NewTemplateDef.md +30 -0
  448. data/docs/NewUser.md +24 -0
  449. data/docs/NewWebhook.md +40 -0
  450. data/docs/Notification.md +22 -0
  451. data/docs/NotificationActivation.md +18 -0
  452. data/docs/NotificationListItem.md +24 -0
  453. data/docs/OktaEvent.md +20 -0
  454. data/docs/OktaEventPayload.md +18 -0
  455. data/docs/OktaEventPayloadData.md +18 -0
  456. data/docs/OktaEventTarget.md +22 -0
  457. data/docs/OneTimeCode.md +24 -0
  458. data/docs/OutgoingIntegrationBrazePolicy.md +20 -0
  459. data/docs/OutgoingIntegrationCleverTapPolicy.md +22 -0
  460. data/docs/OutgoingIntegrationConfiguration.md +24 -0
  461. data/docs/OutgoingIntegrationIterablePolicy.md +20 -0
  462. data/docs/OutgoingIntegrationMoEngagePolicy.md +24 -0
  463. data/docs/OutgoingIntegrationTemplate.md +34 -0
  464. data/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md +36 -0
  465. data/docs/OutgoingIntegrationTemplates.md +18 -0
  466. data/docs/OutgoingIntegrationType.md +26 -0
  467. data/docs/OutgoingIntegrationTypes.md +18 -0
  468. data/docs/PatchItemCatalogAction.md +26 -0
  469. data/docs/PatchManyItemsCatalogAction.md +22 -0
  470. data/docs/PendingActivePointsData.md +30 -0
  471. data/docs/PendingActivePointsNotification.md +22 -0
  472. data/docs/PendingPointsNotificationPolicy.md +22 -0
  473. data/docs/Picklist.md +32 -0
  474. data/docs/PriceDetail.md +26 -0
  475. data/docs/PriceType.md +34 -0
  476. data/docs/PriceTypeReferenceDetail.md +24 -0
  477. data/docs/PriceTypeReferences.md +20 -0
  478. data/docs/PrismaticConfig.md +20 -0
  479. data/docs/PrismaticEventPayloadCouponBasedNotifications.md +52 -0
  480. data/docs/PrismaticEventPayloadCouponBasedNotificationsLimits.md +24 -0
  481. data/docs/PrismaticEventPayloadLoyaltyProfileBasedNotifications.md +46 -0
  482. data/docs/PrismaticEventPayloadLoyaltyProfileBasedNotificationsAction.md +26 -0
  483. data/docs/PrismaticFlow.md +22 -0
  484. data/docs/PrismaticFlowConfig.md +18 -0
  485. data/docs/PrismaticFlowWithConfig.md +24 -0
  486. data/docs/PrismaticPaginatedEventPayload.md +22 -0
  487. data/docs/Product.md +18 -0
  488. data/docs/ProductSearchMatch.md +22 -0
  489. data/docs/ProductUnitAnalytics.md +20 -0
  490. data/docs/ProductUnitAnalyticsDataPoint.md +26 -0
  491. data/docs/ProductUnitAnalyticsTotals.md +18 -0
  492. data/docs/ProfileAudiencesChanges.md +20 -0
  493. data/docs/ProjectedTier.md +22 -0
  494. data/docs/RedeemReferralEffectProps.md +20 -0
  495. data/docs/Referral.md +42 -0
  496. data/docs/ReferralConstraints.md +22 -0
  497. data/docs/ReferralCreatedEffectProps.md +18 -0
  498. data/docs/ReferralRejectionReason.md +22 -0
  499. data/docs/RejectCouponEffectProps.md +28 -0
  500. data/docs/RejectReferralEffectProps.md +28 -0
  501. data/docs/RemoveFromAudienceEffectProps.md +24 -0
  502. data/docs/RemoveItemCatalogAction.md +18 -0
  503. data/docs/RemoveManyItemsCatalogAction.md +18 -0
  504. data/docs/ReopenSessionResponse.md +18 -0
  505. data/docs/ReserveCouponEffectProps.md +22 -0
  506. data/docs/ReturnIntegrationRequest.md +20 -0
  507. data/docs/ReturnedCartItem.md +22 -0
  508. data/docs/Revision.md +36 -0
  509. data/docs/RevisionActivation.md +18 -0
  510. data/docs/RevisionActivationRequest.md +20 -0
  511. data/docs/RevisionVersion.md +54 -0
  512. data/docs/Role.md +34 -0
  513. data/docs/RoleAssign.md +20 -0
  514. data/docs/RoleMembership.md +20 -0
  515. data/docs/RoleV2.md +34 -0
  516. data/docs/RoleV2ApplicationDetails.md +24 -0
  517. data/docs/RoleV2Base.md +24 -0
  518. data/docs/RoleV2PermissionSet.md +20 -0
  519. data/docs/RoleV2Permissions.md +20 -0
  520. data/docs/RoleV2Readonly.md +18 -0
  521. data/docs/RoleV2RolesGroup.md +24 -0
  522. data/docs/RollbackAddedLoyaltyPointsEffectProps.md +32 -0
  523. data/docs/RollbackCouponEffectProps.md +18 -0
  524. data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +32 -0
  525. data/docs/RollbackDiscountEffectProps.md +30 -0
  526. data/docs/RollbackIncreasedAchievementProgressEffectProps.md +28 -0
  527. data/docs/RollbackReferralEffectProps.md +18 -0
  528. data/docs/Rule.md +30 -0
  529. data/docs/RuleFailureReason.md +44 -0
  530. data/docs/Ruleset.md +38 -0
  531. data/docs/SSOConfig.md +20 -0
  532. data/docs/SamlConnection.md +38 -0
  533. data/docs/SamlConnectionInternal.md +20 -0
  534. data/docs/SamlConnectionMetadata.md +24 -0
  535. data/docs/SamlLoginEndpoint.md +22 -0
  536. data/docs/ScimBaseGroup.md +20 -0
  537. data/docs/ScimBaseUser.md +24 -0
  538. data/docs/ScimBaseUserName.md +18 -0
  539. data/docs/ScimGroup.md +22 -0
  540. data/docs/ScimGroupMember.md +20 -0
  541. data/docs/ScimGroupsListResponse.md +22 -0
  542. data/docs/ScimNewUser.md +24 -0
  543. data/docs/ScimPatchOperation.md +22 -0
  544. data/docs/ScimPatchRequest.md +20 -0
  545. data/docs/ScimResource.md +22 -0
  546. data/docs/ScimResourceTypesListResponse.md +18 -0
  547. data/docs/ScimSchemaResource.md +24 -0
  548. data/docs/ScimSchemasListResponse.md +22 -0
  549. data/docs/ScimServiceProviderConfigResponse.md +30 -0
  550. data/docs/ScimServiceProviderConfigResponseBulk.md +22 -0
  551. data/docs/ScimServiceProviderConfigResponseChangePassword.md +18 -0
  552. data/docs/ScimServiceProviderConfigResponseFilter.md +20 -0
  553. data/docs/ScimServiceProviderConfigResponsePatch.md +18 -0
  554. data/docs/ScimServiceProviderConfigResponseSort.md +18 -0
  555. data/docs/ScimUser.md +26 -0
  556. data/docs/ScimUsersListResponse.md +22 -0
  557. data/docs/SecondaryDeployment.md +32 -0
  558. data/docs/Session.md +22 -0
  559. data/docs/SessionCoupons.md +20 -0
  560. data/docs/SetDiscountEffectProps.md +24 -0
  561. data/docs/SetDiscountPerAdditionalCostEffectProps.md +26 -0
  562. data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +30 -0
  563. data/docs/SetDiscountPerItemEffectProps.md +40 -0
  564. data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +24 -0
  565. data/docs/ShowBundleMetadataEffectProps.md +22 -0
  566. data/docs/ShowNotificationEffectProps.md +22 -0
  567. data/docs/SkuUnitAnalytics.md +20 -0
  568. data/docs/SkuUnitAnalyticsDataPoint.md +24 -0
  569. data/docs/SlotDef.md +28 -0
  570. data/docs/Store.md +34 -0
  571. data/docs/StrikethroughChangedItem.md +32 -0
  572. data/docs/StrikethroughCustomEffectPerItemProps.md +22 -0
  573. data/docs/StrikethroughDebugResponse.md +20 -0
  574. data/docs/StrikethroughEffect.md +40 -0
  575. data/docs/StrikethroughLabelingNotification.md +34 -0
  576. data/docs/StrikethroughSetDiscountPerItemEffectProps.md +20 -0
  577. data/docs/StrikethroughSetDiscountPerItemMemberEffectProps.md +20 -0
  578. data/docs/StrikethroughTrigger.md +26 -0
  579. data/docs/SummarizeCampaignStoreBudget200Response.md +18 -0
  580. data/docs/SummaryCampaignStoreBudget.md +24 -0
  581. data/docs/TalangAttribute.md +34 -0
  582. data/docs/TalangAttributeVisibility.md +20 -0
  583. data/docs/TemplateArgDef.md +30 -0
  584. data/docs/TemplateDef.md +38 -0
  585. data/docs/TemplateLimitConfig.md +24 -0
  586. data/docs/Tier.md +26 -0
  587. data/docs/TierDowngradeData.md +32 -0
  588. data/docs/TierDowngradeNotification.md +22 -0
  589. data/docs/TierDowngradeNotificationPolicy.md +22 -0
  590. data/docs/TierUpgradeData.md +36 -0
  591. data/docs/TierUpgradeNotification.md +22 -0
  592. data/docs/TierUpgradeNotificationPolicy.md +22 -0
  593. data/docs/TierWillDowngradeData.md +32 -0
  594. data/docs/TierWillDowngradeNotification.md +22 -0
  595. data/docs/TierWillDowngradeNotificationPolicy.md +24 -0
  596. data/docs/TierWillDowngradeNotificationTrigger.md +20 -0
  597. data/docs/TimePoint.md +28 -0
  598. data/docs/TrackEventV2Response.md +34 -0
  599. data/docs/TransferLoyaltyCard.md +20 -0
  600. data/docs/TriggerWebhookEffectProps.md +20 -0
  601. data/docs/TwoFAConfig.md +20 -0
  602. data/docs/UpdateAccount.md +26 -0
  603. data/docs/UpdateAchievement.md +38 -0
  604. data/docs/UpdateApplication.md +50 -0
  605. data/docs/UpdateApplicationAPIKey.md +18 -0
  606. data/docs/UpdateApplicationCIF.md +24 -0
  607. data/docs/UpdateAttributeEffectProps.md +20 -0
  608. data/docs/UpdateAudience.md +18 -0
  609. data/docs/UpdateCampaign.md +48 -0
  610. data/docs/UpdateCampaignCollection.md +18 -0
  611. data/docs/UpdateCampaignEvaluationGroup.md +28 -0
  612. data/docs/UpdateCampaignGroup.md +24 -0
  613. data/docs/UpdateCampaignTemplate.md +52 -0
  614. data/docs/UpdateCatalog.md +22 -0
  615. data/docs/UpdateCollection.md +20 -0
  616. data/docs/UpdateCoupon.md +36 -0
  617. data/docs/UpdateCouponBatch.md +30 -0
  618. data/docs/UpdateCouponsData.md +30 -0
  619. data/docs/UpdateCustomEffect.md +32 -0
  620. data/docs/UpdateCustomerProfileV2409Response.md +22 -0
  621. data/docs/UpdateCustomerSessionV2409Response.md +22 -0
  622. data/docs/UpdateLoyaltyCard.md +20 -0
  623. data/docs/UpdateLoyaltyProgram.md +48 -0
  624. data/docs/UpdateLoyaltyProgramTier.md +22 -0
  625. data/docs/UpdatePicklist.md +20 -0
  626. data/docs/UpdatePriceType.md +22 -0
  627. data/docs/UpdateReferral.md +26 -0
  628. data/docs/UpdateReferralBatch.md +26 -0
  629. data/docs/UpdateRole.md +24 -0
  630. data/docs/UpdateStore.md +22 -0
  631. data/docs/UpdateUser.md +28 -0
  632. data/docs/User.md +50 -0
  633. data/docs/UserEntity.md +18 -0
  634. data/docs/ValueMap.md +24 -0
  635. data/docs/Webhook.md +46 -0
  636. data/docs/WebhookAuthentication.md +34 -0
  637. data/docs/WebhookAuthenticationBase.md +22 -0
  638. data/docs/WebhookAuthenticationDataBasic.md +20 -0
  639. data/docs/WebhookAuthenticationDataCustom.md +18 -0
  640. data/docs/WebhookAuthenticationWebhookRef.md +22 -0
  641. data/docs/WebhookWithOutgoingIntegrationDetails.md +52 -0
  642. data/docs/WillAwardGiveawayEffectProps.md +22 -0
  643. data/lib/talon_one_sdk/api/integration_api.rb +2536 -0
  644. data/lib/talon_one_sdk/api/management_api.rb +13554 -0
  645. data/lib/talon_one_sdk/api_client.rb +397 -0
  646. data/lib/talon_one_sdk/api_error.rb +58 -0
  647. data/lib/talon_one_sdk/api_model_base.rb +88 -0
  648. data/lib/talon_one_sdk/configuration.rb +322 -0
  649. data/lib/talon_one_sdk/models/accept_coupon_effect_props.rb +166 -0
  650. data/lib/talon_one_sdk/models/accept_referral_effect_props.rb +166 -0
  651. data/lib/talon_one_sdk/models/access_log_entry.rb +328 -0
  652. data/lib/talon_one_sdk/models/account.rb +546 -0
  653. data/lib/talon_one_sdk/models/account_additional_cost.rb +389 -0
  654. data/lib/talon_one_sdk/models/account_analytics.rb +678 -0
  655. data/lib/talon_one_sdk/models/account_dashboard_statistic.rb +212 -0
  656. data/lib/talon_one_sdk/models/account_dashboard_statistic_campaigns.rb +219 -0
  657. data/lib/talon_one_sdk/models/account_dashboard_statistic_discount.rb +219 -0
  658. data/lib/talon_one_sdk/models/account_dashboard_statistic_loyalty_points.rb +192 -0
  659. data/lib/talon_one_sdk/models/account_dashboard_statistic_referrals.rb +192 -0
  660. data/lib/talon_one_sdk/models/account_dashboard_statistic_revenue.rb +219 -0
  661. data/lib/talon_one_sdk/models/account_entity.rb +165 -0
  662. data/lib/talon_one_sdk/models/account_limits.rb +518 -0
  663. data/lib/talon_one_sdk/models/achievement.rb +549 -0
  664. data/lib/talon_one_sdk/models/achievement_additional_properties.rb +256 -0
  665. data/lib/talon_one_sdk/models/achievement_base.rb +332 -0
  666. data/lib/talon_one_sdk/models/achievement_progress.rb +247 -0
  667. data/lib/talon_one_sdk/models/achievement_progress_with_definition.rb +515 -0
  668. data/lib/talon_one_sdk/models/achievement_status_entry.rb +493 -0
  669. data/lib/talon_one_sdk/models/activate_loyalty_points.rb +208 -0
  670. data/lib/talon_one_sdk/models/activate_loyalty_points_response.rb +150 -0
  671. data/lib/talon_one_sdk/models/activate_user_request.rb +172 -0
  672. data/lib/talon_one_sdk/models/add_free_item_effect_props.rb +203 -0
  673. data/lib/talon_one_sdk/models/add_item_catalog_action.rb +207 -0
  674. data/lib/talon_one_sdk/models/add_loyalty_points.rb +245 -0
  675. data/lib/talon_one_sdk/models/add_loyalty_points_effect_props.rb +449 -0
  676. data/lib/talon_one_sdk/models/add_price_adjustment_catalog_action.rb +195 -0
  677. data/lib/talon_one_sdk/models/add_to_audience_effect_props.rb +179 -0
  678. data/lib/talon_one_sdk/models/added_deducted_points_balances_action.rb +263 -0
  679. data/lib/talon_one_sdk/models/added_deducted_points_balances_notification.rb +454 -0
  680. data/lib/talon_one_sdk/models/added_deducted_points_balances_notification_policy.rb +231 -0
  681. data/lib/talon_one_sdk/models/added_deducted_points_notification.rb +492 -0
  682. data/lib/talon_one_sdk/models/added_deducted_points_notification_policy.rb +224 -0
  683. data/lib/talon_one_sdk/models/additional_campaign_properties.rb +440 -0
  684. data/lib/talon_one_sdk/models/additional_cost.rb +164 -0
  685. data/lib/talon_one_sdk/models/analytics_data_point.rb +190 -0
  686. data/lib/talon_one_sdk/models/analytics_data_point_with_trend.rb +190 -0
  687. data/lib/talon_one_sdk/models/analytics_data_point_with_trend_and_influenced_rate.rb +216 -0
  688. data/lib/talon_one_sdk/models/analytics_data_point_with_trend_and_uplift.rb +216 -0
  689. data/lib/talon_one_sdk/models/analytics_product.rb +229 -0
  690. data/lib/talon_one_sdk/models/analytics_sku.rb +232 -0
  691. data/lib/talon_one_sdk/models/api_error.rb +201 -0
  692. data/lib/talon_one_sdk/models/application.rb +592 -0
  693. data/lib/talon_one_sdk/models/application_analytics_data_point.rb +252 -0
  694. data/lib/talon_one_sdk/models/application_api_health.rb +217 -0
  695. data/lib/talon_one_sdk/models/application_api_key.rb +410 -0
  696. data/lib/talon_one_sdk/models/application_campaign_analytics.rb +395 -0
  697. data/lib/talon_one_sdk/models/application_campaign_stats.rb +301 -0
  698. data/lib/talon_one_sdk/models/application_cif.rb +304 -0
  699. data/lib/talon_one_sdk/models/application_cif_expression.rb +259 -0
  700. data/lib/talon_one_sdk/models/application_cif_references.rb +160 -0
  701. data/lib/talon_one_sdk/models/application_customer.rb +418 -0
  702. data/lib/talon_one_sdk/models/application_customer_entity.rb +148 -0
  703. data/lib/talon_one_sdk/models/application_entity.rb +165 -0
  704. data/lib/talon_one_sdk/models/application_event.rb +393 -0
  705. data/lib/talon_one_sdk/models/application_notification.rb +165 -0
  706. data/lib/talon_one_sdk/models/application_referee.rb +325 -0
  707. data/lib/talon_one_sdk/models/application_session.rb +570 -0
  708. data/lib/talon_one_sdk/models/application_session_entity.rb +165 -0
  709. data/lib/talon_one_sdk/models/application_store_entity.rb +148 -0
  710. data/lib/talon_one_sdk/models/async_coupon_creation_response.rb +165 -0
  711. data/lib/talon_one_sdk/models/async_coupon_deletion_job_response.rb +172 -0
  712. data/lib/talon_one_sdk/models/async_coupons_data.rb +297 -0
  713. data/lib/talon_one_sdk/models/attribute.rb +559 -0
  714. data/lib/talon_one_sdk/models/attributes_mandatory.rb +163 -0
  715. data/lib/talon_one_sdk/models/attributes_settings.rb +148 -0
  716. data/lib/talon_one_sdk/models/audience.rb +352 -0
  717. data/lib/talon_one_sdk/models/audience_analytics.rb +159 -0
  718. data/lib/talon_one_sdk/models/audience_customer.rb +411 -0
  719. data/lib/talon_one_sdk/models/audience_integration_id.rb +176 -0
  720. data/lib/talon_one_sdk/models/audience_membership.rb +192 -0
  721. data/lib/talon_one_sdk/models/audience_reference.rb +220 -0
  722. data/lib/talon_one_sdk/models/award_giveaway_effect_props.rb +283 -0
  723. data/lib/talon_one_sdk/models/base_campaign.rb +427 -0
  724. data/lib/talon_one_sdk/models/base_loyalty_program.rb +378 -0
  725. data/lib/talon_one_sdk/models/base_notification.rb +297 -0
  726. data/lib/talon_one_sdk/models/base_notification_entity.rb +177 -0
  727. data/lib/talon_one_sdk/models/base_notification_webhook.rb +296 -0
  728. data/lib/talon_one_sdk/models/base_notifications.rb +150 -0
  729. data/lib/talon_one_sdk/models/base_saml_connection.rb +330 -0
  730. data/lib/talon_one_sdk/models/best_prior_price.rb +298 -0
  731. data/lib/talon_one_sdk/models/best_prior_price_metadata.rb +160 -0
  732. data/lib/talon_one_sdk/models/best_prior_price_request.rb +266 -0
  733. data/lib/talon_one_sdk/models/best_prior_price_request_target.rb +200 -0
  734. data/lib/talon_one_sdk/models/binding.rb +254 -0
  735. data/lib/talon_one_sdk/models/bulk_application_notification.rb +192 -0
  736. data/lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb +237 -0
  737. data/lib/talon_one_sdk/models/campaign.rb +911 -0
  738. data/lib/talon_one_sdk/models/campaign_activation_request.rb +176 -0
  739. data/lib/talon_one_sdk/models/campaign_analytics.rb +812 -0
  740. data/lib/talon_one_sdk/models/campaign_budget.rb +237 -0
  741. data/lib/talon_one_sdk/models/campaign_collection.rb +398 -0
  742. data/lib/talon_one_sdk/models/campaign_collection_edited_notification.rb +235 -0
  743. data/lib/talon_one_sdk/models/campaign_collection_edited_notification_item.rb +209 -0
  744. data/lib/talon_one_sdk/models/campaign_collection_without_payload.rb +370 -0
  745. data/lib/talon_one_sdk/models/campaign_copy.rb +248 -0
  746. data/lib/talon_one_sdk/models/campaign_created_notification.rb +235 -0
  747. data/lib/talon_one_sdk/models/campaign_created_notification_item.rb +209 -0
  748. data/lib/talon_one_sdk/models/campaign_deactivation_request.rb +176 -0
  749. data/lib/talon_one_sdk/models/campaign_deleted_notification.rb +235 -0
  750. data/lib/talon_one_sdk/models/campaign_deleted_notification_item.rb +212 -0
  751. data/lib/talon_one_sdk/models/campaign_detail.rb +177 -0
  752. data/lib/talon_one_sdk/models/campaign_edited_notification.rb +235 -0
  753. data/lib/talon_one_sdk/models/campaign_edited_notification_item.rb +209 -0
  754. data/lib/talon_one_sdk/models/campaign_entity.rb +165 -0
  755. data/lib/talon_one_sdk/models/campaign_evaluation_group.rb +381 -0
  756. data/lib/talon_one_sdk/models/campaign_evaluation_position.rb +220 -0
  757. data/lib/talon_one_sdk/models/campaign_evaluation_tree_changed_message.rb +235 -0
  758. data/lib/talon_one_sdk/models/campaign_evaluation_tree_changed_notification.rb +203 -0
  759. data/lib/talon_one_sdk/models/campaign_group.rb +326 -0
  760. data/lib/talon_one_sdk/models/campaign_group_entity.rb +150 -0
  761. data/lib/talon_one_sdk/models/campaign_log_summary.rb +298 -0
  762. data/lib/talon_one_sdk/models/campaign_notification_base.rb +216 -0
  763. data/lib/talon_one_sdk/models/campaign_notification_generic.rb +252 -0
  764. data/lib/talon_one_sdk/models/campaign_notification_item_base.rb +165 -0
  765. data/lib/talon_one_sdk/models/campaign_notification_policy.rb +198 -0
  766. data/lib/talon_one_sdk/models/campaign_ruleset_changed_notification.rb +235 -0
  767. data/lib/talon_one_sdk/models/campaign_ruleset_changed_notification_item.rb +205 -0
  768. data/lib/talon_one_sdk/models/campaign_search.rb +165 -0
  769. data/lib/talon_one_sdk/models/campaign_set.rb +271 -0
  770. data/lib/talon_one_sdk/models/campaign_set_branch_node.rb +396 -0
  771. data/lib/talon_one_sdk/models/campaign_set_leaf_node.rb +216 -0
  772. data/lib/talon_one_sdk/models/campaign_set_node.rb +164 -0
  773. data/lib/talon_one_sdk/models/campaign_state_changed_notification.rb +235 -0
  774. data/lib/talon_one_sdk/models/campaign_state_changed_notification_item.rb +250 -0
  775. data/lib/talon_one_sdk/models/campaign_store_budget.rb +282 -0
  776. data/lib/talon_one_sdk/models/campaign_store_budget_limit_config.rb +298 -0
  777. data/lib/talon_one_sdk/models/campaign_template.rb +666 -0
  778. data/lib/talon_one_sdk/models/campaign_template_collection.rb +195 -0
  779. data/lib/talon_one_sdk/models/campaign_template_coupon_reservation_settings.rb +188 -0
  780. data/lib/talon_one_sdk/models/campaign_template_params.rb +262 -0
  781. data/lib/talon_one_sdk/models/campaign_versions.rb +244 -0
  782. data/lib/talon_one_sdk/models/card_added_deducted_points_balances_notification.rb +510 -0
  783. data/lib/talon_one_sdk/models/card_added_deducted_points_balances_notification_policy.rb +231 -0
  784. data/lib/talon_one_sdk/models/card_added_deducted_points_notification.rb +548 -0
  785. data/lib/talon_one_sdk/models/card_added_deducted_points_notification_policy.rb +224 -0
  786. data/lib/talon_one_sdk/models/card_expiring_points_notification_policy.rb +244 -0
  787. data/lib/talon_one_sdk/models/card_expiring_points_notification_trigger.rb +225 -0
  788. data/lib/talon_one_sdk/models/card_ledger_points_entry_integration_api.rb +448 -0
  789. data/lib/talon_one_sdk/models/card_ledger_transaction_log_entry.rb +570 -0
  790. data/lib/talon_one_sdk/models/card_ledger_transaction_log_entry_integration_api.rb +570 -0
  791. data/lib/talon_one_sdk/models/cart_item.rb +403 -0
  792. data/lib/talon_one_sdk/models/catalog.rb +376 -0
  793. data/lib/talon_one_sdk/models/catalog_action_filter.rb +229 -0
  794. data/lib/talon_one_sdk/models/catalog_item.rb +319 -0
  795. data/lib/talon_one_sdk/models/catalog_sync_request.rb +213 -0
  796. data/lib/talon_one_sdk/models/catalogs_strikethrough_notification_policy.rb +224 -0
  797. data/lib/talon_one_sdk/models/change.rb +294 -0
  798. data/lib/talon_one_sdk/models/change_loyalty_tier_level_effect_props.rb +267 -0
  799. data/lib/talon_one_sdk/models/change_profile_password.rb +192 -0
  800. data/lib/talon_one_sdk/models/code_generator_settings.rb +223 -0
  801. data/lib/talon_one_sdk/models/collection.rb +410 -0
  802. data/lib/talon_one_sdk/models/collection_item.rb +164 -0
  803. data/lib/talon_one_sdk/models/collection_without_payload.rb +382 -0
  804. data/lib/talon_one_sdk/models/coupon.rb +565 -0
  805. data/lib/talon_one_sdk/models/coupon_constraints.rb +272 -0
  806. data/lib/talon_one_sdk/models/coupon_created_effect_props.rb +193 -0
  807. data/lib/talon_one_sdk/models/coupon_creation_job.rb +734 -0
  808. data/lib/talon_one_sdk/models/coupon_deletion_filters.rb +314 -0
  809. data/lib/talon_one_sdk/models/coupon_deletion_job.rb +440 -0
  810. data/lib/talon_one_sdk/models/coupon_entity.rb +192 -0
  811. data/lib/talon_one_sdk/models/coupon_failure_summary.rb +402 -0
  812. data/lib/talon_one_sdk/models/coupon_limit_configs.rb +150 -0
  813. data/lib/talon_one_sdk/models/coupon_rejection_reason.rb +241 -0
  814. data/lib/talon_one_sdk/models/coupon_rejections.rb +204 -0
  815. data/lib/talon_one_sdk/models/coupon_reservations.rb +176 -0
  816. data/lib/talon_one_sdk/models/coupon_search.rb +165 -0
  817. data/lib/talon_one_sdk/models/coupon_value.rb +167 -0
  818. data/lib/talon_one_sdk/models/coupons_notification_data.rb +291 -0
  819. data/lib/talon_one_sdk/models/coupons_notification_policy.rb +258 -0
  820. data/lib/talon_one_sdk/models/create_achievement.rb +397 -0
  821. data/lib/talon_one_sdk/models/create_application_api_key.rb +268 -0
  822. data/lib/talon_one_sdk/models/create_coupon_data.rb +301 -0
  823. data/lib/talon_one_sdk/models/create_coupons200_response.rb +192 -0
  824. data/lib/talon_one_sdk/models/create_management_key.rb +233 -0
  825. data/lib/talon_one_sdk/models/create_referrals_for_multiple_advocates201_response.rb +192 -0
  826. data/lib/talon_one_sdk/models/create_template_campaign.rb +310 -0
  827. data/lib/talon_one_sdk/models/create_template_campaign_response.rb +201 -0
  828. data/lib/talon_one_sdk/models/custom_effect.rb +493 -0
  829. data/lib/talon_one_sdk/models/custom_effect_props.rb +260 -0
  830. data/lib/talon_one_sdk/models/customer_activity_report.rb +489 -0
  831. data/lib/talon_one_sdk/models/customer_analytics.rb +328 -0
  832. data/lib/talon_one_sdk/models/customer_inventory.rb +201 -0
  833. data/lib/talon_one_sdk/models/customer_profile.rb +389 -0
  834. data/lib/talon_one_sdk/models/customer_profile_audience_request.rb +149 -0
  835. data/lib/talon_one_sdk/models/customer_profile_audience_request_item.rb +252 -0
  836. data/lib/talon_one_sdk/models/customer_profile_entity.rb +192 -0
  837. data/lib/talon_one_sdk/models/customer_profile_integration_request_v2.rb +213 -0
  838. data/lib/talon_one_sdk/models/customer_profile_integration_response_v2.rb +284 -0
  839. data/lib/talon_one_sdk/models/customer_profile_search_query.rb +170 -0
  840. data/lib/talon_one_sdk/models/customer_profile_update_v2_response.rb +165 -0
  841. data/lib/talon_one_sdk/models/customer_session.rb +523 -0
  842. data/lib/talon_one_sdk/models/customer_session_v2.rb +670 -0
  843. data/lib/talon_one_sdk/models/deactivate_user_request.rb +172 -0
  844. data/lib/talon_one_sdk/models/deduct_loyalty_points.rb +205 -0
  845. data/lib/talon_one_sdk/models/deduct_loyalty_points_effect_props.rb +350 -0
  846. data/lib/talon_one_sdk/models/delete_coupons_data.rb +371 -0
  847. data/lib/talon_one_sdk/models/delete_user_request.rb +172 -0
  848. data/lib/talon_one_sdk/models/effect.rb +392 -0
  849. data/lib/talon_one_sdk/models/effect_entity.rb +374 -0
  850. data/lib/talon_one_sdk/models/email_entity.rb +165 -0
  851. data/lib/talon_one_sdk/models/endpoint.rb +165 -0
  852. data/lib/talon_one_sdk/models/entity.rb +192 -0
  853. data/lib/talon_one_sdk/models/entity_with_talang_visible_id.rb +192 -0
  854. data/lib/talon_one_sdk/models/environment.rb +449 -0
  855. data/lib/talon_one_sdk/models/error_effect_props.rb +166 -0
  856. data/lib/talon_one_sdk/models/error_response.rb +177 -0
  857. data/lib/talon_one_sdk/models/error_response_with_status.rb +169 -0
  858. data/lib/talon_one_sdk/models/error_source.rb +179 -0
  859. data/lib/talon_one_sdk/models/evaluable_campaign_ids.rb +150 -0
  860. data/lib/talon_one_sdk/models/event.rb +399 -0
  861. data/lib/talon_one_sdk/models/event_type.rb +282 -0
  862. data/lib/talon_one_sdk/models/event_v2.rb +253 -0
  863. data/lib/talon_one_sdk/models/event_v3.rb +364 -0
  864. data/lib/talon_one_sdk/models/expiring_card_points_data.rb +347 -0
  865. data/lib/talon_one_sdk/models/expiring_card_points_notification.rb +244 -0
  866. data/lib/talon_one_sdk/models/expiring_coupons_data.rb +372 -0
  867. data/lib/talon_one_sdk/models/expiring_coupons_notification.rb +244 -0
  868. data/lib/talon_one_sdk/models/expiring_coupons_notification_policy.rb +244 -0
  869. data/lib/talon_one_sdk/models/expiring_coupons_notification_trigger.rb +225 -0
  870. data/lib/talon_one_sdk/models/expiring_points_data.rb +282 -0
  871. data/lib/talon_one_sdk/models/expiring_points_notification.rb +244 -0
  872. data/lib/talon_one_sdk/models/expiring_points_notification_policy.rb +244 -0
  873. data/lib/talon_one_sdk/models/expiring_points_notification_trigger.rb +225 -0
  874. data/lib/talon_one_sdk/models/export.rb +333 -0
  875. data/lib/talon_one_sdk/models/extend_loyalty_points_expiry_date_effect_props.rb +232 -0
  876. data/lib/talon_one_sdk/models/extended_coupon.rb +588 -0
  877. data/lib/talon_one_sdk/models/feature_flag.rb +212 -0
  878. data/lib/talon_one_sdk/models/features_feed.rb +156 -0
  879. data/lib/talon_one_sdk/models/func_arg_def.rb +204 -0
  880. data/lib/talon_one_sdk/models/function_def.rb +250 -0
  881. data/lib/talon_one_sdk/models/generate_audit_log_summary.rb +165 -0
  882. data/lib/talon_one_sdk/models/generate_campaign_description.rb +219 -0
  883. data/lib/talon_one_sdk/models/generate_campaign_summary.rb +219 -0
  884. data/lib/talon_one_sdk/models/generate_campaign_tags.rb +165 -0
  885. data/lib/talon_one_sdk/models/generate_coupon_failure_detailed_summary.rb +265 -0
  886. data/lib/talon_one_sdk/models/generate_coupon_failure_summary.rb +175 -0
  887. data/lib/talon_one_sdk/models/generate_item_filter_description.rb +167 -0
  888. data/lib/talon_one_sdk/models/generate_loyalty_card.rb +246 -0
  889. data/lib/talon_one_sdk/models/generate_rule_title.rb +191 -0
  890. data/lib/talon_one_sdk/models/generate_rule_title_rule.rb +181 -0
  891. data/lib/talon_one_sdk/models/generate_user_session_summary.rb +192 -0
  892. data/lib/talon_one_sdk/models/get_access_logs_without_total_count200_response.rb +192 -0
  893. data/lib/talon_one_sdk/models/get_additional_costs200_response.rb +192 -0
  894. data/lib/talon_one_sdk/models/get_application_customer_friends200_response.rb +184 -0
  895. data/lib/talon_one_sdk/models/get_application_customers200_response.rb +184 -0
  896. data/lib/talon_one_sdk/models/get_application_customers_by_attributes200_response.rb +184 -0
  897. data/lib/talon_one_sdk/models/get_application_event_types200_response.rb +192 -0
  898. data/lib/talon_one_sdk/models/get_application_events_without_total_count200_response.rb +192 -0
  899. data/lib/talon_one_sdk/models/get_application_sessions200_response.rb +175 -0
  900. data/lib/talon_one_sdk/models/get_applications200_response.rb +192 -0
  901. data/lib/talon_one_sdk/models/get_attributes200_response.rb +192 -0
  902. data/lib/talon_one_sdk/models/get_audience_memberships200_response.rb +175 -0
  903. data/lib/talon_one_sdk/models/get_audiences200_response.rb +184 -0
  904. data/lib/talon_one_sdk/models/get_audiences_analytics200_response.rb +175 -0
  905. data/lib/talon_one_sdk/models/get_campaign_analytics200_response.rb +192 -0
  906. data/lib/talon_one_sdk/models/get_campaign_groups200_response.rb +192 -0
  907. data/lib/talon_one_sdk/models/get_campaign_templates200_response.rb +192 -0
  908. data/lib/talon_one_sdk/models/get_campaigns200_response.rb +192 -0
  909. data/lib/talon_one_sdk/models/get_changes200_response.rb +184 -0
  910. data/lib/talon_one_sdk/models/get_collection_items200_response.rb +192 -0
  911. data/lib/talon_one_sdk/models/get_coupons_without_total_count200_response.rb +192 -0
  912. data/lib/talon_one_sdk/models/get_customer_achievement_history200_response.rb +192 -0
  913. data/lib/talon_one_sdk/models/get_customer_achievements200_response.rb +192 -0
  914. data/lib/talon_one_sdk/models/get_customer_activity_reports_without_total_count200_response.rb +192 -0
  915. data/lib/talon_one_sdk/models/get_customer_profile_achievement_progress200_response.rb +192 -0
  916. data/lib/talon_one_sdk/models/get_customer_profiles200_response.rb +192 -0
  917. data/lib/talon_one_sdk/models/get_customers_by_attributes200_response.rb +184 -0
  918. data/lib/talon_one_sdk/models/get_dashboard_statistics200_response.rb +192 -0
  919. data/lib/talon_one_sdk/models/get_event_types200_response.rb +192 -0
  920. data/lib/talon_one_sdk/models/get_exports200_response.rb +192 -0
  921. data/lib/talon_one_sdk/models/get_integration_coupon_request.rb +212 -0
  922. data/lib/talon_one_sdk/models/get_loyalty_card_points200_response.rb +192 -0
  923. data/lib/talon_one_sdk/models/get_loyalty_card_transaction_logs200_response.rb +194 -0
  924. data/lib/talon_one_sdk/models/get_loyalty_card_transactions200_response.rb +192 -0
  925. data/lib/talon_one_sdk/models/get_loyalty_cards200_response.rb +192 -0
  926. data/lib/talon_one_sdk/models/get_loyalty_program_profile_points200_response.rb +192 -0
  927. data/lib/talon_one_sdk/models/get_loyalty_program_profile_transactions200_response.rb +192 -0
  928. data/lib/talon_one_sdk/models/get_loyalty_program_transactions200_response.rb +192 -0
  929. data/lib/talon_one_sdk/models/get_loyalty_programs200_response.rb +192 -0
  930. data/lib/talon_one_sdk/models/get_referrals_without_total_count200_response.rb +192 -0
  931. data/lib/talon_one_sdk/models/get_reserved_customers200_response.rb +192 -0
  932. data/lib/talon_one_sdk/models/get_rulesets200_response.rb +192 -0
  933. data/lib/talon_one_sdk/models/get_users200_response.rb +192 -0
  934. data/lib/talon_one_sdk/models/get_webhooks200_response.rb +192 -0
  935. data/lib/talon_one_sdk/models/giveaway.rb +323 -0
  936. data/lib/talon_one_sdk/models/giveaways_pool.rb +352 -0
  937. data/lib/talon_one_sdk/models/hidden_conditions_effects.rb +187 -0
  938. data/lib/talon_one_sdk/models/identifiable_entity.rb +165 -0
  939. data/lib/talon_one_sdk/models/import.rb +318 -0
  940. data/lib/talon_one_sdk/models/import_entity.rb +148 -0
  941. data/lib/talon_one_sdk/models/increase_achievement_progress_effect_props.rb +311 -0
  942. data/lib/talon_one_sdk/models/integration_coupon.rb +588 -0
  943. data/lib/talon_one_sdk/models/integration_customer_profile_audience_request.rb +149 -0
  944. data/lib/talon_one_sdk/models/integration_customer_profile_audience_request_item.rb +252 -0
  945. data/lib/talon_one_sdk/models/integration_customer_session_response.rb +159 -0
  946. data/lib/talon_one_sdk/models/integration_entity.rb +201 -0
  947. data/lib/talon_one_sdk/models/integration_event.rb +257 -0
  948. data/lib/talon_one_sdk/models/integration_event_v2_request.rb +316 -0
  949. data/lib/talon_one_sdk/models/integration_event_v3_request.rb +427 -0
  950. data/lib/talon_one_sdk/models/integration_event_v3_response.rb +284 -0
  951. data/lib/talon_one_sdk/models/integration_profile_entity.rb +148 -0
  952. data/lib/talon_one_sdk/models/integration_profile_entity_v3.rb +165 -0
  953. data/lib/talon_one_sdk/models/integration_request.rb +200 -0
  954. data/lib/talon_one_sdk/models/integration_state.rb +235 -0
  955. data/lib/talon_one_sdk/models/integration_state_v2.rb +333 -0
  956. data/lib/talon_one_sdk/models/integration_store_entity.rb +176 -0
  957. data/lib/talon_one_sdk/models/inventory_coupon.rb +615 -0
  958. data/lib/talon_one_sdk/models/inventory_referral.rb +452 -0
  959. data/lib/talon_one_sdk/models/item_attribute.rb +204 -0
  960. data/lib/talon_one_sdk/models/label_target_audience.rb +215 -0
  961. data/lib/talon_one_sdk/models/label_target_none.rb +189 -0
  962. data/lib/talon_one_sdk/models/ledger_entry.rb +382 -0
  963. data/lib/talon_one_sdk/models/ledger_info.rb +330 -0
  964. data/lib/talon_one_sdk/models/ledger_points_entry_integration_api.rb +438 -0
  965. data/lib/talon_one_sdk/models/ledger_transaction_log_entry_integration_api.rb +524 -0
  966. data/lib/talon_one_sdk/models/library_attribute.rb +357 -0
  967. data/lib/talon_one_sdk/models/limit_config.rb +264 -0
  968. data/lib/talon_one_sdk/models/limit_counter.rb +435 -0
  969. data/lib/talon_one_sdk/models/list_account_collections200_response.rb +184 -0
  970. data/lib/talon_one_sdk/models/list_achievements200_response.rb +175 -0
  971. data/lib/talon_one_sdk/models/list_all_roles_v2200_response.rb +192 -0
  972. data/lib/talon_one_sdk/models/list_campaign_store_budget_limits200_response.rb +149 -0
  973. data/lib/talon_one_sdk/models/list_campaign_store_budgets.rb +225 -0
  974. data/lib/talon_one_sdk/models/list_campaign_store_budgets_store.rb +216 -0
  975. data/lib/talon_one_sdk/models/list_catalog_items200_response.rb +184 -0
  976. data/lib/talon_one_sdk/models/list_stores200_response.rb +184 -0
  977. data/lib/talon_one_sdk/models/login_params.rb +199 -0
  978. data/lib/talon_one_sdk/models/loyalty.rb +180 -0
  979. data/lib/talon_one_sdk/models/loyalty_balance.rb +189 -0
  980. data/lib/talon_one_sdk/models/loyalty_balance_with_tier.rb +234 -0
  981. data/lib/talon_one_sdk/models/loyalty_balances.rb +160 -0
  982. data/lib/talon_one_sdk/models/loyalty_balances_with_tiers.rb +160 -0
  983. data/lib/talon_one_sdk/models/loyalty_card.rb +529 -0
  984. data/lib/talon_one_sdk/models/loyalty_card_balances.rb +178 -0
  985. data/lib/talon_one_sdk/models/loyalty_card_batch.rb +269 -0
  986. data/lib/talon_one_sdk/models/loyalty_card_batch_response.rb +192 -0
  987. data/lib/talon_one_sdk/models/loyalty_card_profile_registration.rb +201 -0
  988. data/lib/talon_one_sdk/models/loyalty_card_registration.rb +165 -0
  989. data/lib/talon_one_sdk/models/loyalty_dashboard_data.rb +409 -0
  990. data/lib/talon_one_sdk/models/loyalty_dashboard_points_breakdown.rb +190 -0
  991. data/lib/talon_one_sdk/models/loyalty_ledger.rb +178 -0
  992. data/lib/talon_one_sdk/models/loyalty_ledger_entry.rb +382 -0
  993. data/lib/talon_one_sdk/models/loyalty_ledger_entry_expiry_date_change.rb +203 -0
  994. data/lib/talon_one_sdk/models/loyalty_ledger_entry_flags.rb +149 -0
  995. data/lib/talon_one_sdk/models/loyalty_ledger_transactions.rb +161 -0
  996. data/lib/talon_one_sdk/models/loyalty_membership.rb +175 -0
  997. data/lib/talon_one_sdk/models/loyalty_program.rb +615 -0
  998. data/lib/talon_one_sdk/models/loyalty_program_balance.rb +304 -0
  999. data/lib/talon_one_sdk/models/loyalty_program_entity.rb +185 -0
  1000. data/lib/talon_one_sdk/models/loyalty_program_ledgers.rb +269 -0
  1001. data/lib/talon_one_sdk/models/loyalty_program_transaction.rb +641 -0
  1002. data/lib/talon_one_sdk/models/loyalty_sub_ledger.rb +371 -0
  1003. data/lib/talon_one_sdk/models/loyalty_tier.rb +320 -0
  1004. data/lib/talon_one_sdk/models/management_key.rb +368 -0
  1005. data/lib/talon_one_sdk/models/manager_config.rb +164 -0
  1006. data/lib/talon_one_sdk/models/message_log_entries.rb +177 -0
  1007. data/lib/talon_one_sdk/models/message_log_entry.rb +436 -0
  1008. data/lib/talon_one_sdk/models/message_log_request.rb +193 -0
  1009. data/lib/talon_one_sdk/models/message_log_response.rb +169 -0
  1010. data/lib/talon_one_sdk/models/message_test.rb +192 -0
  1011. data/lib/talon_one_sdk/models/meta.rb +186 -0
  1012. data/lib/talon_one_sdk/models/model_return.rb +424 -0
  1013. data/lib/talon_one_sdk/models/multi_application_entity.rb +176 -0
  1014. data/lib/talon_one_sdk/models/multiple_attribute.rb +149 -0
  1015. data/lib/talon_one_sdk/models/multiple_audiences.rb +193 -0
  1016. data/lib/talon_one_sdk/models/multiple_audiences_item.rb +325 -0
  1017. data/lib/talon_one_sdk/models/multiple_customer_profile_integration_request.rb +149 -0
  1018. data/lib/talon_one_sdk/models/multiple_customer_profile_integration_request_item.rb +191 -0
  1019. data/lib/talon_one_sdk/models/multiple_customer_profile_integration_response_v2.rb +149 -0
  1020. data/lib/talon_one_sdk/models/multiple_new_attribute.rb +149 -0
  1021. data/lib/talon_one_sdk/models/multiple_new_audiences.rb +166 -0
  1022. data/lib/talon_one_sdk/models/mutable_entity.rb +165 -0
  1023. data/lib/talon_one_sdk/models/new_account.rb +173 -0
  1024. data/lib/talon_one_sdk/models/new_account_sign_up.rb +235 -0
  1025. data/lib/talon_one_sdk/models/new_additional_cost.rb +299 -0
  1026. data/lib/talon_one_sdk/models/new_app_wide_coupon_deletion_job.rb +192 -0
  1027. data/lib/talon_one_sdk/models/new_application.rb +456 -0
  1028. data/lib/talon_one_sdk/models/new_application_api_key.rb +437 -0
  1029. data/lib/talon_one_sdk/models/new_application_cif.rb +215 -0
  1030. data/lib/talon_one_sdk/models/new_application_cif_expression.rb +170 -0
  1031. data/lib/talon_one_sdk/models/new_attribute.rb +460 -0
  1032. data/lib/talon_one_sdk/models/new_audience.rb +269 -0
  1033. data/lib/talon_one_sdk/models/new_base_notification.rb +210 -0
  1034. data/lib/talon_one_sdk/models/new_campaign.rb +444 -0
  1035. data/lib/talon_one_sdk/models/new_campaign_collection.rb +202 -0
  1036. data/lib/talon_one_sdk/models/new_campaign_evaluation_group.rb +318 -0
  1037. data/lib/talon_one_sdk/models/new_campaign_group.rb +208 -0
  1038. data/lib/talon_one_sdk/models/new_campaign_set.rb +234 -0
  1039. data/lib/talon_one_sdk/models/new_campaign_store_budget.rb +238 -0
  1040. data/lib/talon_one_sdk/models/new_campaign_store_budget_store_limit.rb +192 -0
  1041. data/lib/talon_one_sdk/models/new_campaign_template.rb +444 -0
  1042. data/lib/talon_one_sdk/models/new_catalog.rb +204 -0
  1043. data/lib/talon_one_sdk/models/new_collection.rb +214 -0
  1044. data/lib/talon_one_sdk/models/new_coupon_creation_job.rb +360 -0
  1045. data/lib/talon_one_sdk/models/new_coupon_deletion_job.rb +164 -0
  1046. data/lib/talon_one_sdk/models/new_coupons.rb +440 -0
  1047. data/lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb +386 -0
  1048. data/lib/talon_one_sdk/models/new_custom_effect.rb +345 -0
  1049. data/lib/talon_one_sdk/models/new_customer_profile.rb +148 -0
  1050. data/lib/talon_one_sdk/models/new_customer_session.rb +322 -0
  1051. data/lib/talon_one_sdk/models/new_customer_session_v2.rb +391 -0
  1052. data/lib/talon_one_sdk/models/new_event.rb +292 -0
  1053. data/lib/talon_one_sdk/models/new_event_type.rb +220 -0
  1054. data/lib/talon_one_sdk/models/new_external_invitation.rb +188 -0
  1055. data/lib/talon_one_sdk/models/new_giveaways_pool.rb +214 -0
  1056. data/lib/talon_one_sdk/models/new_internal_audience.rb +194 -0
  1057. data/lib/talon_one_sdk/models/new_invitation.rb +208 -0
  1058. data/lib/talon_one_sdk/models/new_invite_email.rb +192 -0
  1059. data/lib/talon_one_sdk/models/new_loyalty_program.rb +572 -0
  1060. data/lib/talon_one_sdk/models/new_loyalty_tier.rb +211 -0
  1061. data/lib/talon_one_sdk/models/new_management_key.rb +395 -0
  1062. data/lib/talon_one_sdk/models/new_message_test.rb +272 -0
  1063. data/lib/talon_one_sdk/models/new_multiple_audiences_item.rb +220 -0
  1064. data/lib/talon_one_sdk/models/new_notification_webhook.rb +206 -0
  1065. data/lib/talon_one_sdk/models/new_outgoing_integration_webhook.rb +204 -0
  1066. data/lib/talon_one_sdk/models/new_password.rb +200 -0
  1067. data/lib/talon_one_sdk/models/new_password_email.rb +173 -0
  1068. data/lib/talon_one_sdk/models/new_picklist.rb +227 -0
  1069. data/lib/talon_one_sdk/models/new_price_adjustment.rb +252 -0
  1070. data/lib/talon_one_sdk/models/new_price_type.rb +225 -0
  1071. data/lib/talon_one_sdk/models/new_referral.rb +286 -0
  1072. data/lib/talon_one_sdk/models/new_referrals_for_multiple_advocates.rb +337 -0
  1073. data/lib/talon_one_sdk/models/new_return.rb +167 -0
  1074. data/lib/talon_one_sdk/models/new_revision_version.rb +316 -0
  1075. data/lib/talon_one_sdk/models/new_role.rb +238 -0
  1076. data/lib/talon_one_sdk/models/new_role_v2.rb +221 -0
  1077. data/lib/talon_one_sdk/models/new_ruleset.rb +228 -0
  1078. data/lib/talon_one_sdk/models/new_saml_connection.rb +373 -0
  1079. data/lib/talon_one_sdk/models/new_secondary_deployment.rb +185 -0
  1080. data/lib/talon_one_sdk/models/new_store.rb +272 -0
  1081. data/lib/talon_one_sdk/models/new_template_def.rb +300 -0
  1082. data/lib/talon_one_sdk/models/new_user.rb +244 -0
  1083. data/lib/talon_one_sdk/models/new_webhook.rb +425 -0
  1084. data/lib/talon_one_sdk/models/notification.rb +219 -0
  1085. data/lib/talon_one_sdk/models/notification_activation.rb +165 -0
  1086. data/lib/talon_one_sdk/models/notification_list_item.rb +246 -0
  1087. data/lib/talon_one_sdk/models/okta_event.rb +194 -0
  1088. data/lib/talon_one_sdk/models/okta_event_payload.rb +165 -0
  1089. data/lib/talon_one_sdk/models/okta_event_payload_data.rb +167 -0
  1090. data/lib/talon_one_sdk/models/okta_event_target.rb +220 -0
  1091. data/lib/talon_one_sdk/models/one_time_code.rb +229 -0
  1092. data/lib/talon_one_sdk/models/outgoing_integration_braze_policy.rb +192 -0
  1093. data/lib/talon_one_sdk/models/outgoing_integration_clever_tap_policy.rb +219 -0
  1094. data/lib/talon_one_sdk/models/outgoing_integration_configuration.rb +246 -0
  1095. data/lib/talon_one_sdk/models/outgoing_integration_iterable_policy.rb +192 -0
  1096. data/lib/talon_one_sdk/models/outgoing_integration_mo_engage_policy.rb +246 -0
  1097. data/lib/talon_one_sdk/models/outgoing_integration_template.rb +416 -0
  1098. data/lib/talon_one_sdk/models/outgoing_integration_template_with_configuration_details.rb +450 -0
  1099. data/lib/talon_one_sdk/models/outgoing_integration_templates.rb +150 -0
  1100. data/lib/talon_one_sdk/models/outgoing_integration_type.rb +324 -0
  1101. data/lib/talon_one_sdk/models/outgoing_integration_types.rb +150 -0
  1102. data/lib/talon_one_sdk/models/patch_item_catalog_action.rb +207 -0
  1103. data/lib/talon_one_sdk/models/patch_many_items_catalog_action.rb +171 -0
  1104. data/lib/talon_one_sdk/models/pending_active_points_data.rb +285 -0
  1105. data/lib/talon_one_sdk/models/pending_active_points_notification.rb +244 -0
  1106. data/lib/talon_one_sdk/models/pending_points_notification_policy.rb +198 -0
  1107. data/lib/talon_one_sdk/models/picklist.rb +346 -0
  1108. data/lib/talon_one_sdk/models/price_detail.rb +188 -0
  1109. data/lib/talon_one_sdk/models/price_type.rb +369 -0
  1110. data/lib/talon_one_sdk/models/price_type_reference_detail.rb +253 -0
  1111. data/lib/talon_one_sdk/models/price_type_references.rb +177 -0
  1112. data/lib/talon_one_sdk/models/prismatic_config.rb +193 -0
  1113. data/lib/talon_one_sdk/models/prismatic_event_payload_coupon_based_notifications.rb +404 -0
  1114. data/lib/talon_one_sdk/models/prismatic_event_payload_coupon_based_notifications_limits.rb +227 -0
  1115. data/lib/talon_one_sdk/models/prismatic_event_payload_loyalty_profile_based_notifications.rb +360 -0
  1116. data/lib/talon_one_sdk/models/prismatic_event_payload_loyalty_profile_based_notifications_action.rb +241 -0
  1117. data/lib/talon_one_sdk/models/prismatic_flow.rb +202 -0
  1118. data/lib/talon_one_sdk/models/prismatic_flow_config.rb +164 -0
  1119. data/lib/talon_one_sdk/models/prismatic_flow_with_config.rb +228 -0
  1120. data/lib/talon_one_sdk/models/prismatic_paginated_event_payload.rb +242 -0
  1121. data/lib/talon_one_sdk/models/product.rb +166 -0
  1122. data/lib/talon_one_sdk/models/product_search_match.rb +185 -0
  1123. data/lib/talon_one_sdk/models/product_unit_analytics.rb +192 -0
  1124. data/lib/talon_one_sdk/models/product_unit_analytics_data_point.rb +273 -0
  1125. data/lib/talon_one_sdk/models/product_unit_analytics_totals.rb +148 -0
  1126. data/lib/talon_one_sdk/models/profile_audiences_changes.rb +196 -0
  1127. data/lib/talon_one_sdk/models/projected_tier.rb +185 -0
  1128. data/lib/talon_one_sdk/models/redeem_referral_effect_props.rb +193 -0
  1129. data/lib/talon_one_sdk/models/referral.rb +425 -0
  1130. data/lib/talon_one_sdk/models/referral_constraints.rb +196 -0
  1131. data/lib/talon_one_sdk/models/referral_created_effect_props.rb +166 -0
  1132. data/lib/talon_one_sdk/models/referral_rejection_reason.rb +241 -0
  1133. data/lib/talon_one_sdk/models/reject_coupon_effect_props.rb +233 -0
  1134. data/lib/talon_one_sdk/models/reject_referral_effect_props.rb +233 -0
  1135. data/lib/talon_one_sdk/models/remove_from_audience_effect_props.rb +179 -0
  1136. data/lib/talon_one_sdk/models/remove_item_catalog_action.rb +166 -0
  1137. data/lib/talon_one_sdk/models/remove_many_items_catalog_action.rb +151 -0
  1138. data/lib/talon_one_sdk/models/reopen_session_response.rb +168 -0
  1139. data/lib/talon_one_sdk/models/reserve_coupon_effect_props.rb +220 -0
  1140. data/lib/talon_one_sdk/models/return_integration_request.rb +200 -0
  1141. data/lib/talon_one_sdk/models/returned_cart_item.rb +187 -0
  1142. data/lib/talon_one_sdk/models/revision.rb +339 -0
  1143. data/lib/talon_one_sdk/models/revision_activation.rb +147 -0
  1144. data/lib/talon_one_sdk/models/revision_activation_request.rb +186 -0
  1145. data/lib/talon_one_sdk/models/revision_version.rb +529 -0
  1146. data/lib/talon_one_sdk/models/role.rb +341 -0
  1147. data/lib/talon_one_sdk/models/role_assign.rb +196 -0
  1148. data/lib/talon_one_sdk/models/role_membership.rb +192 -0
  1149. data/lib/talon_one_sdk/models/role_v2.rb +311 -0
  1150. data/lib/talon_one_sdk/models/role_v2_application_details.rb +178 -0
  1151. data/lib/talon_one_sdk/models/role_v2_base.rb +180 -0
  1152. data/lib/talon_one_sdk/models/role_v2_permission_set.rb +203 -0
  1153. data/lib/talon_one_sdk/models/role_v2_permissions.rb +178 -0
  1154. data/lib/talon_one_sdk/models/role_v2_readonly.rb +150 -0
  1155. data/lib/talon_one_sdk/models/role_v2_roles_group.rb +184 -0
  1156. data/lib/talon_one_sdk/models/rollback_added_loyalty_points_effect_props.rb +352 -0
  1157. data/lib/talon_one_sdk/models/rollback_coupon_effect_props.rb +166 -0
  1158. data/lib/talon_one_sdk/models/rollback_deducted_loyalty_points_effect_props.rb +352 -0
  1159. data/lib/talon_one_sdk/models/rollback_discount_effect_props.rb +243 -0
  1160. data/lib/talon_one_sdk/models/rollback_increased_achievement_progress_effect_props.rb +301 -0
  1161. data/lib/talon_one_sdk/models/rollback_referral_effect_props.rb +166 -0
  1162. data/lib/talon_one_sdk/models/rule.rb +274 -0
  1163. data/lib/talon_one_sdk/models/rule_failure_reason.rb +364 -0
  1164. data/lib/talon_one_sdk/models/ruleset.rb +348 -0
  1165. data/lib/talon_one_sdk/models/saml_connection.rb +436 -0
  1166. data/lib/talon_one_sdk/models/saml_connection_internal.rb +210 -0
  1167. data/lib/talon_one_sdk/models/saml_connection_metadata.rb +263 -0
  1168. data/lib/talon_one_sdk/models/saml_login_endpoint.rb +237 -0
  1169. data/lib/talon_one_sdk/models/scim_base_group.rb +161 -0
  1170. data/lib/talon_one_sdk/models/scim_base_user.rb +178 -0
  1171. data/lib/talon_one_sdk/models/scim_base_user_name.rb +149 -0
  1172. data/lib/talon_one_sdk/models/scim_group.rb +195 -0
  1173. data/lib/talon_one_sdk/models/scim_group_member.rb +159 -0
  1174. data/lib/talon_one_sdk/models/scim_groups_list_response.rb +189 -0
  1175. data/lib/talon_one_sdk/models/scim_new_user.rb +202 -0
  1176. data/lib/talon_one_sdk/models/scim_patch_operation.rb +210 -0
  1177. data/lib/talon_one_sdk/models/scim_patch_request.rb +179 -0
  1178. data/lib/talon_one_sdk/models/scim_resource.rb +169 -0
  1179. data/lib/talon_one_sdk/models/scim_resource_types_list_response.rb +167 -0
  1180. data/lib/talon_one_sdk/models/scim_schema_resource.rb +180 -0
  1181. data/lib/talon_one_sdk/models/scim_schemas_list_response.rb +189 -0
  1182. data/lib/talon_one_sdk/models/scim_service_provider_config_response.rb +206 -0
  1183. data/lib/talon_one_sdk/models/scim_service_provider_config_response_bulk.rb +169 -0
  1184. data/lib/talon_one_sdk/models/scim_service_provider_config_response_change_password.rb +149 -0
  1185. data/lib/talon_one_sdk/models/scim_service_provider_config_response_filter.rb +159 -0
  1186. data/lib/talon_one_sdk/models/scim_service_provider_config_response_patch.rb +149 -0
  1187. data/lib/talon_one_sdk/models/scim_service_provider_config_response_sort.rb +149 -0
  1188. data/lib/talon_one_sdk/models/scim_user.rb +229 -0
  1189. data/lib/talon_one_sdk/models/scim_users_list_response.rb +189 -0
  1190. data/lib/talon_one_sdk/models/secondary_deployment.rb +355 -0
  1191. data/lib/talon_one_sdk/models/session.rb +219 -0
  1192. data/lib/talon_one_sdk/models/session_coupons.rb +175 -0
  1193. data/lib/talon_one_sdk/models/set_discount_effect_props.rb +213 -0
  1194. data/lib/talon_one_sdk/models/set_discount_per_additional_cost_effect_props.rb +257 -0
  1195. data/lib/talon_one_sdk/models/set_discount_per_additional_cost_per_item_effect_props.rb +294 -0
  1196. data/lib/talon_one_sdk/models/set_discount_per_item_effect_props.rb +310 -0
  1197. data/lib/talon_one_sdk/models/set_loyalty_points_expiry_date_effect_props.rb +232 -0
  1198. data/lib/talon_one_sdk/models/show_bundle_metadata_effect_props.rb +224 -0
  1199. data/lib/talon_one_sdk/models/show_notification_effect_props.rb +220 -0
  1200. data/lib/talon_one_sdk/models/sku_unit_analytics.rb +192 -0
  1201. data/lib/talon_one_sdk/models/sku_unit_analytics_data_point.rb +246 -0
  1202. data/lib/talon_one_sdk/models/slot_def.rb +266 -0
  1203. data/lib/talon_one_sdk/models/sso_config.rb +175 -0
  1204. data/lib/talon_one_sdk/models/store.rb +393 -0
  1205. data/lib/talon_one_sdk/models/strikethrough_changed_item.rb +333 -0
  1206. data/lib/talon_one_sdk/models/strikethrough_custom_effect_per_item_props.rb +220 -0
  1207. data/lib/talon_one_sdk/models/strikethrough_debug_response.rb +162 -0
  1208. data/lib/talon_one_sdk/models/strikethrough_effect.rb +363 -0
  1209. data/lib/talon_one_sdk/models/strikethrough_labeling_notification.rb +384 -0
  1210. data/lib/talon_one_sdk/models/strikethrough_set_discount_per_item_effect_props.rb +178 -0
  1211. data/lib/talon_one_sdk/models/strikethrough_set_discount_per_item_member_effect_props.rb +178 -0
  1212. data/lib/talon_one_sdk/models/strikethrough_trigger.rb +274 -0
  1213. data/lib/talon_one_sdk/models/summarize_campaign_store_budget200_response.rb +149 -0
  1214. data/lib/talon_one_sdk/models/summary_campaign_store_budget.rb +261 -0
  1215. data/lib/talon_one_sdk/models/talang_attribute.rb +351 -0
  1216. data/lib/talon_one_sdk/models/talang_attribute_visibility.rb +162 -0
  1217. data/lib/talon_one_sdk/models/template_arg_def.rb +304 -0
  1218. data/lib/talon_one_sdk/models/template_def.rb +426 -0
  1219. data/lib/talon_one_sdk/models/template_limit_config.rb +271 -0
  1220. data/lib/talon_one_sdk/models/tier.rb +256 -0
  1221. data/lib/talon_one_sdk/models/tier_downgrade_data.rb +329 -0
  1222. data/lib/talon_one_sdk/models/tier_downgrade_notification.rb +244 -0
  1223. data/lib/talon_one_sdk/models/tier_downgrade_notification_policy.rb +198 -0
  1224. data/lib/talon_one_sdk/models/tier_upgrade_data.rb +366 -0
  1225. data/lib/talon_one_sdk/models/tier_upgrade_notification.rb +244 -0
  1226. data/lib/talon_one_sdk/models/tier_upgrade_notification_policy.rb +198 -0
  1227. data/lib/talon_one_sdk/models/tier_will_downgrade_data.rb +329 -0
  1228. data/lib/talon_one_sdk/models/tier_will_downgrade_notification.rb +244 -0
  1229. data/lib/talon_one_sdk/models/tier_will_downgrade_notification_policy.rb +244 -0
  1230. data/lib/talon_one_sdk/models/tier_will_downgrade_notification_trigger.rb +216 -0
  1231. data/lib/talon_one_sdk/models/time_point.rb +334 -0
  1232. data/lib/talon_one_sdk/models/track_event_v2_response.rb +284 -0
  1233. data/lib/talon_one_sdk/models/transfer_loyalty_card.rb +204 -0
  1234. data/lib/talon_one_sdk/models/trigger_webhook_effect_props.rb +193 -0
  1235. data/lib/talon_one_sdk/models/two_fa_config.rb +175 -0
  1236. data/lib/talon_one_sdk/models/update_account.rb +265 -0
  1237. data/lib/talon_one_sdk/models/update_achievement.rb +339 -0
  1238. data/lib/talon_one_sdk/models/update_application.rb +445 -0
  1239. data/lib/talon_one_sdk/models/update_application_api_key.rb +165 -0
  1240. data/lib/talon_one_sdk/models/update_application_cif.rb +178 -0
  1241. data/lib/talon_one_sdk/models/update_attribute_effect_props.rb +178 -0
  1242. data/lib/talon_one_sdk/models/update_audience.rb +174 -0
  1243. data/lib/talon_one_sdk/models/update_campaign.rb +432 -0
  1244. data/lib/talon_one_sdk/models/update_campaign_collection.rb +148 -0
  1245. data/lib/talon_one_sdk/models/update_campaign_evaluation_group.rb +325 -0
  1246. data/lib/talon_one_sdk/models/update_campaign_group.rb +215 -0
  1247. data/lib/talon_one_sdk/models/update_campaign_template.rb +478 -0
  1248. data/lib/talon_one_sdk/models/update_catalog.rb +170 -0
  1249. data/lib/talon_one_sdk/models/update_collection.rb +160 -0
  1250. data/lib/talon_one_sdk/models/update_coupon.rb +353 -0
  1251. data/lib/talon_one_sdk/models/update_coupon_batch.rb +299 -0
  1252. data/lib/talon_one_sdk/models/update_coupons_data.rb +345 -0
  1253. data/lib/talon_one_sdk/models/update_custom_effect.rb +345 -0
  1254. data/lib/talon_one_sdk/models/update_customer_profile_v2409_response.rb +167 -0
  1255. data/lib/talon_one_sdk/models/update_customer_session_v2409_response.rb +167 -0
  1256. data/lib/talon_one_sdk/models/update_loyalty_card.rb +175 -0
  1257. data/lib/talon_one_sdk/models/update_loyalty_program.rb +397 -0
  1258. data/lib/talon_one_sdk/models/update_loyalty_program_tier.rb +214 -0
  1259. data/lib/talon_one_sdk/models/update_picklist.rb +234 -0
  1260. data/lib/talon_one_sdk/models/update_price_type.rb +204 -0
  1261. data/lib/talon_one_sdk/models/update_referral.rb +235 -0
  1262. data/lib/talon_one_sdk/models/update_referral_batch.rb +233 -0
  1263. data/lib/talon_one_sdk/models/update_role.rb +180 -0
  1264. data/lib/talon_one_sdk/models/update_store.rb +220 -0
  1265. data/lib/talon_one_sdk/models/update_user.rb +234 -0
  1266. data/lib/talon_one_sdk/models/user.rb +497 -0
  1267. data/lib/talon_one_sdk/models/user_entity.rb +165 -0
  1268. data/lib/talon_one_sdk/models/value_map.rb +217 -0
  1269. data/lib/talon_one_sdk/models/webhook.rb +515 -0
  1270. data/lib/talon_one_sdk/models/webhook_authentication.rb +399 -0
  1271. data/lib/talon_one_sdk/models/webhook_authentication_base.rb +227 -0
  1272. data/lib/talon_one_sdk/models/webhook_authentication_data_basic.rb +192 -0
  1273. data/lib/talon_one_sdk/models/webhook_authentication_data_custom.rb +166 -0
  1274. data/lib/talon_one_sdk/models/webhook_authentication_webhook_ref.rb +213 -0
  1275. data/lib/talon_one_sdk/models/webhook_with_outgoing_integration_details.rb +543 -0
  1276. data/lib/talon_one_sdk/models/will_award_giveaway_effect_props.rb +229 -0
  1277. data/lib/talon_one_sdk/version.rb +15 -0
  1278. data/lib/talon_one_sdk.rb +670 -0
  1279. data/spec/api/integration_api_spec.rb +500 -0
  1280. data/spec/api/management_api_spec.rb +2575 -0
  1281. data/spec/models/accept_coupon_effect_props_spec.rb +36 -0
  1282. data/spec/models/accept_referral_effect_props_spec.rb +36 -0
  1283. data/spec/models/access_log_entry_spec.rb +72 -0
  1284. data/spec/models/account_additional_cost_spec.rb +82 -0
  1285. data/spec/models/account_analytics_spec.rb +150 -0
  1286. data/spec/models/account_dashboard_statistic_campaigns_spec.rb +48 -0
  1287. data/spec/models/account_dashboard_statistic_discount_spec.rb +48 -0
  1288. data/spec/models/account_dashboard_statistic_loyalty_points_spec.rb +42 -0
  1289. data/spec/models/account_dashboard_statistic_referrals_spec.rb +42 -0
  1290. data/spec/models/account_dashboard_statistic_revenue_spec.rb +48 -0
  1291. data/spec/models/account_dashboard_statistic_spec.rb +60 -0
  1292. data/spec/models/account_entity_spec.rb +36 -0
  1293. data/spec/models/account_limits_spec.rb +114 -0
  1294. data/spec/models/account_spec.rb +142 -0
  1295. data/spec/models/achievement_additional_properties_spec.rb +64 -0
  1296. data/spec/models/achievement_base_spec.rb +104 -0
  1297. data/spec/models/achievement_progress_spec.rb +64 -0
  1298. data/spec/models/achievement_progress_with_definition_spec.rb +138 -0
  1299. data/spec/models/achievement_spec.rb +150 -0
  1300. data/spec/models/achievement_status_entry_spec.rb +138 -0
  1301. data/spec/models/activate_loyalty_points_response_spec.rb +36 -0
  1302. data/spec/models/activate_loyalty_points_spec.rb +42 -0
  1303. data/spec/models/activate_user_request_spec.rb +36 -0
  1304. data/spec/models/add_free_item_effect_props_spec.rb +48 -0
  1305. data/spec/models/add_item_catalog_action_spec.rb +60 -0
  1306. data/spec/models/add_loyalty_points_effect_props_spec.rb +126 -0
  1307. data/spec/models/add_loyalty_points_spec.rb +78 -0
  1308. data/spec/models/add_price_adjustment_catalog_action_spec.rb +42 -0
  1309. data/spec/models/add_to_audience_effect_props_spec.rb +54 -0
  1310. data/spec/models/added_deducted_points_balances_action_spec.rb +64 -0
  1311. data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +46 -0
  1312. data/spec/models/added_deducted_points_balances_notification_spec.rb +98 -0
  1313. data/spec/models/added_deducted_points_notification_policy_spec.rb +46 -0
  1314. data/spec/models/added_deducted_points_notification_spec.rb +120 -0
  1315. data/spec/models/additional_campaign_properties_spec.rb +178 -0
  1316. data/spec/models/additional_cost_spec.rb +36 -0
  1317. data/spec/models/analytics_data_point_spec.rb +42 -0
  1318. data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +48 -0
  1319. data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +48 -0
  1320. data/spec/models/analytics_data_point_with_trend_spec.rb +42 -0
  1321. data/spec/models/analytics_product_spec.rb +54 -0
  1322. data/spec/models/analytics_sku_spec.rb +66 -0
  1323. data/spec/models/api_error_spec.rb +48 -0
  1324. data/spec/models/application_analytics_data_point_spec.rb +78 -0
  1325. data/spec/models/application_api_health_spec.rb +46 -0
  1326. data/spec/models/application_api_key_spec.rb +98 -0
  1327. data/spec/models/application_campaign_analytics_spec.rb +106 -0
  1328. data/spec/models/application_campaign_stats_spec.rb +66 -0
  1329. data/spec/models/application_cif_expression_spec.rb +66 -0
  1330. data/spec/models/application_cif_references_spec.rb +42 -0
  1331. data/spec/models/application_cif_spec.rb +84 -0
  1332. data/spec/models/application_customer_entity_spec.rb +36 -0
  1333. data/spec/models/application_customer_spec.rb +102 -0
  1334. data/spec/models/application_entity_spec.rb +36 -0
  1335. data/spec/models/application_event_spec.rb +96 -0
  1336. data/spec/models/application_notification_spec.rb +36 -0
  1337. data/spec/models/application_referee_spec.rb +66 -0
  1338. data/spec/models/application_session_entity_spec.rb +36 -0
  1339. data/spec/models/application_session_spec.rb +124 -0
  1340. data/spec/models/application_spec.rb +174 -0
  1341. data/spec/models/application_store_entity_spec.rb +36 -0
  1342. data/spec/models/async_coupon_creation_response_spec.rb +36 -0
  1343. data/spec/models/async_coupon_deletion_job_response_spec.rb +36 -0
  1344. data/spec/models/async_coupons_data_spec.rb +64 -0
  1345. data/spec/models/attribute_spec.rb +144 -0
  1346. data/spec/models/attributes_mandatory_spec.rb +42 -0
  1347. data/spec/models/attributes_settings_spec.rb +36 -0
  1348. data/spec/models/audience_analytics_spec.rb +42 -0
  1349. data/spec/models/audience_customer_spec.rb +108 -0
  1350. data/spec/models/audience_integration_id_spec.rb +36 -0
  1351. data/spec/models/audience_membership_spec.rb +42 -0
  1352. data/spec/models/audience_reference_spec.rb +48 -0
  1353. data/spec/models/audience_spec.rb +90 -0
  1354. data/spec/models/award_giveaway_effect_props_spec.rb +60 -0
  1355. data/spec/models/base_campaign_spec.rb +132 -0
  1356. data/spec/models/base_loyalty_program_spec.rb +136 -0
  1357. data/spec/models/base_notification_entity_spec.rb +42 -0
  1358. data/spec/models/base_notification_spec.rb +64 -0
  1359. data/spec/models/base_notification_webhook_spec.rb +66 -0
  1360. data/spec/models/base_notifications_spec.rb +36 -0
  1361. data/spec/models/base_saml_connection_spec.rb +78 -0
  1362. data/spec/models/best_prior_price_metadata_spec.rb +42 -0
  1363. data/spec/models/best_prior_price_request_spec.rb +60 -0
  1364. data/spec/models/best_prior_price_request_target_spec.rb +46 -0
  1365. data/spec/models/best_prior_price_spec.rb +66 -0
  1366. data/spec/models/binding_spec.rb +78 -0
  1367. data/spec/models/bulk_application_notification_spec.rb +42 -0
  1368. data/spec/models/bulk_operation_on_campaigns_spec.rb +52 -0
  1369. data/spec/models/campaign_activation_request_spec.rb +36 -0
  1370. data/spec/models/campaign_analytics_spec.rb +180 -0
  1371. data/spec/models/campaign_budget_spec.rb +48 -0
  1372. data/spec/models/campaign_collection_edited_notification_item_spec.rb +54 -0
  1373. data/spec/models/campaign_collection_edited_notification_spec.rb +52 -0
  1374. data/spec/models/campaign_collection_spec.rb +96 -0
  1375. data/spec/models/campaign_collection_without_payload_spec.rb +90 -0
  1376. data/spec/models/campaign_copy_spec.rb +72 -0
  1377. data/spec/models/campaign_created_notification_item_spec.rb +54 -0
  1378. data/spec/models/campaign_created_notification_spec.rb +52 -0
  1379. data/spec/models/campaign_deactivation_request_spec.rb +36 -0
  1380. data/spec/models/campaign_deleted_notification_item_spec.rb +48 -0
  1381. data/spec/models/campaign_deleted_notification_spec.rb +52 -0
  1382. data/spec/models/campaign_detail_spec.rb +42 -0
  1383. data/spec/models/campaign_edited_notification_item_spec.rb +54 -0
  1384. data/spec/models/campaign_edited_notification_spec.rb +52 -0
  1385. data/spec/models/campaign_entity_spec.rb +36 -0
  1386. data/spec/models/campaign_evaluation_group_spec.rb +86 -0
  1387. data/spec/models/campaign_evaluation_position_spec.rb +48 -0
  1388. data/spec/models/campaign_evaluation_tree_changed_message_spec.rb +52 -0
  1389. data/spec/models/campaign_evaluation_tree_changed_notification_spec.rb +48 -0
  1390. data/spec/models/campaign_group_entity_spec.rb +36 -0
  1391. data/spec/models/campaign_group_spec.rb +78 -0
  1392. data/spec/models/campaign_log_summary_spec.rb +64 -0
  1393. data/spec/models/campaign_notification_base_spec.rb +46 -0
  1394. data/spec/models/campaign_notification_generic_spec.rb +52 -0
  1395. data/spec/models/campaign_notification_item_base_spec.rb +36 -0
  1396. data/spec/models/campaign_notification_policy_spec.rb +48 -0
  1397. data/spec/models/campaign_ruleset_changed_notification_item_spec.rb +54 -0
  1398. data/spec/models/campaign_ruleset_changed_notification_spec.rb +52 -0
  1399. data/spec/models/campaign_search_spec.rb +36 -0
  1400. data/spec/models/campaign_set_branch_node_spec.rb +100 -0
  1401. data/spec/models/campaign_set_leaf_node_spec.rb +46 -0
  1402. data/spec/models/campaign_set_node_spec.rb +36 -0
  1403. data/spec/models/campaign_set_spec.rb +60 -0
  1404. data/spec/models/campaign_spec.rb +350 -0
  1405. data/spec/models/campaign_state_changed_notification_item_spec.rb +60 -0
  1406. data/spec/models/campaign_state_changed_notification_spec.rb +52 -0
  1407. data/spec/models/campaign_store_budget_limit_config_spec.rb +68 -0
  1408. data/spec/models/campaign_store_budget_spec.rb +60 -0
  1409. data/spec/models/campaign_template_collection_spec.rb +42 -0
  1410. data/spec/models/campaign_template_coupon_reservation_settings_spec.rb +42 -0
  1411. data/spec/models/campaign_template_params_spec.rb +58 -0
  1412. data/spec/models/campaign_template_spec.rb +204 -0
  1413. data/spec/models/campaign_versions_spec.rb +76 -0
  1414. data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +46 -0
  1415. data/spec/models/card_added_deducted_points_balances_notification_spec.rb +110 -0
  1416. data/spec/models/card_added_deducted_points_notification_policy_spec.rb +46 -0
  1417. data/spec/models/card_added_deducted_points_notification_spec.rb +132 -0
  1418. data/spec/models/card_expiring_points_notification_policy_spec.rb +54 -0
  1419. data/spec/models/card_expiring_points_notification_trigger_spec.rb +46 -0
  1420. data/spec/models/card_ledger_points_entry_integration_api_spec.rb +96 -0
  1421. data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +118 -0
  1422. data/spec/models/card_ledger_transaction_log_entry_spec.rb +118 -0
  1423. data/spec/models/cart_item_spec.rb +156 -0
  1424. data/spec/models/catalog_action_filter_spec.rb +52 -0
  1425. data/spec/models/catalog_item_spec.rb +78 -0
  1426. data/spec/models/catalog_spec.rb +84 -0
  1427. data/spec/models/catalog_sync_request_spec.rb +42 -0
  1428. data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +48 -0
  1429. data/spec/models/change_loyalty_tier_level_effect_props_spec.rb +66 -0
  1430. data/spec/models/change_profile_password_spec.rb +42 -0
  1431. data/spec/models/change_spec.rb +78 -0
  1432. data/spec/models/code_generator_settings_spec.rb +42 -0
  1433. data/spec/models/collection_item_spec.rb +36 -0
  1434. data/spec/models/collection_spec.rb +102 -0
  1435. data/spec/models/collection_without_payload_spec.rb +96 -0
  1436. data/spec/models/coupon_constraints_spec.rb +60 -0
  1437. data/spec/models/coupon_created_effect_props_spec.rb +42 -0
  1438. data/spec/models/coupon_creation_job_spec.rb +162 -0
  1439. data/spec/models/coupon_deletion_filters_spec.rb +118 -0
  1440. data/spec/models/coupon_deletion_job_spec.rb +102 -0
  1441. data/spec/models/coupon_entity_spec.rb +42 -0
  1442. data/spec/models/coupon_failure_summary_spec.rb +96 -0
  1443. data/spec/models/coupon_limit_configs_spec.rb +36 -0
  1444. data/spec/models/coupon_rejection_reason_spec.rb +52 -0
  1445. data/spec/models/coupon_rejections_spec.rb +48 -0
  1446. data/spec/models/coupon_reservations_spec.rb +36 -0
  1447. data/spec/models/coupon_search_spec.rb +36 -0
  1448. data/spec/models/coupon_spec.rb +162 -0
  1449. data/spec/models/coupon_value_spec.rb +36 -0
  1450. data/spec/models/coupons_notification_data_spec.rb +70 -0
  1451. data/spec/models/coupons_notification_policy_spec.rb +64 -0
  1452. data/spec/models/create_achievement_spec.rb +104 -0
  1453. data/spec/models/create_application_api_key_spec.rb +68 -0
  1454. data/spec/models/create_coupon_data_spec.rb +76 -0
  1455. data/spec/models/create_coupons200_response_spec.rb +42 -0
  1456. data/spec/models/create_management_key_spec.rb +54 -0
  1457. data/spec/models/create_referrals_for_multiple_advocates201_response_spec.rb +42 -0
  1458. data/spec/models/create_template_campaign_response_spec.rb +48 -0
  1459. data/spec/models/create_template_campaign_spec.rb +90 -0
  1460. data/spec/models/custom_effect_props_spec.rb +72 -0
  1461. data/spec/models/custom_effect_spec.rb +114 -0
  1462. data/spec/models/customer_activity_report_spec.rb +108 -0
  1463. data/spec/models/customer_analytics_spec.rb +72 -0
  1464. data/spec/models/customer_inventory_spec.rb +66 -0
  1465. data/spec/models/customer_profile_audience_request_item_spec.rb +52 -0
  1466. data/spec/models/customer_profile_audience_request_spec.rb +36 -0
  1467. data/spec/models/customer_profile_entity_spec.rb +42 -0
  1468. data/spec/models/customer_profile_integration_request_v2_spec.rb +58 -0
  1469. data/spec/models/customer_profile_integration_response_v2_spec.rb +84 -0
  1470. data/spec/models/customer_profile_search_query_spec.rb +48 -0
  1471. data/spec/models/customer_profile_spec.rb +96 -0
  1472. data/spec/models/customer_profile_update_v2_response_spec.rb +36 -0
  1473. data/spec/models/customer_session_spec.rb +124 -0
  1474. data/spec/models/customer_session_v2_spec.rb +160 -0
  1475. data/spec/models/deactivate_user_request_spec.rb +36 -0
  1476. data/spec/models/deduct_loyalty_points_effect_props_spec.rb +72 -0
  1477. data/spec/models/deduct_loyalty_points_spec.rb +54 -0
  1478. data/spec/models/delete_coupons_data_spec.rb +82 -0
  1479. data/spec/models/delete_user_request_spec.rb +36 -0
  1480. data/spec/models/effect_entity_spec.rb +120 -0
  1481. data/spec/models/effect_spec.rb +126 -0
  1482. data/spec/models/email_entity_spec.rb +36 -0
  1483. data/spec/models/endpoint_spec.rb +36 -0
  1484. data/spec/models/entity_spec.rb +42 -0
  1485. data/spec/models/entity_with_talang_visible_id_spec.rb +42 -0
  1486. data/spec/models/environment_spec.rb +126 -0
  1487. data/spec/models/error_effect_props_spec.rb +36 -0
  1488. data/spec/models/error_response_spec.rb +42 -0
  1489. data/spec/models/error_response_with_status_spec.rb +48 -0
  1490. data/spec/models/error_source_spec.rb +54 -0
  1491. data/spec/models/evaluable_campaign_ids_spec.rb +36 -0
  1492. data/spec/models/event_spec.rb +96 -0
  1493. data/spec/models/event_type_spec.rb +60 -0
  1494. data/spec/models/event_v2_spec.rb +60 -0
  1495. data/spec/models/event_v3_spec.rb +78 -0
  1496. data/spec/models/expiring_card_points_data_spec.rb +72 -0
  1497. data/spec/models/expiring_card_points_notification_spec.rb +52 -0
  1498. data/spec/models/expiring_coupons_data_spec.rb +90 -0
  1499. data/spec/models/expiring_coupons_notification_policy_spec.rb +54 -0
  1500. data/spec/models/expiring_coupons_notification_spec.rb +52 -0
  1501. data/spec/models/expiring_coupons_notification_trigger_spec.rb +46 -0
  1502. data/spec/models/expiring_points_data_spec.rb +60 -0
  1503. data/spec/models/expiring_points_notification_policy_spec.rb +54 -0
  1504. data/spec/models/expiring_points_notification_spec.rb +52 -0
  1505. data/spec/models/expiring_points_notification_trigger_spec.rb +46 -0
  1506. data/spec/models/export_spec.rb +70 -0
  1507. data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +54 -0
  1508. data/spec/models/extended_coupon_spec.rb +168 -0
  1509. data/spec/models/feature_flag_spec.rb +54 -0
  1510. data/spec/models/features_feed_spec.rb +42 -0
  1511. data/spec/models/func_arg_def_spec.rb +46 -0
  1512. data/spec/models/function_def_spec.rb +60 -0
  1513. data/spec/models/generate_audit_log_summary_spec.rb +36 -0
  1514. data/spec/models/generate_campaign_description_spec.rb +48 -0
  1515. data/spec/models/generate_campaign_summary_spec.rb +48 -0
  1516. data/spec/models/generate_campaign_tags_spec.rb +36 -0
  1517. data/spec/models/generate_coupon_failure_detailed_summary_spec.rb +60 -0
  1518. data/spec/models/generate_coupon_failure_summary_spec.rb +42 -0
  1519. data/spec/models/generate_item_filter_description_spec.rb +36 -0
  1520. data/spec/models/generate_loyalty_card_spec.rb +52 -0
  1521. data/spec/models/generate_rule_title_rule_spec.rb +42 -0
  1522. data/spec/models/generate_rule_title_spec.rb +42 -0
  1523. data/spec/models/generate_user_session_summary_spec.rb +42 -0
  1524. data/spec/models/get_access_logs_without_total_count200_response_spec.rb +42 -0
  1525. data/spec/models/get_additional_costs200_response_spec.rb +42 -0
  1526. data/spec/models/get_application_customer_friends200_response_spec.rb +48 -0
  1527. data/spec/models/get_application_customers200_response_spec.rb +48 -0
  1528. data/spec/models/get_application_customers_by_attributes200_response_spec.rb +48 -0
  1529. data/spec/models/get_application_event_types200_response_spec.rb +42 -0
  1530. data/spec/models/get_application_events_without_total_count200_response_spec.rb +42 -0
  1531. data/spec/models/get_application_sessions200_response_spec.rb +42 -0
  1532. data/spec/models/get_applications200_response_spec.rb +42 -0
  1533. data/spec/models/get_attributes200_response_spec.rb +42 -0
  1534. data/spec/models/get_audience_memberships200_response_spec.rb +42 -0
  1535. data/spec/models/get_audiences200_response_spec.rb +48 -0
  1536. data/spec/models/get_audiences_analytics200_response_spec.rb +42 -0
  1537. data/spec/models/get_campaign_analytics200_response_spec.rb +42 -0
  1538. data/spec/models/get_campaign_groups200_response_spec.rb +42 -0
  1539. data/spec/models/get_campaign_templates200_response_spec.rb +42 -0
  1540. data/spec/models/get_campaigns200_response_spec.rb +42 -0
  1541. data/spec/models/get_changes200_response_spec.rb +48 -0
  1542. data/spec/models/get_collection_items200_response_spec.rb +42 -0
  1543. data/spec/models/get_coupons_without_total_count200_response_spec.rb +42 -0
  1544. data/spec/models/get_customer_achievement_history200_response_spec.rb +42 -0
  1545. data/spec/models/get_customer_achievements200_response_spec.rb +42 -0
  1546. data/spec/models/get_customer_activity_reports_without_total_count200_response_spec.rb +42 -0
  1547. data/spec/models/get_customer_profile_achievement_progress200_response_spec.rb +42 -0
  1548. data/spec/models/get_customer_profiles200_response_spec.rb +42 -0
  1549. data/spec/models/get_customers_by_attributes200_response_spec.rb +48 -0
  1550. data/spec/models/get_dashboard_statistics200_response_spec.rb +42 -0
  1551. data/spec/models/get_event_types200_response_spec.rb +42 -0
  1552. data/spec/models/get_exports200_response_spec.rb +42 -0
  1553. data/spec/models/get_integration_coupon_request_spec.rb +42 -0
  1554. data/spec/models/get_loyalty_card_points200_response_spec.rb +42 -0
  1555. data/spec/models/get_loyalty_card_transaction_logs200_response_spec.rb +42 -0
  1556. data/spec/models/get_loyalty_card_transactions200_response_spec.rb +42 -0
  1557. data/spec/models/get_loyalty_cards200_response_spec.rb +42 -0
  1558. data/spec/models/get_loyalty_program_profile_points200_response_spec.rb +42 -0
  1559. data/spec/models/get_loyalty_program_profile_transactions200_response_spec.rb +42 -0
  1560. data/spec/models/get_loyalty_program_transactions200_response_spec.rb +42 -0
  1561. data/spec/models/get_loyalty_programs200_response_spec.rb +42 -0
  1562. data/spec/models/get_referrals_without_total_count200_response_spec.rb +42 -0
  1563. data/spec/models/get_reserved_customers200_response_spec.rb +42 -0
  1564. data/spec/models/get_rulesets200_response_spec.rb +42 -0
  1565. data/spec/models/get_users200_response_spec.rb +42 -0
  1566. data/spec/models/get_webhooks200_response_spec.rb +42 -0
  1567. data/spec/models/giveaway_spec.rb +96 -0
  1568. data/spec/models/giveaways_pool_spec.rb +90 -0
  1569. data/spec/models/hidden_conditions_effects_spec.rb +54 -0
  1570. data/spec/models/identifiable_entity_spec.rb +36 -0
  1571. data/spec/models/import_entity_spec.rb +36 -0
  1572. data/spec/models/import_spec.rb +66 -0
  1573. data/spec/models/increase_achievement_progress_effect_props_spec.rb +72 -0
  1574. data/spec/models/integration_coupon_spec.rb +168 -0
  1575. data/spec/models/integration_customer_profile_audience_request_item_spec.rb +52 -0
  1576. data/spec/models/integration_customer_profile_audience_request_spec.rb +36 -0
  1577. data/spec/models/integration_customer_session_response_spec.rb +42 -0
  1578. data/spec/models/integration_entity_spec.rb +42 -0
  1579. data/spec/models/integration_event_spec.rb +54 -0
  1580. data/spec/models/integration_event_v2_request_spec.rb +76 -0
  1581. data/spec/models/integration_event_v3_request_spec.rb +94 -0
  1582. data/spec/models/integration_event_v3_response_spec.rb +84 -0
  1583. data/spec/models/integration_profile_entity_spec.rb +36 -0
  1584. data/spec/models/integration_profile_entity_v3_spec.rb +36 -0
  1585. data/spec/models/integration_request_spec.rb +46 -0
  1586. data/spec/models/integration_state_spec.rb +60 -0
  1587. data/spec/models/integration_state_v2_spec.rb +114 -0
  1588. data/spec/models/integration_store_entity_spec.rb +36 -0
  1589. data/spec/models/inventory_coupon_spec.rb +174 -0
  1590. data/spec/models/inventory_referral_spec.rb +114 -0
  1591. data/spec/models/item_attribute_spec.rb +48 -0
  1592. data/spec/models/label_target_audience_spec.rb +46 -0
  1593. data/spec/models/label_target_none_spec.rb +40 -0
  1594. data/spec/models/ledger_entry_spec.rb +90 -0
  1595. data/spec/models/ledger_info_spec.rb +90 -0
  1596. data/spec/models/ledger_points_entry_integration_api_spec.rb +90 -0
  1597. data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +118 -0
  1598. data/spec/models/library_attribute_spec.rb +80 -0
  1599. data/spec/models/limit_config_spec.rb +62 -0
  1600. data/spec/models/limit_counter_spec.rb +120 -0
  1601. data/spec/models/list_account_collections200_response_spec.rb +48 -0
  1602. data/spec/models/list_achievements200_response_spec.rb +42 -0
  1603. data/spec/models/list_all_roles_v2200_response_spec.rb +42 -0
  1604. data/spec/models/list_campaign_store_budget_limits200_response_spec.rb +36 -0
  1605. data/spec/models/list_campaign_store_budgets_spec.rb +54 -0
  1606. data/spec/models/list_campaign_store_budgets_store_spec.rb +48 -0
  1607. data/spec/models/list_catalog_items200_response_spec.rb +48 -0
  1608. data/spec/models/list_stores200_response_spec.rb +48 -0
  1609. data/spec/models/login_params_spec.rb +42 -0
  1610. data/spec/models/loyalty_balance_spec.rb +60 -0
  1611. data/spec/models/loyalty_balance_with_tier_spec.rb +84 -0
  1612. data/spec/models/loyalty_balances_spec.rb +42 -0
  1613. data/spec/models/loyalty_balances_with_tiers_spec.rb +42 -0
  1614. data/spec/models/loyalty_card_balances_spec.rb +48 -0
  1615. data/spec/models/loyalty_card_batch_response_spec.rb +42 -0
  1616. data/spec/models/loyalty_card_batch_spec.rb +58 -0
  1617. data/spec/models/loyalty_card_profile_registration_spec.rb +42 -0
  1618. data/spec/models/loyalty_card_registration_spec.rb +36 -0
  1619. data/spec/models/loyalty_card_spec.rb +126 -0
  1620. data/spec/models/loyalty_dashboard_data_spec.rb +90 -0
  1621. data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +42 -0
  1622. data/spec/models/loyalty_ledger_entry_expiry_date_change_spec.rb +48 -0
  1623. data/spec/models/loyalty_ledger_entry_flags_spec.rb +36 -0
  1624. data/spec/models/loyalty_ledger_entry_spec.rb +120 -0
  1625. data/spec/models/loyalty_ledger_spec.rb +42 -0
  1626. data/spec/models/loyalty_ledger_transactions_spec.rb +42 -0
  1627. data/spec/models/loyalty_membership_spec.rb +42 -0
  1628. data/spec/models/loyalty_program_balance_spec.rb +78 -0
  1629. data/spec/models/loyalty_program_entity_spec.rb +48 -0
  1630. data/spec/models/loyalty_program_ledgers_spec.rb +66 -0
  1631. data/spec/models/loyalty_program_spec.rb +202 -0
  1632. data/spec/models/loyalty_program_transaction_spec.rb +154 -0
  1633. data/spec/models/loyalty_spec.rb +42 -0
  1634. data/spec/models/loyalty_sub_ledger_spec.rb +102 -0
  1635. data/spec/models/loyalty_tier_spec.rb +72 -0
  1636. data/spec/models/management_key_spec.rb +90 -0
  1637. data/spec/models/manager_config_spec.rb +36 -0
  1638. data/spec/models/message_log_entries_spec.rb +42 -0
  1639. data/spec/models/message_log_entry_spec.rb +124 -0
  1640. data/spec/models/message_log_request_spec.rb +42 -0
  1641. data/spec/models/message_log_response_spec.rb +48 -0
  1642. data/spec/models/message_test_spec.rb +42 -0
  1643. data/spec/models/meta_spec.rb +60 -0
  1644. data/spec/models/model_return_spec.rb +96 -0
  1645. data/spec/models/multi_application_entity_spec.rb +36 -0
  1646. data/spec/models/multiple_attribute_spec.rb +36 -0
  1647. data/spec/models/multiple_audiences_item_spec.rb +64 -0
  1648. data/spec/models/multiple_audiences_spec.rb +42 -0
  1649. data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +42 -0
  1650. data/spec/models/multiple_customer_profile_integration_request_spec.rb +36 -0
  1651. data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +36 -0
  1652. data/spec/models/multiple_new_attribute_spec.rb +36 -0
  1653. data/spec/models/multiple_new_audiences_spec.rb +36 -0
  1654. data/spec/models/mutable_entity_spec.rb +36 -0
  1655. data/spec/models/new_account_sign_up_spec.rb +48 -0
  1656. data/spec/models/new_account_spec.rb +36 -0
  1657. data/spec/models/new_additional_cost_spec.rb +64 -0
  1658. data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +42 -0
  1659. data/spec/models/new_application_api_key_spec.rb +104 -0
  1660. data/spec/models/new_application_cif_expression_spec.rb +48 -0
  1661. data/spec/models/new_application_cif_spec.rb +66 -0
  1662. data/spec/models/new_application_spec.rb +138 -0
  1663. data/spec/models/new_attribute_spec.rb +120 -0
  1664. data/spec/models/new_audience_spec.rb +72 -0
  1665. data/spec/models/new_base_notification_spec.rb +48 -0
  1666. data/spec/models/new_campaign_collection_spec.rb +42 -0
  1667. data/spec/models/new_campaign_evaluation_group_spec.rb +74 -0
  1668. data/spec/models/new_campaign_group_spec.rb +54 -0
  1669. data/spec/models/new_campaign_set_spec.rb +48 -0
  1670. data/spec/models/new_campaign_spec.rb +138 -0
  1671. data/spec/models/new_campaign_store_budget_spec.rb +56 -0
  1672. data/spec/models/new_campaign_store_budget_store_limit_spec.rb +42 -0
  1673. data/spec/models/new_campaign_template_spec.rb +138 -0
  1674. data/spec/models/new_catalog_spec.rb +48 -0
  1675. data/spec/models/new_collection_spec.rb +48 -0
  1676. data/spec/models/new_coupon_creation_job_spec.rb +78 -0
  1677. data/spec/models/new_coupon_deletion_job_spec.rb +36 -0
  1678. data/spec/models/new_coupons_for_multiple_recipients_spec.rb +84 -0
  1679. data/spec/models/new_coupons_spec.rb +114 -0
  1680. data/spec/models/new_custom_effect_spec.rb +78 -0
  1681. data/spec/models/new_customer_profile_spec.rb +36 -0
  1682. data/spec/models/new_customer_session_spec.rb +82 -0
  1683. data/spec/models/new_customer_session_v2_spec.rb +100 -0
  1684. data/spec/models/new_event_spec.rb +60 -0
  1685. data/spec/models/new_event_type_spec.rb +48 -0
  1686. data/spec/models/new_external_invitation_spec.rb +48 -0
  1687. data/spec/models/new_giveaways_pool_spec.rb +54 -0
  1688. data/spec/models/new_internal_audience_spec.rb +48 -0
  1689. data/spec/models/new_invitation_spec.rb +60 -0
  1690. data/spec/models/new_invite_email_spec.rb +42 -0
  1691. data/spec/models/new_loyalty_program_spec.rb +160 -0
  1692. data/spec/models/new_loyalty_tier_spec.rb +42 -0
  1693. data/spec/models/new_management_key_spec.rb +96 -0
  1694. data/spec/models/new_message_test_spec.rb +76 -0
  1695. data/spec/models/new_multiple_audiences_item_spec.rb +42 -0
  1696. data/spec/models/new_notification_webhook_spec.rb +48 -0
  1697. data/spec/models/new_outgoing_integration_webhook_spec.rb +48 -0
  1698. data/spec/models/new_password_email_spec.rb +36 -0
  1699. data/spec/models/new_password_spec.rb +42 -0
  1700. data/spec/models/new_picklist_spec.rb +46 -0
  1701. data/spec/models/new_price_adjustment_spec.rb +72 -0
  1702. data/spec/models/new_price_type_spec.rb +54 -0
  1703. data/spec/models/new_referral_spec.rb +72 -0
  1704. data/spec/models/new_referrals_for_multiple_advocates_spec.rb +78 -0
  1705. data/spec/models/new_return_spec.rb +36 -0
  1706. data/spec/models/new_revision_version_spec.rb +100 -0
  1707. data/spec/models/new_role_spec.rb +54 -0
  1708. data/spec/models/new_role_v2_spec.rb +54 -0
  1709. data/spec/models/new_ruleset_spec.rb +60 -0
  1710. data/spec/models/new_saml_connection_spec.rb +84 -0
  1711. data/spec/models/new_secondary_deployment_spec.rb +36 -0
  1712. data/spec/models/new_store_spec.rb +54 -0
  1713. data/spec/models/new_template_def_spec.rb +72 -0
  1714. data/spec/models/new_user_spec.rb +54 -0
  1715. data/spec/models/new_webhook_spec.rb +100 -0
  1716. data/spec/models/notification_activation_spec.rb +36 -0
  1717. data/spec/models/notification_list_item_spec.rb +54 -0
  1718. data/spec/models/notification_spec.rb +48 -0
  1719. data/spec/models/okta_event_payload_data_spec.rb +36 -0
  1720. data/spec/models/okta_event_payload_spec.rb +36 -0
  1721. data/spec/models/okta_event_spec.rb +42 -0
  1722. data/spec/models/okta_event_target_spec.rb +48 -0
  1723. data/spec/models/one_time_code_spec.rb +54 -0
  1724. data/spec/models/outgoing_integration_braze_policy_spec.rb +42 -0
  1725. data/spec/models/outgoing_integration_clever_tap_policy_spec.rb +48 -0
  1726. data/spec/models/outgoing_integration_configuration_spec.rb +54 -0
  1727. data/spec/models/outgoing_integration_iterable_policy_spec.rb +42 -0
  1728. data/spec/models/outgoing_integration_mo_engage_policy_spec.rb +54 -0
  1729. data/spec/models/outgoing_integration_template_spec.rb +82 -0
  1730. data/spec/models/outgoing_integration_template_with_configuration_details_spec.rb +88 -0
  1731. data/spec/models/outgoing_integration_templates_spec.rb +36 -0
  1732. data/spec/models/outgoing_integration_type_spec.rb +60 -0
  1733. data/spec/models/outgoing_integration_types_spec.rb +36 -0
  1734. data/spec/models/patch_item_catalog_action_spec.rb +60 -0
  1735. data/spec/models/patch_many_items_catalog_action_spec.rb +48 -0
  1736. data/spec/models/pending_active_points_data_spec.rb +72 -0
  1737. data/spec/models/pending_active_points_notification_spec.rb +52 -0
  1738. data/spec/models/pending_points_notification_policy_spec.rb +48 -0
  1739. data/spec/models/picklist_spec.rb +82 -0
  1740. data/spec/models/price_detail_spec.rb +60 -0
  1741. data/spec/models/price_type_reference_detail_spec.rb +58 -0
  1742. data/spec/models/price_type_references_spec.rb +42 -0
  1743. data/spec/models/price_type_spec.rb +84 -0
  1744. data/spec/models/prismatic_config_spec.rb +42 -0
  1745. data/spec/models/prismatic_event_payload_coupon_based_notifications_limits_spec.rb +54 -0
  1746. data/spec/models/prismatic_event_payload_coupon_based_notifications_spec.rb +138 -0
  1747. data/spec/models/prismatic_event_payload_loyalty_profile_based_notifications_action_spec.rb +64 -0
  1748. data/spec/models/prismatic_event_payload_loyalty_profile_based_notifications_spec.rb +120 -0
  1749. data/spec/models/prismatic_flow_config_spec.rb +36 -0
  1750. data/spec/models/prismatic_flow_spec.rb +48 -0
  1751. data/spec/models/prismatic_flow_with_config_spec.rb +54 -0
  1752. data/spec/models/prismatic_paginated_event_payload_spec.rb +52 -0
  1753. data/spec/models/product_search_match_spec.rb +48 -0
  1754. data/spec/models/product_spec.rb +36 -0
  1755. data/spec/models/product_unit_analytics_data_point_spec.rb +60 -0
  1756. data/spec/models/product_unit_analytics_spec.rb +42 -0
  1757. data/spec/models/product_unit_analytics_totals_spec.rb +36 -0
  1758. data/spec/models/profile_audiences_changes_spec.rb +42 -0
  1759. data/spec/models/projected_tier_spec.rb +48 -0
  1760. data/spec/models/redeem_referral_effect_props_spec.rb +42 -0
  1761. data/spec/models/referral_constraints_spec.rb +48 -0
  1762. data/spec/models/referral_created_effect_props_spec.rb +36 -0
  1763. data/spec/models/referral_rejection_reason_spec.rb +52 -0
  1764. data/spec/models/referral_spec.rb +108 -0
  1765. data/spec/models/reject_coupon_effect_props_spec.rb +66 -0
  1766. data/spec/models/reject_referral_effect_props_spec.rb +66 -0
  1767. data/spec/models/remove_from_audience_effect_props_spec.rb +54 -0
  1768. data/spec/models/remove_item_catalog_action_spec.rb +36 -0
  1769. data/spec/models/remove_many_items_catalog_action_spec.rb +36 -0
  1770. data/spec/models/reopen_session_response_spec.rb +36 -0
  1771. data/spec/models/reserve_coupon_effect_props_spec.rb +48 -0
  1772. data/spec/models/return_integration_request_spec.rb +46 -0
  1773. data/spec/models/returned_cart_item_spec.rb +48 -0
  1774. data/spec/models/revision_activation_request_spec.rb +42 -0
  1775. data/spec/models/revision_activation_spec.rb +36 -0
  1776. data/spec/models/revision_spec.rb +90 -0
  1777. data/spec/models/revision_version_spec.rb +148 -0
  1778. data/spec/models/role_assign_spec.rb +42 -0
  1779. data/spec/models/role_membership_spec.rb +42 -0
  1780. data/spec/models/role_spec.rb +84 -0
  1781. data/spec/models/role_v2_application_details_spec.rb +54 -0
  1782. data/spec/models/role_v2_base_spec.rb +54 -0
  1783. data/spec/models/role_v2_permission_set_spec.rb +42 -0
  1784. data/spec/models/role_v2_permissions_spec.rb +42 -0
  1785. data/spec/models/role_v2_readonly_spec.rb +36 -0
  1786. data/spec/models/role_v2_roles_group_spec.rb +54 -0
  1787. data/spec/models/role_v2_spec.rb +84 -0
  1788. data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +78 -0
  1789. data/spec/models/rollback_coupon_effect_props_spec.rb +36 -0
  1790. data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +78 -0
  1791. data/spec/models/rollback_discount_effect_props_spec.rb +72 -0
  1792. data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +66 -0
  1793. data/spec/models/rollback_referral_effect_props_spec.rb +36 -0
  1794. data/spec/models/rule_failure_reason_spec.rb +114 -0
  1795. data/spec/models/rule_spec.rb +72 -0
  1796. data/spec/models/ruleset_spec.rb +96 -0
  1797. data/spec/models/saml_connection_internal_spec.rb +42 -0
  1798. data/spec/models/saml_connection_metadata_spec.rb +54 -0
  1799. data/spec/models/saml_connection_spec.rb +96 -0
  1800. data/spec/models/saml_login_endpoint_spec.rb +48 -0
  1801. data/spec/models/scim_base_group_spec.rb +42 -0
  1802. data/spec/models/scim_base_user_name_spec.rb +36 -0
  1803. data/spec/models/scim_base_user_spec.rb +54 -0
  1804. data/spec/models/scim_group_member_spec.rb +42 -0
  1805. data/spec/models/scim_group_spec.rb +48 -0
  1806. data/spec/models/scim_groups_list_response_spec.rb +48 -0
  1807. data/spec/models/scim_new_user_spec.rb +54 -0
  1808. data/spec/models/scim_patch_operation_spec.rb +52 -0
  1809. data/spec/models/scim_patch_request_spec.rb +42 -0
  1810. data/spec/models/scim_resource_spec.rb +48 -0
  1811. data/spec/models/scim_resource_types_list_response_spec.rb +36 -0
  1812. data/spec/models/scim_schema_resource_spec.rb +54 -0
  1813. data/spec/models/scim_schemas_list_response_spec.rb +48 -0
  1814. data/spec/models/scim_service_provider_config_response_bulk_spec.rb +48 -0
  1815. data/spec/models/scim_service_provider_config_response_change_password_spec.rb +36 -0
  1816. data/spec/models/scim_service_provider_config_response_filter_spec.rb +42 -0
  1817. data/spec/models/scim_service_provider_config_response_patch_spec.rb +36 -0
  1818. data/spec/models/scim_service_provider_config_response_sort_spec.rb +36 -0
  1819. data/spec/models/scim_service_provider_config_response_spec.rb +72 -0
  1820. data/spec/models/scim_user_spec.rb +60 -0
  1821. data/spec/models/scim_users_list_response_spec.rb +48 -0
  1822. data/spec/models/secondary_deployment_spec.rb +82 -0
  1823. data/spec/models/session_coupons_spec.rb +42 -0
  1824. data/spec/models/session_spec.rb +48 -0
  1825. data/spec/models/set_discount_effect_props_spec.rb +54 -0
  1826. data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +60 -0
  1827. data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +72 -0
  1828. data/spec/models/set_discount_per_item_effect_props_spec.rb +102 -0
  1829. data/spec/models/set_loyalty_points_expiry_date_effect_props_spec.rb +54 -0
  1830. data/spec/models/show_bundle_metadata_effect_props_spec.rb +48 -0
  1831. data/spec/models/show_notification_effect_props_spec.rb +48 -0
  1832. data/spec/models/sku_unit_analytics_data_point_spec.rb +54 -0
  1833. data/spec/models/sku_unit_analytics_spec.rb +42 -0
  1834. data/spec/models/slot_def_spec.rb +66 -0
  1835. data/spec/models/sso_config_spec.rb +42 -0
  1836. data/spec/models/store_spec.rb +84 -0
  1837. data/spec/models/strikethrough_changed_item_spec.rb +78 -0
  1838. data/spec/models/strikethrough_custom_effect_per_item_props_spec.rb +48 -0
  1839. data/spec/models/strikethrough_debug_response_spec.rb +42 -0
  1840. data/spec/models/strikethrough_effect_spec.rb +102 -0
  1841. data/spec/models/strikethrough_labeling_notification_spec.rb +92 -0
  1842. data/spec/models/strikethrough_set_discount_per_item_effect_props_spec.rb +42 -0
  1843. data/spec/models/strikethrough_set_discount_per_item_member_effect_props_spec.rb +42 -0
  1844. data/spec/models/strikethrough_trigger_spec.rb +60 -0
  1845. data/spec/models/summarize_campaign_store_budget200_response_spec.rb +36 -0
  1846. data/spec/models/summary_campaign_store_budget_spec.rb +62 -0
  1847. data/spec/models/talang_attribute_spec.rb +92 -0
  1848. data/spec/models/talang_attribute_visibility_spec.rb +42 -0
  1849. data/spec/models/template_arg_def_spec.rb +76 -0
  1850. data/spec/models/template_def_spec.rb +96 -0
  1851. data/spec/models/template_limit_config_spec.rb +62 -0
  1852. data/spec/models/tier_downgrade_data_spec.rb +78 -0
  1853. data/spec/models/tier_downgrade_notification_policy_spec.rb +48 -0
  1854. data/spec/models/tier_downgrade_notification_spec.rb +52 -0
  1855. data/spec/models/tier_spec.rb +64 -0
  1856. data/spec/models/tier_upgrade_data_spec.rb +90 -0
  1857. data/spec/models/tier_upgrade_notification_policy_spec.rb +48 -0
  1858. data/spec/models/tier_upgrade_notification_spec.rb +52 -0
  1859. data/spec/models/tier_will_downgrade_data_spec.rb +78 -0
  1860. data/spec/models/tier_will_downgrade_notification_policy_spec.rb +54 -0
  1861. data/spec/models/tier_will_downgrade_notification_spec.rb +52 -0
  1862. data/spec/models/tier_will_downgrade_notification_trigger_spec.rb +46 -0
  1863. data/spec/models/time_point_spec.rb +66 -0
  1864. data/spec/models/track_event_v2_response_spec.rb +84 -0
  1865. data/spec/models/transfer_loyalty_card_spec.rb +42 -0
  1866. data/spec/models/trigger_webhook_effect_props_spec.rb +42 -0
  1867. data/spec/models/two_fa_config_spec.rb +42 -0
  1868. data/spec/models/update_account_spec.rb +64 -0
  1869. data/spec/models/update_achievement_spec.rb +104 -0
  1870. data/spec/models/update_application_api_key_spec.rb +36 -0
  1871. data/spec/models/update_application_cif_spec.rb +54 -0
  1872. data/spec/models/update_application_spec.rb +144 -0
  1873. data/spec/models/update_attribute_effect_props_spec.rb +42 -0
  1874. data/spec/models/update_audience_spec.rb +36 -0
  1875. data/spec/models/update_campaign_collection_spec.rb +36 -0
  1876. data/spec/models/update_campaign_evaluation_group_spec.rb +74 -0
  1877. data/spec/models/update_campaign_group_spec.rb +54 -0
  1878. data/spec/models/update_campaign_spec.rb +138 -0
  1879. data/spec/models/update_campaign_template_spec.rb +150 -0
  1880. data/spec/models/update_catalog_spec.rb +48 -0
  1881. data/spec/models/update_collection_spec.rb +42 -0
  1882. data/spec/models/update_coupon_batch_spec.rb +72 -0
  1883. data/spec/models/update_coupon_spec.rb +90 -0
  1884. data/spec/models/update_coupons_data_spec.rb +76 -0
  1885. data/spec/models/update_custom_effect_spec.rb +78 -0
  1886. data/spec/models/update_customer_profile_v2409_response_spec.rb +48 -0
  1887. data/spec/models/update_customer_session_v2409_response_spec.rb +48 -0
  1888. data/spec/models/update_loyalty_card_spec.rb +42 -0
  1889. data/spec/models/update_loyalty_program_spec.rb +142 -0
  1890. data/spec/models/update_loyalty_program_tier_spec.rb +48 -0
  1891. data/spec/models/update_picklist_spec.rb +46 -0
  1892. data/spec/models/update_price_type_spec.rb +48 -0
  1893. data/spec/models/update_referral_batch_spec.rb +60 -0
  1894. data/spec/models/update_referral_spec.rb +60 -0
  1895. data/spec/models/update_role_spec.rb +54 -0
  1896. data/spec/models/update_store_spec.rb +48 -0
  1897. data/spec/models/update_user_spec.rb +70 -0
  1898. data/spec/models/user_entity_spec.rb +36 -0
  1899. data/spec/models/user_spec.rb +136 -0
  1900. data/spec/models/value_map_spec.rb +54 -0
  1901. data/spec/models/webhook_authentication_base_spec.rb +52 -0
  1902. data/spec/models/webhook_authentication_data_basic_spec.rb +42 -0
  1903. data/spec/models/webhook_authentication_data_custom_spec.rb +36 -0
  1904. data/spec/models/webhook_authentication_spec.rb +88 -0
  1905. data/spec/models/webhook_authentication_webhook_ref_spec.rb +48 -0
  1906. data/spec/models/webhook_spec.rb +118 -0
  1907. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +136 -0
  1908. data/spec/models/will_award_giveaway_effect_props_spec.rb +48 -0
  1909. data/spec/spec_helper.rb +111 -0
  1910. data/talon_one_sdk.gemspec +39 -0
  1911. metadata +2643 -0
@@ -0,0 +1,2507 @@
1
+ # TalonOne::IntegrationApi
2
+
3
+ All URIs are relative to *https://yourbaseurl.talon.one*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**best_prior_price**](IntegrationApi.md#best_prior_price) | **POST** /v1/best_prior_price | Fetch best prior price |
8
+ | [**create_audience_v2**](IntegrationApi.md#create_audience_v2) | **POST** /v2/audiences | Create audience |
9
+ | [**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create coupon reservation |
10
+ | [**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create referral code for an advocate |
11
+ | [**create_referrals_for_multiple_advocates**](IntegrationApi.md#create_referrals_for_multiple_advocates) | **POST** /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates |
12
+ | [**delete_audience_memberships_v2**](IntegrationApi.md#delete_audience_memberships_v2) | **DELETE** /v2/audiences/{audienceId}/memberships | Delete audience memberships |
13
+ | [**delete_audience_v2**](IntegrationApi.md#delete_audience_v2) | **DELETE** /v2/audiences/{audienceId} | Delete audience |
14
+ | [**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations |
15
+ | [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data |
16
+ | [**generate_loyalty_card**](IntegrationApi.md#generate_loyalty_card) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card |
17
+ | [**get_customer_achievement_history**](IntegrationApi.md#get_customer_achievement_history) | **GET** /v1/customer_profiles/{integrationId}/achievements/{achievementId} | List customer's achievement history |
18
+ | [**get_customer_achievements**](IntegrationApi.md#get_customer_achievements) | **GET** /v1/customer_profiles/{integrationId}/achievements | List customer's available achievements |
19
+ | [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data |
20
+ | [**get_customer_session**](IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session |
21
+ | [**get_loyalty_balances**](IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances |
22
+ | [**get_loyalty_card_balances**](IntegrationApi.md#get_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances |
23
+ | [**get_loyalty_card_points**](IntegrationApi.md#get_loyalty_card_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points |
24
+ | [**get_loyalty_card_transactions**](IntegrationApi.md#get_loyalty_card_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions |
25
+ | [**get_loyalty_program_profile_points**](IntegrationApi.md#get_loyalty_program_profile_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points | List customer's unused loyalty points |
26
+ | [**get_loyalty_program_profile_transactions**](IntegrationApi.md#get_loyalty_program_profile_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions |
27
+ | [**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved |
28
+ | [**link_loyalty_card_to_profile**](IntegrationApi.md#link_loyalty_card_to_profile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card |
29
+ | [**reopen_customer_session**](IntegrationApi.md#reopen_customer_session) | **PUT** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session |
30
+ | [**return_cart_items**](IntegrationApi.md#return_cart_items) | **POST** /v2/customer_sessions/{customerSessionId}/returns | Return cart items |
31
+ | [**sync_catalog**](IntegrationApi.md#sync_catalog) | **PUT** /v1/catalogs/{catalogId}/sync | Sync cart item catalog |
32
+ | [**track_event_v2**](IntegrationApi.md#track_event_v2) | **POST** /v2/events | Track event |
33
+ | [**update_audience_customers_attributes**](IntegrationApi.md#update_audience_customers_attributes) | **PUT** /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience |
34
+ | [**update_audience_v2**](IntegrationApi.md#update_audience_v2) | **PUT** /v2/audiences/{audienceId} | Update audience name |
35
+ | [**update_customer_profile_audiences**](IntegrationApi.md#update_customer_profile_audiences) | **POST** /v2/customer_audiences | Update multiple customer profiles' audiences |
36
+ | [**update_customer_profile_v2**](IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update customer profile |
37
+ | [**update_customer_profiles_v2**](IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple customer profiles |
38
+ | [**update_customer_session_v2**](IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update customer session |
39
+
40
+
41
+ ## best_prior_price
42
+
43
+ > <Array<BestPriorPrice>> best_prior_price(best_prior_price_request)
44
+
45
+ Fetch best prior price
46
+
47
+ Returns the best prior price based on historical pricing data for the specified SKUs within a defined timeframe.
48
+
49
+ ### Examples
50
+
51
+ ```ruby
52
+ require 'time'
53
+ require 'talon_one_sdk'
54
+ # setup authorization
55
+ TalonOne.configure do |config|
56
+ # Configure API key authorization: management_key
57
+ config.api_key['Authorization'] = 'YOUR API KEY'
58
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
59
+ # config.api_key_prefix['Authorization'] = 'Bearer'
60
+
61
+ # Configure API key authorization: manager_auth
62
+ config.api_key['Authorization'] = 'YOUR API KEY'
63
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
64
+ # config.api_key_prefix['Authorization'] = 'Bearer'
65
+
66
+ # Configure API key authorization: api_key_v1
67
+ config.api_key['Authorization'] = 'YOUR API KEY'
68
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
69
+ # config.api_key_prefix['Authorization'] = 'Bearer'
70
+ end
71
+
72
+ api_instance = TalonOne::IntegrationApi.new
73
+ best_prior_price_request = TalonOne::BestPriorPriceRequest.new({skus: [comma, period], timeframe_end_date: Time.parse('2020-11-10T23:00:00Z'), timeframe: '30', strict_end_date: true}) # BestPriorPriceRequest | body
74
+
75
+ begin
76
+ # Fetch best prior price
77
+ result = api_instance.best_prior_price(best_prior_price_request)
78
+ p result
79
+ rescue TalonOne::ApiError => e
80
+ puts "Error when calling IntegrationApi->best_prior_price: #{e}"
81
+ end
82
+ ```
83
+
84
+ #### Using the best_prior_price_with_http_info variant
85
+
86
+ This returns an Array which contains the response data, status code and headers.
87
+
88
+ > <Array(<Array<BestPriorPrice>>, Integer, Hash)> best_prior_price_with_http_info(best_prior_price_request)
89
+
90
+ ```ruby
91
+ begin
92
+ # Fetch best prior price
93
+ data, status_code, headers = api_instance.best_prior_price_with_http_info(best_prior_price_request)
94
+ p status_code # => 2xx
95
+ p headers # => { ... }
96
+ p data # => <Array<BestPriorPrice>>
97
+ rescue TalonOne::ApiError => e
98
+ puts "Error when calling IntegrationApi->best_prior_price_with_http_info: #{e}"
99
+ end
100
+ ```
101
+
102
+ ### Parameters
103
+
104
+ | Name | Type | Description | Notes |
105
+ | ---- | ---- | ----------- | ----- |
106
+ | **best_prior_price_request** | [**BestPriorPriceRequest**](BestPriorPriceRequest.md) | body | |
107
+
108
+ ### Return type
109
+
110
+ [**Array&lt;BestPriorPrice&gt;**](BestPriorPrice.md)
111
+
112
+ ### Authorization
113
+
114
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
115
+
116
+ ### HTTP request headers
117
+
118
+ - **Content-Type**: application/json
119
+ - **Accept**: application/json
120
+
121
+
122
+ ## create_audience_v2
123
+
124
+ > <Audience> create_audience_v2(new_audience)
125
+
126
+ Create audience
127
+
128
+ Create an audience. The audience can be created directly from scratch or can come from third party platforms. **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
129
+
130
+ ### Examples
131
+
132
+ ```ruby
133
+ require 'time'
134
+ require 'talon_one_sdk'
135
+ # setup authorization
136
+ TalonOne.configure do |config|
137
+ # Configure API key authorization: api_key_v1
138
+ config.api_key['Authorization'] = 'YOUR API KEY'
139
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
140
+ # config.api_key_prefix['Authorization'] = 'Bearer'
141
+ end
142
+
143
+ api_instance = TalonOne::IntegrationApi.new
144
+ new_audience = TalonOne::NewAudience.new({name: 'Travel audience'}) # NewAudience | body
145
+
146
+ begin
147
+ # Create audience
148
+ result = api_instance.create_audience_v2(new_audience)
149
+ p result
150
+ rescue TalonOne::ApiError => e
151
+ puts "Error when calling IntegrationApi->create_audience_v2: #{e}"
152
+ end
153
+ ```
154
+
155
+ #### Using the create_audience_v2_with_http_info variant
156
+
157
+ This returns an Array which contains the response data, status code and headers.
158
+
159
+ > <Array(<Audience>, Integer, Hash)> create_audience_v2_with_http_info(new_audience)
160
+
161
+ ```ruby
162
+ begin
163
+ # Create audience
164
+ data, status_code, headers = api_instance.create_audience_v2_with_http_info(new_audience)
165
+ p status_code # => 2xx
166
+ p headers # => { ... }
167
+ p data # => <Audience>
168
+ rescue TalonOne::ApiError => e
169
+ puts "Error when calling IntegrationApi->create_audience_v2_with_http_info: #{e}"
170
+ end
171
+ ```
172
+
173
+ ### Parameters
174
+
175
+ | Name | Type | Description | Notes |
176
+ | ---- | ---- | ----------- | ----- |
177
+ | **new_audience** | [**NewAudience**](NewAudience.md) | body | |
178
+
179
+ ### Return type
180
+
181
+ [**Audience**](Audience.md)
182
+
183
+ ### Authorization
184
+
185
+ [api_key_v1](../README.md#api_key_v1)
186
+
187
+ ### HTTP request headers
188
+
189
+ - **Content-Type**: application/json
190
+ - **Accept**: application/json
191
+
192
+
193
+ ## create_coupon_reservation
194
+
195
+ > <Coupon> create_coupon_reservation(coupon_value, coupon_reservations)
196
+
197
+ Create coupon reservation
198
+
199
+ Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
200
+
201
+ ### Examples
202
+
203
+ ```ruby
204
+ require 'time'
205
+ require 'talon_one_sdk'
206
+ # setup authorization
207
+ TalonOne.configure do |config|
208
+ # Configure API key authorization: api_key_v1
209
+ config.api_key['Authorization'] = 'YOUR API KEY'
210
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
211
+ # config.api_key_prefix['Authorization'] = 'Bearer'
212
+ end
213
+
214
+ api_instance = TalonOne::IntegrationApi.new
215
+ coupon_value = 'coupon_value_example' # String | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
216
+ coupon_reservations = TalonOne::CouponReservations.new({integration_ids: [URNGV8294NV, BZGGC2454PA]}) # CouponReservations | body
217
+
218
+ begin
219
+ # Create coupon reservation
220
+ result = api_instance.create_coupon_reservation(coupon_value, coupon_reservations)
221
+ p result
222
+ rescue TalonOne::ApiError => e
223
+ puts "Error when calling IntegrationApi->create_coupon_reservation: #{e}"
224
+ end
225
+ ```
226
+
227
+ #### Using the create_coupon_reservation_with_http_info variant
228
+
229
+ This returns an Array which contains the response data, status code and headers.
230
+
231
+ > <Array(<Coupon>, Integer, Hash)> create_coupon_reservation_with_http_info(coupon_value, coupon_reservations)
232
+
233
+ ```ruby
234
+ begin
235
+ # Create coupon reservation
236
+ data, status_code, headers = api_instance.create_coupon_reservation_with_http_info(coupon_value, coupon_reservations)
237
+ p status_code # => 2xx
238
+ p headers # => { ... }
239
+ p data # => <Coupon>
240
+ rescue TalonOne::ApiError => e
241
+ puts "Error when calling IntegrationApi->create_coupon_reservation_with_http_info: #{e}"
242
+ end
243
+ ```
244
+
245
+ ### Parameters
246
+
247
+ | Name | Type | Description | Notes |
248
+ | ---- | ---- | ----------- | ----- |
249
+ | **coupon_value** | **String** | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode &#x60;SUMMER25%OFF&#x60; as &#x60;SUMMER25%25OFF&#x60;. | |
250
+ | **coupon_reservations** | [**CouponReservations**](CouponReservations.md) | body | |
251
+
252
+ ### Return type
253
+
254
+ [**Coupon**](Coupon.md)
255
+
256
+ ### Authorization
257
+
258
+ [api_key_v1](../README.md#api_key_v1)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: application/json
263
+ - **Accept**: application/json
264
+
265
+
266
+ ## create_referral
267
+
268
+ > <Referral> create_referral(new_referral)
269
+
270
+ Create referral code for an advocate
271
+
272
+ Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
273
+
274
+ ### Examples
275
+
276
+ ```ruby
277
+ require 'time'
278
+ require 'talon_one_sdk'
279
+ # setup authorization
280
+ TalonOne.configure do |config|
281
+ # Configure API key authorization: api_key_v1
282
+ config.api_key['Authorization'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ # config.api_key_prefix['Authorization'] = 'Bearer'
285
+ end
286
+
287
+ api_instance = TalonOne::IntegrationApi.new
288
+ new_referral = TalonOne::NewReferral.new({campaign_id: 78, advocate_profile_integration_id: 'URNGV8294NV'}) # NewReferral | body
289
+
290
+ begin
291
+ # Create referral code for an advocate
292
+ result = api_instance.create_referral(new_referral)
293
+ p result
294
+ rescue TalonOne::ApiError => e
295
+ puts "Error when calling IntegrationApi->create_referral: #{e}"
296
+ end
297
+ ```
298
+
299
+ #### Using the create_referral_with_http_info variant
300
+
301
+ This returns an Array which contains the response data, status code and headers.
302
+
303
+ > <Array(<Referral>, Integer, Hash)> create_referral_with_http_info(new_referral)
304
+
305
+ ```ruby
306
+ begin
307
+ # Create referral code for an advocate
308
+ data, status_code, headers = api_instance.create_referral_with_http_info(new_referral)
309
+ p status_code # => 2xx
310
+ p headers # => { ... }
311
+ p data # => <Referral>
312
+ rescue TalonOne::ApiError => e
313
+ puts "Error when calling IntegrationApi->create_referral_with_http_info: #{e}"
314
+ end
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+ | Name | Type | Description | Notes |
320
+ | ---- | ---- | ----------- | ----- |
321
+ | **new_referral** | [**NewReferral**](NewReferral.md) | body | |
322
+
323
+ ### Return type
324
+
325
+ [**Referral**](Referral.md)
326
+
327
+ ### Authorization
328
+
329
+ [api_key_v1](../README.md#api_key_v1)
330
+
331
+ ### HTTP request headers
332
+
333
+ - **Content-Type**: application/json
334
+ - **Accept**: application/json
335
+
336
+
337
+ ## create_referrals_for_multiple_advocates
338
+
339
+ > <CreateReferralsForMultipleAdvocates201Response> create_referrals_for_multiple_advocates(new_referrals_for_multiple_advocates, opts)
340
+
341
+ Create referral codes for multiple advocates
342
+
343
+ Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
344
+
345
+ ### Examples
346
+
347
+ ```ruby
348
+ require 'time'
349
+ require 'talon_one_sdk'
350
+ # setup authorization
351
+ TalonOne.configure do |config|
352
+ # Configure API key authorization: api_key_v1
353
+ config.api_key['Authorization'] = 'YOUR API KEY'
354
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
355
+ # config.api_key_prefix['Authorization'] = 'Bearer'
356
+ end
357
+
358
+ api_instance = TalonOne::IntegrationApi.new
359
+ new_referrals_for_multiple_advocates = TalonOne::NewReferralsForMultipleAdvocates.new({campaign_id: 45, advocate_profile_integration_ids: [URNGV8294NV, DRPVV9476AF]}) # NewReferralsForMultipleAdvocates | body
360
+ opts = {
361
+ silent: 'silent_example' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
362
+ }
363
+
364
+ begin
365
+ # Create referral codes for multiple advocates
366
+ result = api_instance.create_referrals_for_multiple_advocates(new_referrals_for_multiple_advocates, opts)
367
+ p result
368
+ rescue TalonOne::ApiError => e
369
+ puts "Error when calling IntegrationApi->create_referrals_for_multiple_advocates: #{e}"
370
+ end
371
+ ```
372
+
373
+ #### Using the create_referrals_for_multiple_advocates_with_http_info variant
374
+
375
+ This returns an Array which contains the response data, status code and headers.
376
+
377
+ > <Array(<CreateReferralsForMultipleAdvocates201Response>, Integer, Hash)> create_referrals_for_multiple_advocates_with_http_info(new_referrals_for_multiple_advocates, opts)
378
+
379
+ ```ruby
380
+ begin
381
+ # Create referral codes for multiple advocates
382
+ data, status_code, headers = api_instance.create_referrals_for_multiple_advocates_with_http_info(new_referrals_for_multiple_advocates, opts)
383
+ p status_code # => 2xx
384
+ p headers # => { ... }
385
+ p data # => <CreateReferralsForMultipleAdvocates201Response>
386
+ rescue TalonOne::ApiError => e
387
+ puts "Error when calling IntegrationApi->create_referrals_for_multiple_advocates_with_http_info: #{e}"
388
+ end
389
+ ```
390
+
391
+ ### Parameters
392
+
393
+ | Name | Type | Description | Notes |
394
+ | ---- | ---- | ----------- | ----- |
395
+ | **new_referrals_for_multiple_advocates** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md) | body | |
396
+ | **silent** | **String** | Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. | [optional][default to &#39;yes&#39;] |
397
+
398
+ ### Return type
399
+
400
+ [**CreateReferralsForMultipleAdvocates201Response**](CreateReferralsForMultipleAdvocates201Response.md)
401
+
402
+ ### Authorization
403
+
404
+ [api_key_v1](../README.md#api_key_v1)
405
+
406
+ ### HTTP request headers
407
+
408
+ - **Content-Type**: application/json
409
+ - **Accept**: application/json
410
+
411
+
412
+ ## delete_audience_memberships_v2
413
+
414
+ > delete_audience_memberships_v2(audience_id)
415
+
416
+ Delete audience memberships
417
+
418
+ Remove all members from this audience.
419
+
420
+ ### Examples
421
+
422
+ ```ruby
423
+ require 'time'
424
+ require 'talon_one_sdk'
425
+ # setup authorization
426
+ TalonOne.configure do |config|
427
+ # Configure API key authorization: api_key_v1
428
+ config.api_key['Authorization'] = 'YOUR API KEY'
429
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
430
+ # config.api_key_prefix['Authorization'] = 'Bearer'
431
+ end
432
+
433
+ api_instance = TalonOne::IntegrationApi.new
434
+ audience_id = 789 # Integer | The ID of the audience.
435
+
436
+ begin
437
+ # Delete audience memberships
438
+ api_instance.delete_audience_memberships_v2(audience_id)
439
+ rescue TalonOne::ApiError => e
440
+ puts "Error when calling IntegrationApi->delete_audience_memberships_v2: #{e}"
441
+ end
442
+ ```
443
+
444
+ #### Using the delete_audience_memberships_v2_with_http_info variant
445
+
446
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
447
+
448
+ > <Array(nil, Integer, Hash)> delete_audience_memberships_v2_with_http_info(audience_id)
449
+
450
+ ```ruby
451
+ begin
452
+ # Delete audience memberships
453
+ data, status_code, headers = api_instance.delete_audience_memberships_v2_with_http_info(audience_id)
454
+ p status_code # => 2xx
455
+ p headers # => { ... }
456
+ p data # => nil
457
+ rescue TalonOne::ApiError => e
458
+ puts "Error when calling IntegrationApi->delete_audience_memberships_v2_with_http_info: #{e}"
459
+ end
460
+ ```
461
+
462
+ ### Parameters
463
+
464
+ | Name | Type | Description | Notes |
465
+ | ---- | ---- | ----------- | ----- |
466
+ | **audience_id** | **Integer** | The ID of the audience. | |
467
+
468
+ ### Return type
469
+
470
+ nil (empty response body)
471
+
472
+ ### Authorization
473
+
474
+ [api_key_v1](../README.md#api_key_v1)
475
+
476
+ ### HTTP request headers
477
+
478
+ - **Content-Type**: Not defined
479
+ - **Accept**: application/json
480
+
481
+
482
+ ## delete_audience_v2
483
+
484
+ > delete_audience_v2(audience_id)
485
+
486
+ Delete audience
487
+
488
+ Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. **Note:** Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience).
489
+
490
+ ### Examples
491
+
492
+ ```ruby
493
+ require 'time'
494
+ require 'talon_one_sdk'
495
+ # setup authorization
496
+ TalonOne.configure do |config|
497
+ # Configure API key authorization: api_key_v1
498
+ config.api_key['Authorization'] = 'YOUR API KEY'
499
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
500
+ # config.api_key_prefix['Authorization'] = 'Bearer'
501
+ end
502
+
503
+ api_instance = TalonOne::IntegrationApi.new
504
+ audience_id = 789 # Integer | The ID of the audience.
505
+
506
+ begin
507
+ # Delete audience
508
+ api_instance.delete_audience_v2(audience_id)
509
+ rescue TalonOne::ApiError => e
510
+ puts "Error when calling IntegrationApi->delete_audience_v2: #{e}"
511
+ end
512
+ ```
513
+
514
+ #### Using the delete_audience_v2_with_http_info variant
515
+
516
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
517
+
518
+ > <Array(nil, Integer, Hash)> delete_audience_v2_with_http_info(audience_id)
519
+
520
+ ```ruby
521
+ begin
522
+ # Delete audience
523
+ data, status_code, headers = api_instance.delete_audience_v2_with_http_info(audience_id)
524
+ p status_code # => 2xx
525
+ p headers # => { ... }
526
+ p data # => nil
527
+ rescue TalonOne::ApiError => e
528
+ puts "Error when calling IntegrationApi->delete_audience_v2_with_http_info: #{e}"
529
+ end
530
+ ```
531
+
532
+ ### Parameters
533
+
534
+ | Name | Type | Description | Notes |
535
+ | ---- | ---- | ----------- | ----- |
536
+ | **audience_id** | **Integer** | The ID of the audience. | |
537
+
538
+ ### Return type
539
+
540
+ nil (empty response body)
541
+
542
+ ### Authorization
543
+
544
+ [api_key_v1](../README.md#api_key_v1)
545
+
546
+ ### HTTP request headers
547
+
548
+ - **Content-Type**: Not defined
549
+ - **Accept**: application/json
550
+
551
+
552
+ ## delete_coupon_reservation
553
+
554
+ > delete_coupon_reservation(coupon_value, coupon_reservations)
555
+
556
+ Delete coupon reservations
557
+
558
+ Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.
559
+
560
+ ### Examples
561
+
562
+ ```ruby
563
+ require 'time'
564
+ require 'talon_one_sdk'
565
+ # setup authorization
566
+ TalonOne.configure do |config|
567
+ # Configure API key authorization: api_key_v1
568
+ config.api_key['Authorization'] = 'YOUR API KEY'
569
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
570
+ # config.api_key_prefix['Authorization'] = 'Bearer'
571
+ end
572
+
573
+ api_instance = TalonOne::IntegrationApi.new
574
+ coupon_value = 'coupon_value_example' # String | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
575
+ coupon_reservations = TalonOne::CouponReservations.new({integration_ids: [URNGV8294NV, BZGGC2454PA]}) # CouponReservations | body
576
+
577
+ begin
578
+ # Delete coupon reservations
579
+ api_instance.delete_coupon_reservation(coupon_value, coupon_reservations)
580
+ rescue TalonOne::ApiError => e
581
+ puts "Error when calling IntegrationApi->delete_coupon_reservation: #{e}"
582
+ end
583
+ ```
584
+
585
+ #### Using the delete_coupon_reservation_with_http_info variant
586
+
587
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
588
+
589
+ > <Array(nil, Integer, Hash)> delete_coupon_reservation_with_http_info(coupon_value, coupon_reservations)
590
+
591
+ ```ruby
592
+ begin
593
+ # Delete coupon reservations
594
+ data, status_code, headers = api_instance.delete_coupon_reservation_with_http_info(coupon_value, coupon_reservations)
595
+ p status_code # => 2xx
596
+ p headers # => { ... }
597
+ p data # => nil
598
+ rescue TalonOne::ApiError => e
599
+ puts "Error when calling IntegrationApi->delete_coupon_reservation_with_http_info: #{e}"
600
+ end
601
+ ```
602
+
603
+ ### Parameters
604
+
605
+ | Name | Type | Description | Notes |
606
+ | ---- | ---- | ----------- | ----- |
607
+ | **coupon_value** | **String** | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode &#x60;SUMMER25%OFF&#x60; as &#x60;SUMMER25%25OFF&#x60;. | |
608
+ | **coupon_reservations** | [**CouponReservations**](CouponReservations.md) | body | |
609
+
610
+ ### Return type
611
+
612
+ nil (empty response body)
613
+
614
+ ### Authorization
615
+
616
+ [api_key_v1](../README.md#api_key_v1)
617
+
618
+ ### HTTP request headers
619
+
620
+ - **Content-Type**: application/json
621
+ - **Accept**: application/json
622
+
623
+
624
+ ## delete_customer_data
625
+
626
+ > delete_customer_data(integration_id)
627
+
628
+ Delete customer's personal data
629
+
630
+ Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
631
+
632
+ ### Examples
633
+
634
+ ```ruby
635
+ require 'time'
636
+ require 'talon_one_sdk'
637
+ # setup authorization
638
+ TalonOne.configure do |config|
639
+ # Configure API key authorization: api_key_v1
640
+ config.api_key['Authorization'] = 'YOUR API KEY'
641
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
642
+ # config.api_key_prefix['Authorization'] = 'Bearer'
643
+ end
644
+
645
+ api_instance = TalonOne::IntegrationApi.new
646
+ integration_id = 'integration_id_example' # String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
647
+
648
+ begin
649
+ # Delete customer's personal data
650
+ api_instance.delete_customer_data(integration_id)
651
+ rescue TalonOne::ApiError => e
652
+ puts "Error when calling IntegrationApi->delete_customer_data: #{e}"
653
+ end
654
+ ```
655
+
656
+ #### Using the delete_customer_data_with_http_info variant
657
+
658
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
659
+
660
+ > <Array(nil, Integer, Hash)> delete_customer_data_with_http_info(integration_id)
661
+
662
+ ```ruby
663
+ begin
664
+ # Delete customer's personal data
665
+ data, status_code, headers = api_instance.delete_customer_data_with_http_info(integration_id)
666
+ p status_code # => 2xx
667
+ p headers # => { ... }
668
+ p data # => nil
669
+ rescue TalonOne::ApiError => e
670
+ puts "Error when calling IntegrationApi->delete_customer_data_with_http_info: #{e}"
671
+ end
672
+ ```
673
+
674
+ ### Parameters
675
+
676
+ | Name | Type | Description | Notes |
677
+ | ---- | ---- | ----------- | ----- |
678
+ | **integration_id** | **String** | The integration ID of the customer profile. You can get the &#x60;integrationId&#x60; of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application&#39;s customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
679
+
680
+ ### Return type
681
+
682
+ nil (empty response body)
683
+
684
+ ### Authorization
685
+
686
+ [api_key_v1](../README.md#api_key_v1)
687
+
688
+ ### HTTP request headers
689
+
690
+ - **Content-Type**: Not defined
691
+ - **Accept**: application/json
692
+
693
+
694
+ ## generate_loyalty_card
695
+
696
+ > <LoyaltyCard> generate_loyalty_card(loyalty_program_id, generate_loyalty_card)
697
+
698
+ Generate loyalty card
699
+
700
+ Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. **Note:** - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. - If the loyalty program has a defined code format, it will be used for the loyalty card identifier.
701
+
702
+ ### Examples
703
+
704
+ ```ruby
705
+ require 'time'
706
+ require 'talon_one_sdk'
707
+ # setup authorization
708
+ TalonOne.configure do |config|
709
+ # Configure API key authorization: api_key_v1
710
+ config.api_key['Authorization'] = 'YOUR API KEY'
711
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
712
+ # config.api_key_prefix['Authorization'] = 'Bearer'
713
+ end
714
+
715
+ api_instance = TalonOne::IntegrationApi.new
716
+ loyalty_program_id = 789 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
717
+ generate_loyalty_card = TalonOne::GenerateLoyaltyCard.new # GenerateLoyaltyCard | body
718
+
719
+ begin
720
+ # Generate loyalty card
721
+ result = api_instance.generate_loyalty_card(loyalty_program_id, generate_loyalty_card)
722
+ p result
723
+ rescue TalonOne::ApiError => e
724
+ puts "Error when calling IntegrationApi->generate_loyalty_card: #{e}"
725
+ end
726
+ ```
727
+
728
+ #### Using the generate_loyalty_card_with_http_info variant
729
+
730
+ This returns an Array which contains the response data, status code and headers.
731
+
732
+ > <Array(<LoyaltyCard>, Integer, Hash)> generate_loyalty_card_with_http_info(loyalty_program_id, generate_loyalty_card)
733
+
734
+ ```ruby
735
+ begin
736
+ # Generate loyalty card
737
+ data, status_code, headers = api_instance.generate_loyalty_card_with_http_info(loyalty_program_id, generate_loyalty_card)
738
+ p status_code # => 2xx
739
+ p headers # => { ... }
740
+ p data # => <LoyaltyCard>
741
+ rescue TalonOne::ApiError => e
742
+ puts "Error when calling IntegrationApi->generate_loyalty_card_with_http_info: #{e}"
743
+ end
744
+ ```
745
+
746
+ ### Parameters
747
+
748
+ | Name | Type | Description | Notes |
749
+ | ---- | ---- | ----------- | ----- |
750
+ | **loyalty_program_id** | **Integer** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
751
+ | **generate_loyalty_card** | [**GenerateLoyaltyCard**](GenerateLoyaltyCard.md) | body | |
752
+
753
+ ### Return type
754
+
755
+ [**LoyaltyCard**](LoyaltyCard.md)
756
+
757
+ ### Authorization
758
+
759
+ [api_key_v1](../README.md#api_key_v1)
760
+
761
+ ### HTTP request headers
762
+
763
+ - **Content-Type**: application/json
764
+ - **Accept**: application/json
765
+
766
+
767
+ ## get_customer_achievement_history
768
+
769
+ > <GetCustomerAchievementHistory200Response> get_customer_achievement_history(integration_id, achievement_id, opts)
770
+
771
+ List customer's achievement history
772
+
773
+ Retrieve all progress history of a given customer in the given achievement.
774
+
775
+ ### Examples
776
+
777
+ ```ruby
778
+ require 'time'
779
+ require 'talon_one_sdk'
780
+ # setup authorization
781
+ TalonOne.configure do |config|
782
+ # Configure API key authorization: api_key_v1
783
+ config.api_key['Authorization'] = 'YOUR API KEY'
784
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
785
+ # config.api_key_prefix['Authorization'] = 'Bearer'
786
+ end
787
+
788
+ api_instance = TalonOne::IntegrationApi.new
789
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
790
+ achievement_id = 789 # Integer | The achievement identifier.
791
+ opts = {
792
+ progress_status: ['inprogress'], # Array<String> | Filter by customer progress status in the achievement.
793
+ start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp that filters the results to only contain achievements created on or after the start date.
794
+ end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Timestamp that filters the results to only contain achievements created before or on the end date.
795
+ page_size: 789, # Integer | The number of items in the response.
796
+ skip: 789 # Integer | The number of items to skip when paging through large result sets.
797
+ }
798
+
799
+ begin
800
+ # List customer's achievement history
801
+ result = api_instance.get_customer_achievement_history(integration_id, achievement_id, opts)
802
+ p result
803
+ rescue TalonOne::ApiError => e
804
+ puts "Error when calling IntegrationApi->get_customer_achievement_history: #{e}"
805
+ end
806
+ ```
807
+
808
+ #### Using the get_customer_achievement_history_with_http_info variant
809
+
810
+ This returns an Array which contains the response data, status code and headers.
811
+
812
+ > <Array(<GetCustomerAchievementHistory200Response>, Integer, Hash)> get_customer_achievement_history_with_http_info(integration_id, achievement_id, opts)
813
+
814
+ ```ruby
815
+ begin
816
+ # List customer's achievement history
817
+ data, status_code, headers = api_instance.get_customer_achievement_history_with_http_info(integration_id, achievement_id, opts)
818
+ p status_code # => 2xx
819
+ p headers # => { ... }
820
+ p data # => <GetCustomerAchievementHistory200Response>
821
+ rescue TalonOne::ApiError => e
822
+ puts "Error when calling IntegrationApi->get_customer_achievement_history_with_http_info: #{e}"
823
+ end
824
+ ```
825
+
826
+ ### Parameters
827
+
828
+ | Name | Type | Description | Notes |
829
+ | ---- | ---- | ----------- | ----- |
830
+ | **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. | |
831
+ | **achievement_id** | **Integer** | The achievement identifier. | |
832
+ | **progress_status** | [**Array&lt;String&gt;**](String.md) | Filter by customer progress status in the achievement. | [optional] |
833
+ | **start_date** | **Time** | Timestamp that filters the results to only contain achievements created on or after the start date. | [optional] |
834
+ | **end_date** | **Time** | Timestamp that filters the results to only contain achievements created before or on the end date. | [optional] |
835
+ | **page_size** | **Integer** | The number of items in the response. | [optional][default to 1000] |
836
+ | **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
837
+
838
+ ### Return type
839
+
840
+ [**GetCustomerAchievementHistory200Response**](GetCustomerAchievementHistory200Response.md)
841
+
842
+ ### Authorization
843
+
844
+ [api_key_v1](../README.md#api_key_v1)
845
+
846
+ ### HTTP request headers
847
+
848
+ - **Content-Type**: Not defined
849
+ - **Accept**: application/json
850
+
851
+
852
+ ## get_customer_achievements
853
+
854
+ > <GetCustomerAchievements200Response> get_customer_achievements(integration_id, opts)
855
+
856
+ List customer's available achievements
857
+
858
+ Retrieve all the achievements available to a given customer and their progress in them.
859
+
860
+ ### Examples
861
+
862
+ ```ruby
863
+ require 'time'
864
+ require 'talon_one_sdk'
865
+ # setup authorization
866
+ TalonOne.configure do |config|
867
+ # Configure API key authorization: api_key_v1
868
+ config.api_key['Authorization'] = 'YOUR API KEY'
869
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
870
+ # config.api_key_prefix['Authorization'] = 'Bearer'
871
+ end
872
+
873
+ api_instance = TalonOne::IntegrationApi.new
874
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
875
+ opts = {
876
+ campaign_ids: ['inner_example'], # Array<String> | Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned.
877
+ achievement_ids: ['inner_example'], # Array<String> | Filter by one or more Achievement IDs, separated by a comma. **Note:** If no achievements are specified, data for all the achievements in the Application is returned.
878
+ achievement_status: ['active'], # Array<String> | Filter by status of the achievement. **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned.
879
+ current_progress_status: ['inprogress'], # Array<String> | Filter by customer progress status in the achievement.
880
+ page_size: 789, # Integer | The number of items in the response.
881
+ skip: 789 # Integer | The number of items to skip when paging through large result sets.
882
+ }
883
+
884
+ begin
885
+ # List customer's available achievements
886
+ result = api_instance.get_customer_achievements(integration_id, opts)
887
+ p result
888
+ rescue TalonOne::ApiError => e
889
+ puts "Error when calling IntegrationApi->get_customer_achievements: #{e}"
890
+ end
891
+ ```
892
+
893
+ #### Using the get_customer_achievements_with_http_info variant
894
+
895
+ This returns an Array which contains the response data, status code and headers.
896
+
897
+ > <Array(<GetCustomerAchievements200Response>, Integer, Hash)> get_customer_achievements_with_http_info(integration_id, opts)
898
+
899
+ ```ruby
900
+ begin
901
+ # List customer's available achievements
902
+ data, status_code, headers = api_instance.get_customer_achievements_with_http_info(integration_id, opts)
903
+ p status_code # => 2xx
904
+ p headers # => { ... }
905
+ p data # => <GetCustomerAchievements200Response>
906
+ rescue TalonOne::ApiError => e
907
+ puts "Error when calling IntegrationApi->get_customer_achievements_with_http_info: #{e}"
908
+ end
909
+ ```
910
+
911
+ ### Parameters
912
+
913
+ | Name | Type | Description | Notes |
914
+ | ---- | ---- | ----------- | ----- |
915
+ | **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. | |
916
+ | **campaign_ids** | [**Array&lt;String&gt;**](String.md) | Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned. | [optional] |
917
+ | **achievement_ids** | [**Array&lt;String&gt;**](String.md) | Filter by one or more Achievement IDs, separated by a comma. **Note:** If no achievements are specified, data for all the achievements in the Application is returned. | [optional] |
918
+ | **achievement_status** | [**Array&lt;String&gt;**](String.md) | Filter by status of the achievement. **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned. | [optional] |
919
+ | **current_progress_status** | [**Array&lt;String&gt;**](String.md) | Filter by customer progress status in the achievement. | [optional] |
920
+ | **page_size** | **Integer** | The number of items in the response. | [optional][default to 1000] |
921
+ | **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
922
+
923
+ ### Return type
924
+
925
+ [**GetCustomerAchievements200Response**](GetCustomerAchievements200Response.md)
926
+
927
+ ### Authorization
928
+
929
+ [api_key_v1](../README.md#api_key_v1)
930
+
931
+ ### HTTP request headers
932
+
933
+ - **Content-Type**: Not defined
934
+ - **Accept**: application/json
935
+
936
+
937
+ ## get_customer_inventory
938
+
939
+ > <CustomerInventory> get_customer_inventory(integration_id, opts)
940
+
941
+ List customer data
942
+
943
+ Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
944
+
945
+ ### Examples
946
+
947
+ ```ruby
948
+ require 'time'
949
+ require 'talon_one_sdk'
950
+ # setup authorization
951
+ TalonOne.configure do |config|
952
+ # Configure API key authorization: api_key_v1
953
+ config.api_key['Authorization'] = 'YOUR API KEY'
954
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
955
+ # config.api_key_prefix['Authorization'] = 'Bearer'
956
+ end
957
+
958
+ api_instance = TalonOne::IntegrationApi.new
959
+ integration_id = 'integration_id_example' # String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
960
+ opts = {
961
+ profile: true, # Boolean | Set to `true` to include customer profile information in the response.
962
+ referrals: true, # Boolean | Set to `true` to include referral information in the response.
963
+ coupons: true, # Boolean | Set to `true` to include coupon information in the response.
964
+ loyalty: true, # Boolean | Set to `true` to include loyalty information in the response.
965
+ giveaways: true, # Boolean | Set to `true` to include giveaways information in the response.
966
+ achievements: true # Boolean | Set to `true` to include achievement information in the response.
967
+ }
968
+
969
+ begin
970
+ # List customer data
971
+ result = api_instance.get_customer_inventory(integration_id, opts)
972
+ p result
973
+ rescue TalonOne::ApiError => e
974
+ puts "Error when calling IntegrationApi->get_customer_inventory: #{e}"
975
+ end
976
+ ```
977
+
978
+ #### Using the get_customer_inventory_with_http_info variant
979
+
980
+ This returns an Array which contains the response data, status code and headers.
981
+
982
+ > <Array(<CustomerInventory>, Integer, Hash)> get_customer_inventory_with_http_info(integration_id, opts)
983
+
984
+ ```ruby
985
+ begin
986
+ # List customer data
987
+ data, status_code, headers = api_instance.get_customer_inventory_with_http_info(integration_id, opts)
988
+ p status_code # => 2xx
989
+ p headers # => { ... }
990
+ p data # => <CustomerInventory>
991
+ rescue TalonOne::ApiError => e
992
+ puts "Error when calling IntegrationApi->get_customer_inventory_with_http_info: #{e}"
993
+ end
994
+ ```
995
+
996
+ ### Parameters
997
+
998
+ | Name | Type | Description | Notes |
999
+ | ---- | ---- | ----------- | ----- |
1000
+ | **integration_id** | **String** | The integration ID of the customer profile. You can get the &#x60;integrationId&#x60; of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application&#39;s customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. | |
1001
+ | **profile** | **Boolean** | Set to &#x60;true&#x60; to include customer profile information in the response. | [optional] |
1002
+ | **referrals** | **Boolean** | Set to &#x60;true&#x60; to include referral information in the response. | [optional] |
1003
+ | **coupons** | **Boolean** | Set to &#x60;true&#x60; to include coupon information in the response. | [optional] |
1004
+ | **loyalty** | **Boolean** | Set to &#x60;true&#x60; to include loyalty information in the response. | [optional] |
1005
+ | **giveaways** | **Boolean** | Set to &#x60;true&#x60; to include giveaways information in the response. | [optional] |
1006
+ | **achievements** | **Boolean** | Set to &#x60;true&#x60; to include achievement information in the response. | [optional] |
1007
+
1008
+ ### Return type
1009
+
1010
+ [**CustomerInventory**](CustomerInventory.md)
1011
+
1012
+ ### Authorization
1013
+
1014
+ [api_key_v1](../README.md#api_key_v1)
1015
+
1016
+ ### HTTP request headers
1017
+
1018
+ - **Content-Type**: Not defined
1019
+ - **Accept**: application/json
1020
+
1021
+
1022
+ ## get_customer_session
1023
+
1024
+ > <IntegrationCustomerSessionResponse> get_customer_session(customer_session_id)
1025
+
1026
+ Get customer session
1027
+
1028
+ Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
1029
+
1030
+ ### Examples
1031
+
1032
+ ```ruby
1033
+ require 'time'
1034
+ require 'talon_one_sdk'
1035
+ # setup authorization
1036
+ TalonOne.configure do |config|
1037
+ # Configure API key authorization: api_key_v1
1038
+ config.api_key['Authorization'] = 'YOUR API KEY'
1039
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1040
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1041
+ end
1042
+
1043
+ api_instance = TalonOne::IntegrationApi.new
1044
+ customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
1045
+
1046
+ begin
1047
+ # Get customer session
1048
+ result = api_instance.get_customer_session(customer_session_id)
1049
+ p result
1050
+ rescue TalonOne::ApiError => e
1051
+ puts "Error when calling IntegrationApi->get_customer_session: #{e}"
1052
+ end
1053
+ ```
1054
+
1055
+ #### Using the get_customer_session_with_http_info variant
1056
+
1057
+ This returns an Array which contains the response data, status code and headers.
1058
+
1059
+ > <Array(<IntegrationCustomerSessionResponse>, Integer, Hash)> get_customer_session_with_http_info(customer_session_id)
1060
+
1061
+ ```ruby
1062
+ begin
1063
+ # Get customer session
1064
+ data, status_code, headers = api_instance.get_customer_session_with_http_info(customer_session_id)
1065
+ p status_code # => 2xx
1066
+ p headers # => { ... }
1067
+ p data # => <IntegrationCustomerSessionResponse>
1068
+ rescue TalonOne::ApiError => e
1069
+ puts "Error when calling IntegrationApi->get_customer_session_with_http_info: #{e}"
1070
+ end
1071
+ ```
1072
+
1073
+ ### Parameters
1074
+
1075
+ | Name | Type | Description | Notes |
1076
+ | ---- | ---- | ----------- | ----- |
1077
+ | **customer_session_id** | **String** | The &#x60;integration ID&#x60; of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager&#39;s **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
1078
+
1079
+ ### Return type
1080
+
1081
+ [**IntegrationCustomerSessionResponse**](IntegrationCustomerSessionResponse.md)
1082
+
1083
+ ### Authorization
1084
+
1085
+ [api_key_v1](../README.md#api_key_v1)
1086
+
1087
+ ### HTTP request headers
1088
+
1089
+ - **Content-Type**: Not defined
1090
+ - **Accept**: application/json
1091
+
1092
+
1093
+ ## get_loyalty_balances
1094
+
1095
+ > <LoyaltyBalancesWithTiers> get_loyalty_balances(loyalty_program_id, integration_id, opts)
1096
+
1097
+ Get customer's loyalty balances
1098
+
1099
+ Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
1100
+
1101
+ ### Examples
1102
+
1103
+ ```ruby
1104
+ require 'time'
1105
+ require 'talon_one_sdk'
1106
+ # setup authorization
1107
+ TalonOne.configure do |config|
1108
+ # Configure API key authorization: api_key_v1
1109
+ config.api_key['Authorization'] = 'YOUR API KEY'
1110
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1111
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1112
+ end
1113
+
1114
+ api_instance = TalonOne::IntegrationApi.new
1115
+ loyalty_program_id = 789 # 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.
1116
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
1117
+ opts = {
1118
+ end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
1119
+ subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
1120
+ include_tiers: true, # Boolean | Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier.
1121
+ include_projected_tier: true # Boolean | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance.
1122
+ }
1123
+
1124
+ begin
1125
+ # Get customer's loyalty balances
1126
+ result = api_instance.get_loyalty_balances(loyalty_program_id, integration_id, opts)
1127
+ p result
1128
+ rescue TalonOne::ApiError => e
1129
+ puts "Error when calling IntegrationApi->get_loyalty_balances: #{e}"
1130
+ end
1131
+ ```
1132
+
1133
+ #### Using the get_loyalty_balances_with_http_info variant
1134
+
1135
+ This returns an Array which contains the response data, status code and headers.
1136
+
1137
+ > <Array(<LoyaltyBalancesWithTiers>, Integer, Hash)> get_loyalty_balances_with_http_info(loyalty_program_id, integration_id, opts)
1138
+
1139
+ ```ruby
1140
+ begin
1141
+ # Get customer's loyalty balances
1142
+ data, status_code, headers = api_instance.get_loyalty_balances_with_http_info(loyalty_program_id, integration_id, opts)
1143
+ p status_code # => 2xx
1144
+ p headers # => { ... }
1145
+ p data # => <LoyaltyBalancesWithTiers>
1146
+ rescue TalonOne::ApiError => e
1147
+ puts "Error when calling IntegrationApi->get_loyalty_balances_with_http_info: #{e}"
1148
+ end
1149
+ ```
1150
+
1151
+ ### Parameters
1152
+
1153
+ | Name | Type | Description | Notes |
1154
+ | ---- | ---- | ----------- | ----- |
1155
+ | **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. | |
1156
+ | **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. | |
1157
+ | **end_date** | **Time** | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional] |
1158
+ | **subledger_id** | **String** | The ID of the subledger by which we filter the data. | [optional] |
1159
+ | **include_tiers** | **Boolean** | Indicates whether tier information is included in the response. When set to &#x60;true&#x60;, the response includes information about the current tier and the number of points required to move to next tier. | [optional][default to false] |
1160
+ | **include_projected_tier** | **Boolean** | Indicates whether the customer&#39;s projected tier information is included in the response. When set to &#x60;true&#x60;, the response includes information about the customer&#39;s active points and the name of the projected tier. **Note** We recommend filtering by &#x60;subledgerId&#x60; for better performance. | [optional][default to false] |
1161
+
1162
+ ### Return type
1163
+
1164
+ [**LoyaltyBalancesWithTiers**](LoyaltyBalancesWithTiers.md)
1165
+
1166
+ ### Authorization
1167
+
1168
+ [api_key_v1](../README.md#api_key_v1)
1169
+
1170
+ ### HTTP request headers
1171
+
1172
+ - **Content-Type**: Not defined
1173
+ - **Accept**: application/json
1174
+
1175
+
1176
+ ## get_loyalty_card_balances
1177
+
1178
+ > <LoyaltyCardBalances> get_loyalty_card_balances(loyalty_program_id, loyalty_card_id, opts)
1179
+
1180
+ Get card's point balances
1181
+
1182
+ Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
1183
+
1184
+ ### Examples
1185
+
1186
+ ```ruby
1187
+ require 'time'
1188
+ require 'talon_one_sdk'
1189
+ # setup authorization
1190
+ TalonOne.configure do |config|
1191
+ # Configure API key authorization: api_key_v1
1192
+ config.api_key['Authorization'] = 'YOUR API KEY'
1193
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1194
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1195
+ end
1196
+
1197
+ api_instance = TalonOne::IntegrationApi.new
1198
+ loyalty_program_id = 789 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1199
+ loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1200
+ opts = {
1201
+ end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
1202
+ subledger_id: ['inner_example'] # Array<String> | Filter results by one or more subledger IDs. Must be exact match.
1203
+ }
1204
+
1205
+ begin
1206
+ # Get card's point balances
1207
+ result = api_instance.get_loyalty_card_balances(loyalty_program_id, loyalty_card_id, opts)
1208
+ p result
1209
+ rescue TalonOne::ApiError => e
1210
+ puts "Error when calling IntegrationApi->get_loyalty_card_balances: #{e}"
1211
+ end
1212
+ ```
1213
+
1214
+ #### Using the get_loyalty_card_balances_with_http_info variant
1215
+
1216
+ This returns an Array which contains the response data, status code and headers.
1217
+
1218
+ > <Array(<LoyaltyCardBalances>, Integer, Hash)> get_loyalty_card_balances_with_http_info(loyalty_program_id, loyalty_card_id, opts)
1219
+
1220
+ ```ruby
1221
+ begin
1222
+ # Get card's point balances
1223
+ data, status_code, headers = api_instance.get_loyalty_card_balances_with_http_info(loyalty_program_id, loyalty_card_id, opts)
1224
+ p status_code # => 2xx
1225
+ p headers # => { ... }
1226
+ p data # => <LoyaltyCardBalances>
1227
+ rescue TalonOne::ApiError => e
1228
+ puts "Error when calling IntegrationApi->get_loyalty_card_balances_with_http_info: #{e}"
1229
+ end
1230
+ ```
1231
+
1232
+ ### Parameters
1233
+
1234
+ | Name | Type | Description | Notes |
1235
+ | ---- | ---- | ----------- | ----- |
1236
+ | **loyalty_program_id** | **Integer** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
1237
+ | **loyalty_card_id** | **String** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | |
1238
+ | **end_date** | **Time** | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional] |
1239
+ | **subledger_id** | [**Array&lt;String&gt;**](String.md) | Filter results by one or more subledger IDs. Must be exact match. | [optional] |
1240
+
1241
+ ### Return type
1242
+
1243
+ [**LoyaltyCardBalances**](LoyaltyCardBalances.md)
1244
+
1245
+ ### Authorization
1246
+
1247
+ [api_key_v1](../README.md#api_key_v1)
1248
+
1249
+ ### HTTP request headers
1250
+
1251
+ - **Content-Type**: Not defined
1252
+ - **Accept**: application/json
1253
+
1254
+
1255
+ ## get_loyalty_card_points
1256
+
1257
+ > <GetLoyaltyCardPoints200Response> get_loyalty_card_points(loyalty_program_id, loyalty_card_id, opts)
1258
+
1259
+ List card's unused loyalty points
1260
+
1261
+ Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past.
1262
+
1263
+ ### Examples
1264
+
1265
+ ```ruby
1266
+ require 'time'
1267
+ require 'talon_one_sdk'
1268
+ # setup authorization
1269
+ TalonOne.configure do |config|
1270
+ # Configure API key authorization: api_key_v1
1271
+ config.api_key['Authorization'] = 'YOUR API KEY'
1272
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1273
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1274
+ end
1275
+
1276
+ api_instance = TalonOne::IntegrationApi.new
1277
+ loyalty_program_id = 789 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1278
+ loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1279
+ opts = {
1280
+ status: 'active', # String | Filter points based on their status.
1281
+ subledger_id: ['inner_example'], # Array<String> | Filter results by one or more subledger IDs. Must be exact match.
1282
+ customer_session_ids: ['inner_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
1283
+ transaction_uuids: ['inner_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
1284
+ page_size: 789, # Integer | The number of items in the response.
1285
+ skip: 789, # Integer | The number of items to skip when paging through large result sets.
1286
+ sort: 'startDate' # String | The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time.
1287
+ }
1288
+
1289
+ begin
1290
+ # List card's unused loyalty points
1291
+ result = api_instance.get_loyalty_card_points(loyalty_program_id, loyalty_card_id, opts)
1292
+ p result
1293
+ rescue TalonOne::ApiError => e
1294
+ puts "Error when calling IntegrationApi->get_loyalty_card_points: #{e}"
1295
+ end
1296
+ ```
1297
+
1298
+ #### Using the get_loyalty_card_points_with_http_info variant
1299
+
1300
+ This returns an Array which contains the response data, status code and headers.
1301
+
1302
+ > <Array(<GetLoyaltyCardPoints200Response>, Integer, Hash)> get_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, opts)
1303
+
1304
+ ```ruby
1305
+ begin
1306
+ # List card's unused loyalty points
1307
+ data, status_code, headers = api_instance.get_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, opts)
1308
+ p status_code # => 2xx
1309
+ p headers # => { ... }
1310
+ p data # => <GetLoyaltyCardPoints200Response>
1311
+ rescue TalonOne::ApiError => e
1312
+ puts "Error when calling IntegrationApi->get_loyalty_card_points_with_http_info: #{e}"
1313
+ end
1314
+ ```
1315
+
1316
+ ### Parameters
1317
+
1318
+ | Name | Type | Description | Notes |
1319
+ | ---- | ---- | ----------- | ----- |
1320
+ | **loyalty_program_id** | **Integer** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
1321
+ | **loyalty_card_id** | **String** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | |
1322
+ | **status** | **String** | Filter points based on their status. | [optional][default to &#39;active&#39;] |
1323
+ | **subledger_id** | [**Array&lt;String&gt;**](String.md) | Filter results by one or more subledger IDs. Must be exact match. | [optional] |
1324
+ | **customer_session_ids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?customerSessionIDs&#x3D;id1&amp;customerSessionIDs&#x3D;id2&#x60;. The response contains only data associated with the specified sessions. | [optional] |
1325
+ | **transaction_uuids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?transactionUUIDs&#x3D;uuid1&amp;transactionUUIDs&#x3D;uuid2&#x60;. The response contains only data associated with the specified transactions. | [optional] |
1326
+ | **page_size** | **Integer** | The number of items in the response. | [optional][default to 50] |
1327
+ | **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
1328
+ | **sort** | **String** | The field by which results should be sorted. You can enter one of the following values: - &#x60;startDate&#x60;: Sorts the results by the start date of the points. - &#x60;expiryDate&#x60;: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You can only sort by one field at a time. | [optional] |
1329
+
1330
+ ### Return type
1331
+
1332
+ [**GetLoyaltyCardPoints200Response**](GetLoyaltyCardPoints200Response.md)
1333
+
1334
+ ### Authorization
1335
+
1336
+ [api_key_v1](../README.md#api_key_v1)
1337
+
1338
+ ### HTTP request headers
1339
+
1340
+ - **Content-Type**: Not defined
1341
+ - **Accept**: application/json
1342
+
1343
+
1344
+ ## get_loyalty_card_transactions
1345
+
1346
+ > <GetLoyaltyCardTransactions200Response> get_loyalty_card_transactions(loyalty_program_id, loyalty_card_id, opts)
1347
+
1348
+ List card's transactions
1349
+
1350
+ Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
1351
+
1352
+ ### Examples
1353
+
1354
+ ```ruby
1355
+ require 'time'
1356
+ require 'talon_one_sdk'
1357
+ # setup authorization
1358
+ TalonOne.configure do |config|
1359
+ # Configure API key authorization: api_key_v1
1360
+ config.api_key['Authorization'] = 'YOUR API KEY'
1361
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1362
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1363
+ end
1364
+
1365
+ api_instance = TalonOne::IntegrationApi.new
1366
+ loyalty_program_id = 789 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1367
+ loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1368
+ opts = {
1369
+ subledger_id: ['inner_example'], # Array<String> | Filter results by one or more subledger IDs. Must be exact match.
1370
+ loyalty_transaction_type: 'manual', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
1371
+ start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
1372
+ end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
1373
+ customer_session_ids: ['inner_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
1374
+ transaction_uuids: ['inner_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
1375
+ page_size: 789, # Integer | The number of items in the response.
1376
+ skip: 789 # Integer | The number of items to skip when paging through large result sets.
1377
+ }
1378
+
1379
+ begin
1380
+ # List card's transactions
1381
+ result = api_instance.get_loyalty_card_transactions(loyalty_program_id, loyalty_card_id, opts)
1382
+ p result
1383
+ rescue TalonOne::ApiError => e
1384
+ puts "Error when calling IntegrationApi->get_loyalty_card_transactions: #{e}"
1385
+ end
1386
+ ```
1387
+
1388
+ #### Using the get_loyalty_card_transactions_with_http_info variant
1389
+
1390
+ This returns an Array which contains the response data, status code and headers.
1391
+
1392
+ > <Array(<GetLoyaltyCardTransactions200Response>, Integer, Hash)> get_loyalty_card_transactions_with_http_info(loyalty_program_id, loyalty_card_id, opts)
1393
+
1394
+ ```ruby
1395
+ begin
1396
+ # List card's transactions
1397
+ data, status_code, headers = api_instance.get_loyalty_card_transactions_with_http_info(loyalty_program_id, loyalty_card_id, opts)
1398
+ p status_code # => 2xx
1399
+ p headers # => { ... }
1400
+ p data # => <GetLoyaltyCardTransactions200Response>
1401
+ rescue TalonOne::ApiError => e
1402
+ puts "Error when calling IntegrationApi->get_loyalty_card_transactions_with_http_info: #{e}"
1403
+ end
1404
+ ```
1405
+
1406
+ ### Parameters
1407
+
1408
+ | Name | Type | Description | Notes |
1409
+ | ---- | ---- | ----------- | ----- |
1410
+ | **loyalty_program_id** | **Integer** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
1411
+ | **loyalty_card_id** | **String** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | |
1412
+ | **subledger_id** | [**Array&lt;String&gt;**](String.md) | Filter results by one or more subledger IDs. Must be exact match. | [optional] |
1413
+ | **loyalty_transaction_type** | **String** | Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file. | [optional] |
1414
+ | **start_date** | **Time** | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional] |
1415
+ | **end_date** | **Time** | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional] |
1416
+ | **customer_session_ids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?customerSessionIDs&#x3D;id1&amp;customerSessionIDs&#x3D;id2&#x60;. The response contains only data associated with the specified sessions. | [optional] |
1417
+ | **transaction_uuids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?transactionUUIDs&#x3D;uuid1&amp;transactionUUIDs&#x3D;uuid2&#x60;. The response contains only data associated with the specified transactions. | [optional] |
1418
+ | **page_size** | **Integer** | The number of items in the response. | [optional][default to 50] |
1419
+ | **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
1420
+
1421
+ ### Return type
1422
+
1423
+ [**GetLoyaltyCardTransactions200Response**](GetLoyaltyCardTransactions200Response.md)
1424
+
1425
+ ### Authorization
1426
+
1427
+ [api_key_v1](../README.md#api_key_v1)
1428
+
1429
+ ### HTTP request headers
1430
+
1431
+ - **Content-Type**: Not defined
1432
+ - **Accept**: application/json
1433
+
1434
+
1435
+ ## get_loyalty_program_profile_points
1436
+
1437
+ > <GetLoyaltyProgramProfilePoints200Response> get_loyalty_program_profile_points(loyalty_program_id, integration_id, opts)
1438
+
1439
+ List customer's unused loyalty points
1440
+
1441
+ Get paginated results of loyalty points for a given Integration ID in the specified profile-based loyalty program. This endpoint returns only the balances of unused points linked to a customer profile. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past.
1442
+
1443
+ ### Examples
1444
+
1445
+ ```ruby
1446
+ require 'time'
1447
+ require 'talon_one_sdk'
1448
+ # setup authorization
1449
+ TalonOne.configure do |config|
1450
+ # Configure API key authorization: api_key_v1
1451
+ config.api_key['Authorization'] = 'YOUR API KEY'
1452
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1453
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1454
+ end
1455
+
1456
+ api_instance = TalonOne::IntegrationApi.new
1457
+ loyalty_program_id = 789 # 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.
1458
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
1459
+ opts = {
1460
+ status: 'active', # String | Filter points based on their status.
1461
+ subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
1462
+ customer_session_ids: ['inner_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
1463
+ transaction_uuids: ['inner_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
1464
+ page_size: 789, # Integer | The number of items in the response.
1465
+ skip: 789, # Integer | The number of items to skip when paging through large result sets.
1466
+ sort: 'startDate' # String | The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time.
1467
+ }
1468
+
1469
+ begin
1470
+ # List customer's unused loyalty points
1471
+ result = api_instance.get_loyalty_program_profile_points(loyalty_program_id, integration_id, opts)
1472
+ p result
1473
+ rescue TalonOne::ApiError => e
1474
+ puts "Error when calling IntegrationApi->get_loyalty_program_profile_points: #{e}"
1475
+ end
1476
+ ```
1477
+
1478
+ #### Using the get_loyalty_program_profile_points_with_http_info variant
1479
+
1480
+ This returns an Array which contains the response data, status code and headers.
1481
+
1482
+ > <Array(<GetLoyaltyProgramProfilePoints200Response>, Integer, Hash)> get_loyalty_program_profile_points_with_http_info(loyalty_program_id, integration_id, opts)
1483
+
1484
+ ```ruby
1485
+ begin
1486
+ # List customer's unused loyalty points
1487
+ data, status_code, headers = api_instance.get_loyalty_program_profile_points_with_http_info(loyalty_program_id, integration_id, opts)
1488
+ p status_code # => 2xx
1489
+ p headers # => { ... }
1490
+ p data # => <GetLoyaltyProgramProfilePoints200Response>
1491
+ rescue TalonOne::ApiError => e
1492
+ puts "Error when calling IntegrationApi->get_loyalty_program_profile_points_with_http_info: #{e}"
1493
+ end
1494
+ ```
1495
+
1496
+ ### Parameters
1497
+
1498
+ | Name | Type | Description | Notes |
1499
+ | ---- | ---- | ----------- | ----- |
1500
+ | **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. | |
1501
+ | **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. | |
1502
+ | **status** | **String** | Filter points based on their status. | [optional][default to &#39;active&#39;] |
1503
+ | **subledger_id** | **String** | The ID of the subledger by which we filter the data. | [optional] |
1504
+ | **customer_session_ids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?customerSessionIDs&#x3D;id1&amp;customerSessionIDs&#x3D;id2&#x60;. The response contains only data associated with the specified sessions. | [optional] |
1505
+ | **transaction_uuids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?transactionUUIDs&#x3D;uuid1&amp;transactionUUIDs&#x3D;uuid2&#x60;. The response contains only data associated with the specified transactions. | [optional] |
1506
+ | **page_size** | **Integer** | The number of items in the response. | [optional][default to 50] |
1507
+ | **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
1508
+ | **sort** | **String** | The field by which results should be sorted. You can enter one of the following values: - &#x60;startDate&#x60;: Sorts the results by the start date of the points. - &#x60;expiryDate&#x60;: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** You can only sort by one field at a time. | [optional] |
1509
+
1510
+ ### Return type
1511
+
1512
+ [**GetLoyaltyProgramProfilePoints200Response**](GetLoyaltyProgramProfilePoints200Response.md)
1513
+
1514
+ ### Authorization
1515
+
1516
+ [api_key_v1](../README.md#api_key_v1)
1517
+
1518
+ ### HTTP request headers
1519
+
1520
+ - **Content-Type**: Not defined
1521
+ - **Accept**: application/json
1522
+
1523
+
1524
+ ## get_loyalty_program_profile_transactions
1525
+
1526
+ > <GetLoyaltyProgramProfileTransactions200Response> get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
1527
+
1528
+ List customer's loyalty transactions
1529
+
1530
+ Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
1531
+
1532
+ ### Examples
1533
+
1534
+ ```ruby
1535
+ require 'time'
1536
+ require 'talon_one_sdk'
1537
+ # setup authorization
1538
+ TalonOne.configure do |config|
1539
+ # Configure API key authorization: api_key_v1
1540
+ config.api_key['Authorization'] = 'YOUR API KEY'
1541
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1542
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1543
+ end
1544
+
1545
+ api_instance = TalonOne::IntegrationApi.new
1546
+ loyalty_program_id = 789 # 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.
1547
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
1548
+ opts = {
1549
+ customer_session_ids: ['inner_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
1550
+ transaction_uuids: ['inner_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
1551
+ subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
1552
+ loyalty_transaction_type: 'manual', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
1553
+ start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
1554
+ end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
1555
+ page_size: 789, # Integer | The number of items in the response.
1556
+ skip: 789 # Integer | The number of items to skip when paging through large result sets.
1557
+ }
1558
+
1559
+ begin
1560
+ # List customer's loyalty transactions
1561
+ result = api_instance.get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
1562
+ p result
1563
+ rescue TalonOne::ApiError => e
1564
+ puts "Error when calling IntegrationApi->get_loyalty_program_profile_transactions: #{e}"
1565
+ end
1566
+ ```
1567
+
1568
+ #### Using the get_loyalty_program_profile_transactions_with_http_info variant
1569
+
1570
+ This returns an Array which contains the response data, status code and headers.
1571
+
1572
+ > <Array(<GetLoyaltyProgramProfileTransactions200Response>, Integer, Hash)> get_loyalty_program_profile_transactions_with_http_info(loyalty_program_id, integration_id, opts)
1573
+
1574
+ ```ruby
1575
+ begin
1576
+ # List customer's loyalty transactions
1577
+ data, status_code, headers = api_instance.get_loyalty_program_profile_transactions_with_http_info(loyalty_program_id, integration_id, opts)
1578
+ p status_code # => 2xx
1579
+ p headers # => { ... }
1580
+ p data # => <GetLoyaltyProgramProfileTransactions200Response>
1581
+ rescue TalonOne::ApiError => e
1582
+ puts "Error when calling IntegrationApi->get_loyalty_program_profile_transactions_with_http_info: #{e}"
1583
+ end
1584
+ ```
1585
+
1586
+ ### Parameters
1587
+
1588
+ | Name | Type | Description | Notes |
1589
+ | ---- | ---- | ----------- | ----- |
1590
+ | **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. | |
1591
+ | **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. | |
1592
+ | **customer_session_ids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?customerSessionIDs&#x3D;id1&amp;customerSessionIDs&#x3D;id2&#x60;. The response contains only data associated with the specified sessions. | [optional] |
1593
+ | **transaction_uuids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, &#x60;?transactionUUIDs&#x3D;uuid1&amp;transactionUUIDs&#x3D;uuid2&#x60;. The response contains only data associated with the specified transactions. | [optional] |
1594
+ | **subledger_id** | **String** | The ID of the subledger by which we filter the data. | [optional] |
1595
+ | **loyalty_transaction_type** | **String** | Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file. | [optional] |
1596
+ | **start_date** | **Time** | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional] |
1597
+ | **end_date** | **Time** | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. | [optional] |
1598
+ | **page_size** | **Integer** | The number of items in the response. | [optional][default to 50] |
1599
+ | **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
1600
+
1601
+ ### Return type
1602
+
1603
+ [**GetLoyaltyProgramProfileTransactions200Response**](GetLoyaltyProgramProfileTransactions200Response.md)
1604
+
1605
+ ### Authorization
1606
+
1607
+ [api_key_v1](../README.md#api_key_v1)
1608
+
1609
+ ### HTTP request headers
1610
+
1611
+ - **Content-Type**: Not defined
1612
+ - **Accept**: application/json
1613
+
1614
+
1615
+ ## get_reserved_customers
1616
+
1617
+ > <GetReservedCustomers200Response> get_reserved_customers(coupon_value)
1618
+
1619
+ List customers that have this coupon reserved
1620
+
1621
+ Return all customers that have this coupon marked as reserved. This includes hard and soft reservations.
1622
+
1623
+ ### Examples
1624
+
1625
+ ```ruby
1626
+ require 'time'
1627
+ require 'talon_one_sdk'
1628
+ # setup authorization
1629
+ TalonOne.configure do |config|
1630
+ # Configure API key authorization: api_key_v1
1631
+ config.api_key['Authorization'] = 'YOUR API KEY'
1632
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1633
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1634
+ end
1635
+
1636
+ api_instance = TalonOne::IntegrationApi.new
1637
+ coupon_value = 'coupon_value_example' # String | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `SUMMER25%OFF` as `SUMMER25%25OFF`.
1638
+
1639
+ begin
1640
+ # List customers that have this coupon reserved
1641
+ result = api_instance.get_reserved_customers(coupon_value)
1642
+ p result
1643
+ rescue TalonOne::ApiError => e
1644
+ puts "Error when calling IntegrationApi->get_reserved_customers: #{e}"
1645
+ end
1646
+ ```
1647
+
1648
+ #### Using the get_reserved_customers_with_http_info variant
1649
+
1650
+ This returns an Array which contains the response data, status code and headers.
1651
+
1652
+ > <Array(<GetReservedCustomers200Response>, Integer, Hash)> get_reserved_customers_with_http_info(coupon_value)
1653
+
1654
+ ```ruby
1655
+ begin
1656
+ # List customers that have this coupon reserved
1657
+ data, status_code, headers = api_instance.get_reserved_customers_with_http_info(coupon_value)
1658
+ p status_code # => 2xx
1659
+ p headers # => { ... }
1660
+ p data # => <GetReservedCustomers200Response>
1661
+ rescue TalonOne::ApiError => e
1662
+ puts "Error when calling IntegrationApi->get_reserved_customers_with_http_info: #{e}"
1663
+ end
1664
+ ```
1665
+
1666
+ ### Parameters
1667
+
1668
+ | Name | Type | Description | Notes |
1669
+ | ---- | ---- | ----------- | ----- |
1670
+ | **coupon_value** | **String** | The code of the coupon. **Important:** The coupon code requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode &#x60;SUMMER25%OFF&#x60; as &#x60;SUMMER25%25OFF&#x60;. | |
1671
+
1672
+ ### Return type
1673
+
1674
+ [**GetReservedCustomers200Response**](GetReservedCustomers200Response.md)
1675
+
1676
+ ### Authorization
1677
+
1678
+ [api_key_v1](../README.md#api_key_v1)
1679
+
1680
+ ### HTTP request headers
1681
+
1682
+ - **Content-Type**: Not defined
1683
+ - **Accept**: application/json
1684
+
1685
+
1686
+ ## link_loyalty_card_to_profile
1687
+
1688
+ > <LoyaltyCard> link_loyalty_card_to_profile(loyalty_program_id, loyalty_card_id, loyalty_card_registration)
1689
+
1690
+ Link customer profile to card
1691
+
1692
+ [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
1693
+
1694
+ ### Examples
1695
+
1696
+ ```ruby
1697
+ require 'time'
1698
+ require 'talon_one_sdk'
1699
+ # setup authorization
1700
+ TalonOne.configure do |config|
1701
+ # Configure API key authorization: api_key_v1
1702
+ config.api_key['Authorization'] = 'YOUR API KEY'
1703
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1704
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1705
+ end
1706
+
1707
+ api_instance = TalonOne::IntegrationApi.new
1708
+ loyalty_program_id = 789 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
1709
+ loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
1710
+ loyalty_card_registration = TalonOne::LoyaltyCardRegistration.new({integration_id: 'R195412'}) # LoyaltyCardRegistration | body
1711
+
1712
+ begin
1713
+ # Link customer profile to card
1714
+ result = api_instance.link_loyalty_card_to_profile(loyalty_program_id, loyalty_card_id, loyalty_card_registration)
1715
+ p result
1716
+ rescue TalonOne::ApiError => e
1717
+ puts "Error when calling IntegrationApi->link_loyalty_card_to_profile: #{e}"
1718
+ end
1719
+ ```
1720
+
1721
+ #### Using the link_loyalty_card_to_profile_with_http_info variant
1722
+
1723
+ This returns an Array which contains the response data, status code and headers.
1724
+
1725
+ > <Array(<LoyaltyCard>, Integer, Hash)> link_loyalty_card_to_profile_with_http_info(loyalty_program_id, loyalty_card_id, loyalty_card_registration)
1726
+
1727
+ ```ruby
1728
+ begin
1729
+ # Link customer profile to card
1730
+ data, status_code, headers = api_instance.link_loyalty_card_to_profile_with_http_info(loyalty_program_id, loyalty_card_id, loyalty_card_registration)
1731
+ p status_code # => 2xx
1732
+ p headers # => { ... }
1733
+ p data # => <LoyaltyCard>
1734
+ rescue TalonOne::ApiError => e
1735
+ puts "Error when calling IntegrationApi->link_loyalty_card_to_profile_with_http_info: #{e}"
1736
+ end
1737
+ ```
1738
+
1739
+ ### Parameters
1740
+
1741
+ | Name | Type | Description | Notes |
1742
+ | ---- | ---- | ----------- | ----- |
1743
+ | **loyalty_program_id** | **Integer** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | |
1744
+ | **loyalty_card_id** | **String** | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. | |
1745
+ | **loyalty_card_registration** | [**LoyaltyCardRegistration**](LoyaltyCardRegistration.md) | body | |
1746
+
1747
+ ### Return type
1748
+
1749
+ [**LoyaltyCard**](LoyaltyCard.md)
1750
+
1751
+ ### Authorization
1752
+
1753
+ [api_key_v1](../README.md#api_key_v1)
1754
+
1755
+ ### HTTP request headers
1756
+
1757
+ - **Content-Type**: application/json
1758
+ - **Accept**: application/json
1759
+
1760
+
1761
+ ## reopen_customer_session
1762
+
1763
+ > <ReopenSessionResponse> reopen_customer_session(customer_session_id)
1764
+
1765
+ Reopen customer session
1766
+
1767
+ Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> <p>To see an example of a rollback, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets</a>tutorial.</p> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
1768
+
1769
+ ### Examples
1770
+
1771
+ ```ruby
1772
+ require 'time'
1773
+ require 'talon_one_sdk'
1774
+ # setup authorization
1775
+ TalonOne.configure do |config|
1776
+ # Configure API key authorization: api_key_v1
1777
+ config.api_key['Authorization'] = 'YOUR API KEY'
1778
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1779
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1780
+ end
1781
+
1782
+ api_instance = TalonOne::IntegrationApi.new
1783
+ customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
1784
+
1785
+ begin
1786
+ # Reopen customer session
1787
+ result = api_instance.reopen_customer_session(customer_session_id)
1788
+ p result
1789
+ rescue TalonOne::ApiError => e
1790
+ puts "Error when calling IntegrationApi->reopen_customer_session: #{e}"
1791
+ end
1792
+ ```
1793
+
1794
+ #### Using the reopen_customer_session_with_http_info variant
1795
+
1796
+ This returns an Array which contains the response data, status code and headers.
1797
+
1798
+ > <Array(<ReopenSessionResponse>, Integer, Hash)> reopen_customer_session_with_http_info(customer_session_id)
1799
+
1800
+ ```ruby
1801
+ begin
1802
+ # Reopen customer session
1803
+ data, status_code, headers = api_instance.reopen_customer_session_with_http_info(customer_session_id)
1804
+ p status_code # => 2xx
1805
+ p headers # => { ... }
1806
+ p data # => <ReopenSessionResponse>
1807
+ rescue TalonOne::ApiError => e
1808
+ puts "Error when calling IntegrationApi->reopen_customer_session_with_http_info: #{e}"
1809
+ end
1810
+ ```
1811
+
1812
+ ### Parameters
1813
+
1814
+ | Name | Type | Description | Notes |
1815
+ | ---- | ---- | ----------- | ----- |
1816
+ | **customer_session_id** | **String** | The &#x60;integration ID&#x60; of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager&#39;s **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
1817
+
1818
+ ### Return type
1819
+
1820
+ [**ReopenSessionResponse**](ReopenSessionResponse.md)
1821
+
1822
+ ### Authorization
1823
+
1824
+ [api_key_v1](../README.md#api_key_v1)
1825
+
1826
+ ### HTTP request headers
1827
+
1828
+ - **Content-Type**: Not defined
1829
+ - **Accept**: application/json
1830
+
1831
+
1832
+ ## return_cart_items
1833
+
1834
+ > <IntegrationStateV2> return_cart_items(customer_session_id, return_integration_request, opts)
1835
+
1836
+ Return cart items
1837
+
1838
+ Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
1839
+
1840
+ ### Examples
1841
+
1842
+ ```ruby
1843
+ require 'time'
1844
+ require 'talon_one_sdk'
1845
+ # setup authorization
1846
+ TalonOne.configure do |config|
1847
+ # Configure API key authorization: api_key_v1
1848
+ config.api_key['Authorization'] = 'YOUR API KEY'
1849
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1850
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1851
+ end
1852
+
1853
+ api_instance = TalonOne::IntegrationApi.new
1854
+ customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
1855
+ return_integration_request = TalonOne::ReturnIntegrationRequest.new({_return: TalonOne::NewReturn.new({returned_cart_items: [TalonOne::ReturnedCartItem.new]})}) # ReturnIntegrationRequest | body
1856
+ opts = {
1857
+ dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
1858
+ }
1859
+
1860
+ begin
1861
+ # Return cart items
1862
+ result = api_instance.return_cart_items(customer_session_id, return_integration_request, opts)
1863
+ p result
1864
+ rescue TalonOne::ApiError => e
1865
+ puts "Error when calling IntegrationApi->return_cart_items: #{e}"
1866
+ end
1867
+ ```
1868
+
1869
+ #### Using the return_cart_items_with_http_info variant
1870
+
1871
+ This returns an Array which contains the response data, status code and headers.
1872
+
1873
+ > <Array(<IntegrationStateV2>, Integer, Hash)> return_cart_items_with_http_info(customer_session_id, return_integration_request, opts)
1874
+
1875
+ ```ruby
1876
+ begin
1877
+ # Return cart items
1878
+ data, status_code, headers = api_instance.return_cart_items_with_http_info(customer_session_id, return_integration_request, opts)
1879
+ p status_code # => 2xx
1880
+ p headers # => { ... }
1881
+ p data # => <IntegrationStateV2>
1882
+ rescue TalonOne::ApiError => e
1883
+ puts "Error when calling IntegrationApi->return_cart_items_with_http_info: #{e}"
1884
+ end
1885
+ ```
1886
+
1887
+ ### Parameters
1888
+
1889
+ | Name | Type | Description | Notes |
1890
+ | ---- | ---- | ----------- | ----- |
1891
+ | **customer_session_id** | **String** | The &#x60;integration ID&#x60; of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager&#39;s **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
1892
+ | **return_integration_request** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md) | body | |
1893
+ | **dry** | **Boolean** | Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;. | [optional] |
1894
+
1895
+ ### Return type
1896
+
1897
+ [**IntegrationStateV2**](IntegrationStateV2.md)
1898
+
1899
+ ### Authorization
1900
+
1901
+ [api_key_v1](../README.md#api_key_v1)
1902
+
1903
+ ### HTTP request headers
1904
+
1905
+ - **Content-Type**: application/json
1906
+ - **Accept**: application/json
1907
+
1908
+
1909
+ ## sync_catalog
1910
+
1911
+ > <Catalog> sync_catalog(catalog_id, catalog_sync_request)
1912
+
1913
+ Sync cart item catalog
1914
+
1915
+ Perform the following actions for a given cart item catalog: - Add an item to the catalog. - Add multiple items to the catalog. - Update the attributes of an item in the catalog. - Update the attributes of multiple items in the catalog. - Remove an item from the catalog. - Remove multiple items from the catalog. You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding multiple items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Updating the attributes of multiple items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing multiple items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
1916
+
1917
+ ### Examples
1918
+
1919
+ ```ruby
1920
+ require 'time'
1921
+ require 'talon_one_sdk'
1922
+ # setup authorization
1923
+ TalonOne.configure do |config|
1924
+ # Configure API key authorization: api_key_v1
1925
+ config.api_key['Authorization'] = 'YOUR API KEY'
1926
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1927
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1928
+ end
1929
+
1930
+ api_instance = TalonOne::IntegrationApi.new
1931
+ catalog_id = 789 # Integer | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
1932
+ catalog_sync_request = TalonOne::CatalogSyncRequest.new({actions: [3.56]}) # CatalogSyncRequest | body
1933
+
1934
+ begin
1935
+ # Sync cart item catalog
1936
+ result = api_instance.sync_catalog(catalog_id, catalog_sync_request)
1937
+ p result
1938
+ rescue TalonOne::ApiError => e
1939
+ puts "Error when calling IntegrationApi->sync_catalog: #{e}"
1940
+ end
1941
+ ```
1942
+
1943
+ #### Using the sync_catalog_with_http_info variant
1944
+
1945
+ This returns an Array which contains the response data, status code and headers.
1946
+
1947
+ > <Array(<Catalog>, Integer, Hash)> sync_catalog_with_http_info(catalog_id, catalog_sync_request)
1948
+
1949
+ ```ruby
1950
+ begin
1951
+ # Sync cart item catalog
1952
+ data, status_code, headers = api_instance.sync_catalog_with_http_info(catalog_id, catalog_sync_request)
1953
+ p status_code # => 2xx
1954
+ p headers # => { ... }
1955
+ p data # => <Catalog>
1956
+ rescue TalonOne::ApiError => e
1957
+ puts "Error when calling IntegrationApi->sync_catalog_with_http_info: #{e}"
1958
+ end
1959
+ ```
1960
+
1961
+ ### Parameters
1962
+
1963
+ | Name | Type | Description | Notes |
1964
+ | ---- | ---- | ----------- | ----- |
1965
+ | **catalog_id** | **Integer** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** &gt; **Tools** &gt; **Cart item catalogs**. | |
1966
+ | **catalog_sync_request** | [**CatalogSyncRequest**](CatalogSyncRequest.md) | body | |
1967
+
1968
+ ### Return type
1969
+
1970
+ [**Catalog**](Catalog.md)
1971
+
1972
+ ### Authorization
1973
+
1974
+ [api_key_v1](../README.md#api_key_v1)
1975
+
1976
+ ### HTTP request headers
1977
+
1978
+ - **Content-Type**: application/json
1979
+ - **Accept**: application/json
1980
+
1981
+
1982
+ ## track_event_v2
1983
+
1984
+ > <TrackEventV2Response> track_event_v2(integration_event_v2_request, opts)
1985
+
1986
+ Track event
1987
+
1988
+ Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not specify it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. </div>
1989
+
1990
+ ### Examples
1991
+
1992
+ ```ruby
1993
+ require 'time'
1994
+ require 'talon_one_sdk'
1995
+ # setup authorization
1996
+ TalonOne.configure do |config|
1997
+ # Configure API key authorization: api_key_v1
1998
+ config.api_key['Authorization'] = 'YOUR API KEY'
1999
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2000
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2001
+ end
2002
+
2003
+ api_instance = TalonOne::IntegrationApi.new
2004
+ integration_event_v2_request = TalonOne::IntegrationEventV2Request.new({type: 'pageViewed'}) # IntegrationEventV2Request | body
2005
+ opts = {
2006
+ silent: 'silent_example', # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
2007
+ dry: true, # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
2008
+ force_complete_evaluation: true # Boolean | Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`.
2009
+ }
2010
+
2011
+ begin
2012
+ # Track event
2013
+ result = api_instance.track_event_v2(integration_event_v2_request, opts)
2014
+ p result
2015
+ rescue TalonOne::ApiError => e
2016
+ puts "Error when calling IntegrationApi->track_event_v2: #{e}"
2017
+ end
2018
+ ```
2019
+
2020
+ #### Using the track_event_v2_with_http_info variant
2021
+
2022
+ This returns an Array which contains the response data, status code and headers.
2023
+
2024
+ > <Array(<TrackEventV2Response>, Integer, Hash)> track_event_v2_with_http_info(integration_event_v2_request, opts)
2025
+
2026
+ ```ruby
2027
+ begin
2028
+ # Track event
2029
+ data, status_code, headers = api_instance.track_event_v2_with_http_info(integration_event_v2_request, opts)
2030
+ p status_code # => 2xx
2031
+ p headers # => { ... }
2032
+ p data # => <TrackEventV2Response>
2033
+ rescue TalonOne::ApiError => e
2034
+ puts "Error when calling IntegrationApi->track_event_v2_with_http_info: #{e}"
2035
+ end
2036
+ ```
2037
+
2038
+ ### Parameters
2039
+
2040
+ | Name | Type | Description | Notes |
2041
+ | ---- | ---- | ----------- | ----- |
2042
+ | **integration_event_v2_request** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md) | body | |
2043
+ | **silent** | **String** | Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. | [optional][default to &#39;yes&#39;] |
2044
+ | **dry** | **Boolean** | Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;. | [optional] |
2045
+ | **force_complete_evaluation** | **Boolean** | Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires &#x60;dry&#x3D;true&#x60;. | [optional][default to false] |
2046
+
2047
+ ### Return type
2048
+
2049
+ [**TrackEventV2Response**](TrackEventV2Response.md)
2050
+
2051
+ ### Authorization
2052
+
2053
+ [api_key_v1](../README.md#api_key_v1)
2054
+
2055
+ ### HTTP request headers
2056
+
2057
+ - **Content-Type**: application/json
2058
+ - **Accept**: application/json
2059
+
2060
+
2061
+ ## update_audience_customers_attributes
2062
+
2063
+ > update_audience_customers_attributes(audience_id, body)
2064
+
2065
+ Update profile attributes for all customers in audience
2066
+
2067
+ Update the specified profile attributes to the provided values for all customers in the specified audience.
2068
+
2069
+ ### Examples
2070
+
2071
+ ```ruby
2072
+ require 'time'
2073
+ require 'talon_one_sdk'
2074
+ # setup authorization
2075
+ TalonOne.configure do |config|
2076
+ # Configure API key authorization: api_key_v1
2077
+ config.api_key['Authorization'] = 'YOUR API KEY'
2078
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2079
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2080
+ end
2081
+
2082
+ api_instance = TalonOne::IntegrationApi.new
2083
+ audience_id = 789 # Integer | The ID of the audience.
2084
+ body = { ... } # Object | body
2085
+
2086
+ begin
2087
+ # Update profile attributes for all customers in audience
2088
+ api_instance.update_audience_customers_attributes(audience_id, body)
2089
+ rescue TalonOne::ApiError => e
2090
+ puts "Error when calling IntegrationApi->update_audience_customers_attributes: #{e}"
2091
+ end
2092
+ ```
2093
+
2094
+ #### Using the update_audience_customers_attributes_with_http_info variant
2095
+
2096
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2097
+
2098
+ > <Array(nil, Integer, Hash)> update_audience_customers_attributes_with_http_info(audience_id, body)
2099
+
2100
+ ```ruby
2101
+ begin
2102
+ # Update profile attributes for all customers in audience
2103
+ data, status_code, headers = api_instance.update_audience_customers_attributes_with_http_info(audience_id, body)
2104
+ p status_code # => 2xx
2105
+ p headers # => { ... }
2106
+ p data # => nil
2107
+ rescue TalonOne::ApiError => e
2108
+ puts "Error when calling IntegrationApi->update_audience_customers_attributes_with_http_info: #{e}"
2109
+ end
2110
+ ```
2111
+
2112
+ ### Parameters
2113
+
2114
+ | Name | Type | Description | Notes |
2115
+ | ---- | ---- | ----------- | ----- |
2116
+ | **audience_id** | **Integer** | The ID of the audience. | |
2117
+ | **body** | **Object** | body | |
2118
+
2119
+ ### Return type
2120
+
2121
+ nil (empty response body)
2122
+
2123
+ ### Authorization
2124
+
2125
+ [api_key_v1](../README.md#api_key_v1)
2126
+
2127
+ ### HTTP request headers
2128
+
2129
+ - **Content-Type**: application/json
2130
+ - **Accept**: application/json
2131
+
2132
+
2133
+ ## update_audience_v2
2134
+
2135
+ > <Audience> update_audience_v2(audience_id, update_audience)
2136
+
2137
+ Update audience name
2138
+
2139
+ Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
2140
+
2141
+ ### Examples
2142
+
2143
+ ```ruby
2144
+ require 'time'
2145
+ require 'talon_one_sdk'
2146
+ # setup authorization
2147
+ TalonOne.configure do |config|
2148
+ # Configure API key authorization: api_key_v1
2149
+ config.api_key['Authorization'] = 'YOUR API KEY'
2150
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2151
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2152
+ end
2153
+
2154
+ api_instance = TalonOne::IntegrationApi.new
2155
+ audience_id = 789 # Integer | The ID of the audience.
2156
+ update_audience = TalonOne::UpdateAudience.new({name: 'Travel audience'}) # UpdateAudience | body
2157
+
2158
+ begin
2159
+ # Update audience name
2160
+ result = api_instance.update_audience_v2(audience_id, update_audience)
2161
+ p result
2162
+ rescue TalonOne::ApiError => e
2163
+ puts "Error when calling IntegrationApi->update_audience_v2: #{e}"
2164
+ end
2165
+ ```
2166
+
2167
+ #### Using the update_audience_v2_with_http_info variant
2168
+
2169
+ This returns an Array which contains the response data, status code and headers.
2170
+
2171
+ > <Array(<Audience>, Integer, Hash)> update_audience_v2_with_http_info(audience_id, update_audience)
2172
+
2173
+ ```ruby
2174
+ begin
2175
+ # Update audience name
2176
+ data, status_code, headers = api_instance.update_audience_v2_with_http_info(audience_id, update_audience)
2177
+ p status_code # => 2xx
2178
+ p headers # => { ... }
2179
+ p data # => <Audience>
2180
+ rescue TalonOne::ApiError => e
2181
+ puts "Error when calling IntegrationApi->update_audience_v2_with_http_info: #{e}"
2182
+ end
2183
+ ```
2184
+
2185
+ ### Parameters
2186
+
2187
+ | Name | Type | Description | Notes |
2188
+ | ---- | ---- | ----------- | ----- |
2189
+ | **audience_id** | **Integer** | The ID of the audience. | |
2190
+ | **update_audience** | [**UpdateAudience**](UpdateAudience.md) | body | |
2191
+
2192
+ ### Return type
2193
+
2194
+ [**Audience**](Audience.md)
2195
+
2196
+ ### Authorization
2197
+
2198
+ [api_key_v1](../README.md#api_key_v1)
2199
+
2200
+ ### HTTP request headers
2201
+
2202
+ - **Content-Type**: application/json
2203
+ - **Accept**: application/json
2204
+
2205
+
2206
+ ## update_customer_profile_audiences
2207
+
2208
+ > update_customer_profile_audiences(customer_profile_audience_request)
2209
+
2210
+ Update multiple customer profiles' audiences
2211
+
2212
+ Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. **Note:** You can also do this using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
2213
+
2214
+ ### Examples
2215
+
2216
+ ```ruby
2217
+ require 'time'
2218
+ require 'talon_one_sdk'
2219
+ # setup authorization
2220
+ TalonOne.configure do |config|
2221
+ # Configure API key authorization: api_key_v1
2222
+ config.api_key['Authorization'] = 'YOUR API KEY'
2223
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2224
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2225
+ end
2226
+
2227
+ api_instance = TalonOne::IntegrationApi.new
2228
+ customer_profile_audience_request = TalonOne::CustomerProfileAudienceRequest.new # CustomerProfileAudienceRequest | body
2229
+
2230
+ begin
2231
+ # Update multiple customer profiles' audiences
2232
+ api_instance.update_customer_profile_audiences(customer_profile_audience_request)
2233
+ rescue TalonOne::ApiError => e
2234
+ puts "Error when calling IntegrationApi->update_customer_profile_audiences: #{e}"
2235
+ end
2236
+ ```
2237
+
2238
+ #### Using the update_customer_profile_audiences_with_http_info variant
2239
+
2240
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2241
+
2242
+ > <Array(nil, Integer, Hash)> update_customer_profile_audiences_with_http_info(customer_profile_audience_request)
2243
+
2244
+ ```ruby
2245
+ begin
2246
+ # Update multiple customer profiles' audiences
2247
+ data, status_code, headers = api_instance.update_customer_profile_audiences_with_http_info(customer_profile_audience_request)
2248
+ p status_code # => 2xx
2249
+ p headers # => { ... }
2250
+ p data # => nil
2251
+ rescue TalonOne::ApiError => e
2252
+ puts "Error when calling IntegrationApi->update_customer_profile_audiences_with_http_info: #{e}"
2253
+ end
2254
+ ```
2255
+
2256
+ ### Parameters
2257
+
2258
+ | Name | Type | Description | Notes |
2259
+ | ---- | ---- | ----------- | ----- |
2260
+ | **customer_profile_audience_request** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md) | body | |
2261
+
2262
+ ### Return type
2263
+
2264
+ nil (empty response body)
2265
+
2266
+ ### Authorization
2267
+
2268
+ [api_key_v1](../README.md#api_key_v1)
2269
+
2270
+ ### HTTP request headers
2271
+
2272
+ - **Content-Type**: application/json
2273
+ - **Accept**: application/json
2274
+
2275
+
2276
+ ## update_customer_profile_v2
2277
+
2278
+ > <CustomerProfileIntegrationResponseV2> update_customer_profile_v2(integration_id, customer_profile_integration_request_v2, opts)
2279
+
2280
+ Update customer profile
2281
+
2282
+ Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
2283
+
2284
+ ### Examples
2285
+
2286
+ ```ruby
2287
+ require 'time'
2288
+ require 'talon_one_sdk'
2289
+ # setup authorization
2290
+ TalonOne.configure do |config|
2291
+ # Configure API key authorization: api_key_v1
2292
+ config.api_key['Authorization'] = 'YOUR API KEY'
2293
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2294
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2295
+ end
2296
+
2297
+ api_instance = TalonOne::IntegrationApi.new
2298
+ integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
2299
+ customer_profile_integration_request_v2 = TalonOne::CustomerProfileIntegrationRequestV2.new # CustomerProfileIntegrationRequestV2 | body
2300
+ opts = {
2301
+ run_rule_engine: true, # Boolean | Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body.
2302
+ dry: true # Boolean | (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run.
2303
+ }
2304
+
2305
+ begin
2306
+ # Update customer profile
2307
+ result = api_instance.update_customer_profile_v2(integration_id, customer_profile_integration_request_v2, opts)
2308
+ p result
2309
+ rescue TalonOne::ApiError => e
2310
+ puts "Error when calling IntegrationApi->update_customer_profile_v2: #{e}"
2311
+ end
2312
+ ```
2313
+
2314
+ #### Using the update_customer_profile_v2_with_http_info variant
2315
+
2316
+ This returns an Array which contains the response data, status code and headers.
2317
+
2318
+ > <Array(<CustomerProfileIntegrationResponseV2>, Integer, Hash)> update_customer_profile_v2_with_http_info(integration_id, customer_profile_integration_request_v2, opts)
2319
+
2320
+ ```ruby
2321
+ begin
2322
+ # Update customer profile
2323
+ data, status_code, headers = api_instance.update_customer_profile_v2_with_http_info(integration_id, customer_profile_integration_request_v2, opts)
2324
+ p status_code # => 2xx
2325
+ p headers # => { ... }
2326
+ p data # => <CustomerProfileIntegrationResponseV2>
2327
+ rescue TalonOne::ApiError => e
2328
+ puts "Error when calling IntegrationApi->update_customer_profile_v2_with_http_info: #{e}"
2329
+ end
2330
+ ```
2331
+
2332
+ ### Parameters
2333
+
2334
+ | Name | Type | Description | Notes |
2335
+ | ---- | ---- | ----------- | ----- |
2336
+ | **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. | |
2337
+ | **customer_profile_integration_request_v2** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md) | body | |
2338
+ | **run_rule_engine** | **Boolean** | Indicates whether to run the Rule Engine. If &#x60;true&#x60;, the response includes: - The effects generated by the triggered campaigns are returned in the &#x60;effects&#x60; property. - The created coupons and referral objects. If &#x60;false&#x60;: - The rules are not executed and the &#x60;effects&#x60; property is always empty. - The response time improves. - You cannot use &#x60;responseContent&#x60; in the body. | [optional][default to false] |
2339
+ | **dry** | **Boolean** | (Only works when &#x60;runRuleEngine&#x3D;true&#x60;) Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;. When set to &#x60;true&#x60;, you can use the &#x60;evaluableCampaignIds&#x60; body property to select specific campaigns to run. | [optional] |
2340
+
2341
+ ### Return type
2342
+
2343
+ [**CustomerProfileIntegrationResponseV2**](CustomerProfileIntegrationResponseV2.md)
2344
+
2345
+ ### Authorization
2346
+
2347
+ [api_key_v1](../README.md#api_key_v1)
2348
+
2349
+ ### HTTP request headers
2350
+
2351
+ - **Content-Type**: application/json
2352
+ - **Accept**: application/json
2353
+
2354
+
2355
+ ## update_customer_profiles_v2
2356
+
2357
+ > <MultipleCustomerProfileIntegrationResponseV2> update_customer_profiles_v2(multiple_customer_profile_integration_request, opts)
2358
+
2359
+ Update multiple customer profiles
2360
+
2361
+ Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
2362
+
2363
+ ### Examples
2364
+
2365
+ ```ruby
2366
+ require 'time'
2367
+ require 'talon_one_sdk'
2368
+ # setup authorization
2369
+ TalonOne.configure do |config|
2370
+ # Configure API key authorization: api_key_v1
2371
+ config.api_key['Authorization'] = 'YOUR API KEY'
2372
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2373
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2374
+ end
2375
+
2376
+ api_instance = TalonOne::IntegrationApi.new
2377
+ multiple_customer_profile_integration_request = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest | body
2378
+ opts = {
2379
+ silent: 'silent_example' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
2380
+ }
2381
+
2382
+ begin
2383
+ # Update multiple customer profiles
2384
+ result = api_instance.update_customer_profiles_v2(multiple_customer_profile_integration_request, opts)
2385
+ p result
2386
+ rescue TalonOne::ApiError => e
2387
+ puts "Error when calling IntegrationApi->update_customer_profiles_v2: #{e}"
2388
+ end
2389
+ ```
2390
+
2391
+ #### Using the update_customer_profiles_v2_with_http_info variant
2392
+
2393
+ This returns an Array which contains the response data, status code and headers.
2394
+
2395
+ > <Array(<MultipleCustomerProfileIntegrationResponseV2>, Integer, Hash)> update_customer_profiles_v2_with_http_info(multiple_customer_profile_integration_request, opts)
2396
+
2397
+ ```ruby
2398
+ begin
2399
+ # Update multiple customer profiles
2400
+ data, status_code, headers = api_instance.update_customer_profiles_v2_with_http_info(multiple_customer_profile_integration_request, opts)
2401
+ p status_code # => 2xx
2402
+ p headers # => { ... }
2403
+ p data # => <MultipleCustomerProfileIntegrationResponseV2>
2404
+ rescue TalonOne::ApiError => e
2405
+ puts "Error when calling IntegrationApi->update_customer_profiles_v2_with_http_info: #{e}"
2406
+ end
2407
+ ```
2408
+
2409
+ ### Parameters
2410
+
2411
+ | Name | Type | Description | Notes |
2412
+ | ---- | ---- | ----------- | ----- |
2413
+ | **multiple_customer_profile_integration_request** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md) | body | |
2414
+ | **silent** | **String** | Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. | [optional][default to &#39;yes&#39;] |
2415
+
2416
+ ### Return type
2417
+
2418
+ [**MultipleCustomerProfileIntegrationResponseV2**](MultipleCustomerProfileIntegrationResponseV2.md)
2419
+
2420
+ ### Authorization
2421
+
2422
+ [api_key_v1](../README.md#api_key_v1)
2423
+
2424
+ ### HTTP request headers
2425
+
2426
+ - **Content-Type**: application/json
2427
+ - **Accept**: application/json
2428
+
2429
+
2430
+ ## update_customer_session_v2
2431
+
2432
+ > <IntegrationStateV2> update_customer_session_v2(customer_session_id, integration_request, opts)
2433
+
2434
+ Update customer session
2435
+
2436
+ Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
2437
+
2438
+ ### Examples
2439
+
2440
+ ```ruby
2441
+ require 'time'
2442
+ require 'talon_one_sdk'
2443
+ # setup authorization
2444
+ TalonOne.configure do |config|
2445
+ # Configure API key authorization: api_key_v1
2446
+ config.api_key['Authorization'] = 'YOUR API KEY'
2447
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2448
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2449
+ end
2450
+
2451
+ api_instance = TalonOne::IntegrationApi.new
2452
+ customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
2453
+ integration_request = TalonOne::IntegrationRequest.new({customer_session: TalonOne::NewCustomerSessionV2.new}) # IntegrationRequest | body
2454
+ opts = {
2455
+ dry: true, # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests).
2456
+ now: Time.parse('2013-10-20T19:20:30+01:00') # Time | A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`.
2457
+ }
2458
+
2459
+ begin
2460
+ # Update customer session
2461
+ result = api_instance.update_customer_session_v2(customer_session_id, integration_request, opts)
2462
+ p result
2463
+ rescue TalonOne::ApiError => e
2464
+ puts "Error when calling IntegrationApi->update_customer_session_v2: #{e}"
2465
+ end
2466
+ ```
2467
+
2468
+ #### Using the update_customer_session_v2_with_http_info variant
2469
+
2470
+ This returns an Array which contains the response data, status code and headers.
2471
+
2472
+ > <Array(<IntegrationStateV2>, Integer, Hash)> update_customer_session_v2_with_http_info(customer_session_id, integration_request, opts)
2473
+
2474
+ ```ruby
2475
+ begin
2476
+ # Update customer session
2477
+ data, status_code, headers = api_instance.update_customer_session_v2_with_http_info(customer_session_id, integration_request, opts)
2478
+ p status_code # => 2xx
2479
+ p headers # => { ... }
2480
+ p data # => <IntegrationStateV2>
2481
+ rescue TalonOne::ApiError => e
2482
+ puts "Error when calling IntegrationApi->update_customer_session_v2_with_http_info: #{e}"
2483
+ end
2484
+ ```
2485
+
2486
+ ### Parameters
2487
+
2488
+ | Name | Type | Description | Notes |
2489
+ | ---- | ---- | ----------- | ----- |
2490
+ | **customer_session_id** | **String** | The &#x60;integration ID&#x60; of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager&#39;s **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. | |
2491
+ | **integration_request** | [**IntegrationRequest**](IntegrationRequest.md) | body | |
2492
+ | **dry** | **Boolean** | Indicates whether to persist the changes. Changes are ignored when &#x60;dry&#x3D;true&#x60;. When set to &#x60;true&#x60;: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the &#x60;dry&#x60; parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the &#x60;evaluableCampaignIds&#x60; body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | [optional] |
2493
+ | **now** | **Time** | A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the &#x60;dry&#x60; parameter in the query is set to &#x60;true&#x60;. | [optional] |
2494
+
2495
+ ### Return type
2496
+
2497
+ [**IntegrationStateV2**](IntegrationStateV2.md)
2498
+
2499
+ ### Authorization
2500
+
2501
+ [api_key_v1](../README.md#api_key_v1)
2502
+
2503
+ ### HTTP request headers
2504
+
2505
+ - **Content-Type**: application/json
2506
+ - **Accept**: application/json
2507
+