talon_one 5.0.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (327) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +77 -17
  3. data/docs/AchievementProgress.md +2 -0
  4. data/docs/AdditionalCampaignProperties.md +3 -1
  5. data/docs/AnalyticsDataPoint.md +19 -0
  6. data/docs/AnalyticsDataPointWithTrend.md +19 -0
  7. data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +21 -0
  8. data/docs/AnalyticsDataPointWithTrendAndUplift.md +21 -0
  9. data/docs/Application.md +4 -0
  10. data/docs/ApplicationAnalyticsDataPoint.md +6 -6
  11. data/docs/ApplicationCIF.md +33 -0
  12. data/docs/ApplicationCIFExpression.md +27 -0
  13. data/docs/ApplicationCampaignAnalytics.md +13 -19
  14. data/docs/ApplicationCampaignStats.md +1 -3
  15. data/docs/AsyncCouponDeletionJobResponse.md +17 -0
  16. data/docs/BaseLoyaltyProgram.md +8 -4
  17. data/docs/BaseNotification.md +1 -1
  18. data/docs/BaseNotificationEntity.md +1 -1
  19. data/docs/Campaign.md +15 -1
  20. data/docs/CampaignCollectionEditedNotification.md +21 -0
  21. data/docs/CampaignNotificationPolicy.md +3 -1
  22. data/docs/CampaignStateChangedNotification.md +2 -2
  23. data/docs/CampaignStoreBudget.md +25 -0
  24. data/docs/CampaignVersions.md +27 -0
  25. data/docs/CardAddedDeductedPointsNotificationPolicy.md +19 -0
  26. data/docs/CartItem.md +1 -1
  27. data/docs/CodeGeneratorSettings.md +1 -1
  28. data/docs/Coupon.md +1 -1
  29. data/docs/CouponConstraints.md +1 -1
  30. data/docs/CouponCreationJob.md +1 -1
  31. data/docs/CouponDeletionFilters.md +43 -0
  32. data/docs/CouponDeletionJob.md +39 -0
  33. data/docs/CustomerSessionV2.md +2 -2
  34. data/docs/Effect.md +8 -0
  35. data/docs/EffectEntity.md +9 -1
  36. data/docs/Environment.md +3 -1
  37. data/docs/Event.md +1 -1
  38. data/docs/GenerateCampaignDescription.md +19 -0
  39. data/docs/GenerateCampaignTags.md +17 -0
  40. data/docs/GenerateItemFilterDescription.md +17 -0
  41. data/docs/GenerateLoyaltyCard.md +19 -0
  42. data/docs/GenerateRuleTitle.md +19 -0
  43. data/docs/GenerateRuleTitleRule.md +19 -0
  44. data/docs/IncreaseAchievementProgressEffectProps.md +1 -1
  45. data/docs/IntegrationApi.md +67 -6
  46. data/docs/IntegrationCoupon.md +1 -1
  47. data/docs/InventoryCoupon.md +1 -1
  48. data/docs/InventoryReferral.md +1 -1
  49. data/docs/LoyaltyBalanceWithTier.md +31 -0
  50. data/docs/LoyaltyBalancesWithTiers.md +19 -0
  51. data/docs/LoyaltyCard.md +6 -2
  52. data/docs/LoyaltyCardBatch.md +21 -0
  53. data/docs/LoyaltyCardBatchResponse.md +19 -0
  54. data/docs/LoyaltyProgram.md +14 -6
  55. data/docs/ManagementApi.md +1044 -69
  56. data/docs/MessageLogResponse.md +3 -3
  57. data/docs/NewAppWideCouponDeletionJob.md +19 -0
  58. data/docs/NewApplication.md +3 -1
  59. data/docs/NewApplicationCIF.md +27 -0
  60. data/docs/NewApplicationCIFExpression.md +21 -0
  61. data/docs/NewBaseNotification.md +1 -1
  62. data/docs/NewCouponCreationJob.md +1 -1
  63. data/docs/NewCouponDeletionJob.md +17 -0
  64. data/docs/NewCoupons.md +1 -1
  65. data/docs/NewCouponsForMultipleRecipients.md +1 -1
  66. data/docs/NewCustomerSessionV2.md +2 -2
  67. data/docs/NewLoyaltyProgram.md +8 -4
  68. data/docs/NewOutgoingIntegrationWebhook.md +2 -0
  69. data/docs/NewReferral.md +1 -1
  70. data/docs/NewReferralsForMultipleAdvocates.md +1 -1
  71. data/docs/NewRevisionVersion.md +37 -0
  72. data/docs/NewWebhook.md +2 -0
  73. data/docs/OktaEvent.md +19 -0
  74. data/docs/OktaEventPayload.md +17 -0
  75. data/docs/OktaEventPayloadData.md +17 -0
  76. data/docs/OktaEventTarget.md +21 -0
  77. data/docs/ProjectedTier.md +21 -0
  78. data/docs/Referral.md +1 -1
  79. data/docs/ReferralConstraints.md +1 -1
  80. data/docs/RejectCouponEffectProps.md +3 -1
  81. data/docs/RejectReferralEffectProps.md +3 -1
  82. data/docs/Revision.md +35 -0
  83. data/docs/RevisionActivation.md +17 -0
  84. data/docs/RevisionVersion.md +53 -0
  85. data/docs/RollbackIncreasedAchievementProgressEffectProps.md +27 -0
  86. data/docs/RuleFailureReason.md +5 -1
  87. data/docs/SSOConfig.md +3 -1
  88. data/docs/ScimBaseUser.md +23 -0
  89. data/docs/ScimBaseUserName.md +17 -0
  90. data/docs/ScimNewUser.md +23 -0
  91. data/docs/ScimPatchOperation.md +21 -0
  92. data/docs/ScimPatchRequest.md +19 -0
  93. data/docs/ScimResource.md +21 -0
  94. data/docs/ScimResourceTypesListResponse.md +17 -0
  95. data/docs/ScimSchemaResource.md +23 -0
  96. data/docs/ScimSchemasListResponse.md +21 -0
  97. data/docs/ScimServiceProviderConfigResponse.md +27 -0
  98. data/docs/ScimServiceProviderConfigResponseBulk.md +21 -0
  99. data/docs/ScimServiceProviderConfigResponseChangePassword.md +17 -0
  100. data/docs/ScimServiceProviderConfigResponseFilter.md +19 -0
  101. data/docs/ScimServiceProviderConfigResponsePatch.md +17 -0
  102. data/docs/ScimUser.md +25 -0
  103. data/docs/ScimUsersListResponse.md +21 -0
  104. data/docs/Tier.md +3 -1
  105. data/docs/TransferLoyaltyCard.md +3 -1
  106. data/docs/UpdateApplication.md +5 -1
  107. data/docs/UpdateApplicationCIF.md +23 -0
  108. data/docs/UpdateCampaign.md +1 -1
  109. data/docs/UpdateCoupon.md +1 -1
  110. data/docs/UpdateCouponBatch.md +1 -1
  111. data/docs/UpdateLoyaltyCard.md +4 -2
  112. data/docs/UpdateLoyaltyProgram.md +8 -4
  113. data/docs/UpdateReferral.md +1 -1
  114. data/docs/UpdateReferralBatch.md +1 -1
  115. data/docs/User.md +3 -1
  116. data/docs/Webhook.md +2 -0
  117. data/docs/WebhookWithOutgoingIntegrationDetails.md +2 -0
  118. data/lib/talon_one/api/integration_api.rb +83 -7
  119. data/lib/talon_one/api/management_api.rb +1127 -78
  120. data/lib/talon_one/models/achievement_progress.rb +16 -1
  121. data/lib/talon_one/models/additional_campaign_properties.rb +21 -6
  122. data/lib/talon_one/models/analytics_data_point.rb +225 -0
  123. data/lib/talon_one/models/analytics_data_point_with_trend.rb +225 -0
  124. data/lib/talon_one/models/analytics_data_point_with_trend_and_influenced_rate.rb +239 -0
  125. data/lib/talon_one/models/analytics_data_point_with_trend_and_uplift.rb +239 -0
  126. data/lib/talon_one/models/application.rb +21 -1
  127. data/lib/talon_one/models/application_analytics_data_point.rb +14 -4
  128. data/lib/talon_one/models/application_campaign_analytics.rb +39 -41
  129. data/lib/talon_one/models/application_campaign_stats.rb +1 -16
  130. data/lib/talon_one/models/application_cif.rb +308 -0
  131. data/lib/talon_one/models/application_cif_expression.rb +275 -0
  132. data/lib/talon_one/models/async_coupon_deletion_job_response.rb +213 -0
  133. data/lib/talon_one/models/attribute.rb +2 -2
  134. data/lib/talon_one/models/base_loyalty_program.rb +44 -25
  135. data/lib/talon_one/models/base_notification.rb +3 -2
  136. data/lib/talon_one/models/base_notification_entity.rb +1 -0
  137. data/lib/talon_one/models/campaign.rb +83 -6
  138. data/lib/talon_one/models/campaign_collection_edited_notification.rb +235 -0
  139. data/lib/talon_one/models/campaign_notification_policy.rb +16 -4
  140. data/lib/talon_one/models/campaign_state_changed_notification.rb +2 -2
  141. data/lib/talon_one/models/campaign_store_budget.rb +275 -0
  142. data/lib/talon_one/models/campaign_versions.rb +259 -0
  143. data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb +269 -0
  144. data/lib/talon_one/models/cart_item.rb +1 -1
  145. data/lib/talon_one/models/code_generator_settings.rb +1 -1
  146. data/lib/talon_one/models/coupon.rb +1 -1
  147. data/lib/talon_one/models/coupon_constraints.rb +1 -1
  148. data/lib/talon_one/models/coupon_creation_job.rb +1 -1
  149. data/lib/talon_one/models/coupon_deletion_filters.rb +375 -0
  150. data/lib/talon_one/models/coupon_deletion_job.rb +370 -0
  151. data/lib/talon_one/models/customer_session_v2.rb +2 -2
  152. data/lib/talon_one/models/effect.rb +41 -1
  153. data/lib/talon_one/models/effect_entity.rb +44 -4
  154. data/lib/talon_one/models/environment.rb +16 -4
  155. data/lib/talon_one/models/event.rb +0 -5
  156. data/lib/talon_one/models/generate_campaign_description.rb +227 -0
  157. data/lib/talon_one/models/generate_campaign_tags.rb +212 -0
  158. data/lib/talon_one/models/generate_item_filter_description.rb +214 -0
  159. data/lib/talon_one/models/generate_loyalty_card.rb +256 -0
  160. data/lib/talon_one/models/generate_rule_title.rb +226 -0
  161. data/lib/talon_one/models/generate_rule_title_rule.rb +221 -0
  162. data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +1 -1
  163. data/lib/talon_one/models/integration_coupon.rb +1 -1
  164. data/lib/talon_one/models/inventory_coupon.rb +1 -1
  165. data/lib/talon_one/models/inventory_referral.rb +1 -1
  166. data/lib/talon_one/models/loyalty_balance_with_tier.rb +276 -0
  167. data/lib/talon_one/models/loyalty_balances_with_tiers.rb +219 -0
  168. data/lib/talon_one/models/loyalty_card.rb +25 -5
  169. data/lib/talon_one/models/loyalty_card_batch.rb +304 -0
  170. data/lib/talon_one/models/loyalty_card_batch_response.rb +227 -0
  171. data/lib/talon_one/models/loyalty_program.rb +70 -29
  172. data/lib/talon_one/models/message_log_response.rb +3 -22
  173. data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb +227 -0
  174. data/lib/talon_one/models/new_application.rb +14 -4
  175. data/lib/talon_one/models/new_application_cif.rb +262 -0
  176. data/lib/talon_one/models/new_application_cif_expression.rb +229 -0
  177. data/lib/talon_one/models/new_attribute.rb +2 -2
  178. data/lib/talon_one/models/new_base_notification.rb +1 -0
  179. data/lib/talon_one/models/new_coupon_creation_job.rb +1 -1
  180. data/lib/talon_one/models/new_coupon_deletion_job.rb +211 -0
  181. data/lib/talon_one/models/new_coupons.rb +1 -1
  182. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +1 -1
  183. data/lib/talon_one/models/new_customer_session_v2.rb +2 -2
  184. data/lib/talon_one/models/new_loyalty_program.rb +44 -25
  185. data/lib/talon_one/models/new_notification_test.rb +2 -2
  186. data/lib/talon_one/models/new_outgoing_integration_webhook.rb +11 -1
  187. data/lib/talon_one/models/new_referral.rb +1 -1
  188. data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +1 -1
  189. data/lib/talon_one/models/new_revision_version.rb +352 -0
  190. data/lib/talon_one/models/new_webhook.rb +11 -1
  191. data/lib/talon_one/models/okta_event.rb +229 -0
  192. data/lib/talon_one/models/okta_event_payload.rb +212 -0
  193. data/lib/talon_one/models/okta_event_payload_data.rb +214 -0
  194. data/lib/talon_one/models/okta_event_target.rb +243 -0
  195. data/lib/talon_one/models/projected_tier.rb +232 -0
  196. data/lib/talon_one/models/referral.rb +1 -1
  197. data/lib/talon_one/models/referral_constraints.rb +1 -1
  198. data/lib/talon_one/models/reject_coupon_effect_props.rb +14 -4
  199. data/lib/talon_one/models/reject_referral_effect_props.rb +14 -4
  200. data/lib/talon_one/models/revision.rb +319 -0
  201. data/lib/talon_one/models/revision_activation.rb +206 -0
  202. data/lib/talon_one/models/revision_version.rb +466 -0
  203. data/lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb +288 -0
  204. data/lib/talon_one/models/rule_failure_reason.rb +24 -4
  205. data/lib/talon_one/models/scim_base_user.rb +237 -0
  206. data/lib/talon_one/models/scim_base_user_name.rb +208 -0
  207. data/lib/talon_one/models/scim_new_user.rb +237 -0
  208. data/lib/talon_one/models/scim_patch_operation.rb +267 -0
  209. data/lib/talon_one/models/scim_patch_request.rb +226 -0
  210. data/lib/talon_one/models/scim_resource.rb +228 -0
  211. data/lib/talon_one/models/scim_resource_types_list_response.rb +214 -0
  212. data/lib/talon_one/models/scim_schema_resource.rb +239 -0
  213. data/lib/talon_one/models/scim_schemas_list_response.rb +236 -0
  214. data/lib/talon_one/models/scim_service_provider_config_response.rb +256 -0
  215. data/lib/talon_one/models/scim_service_provider_config_response_bulk.rb +228 -0
  216. data/lib/talon_one/models/scim_service_provider_config_response_change_password.rb +208 -0
  217. data/lib/talon_one/models/scim_service_provider_config_response_filter.rb +218 -0
  218. data/lib/talon_one/models/scim_service_provider_config_response_patch.rb +208 -0
  219. data/lib/talon_one/models/scim_user.rb +252 -0
  220. data/lib/talon_one/models/scim_users_list_response.rb +236 -0
  221. data/lib/talon_one/models/sso_config.rb +14 -4
  222. data/lib/talon_one/models/tier.rb +12 -2
  223. data/lib/talon_one/models/transfer_loyalty_card.rb +14 -4
  224. data/lib/talon_one/models/update_application.rb +24 -4
  225. data/lib/talon_one/models/update_application_cif.rb +237 -0
  226. data/lib/talon_one/models/update_campaign.rb +1 -1
  227. data/lib/talon_one/models/update_coupon.rb +1 -1
  228. data/lib/talon_one/models/update_coupon_batch.rb +1 -1
  229. data/lib/talon_one/models/update_loyalty_card.rb +15 -5
  230. data/lib/talon_one/models/update_loyalty_program.rb +44 -25
  231. data/lib/talon_one/models/update_referral.rb +1 -1
  232. data/lib/talon_one/models/update_referral_batch.rb +1 -1
  233. data/lib/talon_one/models/user.rb +14 -4
  234. data/lib/talon_one/models/webhook.rb +11 -1
  235. data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +11 -1
  236. data/lib/talon_one/version.rb +1 -1
  237. data/lib/talon_one.rb +54 -11
  238. data/spec/api/integration_api_spec.rb +18 -3
  239. data/spec/api/management_api_spec.rb +227 -23
  240. data/spec/models/achievement_progress_spec.rb +6 -0
  241. data/spec/models/additional_campaign_properties_spec.rb +7 -1
  242. data/spec/models/analytics_data_point_spec.rb +47 -0
  243. data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +53 -0
  244. data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +53 -0
  245. data/spec/models/analytics_data_point_with_trend_spec.rb +47 -0
  246. data/spec/models/application_campaign_analytics_spec.rb +1 -19
  247. data/spec/models/application_campaign_stats_spec.rb +0 -6
  248. data/spec/models/application_cif_expression_spec.rb +71 -0
  249. data/spec/models/application_cif_spec.rb +89 -0
  250. data/spec/models/application_spec.rb +12 -0
  251. data/spec/models/async_coupon_deletion_job_response_spec.rb +41 -0
  252. data/spec/models/attribute_spec.rb +1 -1
  253. data/spec/models/base_loyalty_program_spec.rb +18 -6
  254. data/spec/models/base_notification_spec.rb +1 -1
  255. data/spec/models/campaign_collection_edited_notification_spec.rb +53 -0
  256. data/spec/models/campaign_notification_policy_spec.rb +6 -0
  257. data/spec/models/campaign_spec.rb +43 -1
  258. data/spec/models/campaign_store_budget_spec.rb +65 -0
  259. data/spec/models/campaign_versions_spec.rb +71 -0
  260. data/spec/models/card_added_deducted_points_notification_policy_spec.rb +51 -0
  261. data/spec/models/coupon_deletion_filters_spec.rb +123 -0
  262. data/spec/models/coupon_deletion_job_spec.rb +107 -0
  263. data/spec/models/effect_entity_spec.rb +24 -0
  264. data/spec/models/effect_spec.rb +24 -0
  265. data/spec/models/environment_spec.rb +6 -0
  266. data/spec/models/generate_campaign_description_spec.rb +47 -0
  267. data/spec/models/generate_campaign_tags_spec.rb +41 -0
  268. data/spec/models/generate_item_filter_description_spec.rb +41 -0
  269. data/spec/models/generate_loyalty_card_spec.rb +51 -0
  270. data/spec/models/generate_rule_title_rule_spec.rb +47 -0
  271. data/spec/models/generate_rule_title_spec.rb +47 -0
  272. data/spec/models/loyalty_balance_with_tier_spec.rb +83 -0
  273. data/spec/models/loyalty_balances_with_tiers_spec.rb +47 -0
  274. data/spec/models/loyalty_card_batch_response_spec.rb +47 -0
  275. data/spec/models/loyalty_card_batch_spec.rb +57 -0
  276. data/spec/models/loyalty_card_spec.rb +12 -0
  277. data/spec/models/loyalty_program_spec.rb +30 -6
  278. data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +47 -0
  279. data/spec/models/new_application_cif_expression_spec.rb +53 -0
  280. data/spec/models/new_application_cif_spec.rb +71 -0
  281. data/spec/models/new_application_spec.rb +6 -0
  282. data/spec/models/new_attribute_spec.rb +1 -1
  283. data/spec/models/new_coupon_deletion_job_spec.rb +41 -0
  284. data/spec/models/new_loyalty_program_spec.rb +18 -6
  285. data/spec/models/new_notification_test_spec.rb +1 -1
  286. data/spec/models/new_outgoing_integration_webhook_spec.rb +6 -0
  287. data/spec/models/new_revision_version_spec.rb +105 -0
  288. data/spec/models/new_webhook_spec.rb +6 -0
  289. data/spec/models/okta_event_payload_data_spec.rb +41 -0
  290. data/spec/models/okta_event_payload_spec.rb +41 -0
  291. data/spec/models/okta_event_spec.rb +47 -0
  292. data/spec/models/okta_event_target_spec.rb +53 -0
  293. data/spec/models/projected_tier_spec.rb +53 -0
  294. data/spec/models/reject_coupon_effect_props_spec.rb +6 -0
  295. data/spec/models/reject_referral_effect_props_spec.rb +6 -0
  296. data/spec/models/revision_activation_spec.rb +41 -0
  297. data/spec/models/revision_spec.rb +95 -0
  298. data/spec/models/revision_version_spec.rb +153 -0
  299. data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +71 -0
  300. data/spec/models/rule_failure_reason_spec.rb +12 -0
  301. data/spec/models/scim_base_user_name_spec.rb +41 -0
  302. data/spec/models/scim_base_user_spec.rb +59 -0
  303. data/spec/models/scim_new_user_spec.rb +59 -0
  304. data/spec/models/scim_patch_operation_spec.rb +57 -0
  305. data/spec/models/scim_patch_request_spec.rb +47 -0
  306. data/spec/models/scim_resource_spec.rb +53 -0
  307. data/spec/models/scim_resource_types_list_response_spec.rb +41 -0
  308. data/spec/models/scim_schema_resource_spec.rb +59 -0
  309. data/spec/models/scim_schemas_list_response_spec.rb +53 -0
  310. data/spec/models/scim_service_provider_config_response_bulk_spec.rb +53 -0
  311. data/spec/models/scim_service_provider_config_response_change_password_spec.rb +41 -0
  312. data/spec/models/scim_service_provider_config_response_filter_spec.rb +47 -0
  313. data/spec/models/scim_service_provider_config_response_patch_spec.rb +41 -0
  314. data/spec/models/scim_service_provider_config_response_spec.rb +71 -0
  315. data/spec/models/scim_user_spec.rb +65 -0
  316. data/spec/models/scim_users_list_response_spec.rb +53 -0
  317. data/spec/models/sso_config_spec.rb +6 -0
  318. data/spec/models/tier_spec.rb +6 -0
  319. data/spec/models/transfer_loyalty_card_spec.rb +6 -0
  320. data/spec/models/update_application_cif_spec.rb +59 -0
  321. data/spec/models/update_application_spec.rb +12 -0
  322. data/spec/models/update_loyalty_card_spec.rb +6 -0
  323. data/spec/models/update_loyalty_program_spec.rb +18 -6
  324. data/spec/models/user_spec.rb +6 -0
  325. data/spec/models/webhook_spec.rb +6 -0
  326. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
  327. metadata +219 -3
@@ -4,7 +4,7 @@ All URIs are relative to *https://yourbaseurl.talon.one*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**activate_user_by_email**](ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate | Activate user by email address
7
+ [**activate_user_by_email**](ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate | Enable user by email address
8
8
  [**add_loyalty_card_points**](ManagementApi.md#add_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card
9
9
  [**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile
10
10
  [**copy_campaign_to_applications**](ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application
@@ -12,17 +12,19 @@ Method | HTTP request | Description
12
12
  [**create_achievement**](ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement
13
13
  [**create_additional_cost**](ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost
14
14
  [**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
15
+ [**create_batch_loyalty_cards**](ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
15
16
  [**create_campaign_from_template**](ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
16
17
  [**create_collection**](ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
17
18
  [**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
18
19
  [**create_coupons_async**](ManagementApi.md#create_coupons_async) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously
20
+ [**create_coupons_deletion_job**](ManagementApi.md#create_coupons_deletion_job) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job
19
21
  [**create_coupons_for_multiple_recipients**](ManagementApi.md#create_coupons_for_multiple_recipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients
20
22
  [**create_invite_email**](ManagementApi.md#create_invite_email) | **POST** /v1/invite_emails | Resend invitation email
21
23
  [**create_invite_v2**](ManagementApi.md#create_invite_v2) | **POST** /v2/invites | Invite user
22
24
  [**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
23
25
  [**create_session**](ManagementApi.md#create_session) | **POST** /v1/sessions | Create session
24
26
  [**create_store**](ManagementApi.md#create_store) | **POST** /v1/applications/{applicationId}/stores | Create store
25
- [**deactivate_user_by_email**](ManagementApi.md#deactivate_user_by_email) | **POST** /v1/users/deactivate | Deactivate user by email address
27
+ [**deactivate_user_by_email**](ManagementApi.md#deactivate_user_by_email) | **POST** /v1/users/deactivate | Disable user by email address
26
28
  [**deduct_loyalty_card_points**](ManagementApi.md#deduct_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card
27
29
  [**delete_account_collection**](ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
28
30
  [**delete_achievement**](ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
@@ -36,9 +38,11 @@ Method | HTTP request | Description
36
38
  [**delete_user**](ManagementApi.md#delete_user) | **DELETE** /v1/users/{userId} | Delete user
37
39
  [**delete_user_by_email**](ManagementApi.md#delete_user_by_email) | **POST** /v1/users/delete | Delete user by email address
38
40
  [**destroy_session**](ManagementApi.md#destroy_session) | **DELETE** /v1/sessions | Destroy session
41
+ [**disconnect_campaign_stores**](ManagementApi.md#disconnect_campaign_stores) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores
39
42
  [**export_account_collection_items**](ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
40
43
  [**export_achievements**](ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
41
44
  [**export_audiences_memberships**](ManagementApi.md#export_audiences_memberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
45
+ [**export_campaign_stores**](ManagementApi.md#export_campaign_stores) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
42
46
  [**export_collection_items**](ManagementApi.md#export_collection_items) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
43
47
  [**export_coupons**](ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
44
48
  [**export_customer_sessions**](ManagementApi.md#export_customer_sessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions
@@ -48,6 +52,7 @@ Method | HTTP request | Description
48
52
  [**export_loyalty_balances**](ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances
49
53
  [**export_loyalty_card_balances**](ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs
50
54
  [**export_loyalty_card_ledger**](ManagementApi.md#export_loyalty_card_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log
55
+ [**export_loyalty_cards**](ManagementApi.md#export_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards
51
56
  [**export_loyalty_ledger**](ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs
52
57
  [**export_pool_giveaways**](ManagementApi.md#export_pool_giveaways) | **GET** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool
53
58
  [**export_referrals**](ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals
@@ -117,6 +122,7 @@ Method | HTTP request | Description
117
122
  [**import_account_collection**](ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
118
123
  [**import_allowed_list**](ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
119
124
  [**import_audiences_memberships**](ManagementApi.md#import_audiences_memberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
125
+ [**import_campaign_stores**](ManagementApi.md#import_campaign_stores) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
120
126
  [**import_collection**](ManagementApi.md#import_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
121
127
  [**import_coupons**](ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
122
128
  [**import_loyalty_cards**](ManagementApi.md#import_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards
@@ -133,11 +139,21 @@ Method | HTTP request | Description
133
139
  [**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
134
140
  [**list_stores**](ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
135
141
  [**notification_activation**](ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
142
+ [**okta_event_handler_challenge**](ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
136
143
  [**post_added_deducted_points_notification**](ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
137
144
  [**post_catalogs_strikethrough_notification**](ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
138
145
  [**post_pending_points_notification**](ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
139
146
  [**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
140
147
  [**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
148
+ [**scim_create_user**](ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
149
+ [**scim_delete_user**](ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user
150
+ [**scim_get_resource_types**](ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
151
+ [**scim_get_schemas**](ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas
152
+ [**scim_get_service_provider_config**](ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
153
+ [**scim_get_user**](ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user
154
+ [**scim_get_users**](ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users
155
+ [**scim_patch_user**](ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
156
+ [**scim_replace_user_attributes**](ManagementApi.md#scim_replace_user_attributes) | **PUT** /v1/provisioning/scim/Users/{userId} | Update SCIM user
141
157
  [**search_coupons_advanced_application_wide_without_total_count**](ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count)
142
158
  [**search_coupons_advanced_without_total_count**](ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count)
143
159
  [**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
@@ -161,9 +177,9 @@ Method | HTTP request | Description
161
177
 
162
178
  > activate_user_by_email(body)
163
179
 
164
- Activate user by email address
180
+ Enable user by email address
165
181
 
166
- Activate a deactivated user by their email address.
182
+ Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
167
183
 
168
184
  ### Example
169
185
 
@@ -187,7 +203,7 @@ api_instance = TalonOne::ManagementApi.new
187
203
  body = TalonOne::ActivateUserRequest.new # ActivateUserRequest | body
188
204
 
189
205
  begin
190
- #Activate user by email address
206
+ #Enable user by email address
191
207
  api_instance.activate_user_by_email(body)
192
208
  rescue TalonOne::ApiError => e
193
209
  puts "Exception when calling ManagementApi->activate_user_by_email: #{e}"
@@ -642,6 +658,67 @@ Name | Type | Description | Notes
642
658
  - **Accept**: application/json
643
659
 
644
660
 
661
+ ## create_batch_loyalty_cards
662
+
663
+ > LoyaltyCardBatchResponse create_batch_loyalty_cards(loyalty_program_id, body)
664
+
665
+ Create loyalty cards
666
+
667
+ Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
668
+
669
+ ### Example
670
+
671
+ ```ruby
672
+ # load the gem
673
+ require 'talon_one'
674
+ # setup authorization
675
+ TalonOne.configure do |config|
676
+ # Configure API key authorization: management_key
677
+ config.api_key['Authorization'] = 'YOUR API KEY'
678
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
679
+ #config.api_key_prefix['Authorization'] = 'Bearer'
680
+
681
+ # Configure API key authorization: manager_auth
682
+ config.api_key['Authorization'] = 'YOUR API KEY'
683
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
684
+ #config.api_key_prefix['Authorization'] = 'Bearer'
685
+ end
686
+
687
+ api_instance = TalonOne::ManagementApi.new
688
+ loyalty_program_id = 56 # 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.
689
+ body = TalonOne::LoyaltyCardBatch.new # LoyaltyCardBatch | body
690
+
691
+ begin
692
+ #Create loyalty cards
693
+ result = api_instance.create_batch_loyalty_cards(loyalty_program_id, body)
694
+ p result
695
+ rescue TalonOne::ApiError => e
696
+ puts "Exception when calling ManagementApi->create_batch_loyalty_cards: #{e}"
697
+ end
698
+ ```
699
+
700
+ ### Parameters
701
+
702
+
703
+ Name | Type | Description | Notes
704
+ ------------- | ------------- | ------------- | -------------
705
+ **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. |
706
+ **body** | [**LoyaltyCardBatch**](LoyaltyCardBatch.md)| body |
707
+
708
+ ### Return type
709
+
710
+ [**LoyaltyCardBatchResponse**](LoyaltyCardBatchResponse.md)
711
+
712
+ ### Authorization
713
+
714
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
715
+
716
+ ### HTTP request headers
717
+
718
+ - **Content-Type**: application/json
719
+ - **Accept**: application/json
720
+
721
+
645
722
  ## create_campaign_from_template
646
723
 
647
724
  > CreateTemplateCampaignResponse create_campaign_from_template(application_id, body)
@@ -896,6 +973,69 @@ Name | Type | Description | Notes
896
973
  - **Accept**: application/json
897
974
 
898
975
 
976
+ ## create_coupons_deletion_job
977
+
978
+ > AsyncCouponDeletionJobResponse create_coupons_deletion_job(application_id, campaign_id, body)
979
+
980
+ Creates a coupon deletion job
981
+
982
+ This endpoint handles creating a job to delete coupons asynchronously.
983
+
984
+ ### Example
985
+
986
+ ```ruby
987
+ # load the gem
988
+ require 'talon_one'
989
+ # setup authorization
990
+ TalonOne.configure do |config|
991
+ # Configure API key authorization: management_key
992
+ config.api_key['Authorization'] = 'YOUR API KEY'
993
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
994
+ #config.api_key_prefix['Authorization'] = 'Bearer'
995
+
996
+ # Configure API key authorization: manager_auth
997
+ config.api_key['Authorization'] = 'YOUR API KEY'
998
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
999
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1000
+ end
1001
+
1002
+ api_instance = TalonOne::ManagementApi.new
1003
+ application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
1004
+ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
1005
+ body = TalonOne::NewCouponDeletionJob.new # NewCouponDeletionJob | body
1006
+
1007
+ begin
1008
+ #Creates a coupon deletion job
1009
+ result = api_instance.create_coupons_deletion_job(application_id, campaign_id, body)
1010
+ p result
1011
+ rescue TalonOne::ApiError => e
1012
+ puts "Exception when calling ManagementApi->create_coupons_deletion_job: #{e}"
1013
+ end
1014
+ ```
1015
+
1016
+ ### Parameters
1017
+
1018
+
1019
+ Name | Type | Description | Notes
1020
+ ------------- | ------------- | ------------- | -------------
1021
+ **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
1022
+ **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
1023
+ **body** | [**NewCouponDeletionJob**](NewCouponDeletionJob.md)| body |
1024
+
1025
+ ### Return type
1026
+
1027
+ [**AsyncCouponDeletionJobResponse**](AsyncCouponDeletionJobResponse.md)
1028
+
1029
+ ### Authorization
1030
+
1031
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
1032
+
1033
+ ### HTTP request headers
1034
+
1035
+ - **Content-Type**: application/json
1036
+ - **Accept**: application/json
1037
+
1038
+
899
1039
  ## create_coupons_for_multiple_recipients
900
1040
 
901
1041
  > InlineResponse2008 create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
@@ -1264,9 +1404,9 @@ Name | Type | Description | Notes
1264
1404
 
1265
1405
  > deactivate_user_by_email(body)
1266
1406
 
1267
- Deactivate user by email address
1407
+ Disable user by email address
1268
1408
 
1269
- Deactivate a specific user by their email address.
1409
+ [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
1270
1410
 
1271
1411
  ### Example
1272
1412
 
@@ -1290,7 +1430,7 @@ api_instance = TalonOne::ManagementApi.new
1290
1430
  body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
1291
1431
 
1292
1432
  begin
1293
- #Deactivate user by email address
1433
+ #Disable user by email address
1294
1434
  api_instance.deactivate_user_by_email(body)
1295
1435
  rescue TalonOne::ApiError => e
1296
1436
  puts "Exception when calling ManagementApi->deactivate_user_by_email: #{e}"
@@ -1717,10 +1857,10 @@ opts = {
1717
1857
  value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1718
1858
  created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1719
1859
  created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1720
- starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1721
- starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1722
- expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1723
- expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1860
+ starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1861
+ starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1862
+ expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1863
+ expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1724
1864
  valid: 'valid_example', # String | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
1725
1865
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
1726
1866
  usable: 'usable_example', # String | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
@@ -1747,10 +1887,10 @@ Name | Type | Description | Notes
1747
1887
  **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
1748
1888
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1749
1889
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1750
- **starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1751
- **starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1752
- **expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1753
- **expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1890
+ **starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1891
+ **starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1892
+ **expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1893
+ **expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
1754
1894
  **valid** | **String**| - &#x60;expired&#x60;: Matches coupons in which the expiration date is set and in the past. - &#x60;validNow&#x60;: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - &#x60;validFuture&#x60;: Matches coupons in which start date is set and in the future. | [optional]
1755
1895
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
1756
1896
  **usable** | **String**| - &#x60;true&#x60;: only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned. - &#x60;false&#x60;: only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60; will be returned. | [optional]
@@ -2018,7 +2158,7 @@ nil (empty response body)
2018
2158
 
2019
2159
  Delete user by email address
2020
2160
 
2021
- Delete a specific user by their email address.
2161
+ [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
2022
2162
 
2023
2163
  ### Example
2024
2164
 
@@ -2124,6 +2264,66 @@ nil (empty response body)
2124
2264
  - **Accept**: Not defined
2125
2265
 
2126
2266
 
2267
+ ## disconnect_campaign_stores
2268
+
2269
+ > disconnect_campaign_stores(application_id, campaign_id)
2270
+
2271
+ Disconnect stores
2272
+
2273
+ Disconnect the stores linked to a specific campaign.
2274
+
2275
+ ### Example
2276
+
2277
+ ```ruby
2278
+ # load the gem
2279
+ require 'talon_one'
2280
+ # setup authorization
2281
+ TalonOne.configure do |config|
2282
+ # Configure API key authorization: management_key
2283
+ config.api_key['Authorization'] = 'YOUR API KEY'
2284
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2285
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2286
+
2287
+ # Configure API key authorization: manager_auth
2288
+ config.api_key['Authorization'] = 'YOUR API KEY'
2289
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2290
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2291
+ end
2292
+
2293
+ api_instance = TalonOne::ManagementApi.new
2294
+ application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2295
+ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
2296
+
2297
+ begin
2298
+ #Disconnect stores
2299
+ api_instance.disconnect_campaign_stores(application_id, campaign_id)
2300
+ rescue TalonOne::ApiError => e
2301
+ puts "Exception when calling ManagementApi->disconnect_campaign_stores: #{e}"
2302
+ end
2303
+ ```
2304
+
2305
+ ### Parameters
2306
+
2307
+
2308
+ Name | Type | Description | Notes
2309
+ ------------- | ------------- | ------------- | -------------
2310
+ **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2311
+ **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
2312
+
2313
+ ### Return type
2314
+
2315
+ nil (empty response body)
2316
+
2317
+ ### Authorization
2318
+
2319
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
2320
+
2321
+ ### HTTP request headers
2322
+
2323
+ - **Content-Type**: Not defined
2324
+ - **Accept**: application/json
2325
+
2326
+
2127
2327
  ## export_account_collection_items
2128
2328
 
2129
2329
  > String export_account_collection_items(collection_id)
@@ -2305,6 +2505,67 @@ Name | Type | Description | Notes
2305
2505
  - **Accept**: application/csv
2306
2506
 
2307
2507
 
2508
+ ## export_campaign_stores
2509
+
2510
+ > String export_campaign_stores(application_id, campaign_id)
2511
+
2512
+ Export stores
2513
+
2514
+ Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
2515
+
2516
+ ### Example
2517
+
2518
+ ```ruby
2519
+ # load the gem
2520
+ require 'talon_one'
2521
+ # setup authorization
2522
+ TalonOne.configure do |config|
2523
+ # Configure API key authorization: management_key
2524
+ config.api_key['Authorization'] = 'YOUR API KEY'
2525
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2526
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2527
+
2528
+ # Configure API key authorization: manager_auth
2529
+ config.api_key['Authorization'] = 'YOUR API KEY'
2530
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2531
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2532
+ end
2533
+
2534
+ api_instance = TalonOne::ManagementApi.new
2535
+ application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2536
+ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
2537
+
2538
+ begin
2539
+ #Export stores
2540
+ result = api_instance.export_campaign_stores(application_id, campaign_id)
2541
+ p result
2542
+ rescue TalonOne::ApiError => e
2543
+ puts "Exception when calling ManagementApi->export_campaign_stores: #{e}"
2544
+ end
2545
+ ```
2546
+
2547
+ ### Parameters
2548
+
2549
+
2550
+ Name | Type | Description | Notes
2551
+ ------------- | ------------- | ------------- | -------------
2552
+ **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2553
+ **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
2554
+
2555
+ ### Return type
2556
+
2557
+ **String**
2558
+
2559
+ ### Authorization
2560
+
2561
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
2562
+
2563
+ ### HTTP request headers
2564
+
2565
+ - **Content-Type**: Not defined
2566
+ - **Accept**: application/csv
2567
+
2568
+
2308
2569
  ## export_collection_items
2309
2570
 
2310
2571
  > String export_collection_items(application_id, campaign_id, collection_id)
@@ -2409,7 +2670,7 @@ opts = {
2409
2670
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
2410
2671
  exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code.
2411
2672
  date_format: 'date_format_example', # String | Determines the format of dates in the export document.
2412
- campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
2673
+ campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
2413
2674
  values_only: false # Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
2414
2675
  }
2415
2676
 
@@ -2440,7 +2701,7 @@ Name | Type | Description | Notes
2440
2701
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
2441
2702
  **exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
2442
2703
  **date_format** | **String**| Determines the format of dates in the export document. | [optional]
2443
- **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts. | [optional]
2704
+ **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. | [optional]
2444
2705
  **values_only** | **Boolean**| Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data. | [optional] [default to false]
2445
2706
 
2446
2707
  ### Return type
@@ -2534,7 +2795,7 @@ Name | Type | Description | Notes
2534
2795
 
2535
2796
  Export customers' tier data
2536
2797
 
2537
- Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported.
2798
+ Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerIds` (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierNames` (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported.
2538
2799
 
2539
2800
  ### Example
2540
2801
 
@@ -2623,8 +2884,8 @@ api_instance = TalonOne::ManagementApi.new
2623
2884
  application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2624
2885
  opts = {
2625
2886
  campaign_id: 3.4, # Float | Filter results by campaign.
2626
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
2627
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
2887
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
2888
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
2628
2889
  date_format: 'date_format_example' # String | Determines the format of dates in the export document.
2629
2890
  }
2630
2891
 
@@ -2644,8 +2905,8 @@ Name | Type | Description | Notes
2644
2905
  ------------- | ------------- | ------------- | -------------
2645
2906
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2646
2907
  **campaign_id** | **Float**| Filter results by campaign. | [optional]
2647
- **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
2648
- **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
2908
+ **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
2909
+ **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
2649
2910
  **date_format** | **String**| Determines the format of dates in the export document. | [optional]
2650
2911
 
2651
2912
  ### Return type
@@ -2920,13 +3181,13 @@ Name | Type | Description | Notes
2920
3181
  - **Accept**: application/csv
2921
3182
 
2922
3183
 
2923
- ## export_loyalty_ledger
3184
+ ## export_loyalty_cards
2924
3185
 
2925
- > String export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts)
3186
+ > String export_loyalty_cards(loyalty_program_id, opts)
2926
3187
 
2927
- Export customer's transaction logs
3188
+ Export loyalty cards
2928
3189
 
2929
- Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The type of the loyalty program. - `name`: The name of the loyalty program. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
3190
+ Download a CSV file containing the loyalty cards from a specified loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
2930
3191
 
2931
3192
  ### Example
2932
3193
 
@@ -2947,20 +3208,17 @@ TalonOne.configure do |config|
2947
3208
  end
2948
3209
 
2949
3210
  api_instance = TalonOne::ManagementApi.new
2950
- range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `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.
2951
- range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `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.
2952
- loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
2953
- integration_id = 'integration_id_example' # String | The identifier of the profile.
3211
+ loyalty_program_id = 56 # 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.
2954
3212
  opts = {
2955
- date_format: 'date_format_example' # String | Determines the format of dates in the export document.
3213
+ batch_id: 'batch_id_example' # String | Filter results by loyalty card batch ID.
2956
3214
  }
2957
3215
 
2958
3216
  begin
2959
- #Export customer's transaction logs
2960
- result = api_instance.export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts)
3217
+ #Export loyalty cards
3218
+ result = api_instance.export_loyalty_cards(loyalty_program_id, opts)
2961
3219
  p result
2962
3220
  rescue TalonOne::ApiError => e
2963
- puts "Exception when calling ManagementApi->export_loyalty_ledger: #{e}"
3221
+ puts "Exception when calling ManagementApi->export_loyalty_cards: #{e}"
2964
3222
  end
2965
3223
  ```
2966
3224
 
@@ -2969,11 +3227,8 @@ end
2969
3227
 
2970
3228
  Name | Type | Description | Notes
2971
3229
  ------------- | ------------- | ------------- | -------------
2972
- **range_start** | **DateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. |
2973
- **range_end** | **DateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. |
2974
- **loyalty_program_id** | **String**| The identifier for the loyalty program. |
2975
- **integration_id** | **String**| The identifier of the profile. |
2976
- **date_format** | **String**| Determines the format of dates in the export document. | [optional]
3230
+ **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. |
3231
+ **batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
2977
3232
 
2978
3233
  ### Return type
2979
3234
 
@@ -2989,13 +3244,13 @@ Name | Type | Description | Notes
2989
3244
  - **Accept**: application/csv
2990
3245
 
2991
3246
 
2992
- ## export_pool_giveaways
3247
+ ## export_loyalty_ledger
2993
3248
 
2994
- > String export_pool_giveaways(pool_id, opts)
3249
+ > String export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts)
2995
3250
 
2996
- Export giveaway codes of a giveaway pool
3251
+ Export customer's transaction logs
2997
3252
 
2998
- Download a CSV file containing the giveaway codes of a specific giveaway pool. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
3253
+ Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
2999
3254
 
3000
3255
  ### Example
3001
3256
 
@@ -3016,18 +3271,20 @@ TalonOne.configure do |config|
3016
3271
  end
3017
3272
 
3018
3273
  api_instance = TalonOne::ManagementApi.new
3019
- pool_id = 56 # Integer | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
3274
+ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `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.
3275
+ range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `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.
3276
+ loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
3277
+ integration_id = 'integration_id_example' # String | The identifier of the profile.
3020
3278
  opts = {
3021
- created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.
3022
- created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
3279
+ date_format: 'date_format_example' # String | Determines the format of dates in the export document.
3023
3280
  }
3024
3281
 
3025
3282
  begin
3026
- #Export giveaway codes of a giveaway pool
3027
- result = api_instance.export_pool_giveaways(pool_id, opts)
3283
+ #Export customer's transaction logs
3284
+ result = api_instance.export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts)
3028
3285
  p result
3029
3286
  rescue TalonOne::ApiError => e
3030
- puts "Exception when calling ManagementApi->export_pool_giveaways: #{e}"
3287
+ puts "Exception when calling ManagementApi->export_loyalty_ledger: #{e}"
3031
3288
  end
3032
3289
  ```
3033
3290
 
@@ -3036,8 +3293,75 @@ end
3036
3293
 
3037
3294
  Name | Type | Description | Notes
3038
3295
  ------------- | ------------- | ------------- | -------------
3039
- **pool_id** | **Integer**| The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. |
3040
- **created_before** | **DateTime**| Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. | [optional]
3296
+ **range_start** | **DateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. |
3297
+ **range_end** | **DateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered. |
3298
+ **loyalty_program_id** | **String**| The identifier for the loyalty program. |
3299
+ **integration_id** | **String**| The identifier of the profile. |
3300
+ **date_format** | **String**| Determines the format of dates in the export document. | [optional]
3301
+
3302
+ ### Return type
3303
+
3304
+ **String**
3305
+
3306
+ ### Authorization
3307
+
3308
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
3309
+
3310
+ ### HTTP request headers
3311
+
3312
+ - **Content-Type**: Not defined
3313
+ - **Accept**: application/csv
3314
+
3315
+
3316
+ ## export_pool_giveaways
3317
+
3318
+ > String export_pool_giveaways(pool_id, opts)
3319
+
3320
+ Export giveaway codes of a giveaway pool
3321
+
3322
+ Download a CSV file containing the giveaway codes of a specific giveaway pool. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
3323
+
3324
+ ### Example
3325
+
3326
+ ```ruby
3327
+ # load the gem
3328
+ require 'talon_one'
3329
+ # setup authorization
3330
+ TalonOne.configure do |config|
3331
+ # Configure API key authorization: management_key
3332
+ config.api_key['Authorization'] = 'YOUR API KEY'
3333
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3334
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3335
+
3336
+ # Configure API key authorization: manager_auth
3337
+ config.api_key['Authorization'] = 'YOUR API KEY'
3338
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3339
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3340
+ end
3341
+
3342
+ api_instance = TalonOne::ManagementApi.new
3343
+ pool_id = 56 # Integer | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
3344
+ opts = {
3345
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.
3346
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
3347
+ }
3348
+
3349
+ begin
3350
+ #Export giveaway codes of a giveaway pool
3351
+ result = api_instance.export_pool_giveaways(pool_id, opts)
3352
+ p result
3353
+ rescue TalonOne::ApiError => e
3354
+ puts "Exception when calling ManagementApi->export_pool_giveaways: #{e}"
3355
+ end
3356
+ ```
3357
+
3358
+ ### Parameters
3359
+
3360
+
3361
+ Name | Type | Description | Notes
3362
+ ------------- | ------------- | ------------- | -------------
3363
+ **pool_id** | **Integer**| The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. |
3364
+ **created_before** | **DateTime**| Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. | [optional]
3041
3365
  **created_after** | **DateTime**| Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. | [optional]
3042
3366
 
3043
3367
  ### Return type
@@ -4886,7 +5210,7 @@ opts = {
4886
5210
  page_size: 1000, # Integer | The number of items in the response.
4887
5211
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4888
5212
  sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4889
- campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
5213
+ campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
4890
5214
  }
4891
5215
 
4892
5216
  begin
@@ -4908,7 +5232,7 @@ Name | Type | Description | Notes
4908
5232
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4909
5233
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4910
5234
  **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields. | [optional]
4911
- **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts. | [optional]
5235
+ **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. | [optional]
4912
5236
 
4913
5237
  ### Return type
4914
5238
 
@@ -5153,7 +5477,7 @@ opts = {
5153
5477
  page_size: 1000, # Integer | The number of items in the response.
5154
5478
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5155
5479
  sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5156
- campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
5480
+ campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
5157
5481
  name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
5158
5482
  tags: 'tags_example', # String | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
5159
5483
  created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -5181,7 +5505,7 @@ Name | Type | Description | Notes
5181
5505
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5182
5506
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5183
5507
  **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields. | [optional]
5184
- **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts. | [optional]
5508
+ **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. | [optional]
5185
5509
  **name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
5186
5510
  **tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values | [optional]
5187
5511
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -5451,10 +5775,16 @@ opts = {
5451
5775
  created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
5452
5776
  valid: 'valid_example', # String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
5453
5777
  usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
5778
+ redeemed: 'redeemed_example', # String | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter.
5454
5779
  referral_id: 56, # Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
5455
5780
  recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
5456
5781
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
5457
- exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
5782
+ exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
5783
+ expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
5784
+ expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
5785
+ starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
5786
+ starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
5787
+ values_only: false # Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
5458
5788
  }
5459
5789
 
5460
5790
  begin
@@ -5481,10 +5811,16 @@ Name | Type | Description | Notes
5481
5811
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
5482
5812
  **valid** | **String**| Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
5483
5813
  **usable** | **String**| Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;. | [optional]
5814
+ **redeemed** | **String**| - &#x60;true&#x60;: only coupons where &#x60;usageCounter &gt; 0&#x60; will be returned. - &#x60;false&#x60;: only coupons where &#x60;usageCounter &#x3D; 0&#x60; will be returned. - This field cannot be used in conjunction with the &#x60;usable&#x60; query parameter. | [optional]
5484
5815
  **referral_id** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
5485
5816
  **recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field | [optional]
5486
5817
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
5487
5818
  **exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
5819
+ **expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
5820
+ **expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
5821
+ **starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
5822
+ **starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
5823
+ **values_only** | **Boolean**| Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data. | [optional] [default to false]
5488
5824
 
5489
5825
  ### Return type
5490
5826
 
@@ -6285,8 +6621,9 @@ opts = {
6285
6621
  page_size: 1000, # Integer | The number of items in the response.
6286
6622
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
6287
6623
  sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
6288
- identifier: 'identifier_example', # String | Optional query parameter to search cards by identifier.
6289
- profile_id: 56 # Integer | Filter by the profile ID.
6624
+ identifier: 'identifier_example', # String | The card code by which to filter loyalty cards in the response.
6625
+ profile_id: 56, # Integer | Filter results by customer profile ID.
6626
+ batch_id: 'batch_id_example' # String | Filter results by loyalty card batch ID.
6290
6627
  }
6291
6628
 
6292
6629
  begin
@@ -6307,8 +6644,9 @@ Name | Type | Description | Notes
6307
6644
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
6308
6645
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
6309
6646
  **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields. | [optional]
6310
- **identifier** | **String**| Optional query parameter to search cards by identifier. | [optional]
6311
- **profile_id** | **Integer**| Filter by the profile ID. | [optional]
6647
+ **identifier** | **String**| The card code by which to filter loyalty cards in the response. | [optional]
6648
+ **profile_id** | **Integer**| Filter results by customer profile ID. | [optional]
6649
+ **batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
6312
6650
 
6313
6651
  ### Return type
6314
6652
 
@@ -7331,7 +7669,7 @@ end
7331
7669
 
7332
7670
  api_instance = TalonOne::ManagementApi.new
7333
7671
  opts = {
7334
- application_ids: 'application_ids_example', # String | Filter by one or more Application IDs, separated by a comma.
7672
+ application_ids: 'application_ids_example', # String | Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
7335
7673
  sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
7336
7674
  page_size: 1000, # Integer | The number of items in the response.
7337
7675
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
@@ -7355,7 +7693,7 @@ end
7355
7693
 
7356
7694
  Name | Type | Description | Notes
7357
7695
  ------------- | ------------- | ------------- | -------------
7358
- **application_ids** | **String**| Filter by one or more Application IDs, separated by a comma. | [optional]
7696
+ **application_ids** | **String**| Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications. | [optional]
7359
7697
  **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields. | [optional]
7360
7698
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7361
7699
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
@@ -7567,6 +7905,71 @@ Name | Type | Description | Notes
7567
7905
  - **Accept**: application/json
7568
7906
 
7569
7907
 
7908
+ ## import_campaign_stores
7909
+
7910
+ > Import import_campaign_stores(application_id, campaign_id, opts)
7911
+
7912
+ Import stores
7913
+
7914
+ Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
7915
+
7916
+ ### Example
7917
+
7918
+ ```ruby
7919
+ # load the gem
7920
+ require 'talon_one'
7921
+ # setup authorization
7922
+ TalonOne.configure do |config|
7923
+ # Configure API key authorization: management_key
7924
+ config.api_key['Authorization'] = 'YOUR API KEY'
7925
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
7926
+ #config.api_key_prefix['Authorization'] = 'Bearer'
7927
+
7928
+ # Configure API key authorization: manager_auth
7929
+ config.api_key['Authorization'] = 'YOUR API KEY'
7930
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
7931
+ #config.api_key_prefix['Authorization'] = 'Bearer'
7932
+ end
7933
+
7934
+ api_instance = TalonOne::ManagementApi.new
7935
+ application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
7936
+ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
7937
+ opts = {
7938
+ up_file: 'up_file_example' # String | The file containing the data that is being imported.
7939
+ }
7940
+
7941
+ begin
7942
+ #Import stores
7943
+ result = api_instance.import_campaign_stores(application_id, campaign_id, opts)
7944
+ p result
7945
+ rescue TalonOne::ApiError => e
7946
+ puts "Exception when calling ManagementApi->import_campaign_stores: #{e}"
7947
+ end
7948
+ ```
7949
+
7950
+ ### Parameters
7951
+
7952
+
7953
+ Name | Type | Description | Notes
7954
+ ------------- | ------------- | ------------- | -------------
7955
+ **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
7956
+ **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
7957
+ **up_file** | **String**| The file containing the data that is being imported. | [optional]
7958
+
7959
+ ### Return type
7960
+
7961
+ [**Import**](Import.md)
7962
+
7963
+ ### Authorization
7964
+
7965
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
7966
+
7967
+ ### HTTP request headers
7968
+
7969
+ - **Content-Type**: multipart/form-data
7970
+ - **Accept**: application/json
7971
+
7972
+
7570
7973
  ## import_collection
7571
7974
 
7572
7975
  > Import import_collection(application_id, campaign_id, collection_id, opts)
@@ -7770,7 +8173,7 @@ Name | Type | Description | Notes
7770
8173
 
7771
8174
  Import customers into loyalty tiers
7772
8175
 
7773
- Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
8176
+ Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
7774
8177
 
7775
8178
  ### Example
7776
8179
 
@@ -8024,7 +8427,7 @@ Name | Type | Description | Notes
8024
8427
 
8025
8428
  Invite user from identity provider
8026
8429
 
8027
- Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
8430
+ [Invite a user](https://docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address.
8028
8431
 
8029
8432
  ### Example
8030
8433
 
@@ -8621,6 +9024,60 @@ nil (empty response body)
8621
9024
  - **Accept**: Not defined
8622
9025
 
8623
9026
 
9027
+ ## okta_event_handler_challenge
9028
+
9029
+ > okta_event_handler_challenge
9030
+
9031
+ Validate Okta API ownership
9032
+
9033
+ Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
9034
+
9035
+ ### Example
9036
+
9037
+ ```ruby
9038
+ # load the gem
9039
+ require 'talon_one'
9040
+ # setup authorization
9041
+ TalonOne.configure do |config|
9042
+ # Configure API key authorization: management_key
9043
+ config.api_key['Authorization'] = 'YOUR API KEY'
9044
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9045
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9046
+
9047
+ # Configure API key authorization: manager_auth
9048
+ config.api_key['Authorization'] = 'YOUR API KEY'
9049
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9050
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9051
+ end
9052
+
9053
+ api_instance = TalonOne::ManagementApi.new
9054
+
9055
+ begin
9056
+ #Validate Okta API ownership
9057
+ api_instance.okta_event_handler_challenge
9058
+ rescue TalonOne::ApiError => e
9059
+ puts "Exception when calling ManagementApi->okta_event_handler_challenge: #{e}"
9060
+ end
9061
+ ```
9062
+
9063
+ ### Parameters
9064
+
9065
+ This endpoint does not need any parameter.
9066
+
9067
+ ### Return type
9068
+
9069
+ nil (empty response body)
9070
+
9071
+ ### Authorization
9072
+
9073
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9074
+
9075
+ ### HTTP request headers
9076
+
9077
+ - **Content-Type**: Not defined
9078
+ - **Accept**: Not defined
9079
+
9080
+
8624
9081
  ## post_added_deducted_points_notification
8625
9082
 
8626
9083
  > BaseNotification post_added_deducted_points_notification(loyalty_program_id, body)
@@ -8925,6 +9382,524 @@ Name | Type | Description | Notes
8925
9382
  - **Accept**: application/json
8926
9383
 
8927
9384
 
9385
+ ## scim_create_user
9386
+
9387
+ > ScimUser scim_create_user(body)
9388
+
9389
+ Create SCIM user
9390
+
9391
+ Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
9392
+
9393
+ ### Example
9394
+
9395
+ ```ruby
9396
+ # load the gem
9397
+ require 'talon_one'
9398
+ # setup authorization
9399
+ TalonOne.configure do |config|
9400
+ # Configure API key authorization: management_key
9401
+ config.api_key['Authorization'] = 'YOUR API KEY'
9402
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9403
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9404
+
9405
+ # Configure API key authorization: manager_auth
9406
+ config.api_key['Authorization'] = 'YOUR API KEY'
9407
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9408
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9409
+ end
9410
+
9411
+ api_instance = TalonOne::ManagementApi.new
9412
+ body = TalonOne::ScimNewUser.new # ScimNewUser | body
9413
+
9414
+ begin
9415
+ #Create SCIM user
9416
+ result = api_instance.scim_create_user(body)
9417
+ p result
9418
+ rescue TalonOne::ApiError => e
9419
+ puts "Exception when calling ManagementApi->scim_create_user: #{e}"
9420
+ end
9421
+ ```
9422
+
9423
+ ### Parameters
9424
+
9425
+
9426
+ Name | Type | Description | Notes
9427
+ ------------- | ------------- | ------------- | -------------
9428
+ **body** | [**ScimNewUser**](ScimNewUser.md)| body |
9429
+
9430
+ ### Return type
9431
+
9432
+ [**ScimUser**](ScimUser.md)
9433
+
9434
+ ### Authorization
9435
+
9436
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9437
+
9438
+ ### HTTP request headers
9439
+
9440
+ - **Content-Type**: application/json
9441
+ - **Accept**: application/json
9442
+
9443
+
9444
+ ## scim_delete_user
9445
+
9446
+ > scim_delete_user(user_id)
9447
+
9448
+ Delete SCIM user
9449
+
9450
+ Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
9451
+
9452
+ ### Example
9453
+
9454
+ ```ruby
9455
+ # load the gem
9456
+ require 'talon_one'
9457
+ # setup authorization
9458
+ TalonOne.configure do |config|
9459
+ # Configure API key authorization: management_key
9460
+ config.api_key['Authorization'] = 'YOUR API KEY'
9461
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9462
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9463
+
9464
+ # Configure API key authorization: manager_auth
9465
+ config.api_key['Authorization'] = 'YOUR API KEY'
9466
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9467
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9468
+ end
9469
+
9470
+ api_instance = TalonOne::ManagementApi.new
9471
+ user_id = 56 # Integer | The ID of the user.
9472
+
9473
+ begin
9474
+ #Delete SCIM user
9475
+ api_instance.scim_delete_user(user_id)
9476
+ rescue TalonOne::ApiError => e
9477
+ puts "Exception when calling ManagementApi->scim_delete_user: #{e}"
9478
+ end
9479
+ ```
9480
+
9481
+ ### Parameters
9482
+
9483
+
9484
+ Name | Type | Description | Notes
9485
+ ------------- | ------------- | ------------- | -------------
9486
+ **user_id** | **Integer**| The ID of the user. |
9487
+
9488
+ ### Return type
9489
+
9490
+ nil (empty response body)
9491
+
9492
+ ### Authorization
9493
+
9494
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9495
+
9496
+ ### HTTP request headers
9497
+
9498
+ - **Content-Type**: Not defined
9499
+ - **Accept**: Not defined
9500
+
9501
+
9502
+ ## scim_get_resource_types
9503
+
9504
+ > ScimResourceTypesListResponse scim_get_resource_types
9505
+
9506
+ List supported SCIM resource types
9507
+
9508
+ Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.
9509
+
9510
+ ### Example
9511
+
9512
+ ```ruby
9513
+ # load the gem
9514
+ require 'talon_one'
9515
+ # setup authorization
9516
+ TalonOne.configure do |config|
9517
+ # Configure API key authorization: management_key
9518
+ config.api_key['Authorization'] = 'YOUR API KEY'
9519
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9520
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9521
+
9522
+ # Configure API key authorization: manager_auth
9523
+ config.api_key['Authorization'] = 'YOUR API KEY'
9524
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9525
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9526
+ end
9527
+
9528
+ api_instance = TalonOne::ManagementApi.new
9529
+
9530
+ begin
9531
+ #List supported SCIM resource types
9532
+ result = api_instance.scim_get_resource_types
9533
+ p result
9534
+ rescue TalonOne::ApiError => e
9535
+ puts "Exception when calling ManagementApi->scim_get_resource_types: #{e}"
9536
+ end
9537
+ ```
9538
+
9539
+ ### Parameters
9540
+
9541
+ This endpoint does not need any parameter.
9542
+
9543
+ ### Return type
9544
+
9545
+ [**ScimResourceTypesListResponse**](ScimResourceTypesListResponse.md)
9546
+
9547
+ ### Authorization
9548
+
9549
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9550
+
9551
+ ### HTTP request headers
9552
+
9553
+ - **Content-Type**: Not defined
9554
+ - **Accept**: application/json
9555
+
9556
+
9557
+ ## scim_get_schemas
9558
+
9559
+ > ScimSchemasListResponse scim_get_schemas
9560
+
9561
+ List supported SCIM schemas
9562
+
9563
+ Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources.
9564
+
9565
+ ### Example
9566
+
9567
+ ```ruby
9568
+ # load the gem
9569
+ require 'talon_one'
9570
+ # setup authorization
9571
+ TalonOne.configure do |config|
9572
+ # Configure API key authorization: management_key
9573
+ config.api_key['Authorization'] = 'YOUR API KEY'
9574
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9575
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9576
+
9577
+ # Configure API key authorization: manager_auth
9578
+ config.api_key['Authorization'] = 'YOUR API KEY'
9579
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9580
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9581
+ end
9582
+
9583
+ api_instance = TalonOne::ManagementApi.new
9584
+
9585
+ begin
9586
+ #List supported SCIM schemas
9587
+ result = api_instance.scim_get_schemas
9588
+ p result
9589
+ rescue TalonOne::ApiError => e
9590
+ puts "Exception when calling ManagementApi->scim_get_schemas: #{e}"
9591
+ end
9592
+ ```
9593
+
9594
+ ### Parameters
9595
+
9596
+ This endpoint does not need any parameter.
9597
+
9598
+ ### Return type
9599
+
9600
+ [**ScimSchemasListResponse**](ScimSchemasListResponse.md)
9601
+
9602
+ ### Authorization
9603
+
9604
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9605
+
9606
+ ### HTTP request headers
9607
+
9608
+ - **Content-Type**: Not defined
9609
+ - **Accept**: application/json
9610
+
9611
+
9612
+ ## scim_get_service_provider_config
9613
+
9614
+ > ScimServiceProviderConfigResponse scim_get_service_provider_config
9615
+
9616
+ Get SCIM service provider configuration
9617
+
9618
+ Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings.
9619
+
9620
+ ### Example
9621
+
9622
+ ```ruby
9623
+ # load the gem
9624
+ require 'talon_one'
9625
+ # setup authorization
9626
+ TalonOne.configure do |config|
9627
+ # Configure API key authorization: management_key
9628
+ config.api_key['Authorization'] = 'YOUR API KEY'
9629
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9630
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9631
+
9632
+ # Configure API key authorization: manager_auth
9633
+ config.api_key['Authorization'] = 'YOUR API KEY'
9634
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9635
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9636
+ end
9637
+
9638
+ api_instance = TalonOne::ManagementApi.new
9639
+
9640
+ begin
9641
+ #Get SCIM service provider configuration
9642
+ result = api_instance.scim_get_service_provider_config
9643
+ p result
9644
+ rescue TalonOne::ApiError => e
9645
+ puts "Exception when calling ManagementApi->scim_get_service_provider_config: #{e}"
9646
+ end
9647
+ ```
9648
+
9649
+ ### Parameters
9650
+
9651
+ This endpoint does not need any parameter.
9652
+
9653
+ ### Return type
9654
+
9655
+ [**ScimServiceProviderConfigResponse**](ScimServiceProviderConfigResponse.md)
9656
+
9657
+ ### Authorization
9658
+
9659
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9660
+
9661
+ ### HTTP request headers
9662
+
9663
+ - **Content-Type**: Not defined
9664
+ - **Accept**: application/json
9665
+
9666
+
9667
+ ## scim_get_user
9668
+
9669
+ > ScimUser scim_get_user(user_id)
9670
+
9671
+ Get SCIM user
9672
+
9673
+ Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
9674
+
9675
+ ### Example
9676
+
9677
+ ```ruby
9678
+ # load the gem
9679
+ require 'talon_one'
9680
+ # setup authorization
9681
+ TalonOne.configure do |config|
9682
+ # Configure API key authorization: management_key
9683
+ config.api_key['Authorization'] = 'YOUR API KEY'
9684
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9685
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9686
+
9687
+ # Configure API key authorization: manager_auth
9688
+ config.api_key['Authorization'] = 'YOUR API KEY'
9689
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9690
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9691
+ end
9692
+
9693
+ api_instance = TalonOne::ManagementApi.new
9694
+ user_id = 56 # Integer | The ID of the user.
9695
+
9696
+ begin
9697
+ #Get SCIM user
9698
+ result = api_instance.scim_get_user(user_id)
9699
+ p result
9700
+ rescue TalonOne::ApiError => e
9701
+ puts "Exception when calling ManagementApi->scim_get_user: #{e}"
9702
+ end
9703
+ ```
9704
+
9705
+ ### Parameters
9706
+
9707
+
9708
+ Name | Type | Description | Notes
9709
+ ------------- | ------------- | ------------- | -------------
9710
+ **user_id** | **Integer**| The ID of the user. |
9711
+
9712
+ ### Return type
9713
+
9714
+ [**ScimUser**](ScimUser.md)
9715
+
9716
+ ### Authorization
9717
+
9718
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9719
+
9720
+ ### HTTP request headers
9721
+
9722
+ - **Content-Type**: Not defined
9723
+ - **Accept**: application/json
9724
+
9725
+
9726
+ ## scim_get_users
9727
+
9728
+ > ScimUsersListResponse scim_get_users
9729
+
9730
+ List SCIM users
9731
+
9732
+ Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
9733
+
9734
+ ### Example
9735
+
9736
+ ```ruby
9737
+ # load the gem
9738
+ require 'talon_one'
9739
+ # setup authorization
9740
+ TalonOne.configure do |config|
9741
+ # Configure API key authorization: management_key
9742
+ config.api_key['Authorization'] = 'YOUR API KEY'
9743
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9744
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9745
+
9746
+ # Configure API key authorization: manager_auth
9747
+ config.api_key['Authorization'] = 'YOUR API KEY'
9748
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9749
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9750
+ end
9751
+
9752
+ api_instance = TalonOne::ManagementApi.new
9753
+
9754
+ begin
9755
+ #List SCIM users
9756
+ result = api_instance.scim_get_users
9757
+ p result
9758
+ rescue TalonOne::ApiError => e
9759
+ puts "Exception when calling ManagementApi->scim_get_users: #{e}"
9760
+ end
9761
+ ```
9762
+
9763
+ ### Parameters
9764
+
9765
+ This endpoint does not need any parameter.
9766
+
9767
+ ### Return type
9768
+
9769
+ [**ScimUsersListResponse**](ScimUsersListResponse.md)
9770
+
9771
+ ### Authorization
9772
+
9773
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9774
+
9775
+ ### HTTP request headers
9776
+
9777
+ - **Content-Type**: Not defined
9778
+ - **Accept**: application/json
9779
+
9780
+
9781
+ ## scim_patch_user
9782
+
9783
+ > ScimUser scim_patch_user(user_id, body)
9784
+
9785
+ Update SCIM user attributes
9786
+
9787
+ Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.
9788
+
9789
+ ### Example
9790
+
9791
+ ```ruby
9792
+ # load the gem
9793
+ require 'talon_one'
9794
+ # setup authorization
9795
+ TalonOne.configure do |config|
9796
+ # Configure API key authorization: management_key
9797
+ config.api_key['Authorization'] = 'YOUR API KEY'
9798
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9799
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9800
+
9801
+ # Configure API key authorization: manager_auth
9802
+ config.api_key['Authorization'] = 'YOUR API KEY'
9803
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9804
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9805
+ end
9806
+
9807
+ api_instance = TalonOne::ManagementApi.new
9808
+ user_id = 56 # Integer | The ID of the user.
9809
+ body = TalonOne::ScimPatchRequest.new # ScimPatchRequest | body
9810
+
9811
+ begin
9812
+ #Update SCIM user attributes
9813
+ result = api_instance.scim_patch_user(user_id, body)
9814
+ p result
9815
+ rescue TalonOne::ApiError => e
9816
+ puts "Exception when calling ManagementApi->scim_patch_user: #{e}"
9817
+ end
9818
+ ```
9819
+
9820
+ ### Parameters
9821
+
9822
+
9823
+ Name | Type | Description | Notes
9824
+ ------------- | ------------- | ------------- | -------------
9825
+ **user_id** | **Integer**| The ID of the user. |
9826
+ **body** | [**ScimPatchRequest**](ScimPatchRequest.md)| body |
9827
+
9828
+ ### Return type
9829
+
9830
+ [**ScimUser**](ScimUser.md)
9831
+
9832
+ ### Authorization
9833
+
9834
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9835
+
9836
+ ### HTTP request headers
9837
+
9838
+ - **Content-Type**: application/json
9839
+ - **Accept**: application/json
9840
+
9841
+
9842
+ ## scim_replace_user_attributes
9843
+
9844
+ > ScimUser scim_replace_user_attributes(user_id, body)
9845
+
9846
+ Update SCIM user
9847
+
9848
+ Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.
9849
+
9850
+ ### Example
9851
+
9852
+ ```ruby
9853
+ # load the gem
9854
+ require 'talon_one'
9855
+ # setup authorization
9856
+ TalonOne.configure do |config|
9857
+ # Configure API key authorization: management_key
9858
+ config.api_key['Authorization'] = 'YOUR API KEY'
9859
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9860
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9861
+
9862
+ # Configure API key authorization: manager_auth
9863
+ config.api_key['Authorization'] = 'YOUR API KEY'
9864
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9865
+ #config.api_key_prefix['Authorization'] = 'Bearer'
9866
+ end
9867
+
9868
+ api_instance = TalonOne::ManagementApi.new
9869
+ user_id = 56 # Integer | The ID of the user.
9870
+ body = TalonOne::ScimNewUser.new # ScimNewUser | body
9871
+
9872
+ begin
9873
+ #Update SCIM user
9874
+ result = api_instance.scim_replace_user_attributes(user_id, body)
9875
+ p result
9876
+ rescue TalonOne::ApiError => e
9877
+ puts "Exception when calling ManagementApi->scim_replace_user_attributes: #{e}"
9878
+ end
9879
+ ```
9880
+
9881
+ ### Parameters
9882
+
9883
+
9884
+ Name | Type | Description | Notes
9885
+ ------------- | ------------- | ------------- | -------------
9886
+ **user_id** | **Integer**| The ID of the user. |
9887
+ **body** | [**ScimNewUser**](ScimNewUser.md)| body |
9888
+
9889
+ ### Return type
9890
+
9891
+ [**ScimUser**](ScimUser.md)
9892
+
9893
+ ### Authorization
9894
+
9895
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9896
+
9897
+ ### HTTP request headers
9898
+
9899
+ - **Content-Type**: application/json
9900
+ - **Accept**: application/json
9901
+
9902
+
8928
9903
  ## search_coupons_advanced_application_wide_without_total_count
8929
9904
 
8930
9905
  > InlineResponse2009 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
@@ -8967,7 +9942,7 @@ opts = {
8967
9942
  recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
8968
9943
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
8969
9944
  exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
8970
- campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
9945
+ campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
8971
9946
  }
8972
9947
 
8973
9948
  begin
@@ -8998,7 +9973,7 @@ Name | Type | Description | Notes
8998
9973
  **recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field | [optional]
8999
9974
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
9000
9975
  **exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
9001
- **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts. | [optional]
9976
+ **campaign_state** | **String**| Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. | [optional]
9002
9977
 
9003
9978
  ### Return type
9004
9979
 
@@ -9547,7 +10522,7 @@ Name | Type | Description | Notes
9547
10522
 
9548
10523
  Update coupon
9549
10524
 
9550
- Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this PUT endpoint only, any property you do not explicitly set in your request will be set to <code>null</code>.</p> </div>
10525
+ Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint alone, if you do not explicitly set a value for the <code>startDate</code>, <code>expiryDate</code>, and <code>recipientIntegrationId</code> properties in your request, it is automatically set to <code>null</code>.</p> </div>
9551
10526
 
9552
10527
  ### Example
9553
10528