talon_one 4.0.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (347) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +83 -18
  3. data/docs/AchievementProgress.md +2 -0
  4. data/docs/ActivateUserRequest.md +17 -0
  5. data/docs/AdditionalCampaignProperties.md +3 -1
  6. data/docs/AnalyticsDataPoint.md +19 -0
  7. data/docs/AnalyticsDataPointWithTrend.md +19 -0
  8. data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +21 -0
  9. data/docs/AnalyticsDataPointWithTrendAndUplift.md +21 -0
  10. data/docs/Application.md +4 -0
  11. data/docs/ApplicationAnalyticsDataPoint.md +6 -6
  12. data/docs/ApplicationCIF.md +33 -0
  13. data/docs/ApplicationCIFExpression.md +27 -0
  14. data/docs/ApplicationCampaignAnalytics.md +13 -19
  15. data/docs/ApplicationCampaignStats.md +1 -3
  16. data/docs/AsyncCouponDeletionJobResponse.md +17 -0
  17. data/docs/BaseLoyaltyProgram.md +8 -4
  18. data/docs/BaseNotification.md +1 -1
  19. data/docs/BaseNotificationEntity.md +1 -1
  20. data/docs/Campaign.md +15 -1
  21. data/docs/CampaignCollectionEditedNotification.md +21 -0
  22. data/docs/CampaignNotificationPolicy.md +3 -1
  23. data/docs/CampaignStateChangedNotification.md +2 -2
  24. data/docs/CampaignStoreBudget.md +25 -0
  25. data/docs/CampaignVersions.md +27 -0
  26. data/docs/CardAddedDeductedPointsNotificationPolicy.md +19 -0
  27. data/docs/CartItem.md +1 -1
  28. data/docs/CodeGeneratorSettings.md +1 -1
  29. data/docs/Coupon.md +3 -3
  30. data/docs/CouponConstraints.md +1 -1
  31. data/docs/CouponCreationJob.md +1 -1
  32. data/docs/CouponDeletionFilters.md +43 -0
  33. data/docs/CouponDeletionJob.md +39 -0
  34. data/docs/CustomerInventory.md +1 -1
  35. data/docs/CustomerSessionV2.md +2 -2
  36. data/docs/Effect.md +8 -0
  37. data/docs/EffectEntity.md +9 -1
  38. data/docs/Environment.md +3 -1
  39. data/docs/Event.md +1 -1
  40. data/docs/GenerateCampaignDescription.md +19 -0
  41. data/docs/GenerateCampaignTags.md +17 -0
  42. data/docs/GenerateItemFilterDescription.md +17 -0
  43. data/docs/GenerateLoyaltyCard.md +19 -0
  44. data/docs/GenerateRuleTitle.md +19 -0
  45. data/docs/GenerateRuleTitleRule.md +19 -0
  46. data/docs/IncreaseAchievementProgressEffectProps.md +1 -1
  47. data/docs/InlineResponse20044.md +1 -1
  48. data/docs/IntegrationApi.md +77 -16
  49. data/docs/IntegrationCoupon.md +3 -3
  50. data/docs/InventoryCoupon.md +3 -3
  51. data/docs/InventoryReferral.md +1 -1
  52. data/docs/LoyaltyBalanceWithTier.md +31 -0
  53. data/docs/LoyaltyBalancesWithTiers.md +19 -0
  54. data/docs/LoyaltyCard.md +6 -2
  55. data/docs/LoyaltyCardBalances.md +21 -0
  56. data/docs/LoyaltyCardBatch.md +21 -0
  57. data/docs/LoyaltyCardBatchResponse.md +19 -0
  58. data/docs/LoyaltyCardProfileRegistration.md +1 -1
  59. data/docs/LoyaltyProgram.md +14 -6
  60. data/docs/ManagementApi.md +1269 -176
  61. data/docs/MessageLogEntry.md +1 -3
  62. data/docs/MessageLogResponse.md +3 -3
  63. data/docs/NewAppWideCouponDeletionJob.md +19 -0
  64. data/docs/NewApplication.md +3 -1
  65. data/docs/NewApplicationCIF.md +27 -0
  66. data/docs/NewApplicationCIFExpression.md +21 -0
  67. data/docs/NewBaseNotification.md +1 -1
  68. data/docs/NewCouponCreationJob.md +1 -1
  69. data/docs/NewCouponDeletionJob.md +17 -0
  70. data/docs/NewCoupons.md +2 -2
  71. data/docs/NewCouponsForMultipleRecipients.md +1 -1
  72. data/docs/NewCustomerSessionV2.md +2 -2
  73. data/docs/NewExternalInvitation.md +21 -0
  74. data/docs/NewLoyaltyProgram.md +8 -4
  75. data/docs/NewOutgoingIntegrationWebhook.md +2 -0
  76. data/docs/NewReferral.md +1 -1
  77. data/docs/NewReferralsForMultipleAdvocates.md +1 -1
  78. data/docs/NewRevisionVersion.md +37 -0
  79. data/docs/NewWebhook.md +2 -0
  80. data/docs/OktaEvent.md +19 -0
  81. data/docs/OktaEventPayload.md +17 -0
  82. data/docs/OktaEventPayloadData.md +17 -0
  83. data/docs/OktaEventTarget.md +21 -0
  84. data/docs/ProjectedTier.md +21 -0
  85. data/docs/Referral.md +1 -1
  86. data/docs/ReferralConstraints.md +1 -1
  87. data/docs/RejectCouponEffectProps.md +3 -1
  88. data/docs/RejectReferralEffectProps.md +3 -1
  89. data/docs/Revision.md +35 -0
  90. data/docs/RevisionActivation.md +17 -0
  91. data/docs/RevisionVersion.md +53 -0
  92. data/docs/RollbackIncreasedAchievementProgressEffectProps.md +27 -0
  93. data/docs/RuleFailureReason.md +5 -1
  94. data/docs/SSOConfig.md +3 -1
  95. data/docs/ScimBaseUser.md +23 -0
  96. data/docs/ScimBaseUserName.md +17 -0
  97. data/docs/ScimNewUser.md +23 -0
  98. data/docs/ScimPatchOperation.md +21 -0
  99. data/docs/ScimPatchRequest.md +19 -0
  100. data/docs/ScimResource.md +21 -0
  101. data/docs/ScimResourceTypesListResponse.md +17 -0
  102. data/docs/ScimSchemaResource.md +23 -0
  103. data/docs/ScimSchemasListResponse.md +21 -0
  104. data/docs/ScimServiceProviderConfigResponse.md +27 -0
  105. data/docs/ScimServiceProviderConfigResponseBulk.md +21 -0
  106. data/docs/ScimServiceProviderConfigResponseChangePassword.md +17 -0
  107. data/docs/ScimServiceProviderConfigResponseFilter.md +19 -0
  108. data/docs/ScimServiceProviderConfigResponsePatch.md +17 -0
  109. data/docs/ScimUser.md +25 -0
  110. data/docs/ScimUsersListResponse.md +21 -0
  111. data/docs/Tier.md +3 -1
  112. data/docs/TransferLoyaltyCard.md +3 -1
  113. data/docs/UpdateApplication.md +5 -1
  114. data/docs/UpdateApplicationCIF.md +23 -0
  115. data/docs/UpdateCampaign.md +1 -1
  116. data/docs/UpdateCoupon.md +2 -2
  117. data/docs/UpdateCouponBatch.md +1 -1
  118. data/docs/UpdateLoyaltyCard.md +4 -2
  119. data/docs/UpdateLoyaltyProgram.md +8 -4
  120. data/docs/UpdateReferral.md +1 -1
  121. data/docs/UpdateReferralBatch.md +1 -1
  122. data/docs/UpdateUser.md +1 -1
  123. data/docs/User.md +3 -1
  124. data/docs/Webhook.md +2 -0
  125. data/docs/WebhookWithOutgoingIntegrationDetails.md +2 -0
  126. data/lib/talon_one/api/integration_api.rb +101 -25
  127. data/lib/talon_one/api/management_api.rb +1362 -189
  128. data/lib/talon_one/models/achievement_progress.rb +16 -1
  129. data/lib/talon_one/models/activate_user_request.rb +213 -0
  130. data/lib/talon_one/models/additional_campaign_properties.rb +21 -6
  131. data/lib/talon_one/models/analytics_data_point.rb +225 -0
  132. data/lib/talon_one/models/analytics_data_point_with_trend.rb +225 -0
  133. data/lib/talon_one/models/analytics_data_point_with_trend_and_influenced_rate.rb +239 -0
  134. data/lib/talon_one/models/analytics_data_point_with_trend_and_uplift.rb +239 -0
  135. data/lib/talon_one/models/application.rb +21 -1
  136. data/lib/talon_one/models/application_analytics_data_point.rb +14 -4
  137. data/lib/talon_one/models/application_campaign_analytics.rb +39 -41
  138. data/lib/talon_one/models/application_campaign_stats.rb +1 -16
  139. data/lib/talon_one/models/application_cif.rb +308 -0
  140. data/lib/talon_one/models/application_cif_expression.rb +275 -0
  141. data/lib/talon_one/models/async_coupon_deletion_job_response.rb +213 -0
  142. data/lib/talon_one/models/attribute.rb +2 -2
  143. data/lib/talon_one/models/base_loyalty_program.rb +44 -25
  144. data/lib/talon_one/models/base_notification.rb +3 -2
  145. data/lib/talon_one/models/base_notification_entity.rb +1 -0
  146. data/lib/talon_one/models/campaign.rb +83 -6
  147. data/lib/talon_one/models/campaign_collection_edited_notification.rb +235 -0
  148. data/lib/talon_one/models/campaign_notification_policy.rb +16 -4
  149. data/lib/talon_one/models/campaign_state_changed_notification.rb +2 -2
  150. data/lib/talon_one/models/campaign_store_budget.rb +275 -0
  151. data/lib/talon_one/models/campaign_versions.rb +259 -0
  152. data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb +269 -0
  153. data/lib/talon_one/models/cart_item.rb +1 -1
  154. data/lib/talon_one/models/code_generator_settings.rb +1 -1
  155. data/lib/talon_one/models/coupon.rb +3 -3
  156. data/lib/talon_one/models/coupon_constraints.rb +1 -1
  157. data/lib/talon_one/models/coupon_creation_job.rb +1 -1
  158. data/lib/talon_one/models/coupon_deletion_filters.rb +375 -0
  159. data/lib/talon_one/models/coupon_deletion_job.rb +370 -0
  160. data/lib/talon_one/models/customer_inventory.rb +1 -1
  161. data/lib/talon_one/models/customer_session_v2.rb +2 -2
  162. data/lib/talon_one/models/effect.rb +41 -1
  163. data/lib/talon_one/models/effect_entity.rb +44 -4
  164. data/lib/talon_one/models/environment.rb +16 -4
  165. data/lib/talon_one/models/event.rb +0 -5
  166. data/lib/talon_one/models/generate_campaign_description.rb +227 -0
  167. data/lib/talon_one/models/generate_campaign_tags.rb +212 -0
  168. data/lib/talon_one/models/generate_item_filter_description.rb +214 -0
  169. data/lib/talon_one/models/generate_loyalty_card.rb +256 -0
  170. data/lib/talon_one/models/generate_rule_title.rb +226 -0
  171. data/lib/talon_one/models/generate_rule_title_rule.rb +221 -0
  172. data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +1 -1
  173. data/lib/talon_one/models/inline_response20044.rb +1 -1
  174. data/lib/talon_one/models/integration_coupon.rb +3 -3
  175. data/lib/talon_one/models/inventory_coupon.rb +3 -3
  176. data/lib/talon_one/models/inventory_referral.rb +1 -1
  177. data/lib/talon_one/models/loyalty_balance_with_tier.rb +276 -0
  178. data/lib/talon_one/models/loyalty_balances_with_tiers.rb +219 -0
  179. data/lib/talon_one/models/loyalty_card.rb +25 -5
  180. data/lib/talon_one/models/loyalty_card_balances.rb +231 -0
  181. data/lib/talon_one/models/loyalty_card_batch.rb +304 -0
  182. data/lib/talon_one/models/loyalty_card_batch_response.rb +227 -0
  183. data/lib/talon_one/models/loyalty_card_profile_registration.rb +1 -1
  184. data/lib/talon_one/models/loyalty_program.rb +70 -29
  185. data/lib/talon_one/models/message_log_entry.rb +4 -14
  186. data/lib/talon_one/models/message_log_response.rb +3 -22
  187. data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb +227 -0
  188. data/lib/talon_one/models/new_application.rb +14 -4
  189. data/lib/talon_one/models/new_application_cif.rb +262 -0
  190. data/lib/talon_one/models/new_application_cif_expression.rb +229 -0
  191. data/lib/talon_one/models/new_attribute.rb +2 -2
  192. data/lib/talon_one/models/new_base_notification.rb +1 -0
  193. data/lib/talon_one/models/new_coupon_creation_job.rb +1 -1
  194. data/lib/talon_one/models/new_coupon_deletion_job.rb +211 -0
  195. data/lib/talon_one/models/new_coupons.rb +2 -2
  196. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +1 -1
  197. data/lib/talon_one/models/new_customer_session_v2.rb +2 -2
  198. data/lib/talon_one/models/new_external_invitation.rb +235 -0
  199. data/lib/talon_one/models/new_loyalty_program.rb +44 -25
  200. data/lib/talon_one/models/new_notification_test.rb +2 -2
  201. data/lib/talon_one/models/new_outgoing_integration_webhook.rb +11 -1
  202. data/lib/talon_one/models/new_referral.rb +1 -1
  203. data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +1 -1
  204. data/lib/talon_one/models/new_revision_version.rb +352 -0
  205. data/lib/talon_one/models/new_webhook.rb +11 -1
  206. data/lib/talon_one/models/okta_event.rb +229 -0
  207. data/lib/talon_one/models/okta_event_payload.rb +212 -0
  208. data/lib/talon_one/models/okta_event_payload_data.rb +214 -0
  209. data/lib/talon_one/models/okta_event_target.rb +243 -0
  210. data/lib/talon_one/models/projected_tier.rb +232 -0
  211. data/lib/talon_one/models/referral.rb +1 -1
  212. data/lib/talon_one/models/referral_constraints.rb +1 -1
  213. data/lib/talon_one/models/reject_coupon_effect_props.rb +14 -4
  214. data/lib/talon_one/models/reject_referral_effect_props.rb +14 -4
  215. data/lib/talon_one/models/revision.rb +319 -0
  216. data/lib/talon_one/models/revision_activation.rb +206 -0
  217. data/lib/talon_one/models/revision_version.rb +466 -0
  218. data/lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb +288 -0
  219. data/lib/talon_one/models/rule_failure_reason.rb +24 -4
  220. data/lib/talon_one/models/scim_base_user.rb +237 -0
  221. data/lib/talon_one/models/scim_base_user_name.rb +208 -0
  222. data/lib/talon_one/models/scim_new_user.rb +237 -0
  223. data/lib/talon_one/models/scim_patch_operation.rb +267 -0
  224. data/lib/talon_one/models/scim_patch_request.rb +226 -0
  225. data/lib/talon_one/models/scim_resource.rb +228 -0
  226. data/lib/talon_one/models/scim_resource_types_list_response.rb +214 -0
  227. data/lib/talon_one/models/scim_schema_resource.rb +239 -0
  228. data/lib/talon_one/models/scim_schemas_list_response.rb +236 -0
  229. data/lib/talon_one/models/scim_service_provider_config_response.rb +256 -0
  230. data/lib/talon_one/models/scim_service_provider_config_response_bulk.rb +228 -0
  231. data/lib/talon_one/models/scim_service_provider_config_response_change_password.rb +208 -0
  232. data/lib/talon_one/models/scim_service_provider_config_response_filter.rb +218 -0
  233. data/lib/talon_one/models/scim_service_provider_config_response_patch.rb +208 -0
  234. data/lib/talon_one/models/scim_user.rb +252 -0
  235. data/lib/talon_one/models/scim_users_list_response.rb +236 -0
  236. data/lib/talon_one/models/sso_config.rb +14 -4
  237. data/lib/talon_one/models/tier.rb +12 -2
  238. data/lib/talon_one/models/transfer_loyalty_card.rb +14 -4
  239. data/lib/talon_one/models/update_application.rb +24 -4
  240. data/lib/talon_one/models/update_application_cif.rb +237 -0
  241. data/lib/talon_one/models/update_campaign.rb +1 -1
  242. data/lib/talon_one/models/update_coupon.rb +2 -2
  243. data/lib/talon_one/models/update_coupon_batch.rb +1 -1
  244. data/lib/talon_one/models/update_loyalty_card.rb +15 -5
  245. data/lib/talon_one/models/update_loyalty_program.rb +44 -25
  246. data/lib/talon_one/models/update_referral.rb +1 -1
  247. data/lib/talon_one/models/update_referral_batch.rb +1 -1
  248. data/lib/talon_one/models/update_user.rb +1 -1
  249. data/lib/talon_one/models/user.rb +14 -4
  250. data/lib/talon_one/models/webhook.rb +11 -1
  251. data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +11 -1
  252. data/lib/talon_one/version.rb +1 -1
  253. data/lib/talon_one.rb +57 -11
  254. data/spec/api/integration_api_spec.rb +25 -10
  255. data/spec/api/management_api_spec.rb +267 -39
  256. data/spec/models/achievement_progress_spec.rb +6 -0
  257. data/spec/models/activate_user_request_spec.rb +41 -0
  258. data/spec/models/additional_campaign_properties_spec.rb +7 -1
  259. data/spec/models/analytics_data_point_spec.rb +47 -0
  260. data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +53 -0
  261. data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +53 -0
  262. data/spec/models/analytics_data_point_with_trend_spec.rb +47 -0
  263. data/spec/models/application_campaign_analytics_spec.rb +1 -19
  264. data/spec/models/application_campaign_stats_spec.rb +0 -6
  265. data/spec/models/application_cif_expression_spec.rb +71 -0
  266. data/spec/models/application_cif_spec.rb +89 -0
  267. data/spec/models/application_spec.rb +12 -0
  268. data/spec/models/async_coupon_deletion_job_response_spec.rb +41 -0
  269. data/spec/models/attribute_spec.rb +1 -1
  270. data/spec/models/base_loyalty_program_spec.rb +18 -6
  271. data/spec/models/base_notification_spec.rb +1 -1
  272. data/spec/models/campaign_collection_edited_notification_spec.rb +53 -0
  273. data/spec/models/campaign_notification_policy_spec.rb +6 -0
  274. data/spec/models/campaign_spec.rb +43 -1
  275. data/spec/models/campaign_store_budget_spec.rb +65 -0
  276. data/spec/models/campaign_versions_spec.rb +71 -0
  277. data/spec/models/card_added_deducted_points_notification_policy_spec.rb +51 -0
  278. data/spec/models/coupon_deletion_filters_spec.rb +123 -0
  279. data/spec/models/coupon_deletion_job_spec.rb +107 -0
  280. data/spec/models/effect_entity_spec.rb +24 -0
  281. data/spec/models/effect_spec.rb +24 -0
  282. data/spec/models/environment_spec.rb +6 -0
  283. data/spec/models/generate_campaign_description_spec.rb +47 -0
  284. data/spec/models/generate_campaign_tags_spec.rb +41 -0
  285. data/spec/models/generate_item_filter_description_spec.rb +41 -0
  286. data/spec/models/generate_loyalty_card_spec.rb +51 -0
  287. data/spec/models/generate_rule_title_rule_spec.rb +47 -0
  288. data/spec/models/generate_rule_title_spec.rb +47 -0
  289. data/spec/models/loyalty_balance_with_tier_spec.rb +83 -0
  290. data/spec/models/loyalty_balances_with_tiers_spec.rb +47 -0
  291. data/spec/models/loyalty_card_balances_spec.rb +53 -0
  292. data/spec/models/loyalty_card_batch_response_spec.rb +47 -0
  293. data/spec/models/loyalty_card_batch_spec.rb +57 -0
  294. data/spec/models/loyalty_card_spec.rb +12 -0
  295. data/spec/models/loyalty_program_spec.rb +30 -6
  296. data/spec/models/message_log_entry_spec.rb +1 -7
  297. data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +47 -0
  298. data/spec/models/new_application_cif_expression_spec.rb +53 -0
  299. data/spec/models/new_application_cif_spec.rb +71 -0
  300. data/spec/models/new_application_spec.rb +6 -0
  301. data/spec/models/new_attribute_spec.rb +1 -1
  302. data/spec/models/new_coupon_deletion_job_spec.rb +41 -0
  303. data/spec/models/new_external_invitation_spec.rb +53 -0
  304. data/spec/models/new_loyalty_program_spec.rb +18 -6
  305. data/spec/models/new_notification_test_spec.rb +1 -1
  306. data/spec/models/new_outgoing_integration_webhook_spec.rb +6 -0
  307. data/spec/models/new_revision_version_spec.rb +105 -0
  308. data/spec/models/new_webhook_spec.rb +6 -0
  309. data/spec/models/okta_event_payload_data_spec.rb +41 -0
  310. data/spec/models/okta_event_payload_spec.rb +41 -0
  311. data/spec/models/okta_event_spec.rb +47 -0
  312. data/spec/models/okta_event_target_spec.rb +53 -0
  313. data/spec/models/projected_tier_spec.rb +53 -0
  314. data/spec/models/reject_coupon_effect_props_spec.rb +6 -0
  315. data/spec/models/reject_referral_effect_props_spec.rb +6 -0
  316. data/spec/models/revision_activation_spec.rb +41 -0
  317. data/spec/models/revision_spec.rb +95 -0
  318. data/spec/models/revision_version_spec.rb +153 -0
  319. data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +71 -0
  320. data/spec/models/rule_failure_reason_spec.rb +12 -0
  321. data/spec/models/scim_base_user_name_spec.rb +41 -0
  322. data/spec/models/scim_base_user_spec.rb +59 -0
  323. data/spec/models/scim_new_user_spec.rb +59 -0
  324. data/spec/models/scim_patch_operation_spec.rb +57 -0
  325. data/spec/models/scim_patch_request_spec.rb +47 -0
  326. data/spec/models/scim_resource_spec.rb +53 -0
  327. data/spec/models/scim_resource_types_list_response_spec.rb +41 -0
  328. data/spec/models/scim_schema_resource_spec.rb +59 -0
  329. data/spec/models/scim_schemas_list_response_spec.rb +53 -0
  330. data/spec/models/scim_service_provider_config_response_bulk_spec.rb +53 -0
  331. data/spec/models/scim_service_provider_config_response_change_password_spec.rb +41 -0
  332. data/spec/models/scim_service_provider_config_response_filter_spec.rb +47 -0
  333. data/spec/models/scim_service_provider_config_response_patch_spec.rb +41 -0
  334. data/spec/models/scim_service_provider_config_response_spec.rb +71 -0
  335. data/spec/models/scim_user_spec.rb +65 -0
  336. data/spec/models/scim_users_list_response_spec.rb +53 -0
  337. data/spec/models/sso_config_spec.rb +6 -0
  338. data/spec/models/tier_spec.rb +6 -0
  339. data/spec/models/transfer_loyalty_card_spec.rb +6 -0
  340. data/spec/models/update_application_cif_spec.rb +59 -0
  341. data/spec/models/update_application_spec.rb +12 -0
  342. data/spec/models/update_loyalty_card_spec.rb +6 -0
  343. data/spec/models/update_loyalty_program_spec.rb +18 -6
  344. data/spec/models/user_spec.rb +6 -0
  345. data/spec/models/webhook_spec.rb +6 -0
  346. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
  347. metadata +246 -18
@@ -4,6 +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 | Enable user by email address
7
8
  [**add_loyalty_card_points**](ManagementApi.md#add_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card
8
9
  [**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile
9
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
@@ -11,17 +12,19 @@ Method | HTTP request | Description
11
12
  [**create_achievement**](ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement
12
13
  [**create_additional_cost**](ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost
13
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
14
16
  [**create_campaign_from_template**](ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
15
17
  [**create_collection**](ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
16
18
  [**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
17
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
18
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
19
22
  [**create_invite_email**](ManagementApi.md#create_invite_email) | **POST** /v1/invite_emails | Resend invitation email
20
23
  [**create_invite_v2**](ManagementApi.md#create_invite_v2) | **POST** /v2/invites | Invite user
21
24
  [**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
22
25
  [**create_session**](ManagementApi.md#create_session) | **POST** /v1/sessions | Create session
23
26
  [**create_store**](ManagementApi.md#create_store) | **POST** /v1/applications/{applicationId}/stores | Create store
24
- [**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
25
28
  [**deduct_loyalty_card_points**](ManagementApi.md#deduct_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card
26
29
  [**delete_account_collection**](ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
27
30
  [**delete_achievement**](ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
@@ -35,9 +38,11 @@ Method | HTTP request | Description
35
38
  [**delete_user**](ManagementApi.md#delete_user) | **DELETE** /v1/users/{userId} | Delete user
36
39
  [**delete_user_by_email**](ManagementApi.md#delete_user_by_email) | **POST** /v1/users/delete | Delete user by email address
37
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
38
42
  [**export_account_collection_items**](ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
39
43
  [**export_achievements**](ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
40
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
41
46
  [**export_collection_items**](ManagementApi.md#export_collection_items) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
42
47
  [**export_coupons**](ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
43
48
  [**export_customer_sessions**](ManagementApi.md#export_customer_sessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions
@@ -47,6 +52,7 @@ Method | HTTP request | Description
47
52
  [**export_loyalty_balances**](ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances
48
53
  [**export_loyalty_card_balances**](ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs
49
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
50
56
  [**export_loyalty_ledger**](ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs
51
57
  [**export_pool_giveaways**](ManagementApi.md#export_pool_giveaways) | **GET** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool
52
58
  [**export_referrals**](ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals
@@ -58,7 +64,6 @@ Method | HTTP request | Description
58
64
  [**get_additional_cost**](ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost
59
65
  [**get_additional_costs**](ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
60
66
  [**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | List access logs
61
- [**get_all_roles**](ManagementApi.md#get_all_roles) | **GET** /v1/roles | List roles
62
67
  [**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
63
68
  [**get_application_api_health**](ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get Application health
64
69
  [**get_application_customer**](ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer
@@ -104,7 +109,7 @@ Method | HTTP request | Description
104
109
  [**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
105
110
  [**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
106
111
  [**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
107
- [**get_role**](ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get role
112
+ [**get_role_v2**](ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
108
113
  [**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
109
114
  [**get_rulesets**](ManagementApi.md#get_rulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets
110
115
  [**get_store**](ManagementApi.md#get_store) | **GET** /v1/applications/{applicationId}/stores/{storeId} | Get store
@@ -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
@@ -124,18 +130,30 @@ Method | HTTP request | Description
124
130
  [**import_loyalty_points**](ManagementApi.md#import_loyalty_points) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points
125
131
  [**import_pool_giveaways**](ManagementApi.md#import_pool_giveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool
126
132
  [**import_referrals**](ManagementApi.md#import_referrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals
133
+ [**invite_user_external**](ManagementApi.md#invite_user_external) | **POST** /v1/users/invite | Invite user from identity provider
127
134
  [**list_account_collections**](ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
128
135
  [**list_achievements**](ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
136
+ [**list_all_roles_v2**](ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
129
137
  [**list_catalog_items**](ManagementApi.md#list_catalog_items) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
130
138
  [**list_collections**](ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
131
139
  [**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
132
140
  [**list_stores**](ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
133
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
134
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
135
144
  [**post_catalogs_strikethrough_notification**](ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
136
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
137
146
  [**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
138
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
139
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)
140
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)
141
159
  [**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
@@ -155,6 +173,64 @@ Method | HTTP request | Description
155
173
 
156
174
 
157
175
 
176
+ ## activate_user_by_email
177
+
178
+ > activate_user_by_email(body)
179
+
180
+ Enable user by email address
181
+
182
+ Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
183
+
184
+ ### Example
185
+
186
+ ```ruby
187
+ # load the gem
188
+ require 'talon_one'
189
+ # setup authorization
190
+ TalonOne.configure do |config|
191
+ # Configure API key authorization: management_key
192
+ config.api_key['Authorization'] = 'YOUR API KEY'
193
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
194
+ #config.api_key_prefix['Authorization'] = 'Bearer'
195
+
196
+ # Configure API key authorization: manager_auth
197
+ config.api_key['Authorization'] = 'YOUR API KEY'
198
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
199
+ #config.api_key_prefix['Authorization'] = 'Bearer'
200
+ end
201
+
202
+ api_instance = TalonOne::ManagementApi.new
203
+ body = TalonOne::ActivateUserRequest.new # ActivateUserRequest | body
204
+
205
+ begin
206
+ #Enable user by email address
207
+ api_instance.activate_user_by_email(body)
208
+ rescue TalonOne::ApiError => e
209
+ puts "Exception when calling ManagementApi->activate_user_by_email: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
214
+
215
+
216
+ Name | Type | Description | Notes
217
+ ------------- | ------------- | ------------- | -------------
218
+ **body** | [**ActivateUserRequest**](ActivateUserRequest.md)| body |
219
+
220
+ ### Return type
221
+
222
+ nil (empty response body)
223
+
224
+ ### Authorization
225
+
226
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
227
+
228
+ ### HTTP request headers
229
+
230
+ - **Content-Type**: application/json
231
+ - **Accept**: Not defined
232
+
233
+
158
234
  ## add_loyalty_card_points
159
235
 
160
236
  > add_loyalty_card_points(loyalty_program_id, loyalty_card_id, body)
@@ -582,6 +658,67 @@ Name | Type | Description | Notes
582
658
  - **Accept**: application/json
583
659
 
584
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
+
585
722
  ## create_campaign_from_template
586
723
 
587
724
  > CreateTemplateCampaignResponse create_campaign_from_template(application_id, body)
@@ -836,6 +973,69 @@ Name | Type | Description | Notes
836
973
  - **Accept**: application/json
837
974
 
838
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
+
839
1039
  ## create_coupons_for_multiple_recipients
840
1040
 
841
1041
  > InlineResponse2008 create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
@@ -1204,9 +1404,9 @@ Name | Type | Description | Notes
1204
1404
 
1205
1405
  > deactivate_user_by_email(body)
1206
1406
 
1207
- Deactivate user by email address
1407
+ Disable user by email address
1208
1408
 
1209
- 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.
1210
1410
 
1211
1411
  ### Example
1212
1412
 
@@ -1230,7 +1430,7 @@ api_instance = TalonOne::ManagementApi.new
1230
1430
  body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
1231
1431
 
1232
1432
  begin
1233
- #Deactivate user by email address
1433
+ #Disable user by email address
1234
1434
  api_instance.deactivate_user_by_email(body)
1235
1435
  rescue TalonOne::ApiError => e
1236
1436
  puts "Exception when calling ManagementApi->deactivate_user_by_email: #{e}"
@@ -1657,10 +1857,10 @@ opts = {
1657
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.
1658
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.
1659
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.
1660
- 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.
1661
- 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.
1662
- 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.
1663
- 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.
1664
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.
1665
1865
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
1666
1866
  usable: 'usable_example', # String | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
@@ -1687,10 +1887,10 @@ Name | Type | Description | Notes
1687
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]
1688
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]
1689
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]
1690
- **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]
1691
- **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]
1692
- **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]
1693
- **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]
1694
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]
1695
1895
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
1696
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]
@@ -1958,7 +2158,7 @@ nil (empty response body)
1958
2158
 
1959
2159
  Delete user by email address
1960
2160
 
1961
- 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.
1962
2162
 
1963
2163
  ### Example
1964
2164
 
@@ -2064,6 +2264,66 @@ nil (empty response body)
2064
2264
  - **Accept**: Not defined
2065
2265
 
2066
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
+
2067
2327
  ## export_account_collection_items
2068
2328
 
2069
2329
  > String export_account_collection_items(collection_id)
@@ -2245,13 +2505,13 @@ Name | Type | Description | Notes
2245
2505
  - **Accept**: application/csv
2246
2506
 
2247
2507
 
2248
- ## export_collection_items
2508
+ ## export_campaign_stores
2249
2509
 
2250
- > String export_collection_items(application_id, campaign_id, collection_id)
2510
+ > String export_campaign_stores(application_id, campaign_id)
2251
2511
 
2252
- Export campaign-level collection's items
2512
+ Export stores
2253
2513
 
2254
- Download a CSV file containing items from a given campaign-level collection. **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/).
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.
2255
2515
 
2256
2516
  ### Example
2257
2517
 
@@ -2274,14 +2534,13 @@ end
2274
2534
  api_instance = TalonOne::ManagementApi.new
2275
2535
  application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2276
2536
  campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
2277
- collection_id = 56 # Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
2278
2537
 
2279
2538
  begin
2280
- #Export campaign-level collection's items
2281
- result = api_instance.export_collection_items(application_id, campaign_id, collection_id)
2539
+ #Export stores
2540
+ result = api_instance.export_campaign_stores(application_id, campaign_id)
2282
2541
  p result
2283
2542
  rescue TalonOne::ApiError => e
2284
- puts "Exception when calling ManagementApi->export_collection_items: #{e}"
2543
+ puts "Exception when calling ManagementApi->export_campaign_stores: #{e}"
2285
2544
  end
2286
2545
  ```
2287
2546
 
@@ -2292,7 +2551,6 @@ Name | Type | Description | Notes
2292
2551
  ------------- | ------------- | ------------- | -------------
2293
2552
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2294
2553
  **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
2295
- **collection_id** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
2296
2554
 
2297
2555
  ### Return type
2298
2556
 
@@ -2308,13 +2566,13 @@ Name | Type | Description | Notes
2308
2566
  - **Accept**: application/csv
2309
2567
 
2310
2568
 
2311
- ## export_coupons
2569
+ ## export_collection_items
2312
2570
 
2313
- > String export_coupons(application_id, opts)
2571
+ > String export_collection_items(application_id, campaign_id, collection_id)
2314
2572
 
2315
- Export coupons
2573
+ Export campaign-level collection's items
2316
2574
 
2317
- Download a CSV file containing the coupons that match the given properties. **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 can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon is reserved. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
2575
+ Download a CSV file containing items from a given campaign-level collection. **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/).
2318
2576
 
2319
2577
  ### Example
2320
2578
 
@@ -2336,29 +2594,15 @@ end
2336
2594
 
2337
2595
  api_instance = TalonOne::ManagementApi.new
2338
2596
  application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2339
- opts = {
2340
- campaign_id: 3.4, # Float | Filter results by campaign.
2341
- 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.
2342
- 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.
2343
- 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.
2344
- 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.
2345
- 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.
2346
- 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`.
2347
- 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.
2348
- recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.
2349
- batch_id: 'batch_id_example', # String | Filter results by batches of coupons
2350
- exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code.
2351
- date_format: 'date_format_example', # String | Determines the format of dates in the export document.
2352
- 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.
2353
- values_only: false # Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
2354
- }
2597
+ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
2598
+ collection_id = 56 # Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
2355
2599
 
2356
2600
  begin
2357
- #Export coupons
2358
- result = api_instance.export_coupons(application_id, opts)
2601
+ #Export campaign-level collection's items
2602
+ result = api_instance.export_collection_items(application_id, campaign_id, collection_id)
2359
2603
  p result
2360
2604
  rescue TalonOne::ApiError => e
2361
- puts "Exception when calling ManagementApi->export_coupons: #{e}"
2605
+ puts "Exception when calling ManagementApi->export_collection_items: #{e}"
2362
2606
  end
2363
2607
  ```
2364
2608
 
@@ -2368,19 +2612,96 @@ end
2368
2612
  Name | Type | Description | Notes
2369
2613
  ------------- | ------------- | ------------- | -------------
2370
2614
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2371
- **campaign_id** | **Float**| Filter results by campaign. | [optional]
2372
- **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]
2373
- **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]
2374
- **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]
2375
- **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]
2376
- **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]
2377
- **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]
2378
- **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]
2379
- **recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field. | [optional]
2380
- **batch_id** | **String**| Filter results by batches of coupons | [optional]
2381
- **exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
2615
+ **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
2616
+ **collection_id** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
2617
+
2618
+ ### Return type
2619
+
2620
+ **String**
2621
+
2622
+ ### Authorization
2623
+
2624
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
2625
+
2626
+ ### HTTP request headers
2627
+
2628
+ - **Content-Type**: Not defined
2629
+ - **Accept**: application/csv
2630
+
2631
+
2632
+ ## export_coupons
2633
+
2634
+ > String export_coupons(application_id, opts)
2635
+
2636
+ Export coupons
2637
+
2638
+ Download a CSV file containing the coupons that match the given properties. **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 can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
2639
+
2640
+ ### Example
2641
+
2642
+ ```ruby
2643
+ # load the gem
2644
+ require 'talon_one'
2645
+ # setup authorization
2646
+ TalonOne.configure do |config|
2647
+ # Configure API key authorization: management_key
2648
+ config.api_key['Authorization'] = 'YOUR API KEY'
2649
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2650
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2651
+
2652
+ # Configure API key authorization: manager_auth
2653
+ config.api_key['Authorization'] = 'YOUR API KEY'
2654
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2655
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2656
+ end
2657
+
2658
+ api_instance = TalonOne::ManagementApi.new
2659
+ application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2660
+ opts = {
2661
+ campaign_id: 3.4, # Float | Filter results by campaign.
2662
+ 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.
2663
+ 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.
2664
+ 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.
2665
+ 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.
2666
+ 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.
2667
+ 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`.
2668
+ 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.
2669
+ recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.
2670
+ batch_id: 'batch_id_example', # String | Filter results by batches of coupons
2671
+ exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code.
2672
+ date_format: 'date_format_example', # String | Determines the format of dates in the export document.
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.
2674
+ values_only: false # Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
2675
+ }
2676
+
2677
+ begin
2678
+ #Export coupons
2679
+ result = api_instance.export_coupons(application_id, opts)
2680
+ p result
2681
+ rescue TalonOne::ApiError => e
2682
+ puts "Exception when calling ManagementApi->export_coupons: #{e}"
2683
+ end
2684
+ ```
2685
+
2686
+ ### Parameters
2687
+
2688
+
2689
+ Name | Type | Description | Notes
2690
+ ------------- | ------------- | ------------- | -------------
2691
+ **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2692
+ **campaign_id** | **Float**| Filter results by campaign. | [optional]
2693
+ **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]
2694
+ **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]
2695
+ **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]
2696
+ **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]
2697
+ **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]
2698
+ **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]
2699
+ **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]
2700
+ **recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field. | [optional]
2701
+ **batch_id** | **String**| Filter results by batches of coupons | [optional]
2702
+ **exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
2382
2703
  **date_format** | **String**| Determines the format of dates in the export document. | [optional]
2383
- **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]
2384
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]
2385
2706
 
2386
2707
  ### Return type
@@ -2474,7 +2795,7 @@ Name | Type | Description | Notes
2474
2795
 
2475
2796
  Export customers' tier data
2476
2797
 
2477
- 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.
2478
2799
 
2479
2800
  ### Example
2480
2801
 
@@ -2563,8 +2884,8 @@ api_instance = TalonOne::ManagementApi.new
2563
2884
  application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2564
2885
  opts = {
2565
2886
  campaign_id: 3.4, # Float | Filter results by campaign.
2566
- 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.
2567
- 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.
2568
2889
  date_format: 'date_format_example' # String | Determines the format of dates in the export document.
2569
2890
  }
2570
2891
 
@@ -2584,8 +2905,8 @@ Name | Type | Description | Notes
2584
2905
  ------------- | ------------- | ------------- | -------------
2585
2906
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2586
2907
  **campaign_id** | **Float**| Filter results by campaign. | [optional]
2587
- **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]
2588
- **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]
2589
2910
  **date_format** | **String**| Determines the format of dates in the export document. | [optional]
2590
2911
 
2591
2912
  ### Return type
@@ -2860,13 +3181,76 @@ Name | Type | Description | Notes
2860
3181
  - **Accept**: application/csv
2861
3182
 
2862
3183
 
3184
+ ## export_loyalty_cards
3185
+
3186
+ > String export_loyalty_cards(loyalty_program_id, opts)
3187
+
3188
+ Export loyalty cards
3189
+
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.
3191
+
3192
+ ### Example
3193
+
3194
+ ```ruby
3195
+ # load the gem
3196
+ require 'talon_one'
3197
+ # setup authorization
3198
+ TalonOne.configure do |config|
3199
+ # Configure API key authorization: management_key
3200
+ config.api_key['Authorization'] = 'YOUR API KEY'
3201
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3202
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3203
+
3204
+ # Configure API key authorization: manager_auth
3205
+ config.api_key['Authorization'] = 'YOUR API KEY'
3206
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3207
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3208
+ end
3209
+
3210
+ api_instance = TalonOne::ManagementApi.new
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.
3212
+ opts = {
3213
+ batch_id: 'batch_id_example' # String | Filter results by loyalty card batch ID.
3214
+ }
3215
+
3216
+ begin
3217
+ #Export loyalty cards
3218
+ result = api_instance.export_loyalty_cards(loyalty_program_id, opts)
3219
+ p result
3220
+ rescue TalonOne::ApiError => e
3221
+ puts "Exception when calling ManagementApi->export_loyalty_cards: #{e}"
3222
+ end
3223
+ ```
3224
+
3225
+ ### Parameters
3226
+
3227
+
3228
+ Name | Type | Description | Notes
3229
+ ------------- | ------------- | ------------- | -------------
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]
3232
+
3233
+ ### Return type
3234
+
3235
+ **String**
3236
+
3237
+ ### Authorization
3238
+
3239
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
3240
+
3241
+ ### HTTP request headers
3242
+
3243
+ - **Content-Type**: Not defined
3244
+ - **Accept**: application/csv
3245
+
3246
+
2863
3247
  ## export_loyalty_ledger
2864
3248
 
2865
3249
  > String export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts)
2866
3250
 
2867
3251
  Export customer's transaction logs
2868
3252
 
2869
- 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.
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.
2870
3254
 
2871
3255
  ### Example
2872
3256
 
@@ -3585,61 +3969,6 @@ Name | Type | Description | Notes
3585
3969
  - **Accept**: application/json
3586
3970
 
3587
3971
 
3588
- ## get_all_roles
3589
-
3590
- > InlineResponse20044 get_all_roles
3591
-
3592
- List roles
3593
-
3594
- List all roles.
3595
-
3596
- ### Example
3597
-
3598
- ```ruby
3599
- # load the gem
3600
- require 'talon_one'
3601
- # setup authorization
3602
- TalonOne.configure do |config|
3603
- # Configure API key authorization: management_key
3604
- config.api_key['Authorization'] = 'YOUR API KEY'
3605
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3606
- #config.api_key_prefix['Authorization'] = 'Bearer'
3607
-
3608
- # Configure API key authorization: manager_auth
3609
- config.api_key['Authorization'] = 'YOUR API KEY'
3610
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3611
- #config.api_key_prefix['Authorization'] = 'Bearer'
3612
- end
3613
-
3614
- api_instance = TalonOne::ManagementApi.new
3615
-
3616
- begin
3617
- #List roles
3618
- result = api_instance.get_all_roles
3619
- p result
3620
- rescue TalonOne::ApiError => e
3621
- puts "Exception when calling ManagementApi->get_all_roles: #{e}"
3622
- end
3623
- ```
3624
-
3625
- ### Parameters
3626
-
3627
- This endpoint does not need any parameter.
3628
-
3629
- ### Return type
3630
-
3631
- [**InlineResponse20044**](InlineResponse20044.md)
3632
-
3633
- ### Authorization
3634
-
3635
- [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
3636
-
3637
- ### HTTP request headers
3638
-
3639
- - **Content-Type**: Not defined
3640
- - **Accept**: application/json
3641
-
3642
-
3643
3972
  ## get_application
3644
3973
 
3645
3974
  > Application get_application(application_id)
@@ -4881,7 +5210,7 @@ opts = {
4881
5210
  page_size: 1000, # Integer | The number of items in the response.
4882
5211
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4883
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.
4884
- 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.
4885
5214
  }
4886
5215
 
4887
5216
  begin
@@ -4903,7 +5232,7 @@ Name | Type | Description | Notes
4903
5232
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4904
5233
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4905
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]
4906
- **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]
4907
5236
 
4908
5237
  ### Return type
4909
5238
 
@@ -5148,7 +5477,7 @@ opts = {
5148
5477
  page_size: 1000, # Integer | The number of items in the response.
5149
5478
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5150
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.
5151
- 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.
5152
5481
  name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
5153
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
5154
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.
@@ -5176,7 +5505,7 @@ Name | Type | Description | Notes
5176
5505
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5177
5506
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5178
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]
5179
- **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]
5180
5509
  **name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
5181
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]
5182
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]
@@ -5446,10 +5775,16 @@ opts = {
5446
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.
5447
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.
5448
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.
5449
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.
5450
5780
  recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
5451
5781
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
5452
- 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.
5453
5788
  }
5454
5789
 
5455
5790
  begin
@@ -5476,10 +5811,16 @@ Name | Type | Description | Notes
5476
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]
5477
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]
5478
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]
5479
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]
5480
5816
  **recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field | [optional]
5481
5817
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
5482
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]
5483
5824
 
5484
5825
  ### Return type
5485
5826
 
@@ -6280,8 +6621,9 @@ opts = {
6280
6621
  page_size: 1000, # Integer | The number of items in the response.
6281
6622
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
6282
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.
6283
- identifier: 'identifier_example', # String | Optional query parameter to search cards by identifier.
6284
- 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.
6285
6627
  }
6286
6628
 
6287
6629
  begin
@@ -6302,8 +6644,9 @@ Name | Type | Description | Notes
6302
6644
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
6303
6645
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
6304
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]
6305
- **identifier** | **String**| Optional query parameter to search cards by identifier. | [optional]
6306
- **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]
6307
6650
 
6308
6651
  ### Return type
6309
6652
 
@@ -6707,13 +7050,13 @@ Name | Type | Description | Notes
6707
7050
  - **Accept**: application/json
6708
7051
 
6709
7052
 
6710
- ## get_role
7053
+ ## get_role_v2
6711
7054
 
6712
- > Role get_role(role_id)
7055
+ > RoleV2 get_role_v2(role_id)
6713
7056
 
6714
7057
  Get role
6715
7058
 
6716
- Get the details of a specific role. To see all the roles, use [List roles](#operation/getAllRoles).
7059
+ Get the details of a specific role. To see all the roles, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
6717
7060
 
6718
7061
  ### Example
6719
7062
 
@@ -6734,14 +7077,14 @@ TalonOne.configure do |config|
6734
7077
  end
6735
7078
 
6736
7079
  api_instance = TalonOne::ManagementApi.new
6737
- role_id = 56 # Integer | ID of role. **Note**: To find the ID of a role, use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint.
7080
+ role_id = 56 # Integer | The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
6738
7081
 
6739
7082
  begin
6740
7083
  #Get role
6741
- result = api_instance.get_role(role_id)
7084
+ result = api_instance.get_role_v2(role_id)
6742
7085
  p result
6743
7086
  rescue TalonOne::ApiError => e
6744
- puts "Exception when calling ManagementApi->get_role: #{e}"
7087
+ puts "Exception when calling ManagementApi->get_role_v2: #{e}"
6745
7088
  end
6746
7089
  ```
6747
7090
 
@@ -6750,11 +7093,11 @@ end
6750
7093
 
6751
7094
  Name | Type | Description | Notes
6752
7095
  ------------- | ------------- | ------------- | -------------
6753
- **role_id** | **Integer**| ID of role. **Note**: To find the ID of a role, use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint. |
7096
+ **role_id** | **Integer**| The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. |
6754
7097
 
6755
7098
  ### Return type
6756
7099
 
6757
- [**Role**](Role.md)
7100
+ [**RoleV2**](RoleV2.md)
6758
7101
 
6759
7102
  ### Authorization
6760
7103
 
@@ -7326,7 +7669,7 @@ end
7326
7669
 
7327
7670
  api_instance = TalonOne::ManagementApi.new
7328
7671
  opts = {
7329
- 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.
7330
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.
7331
7674
  page_size: 1000, # Integer | The number of items in the response.
7332
7675
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
@@ -7350,7 +7693,7 @@ end
7350
7693
 
7351
7694
  Name | Type | Description | Notes
7352
7695
  ------------- | ------------- | ------------- | -------------
7353
- **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]
7354
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]
7355
7698
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7356
7699
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
@@ -7562,13 +7905,13 @@ Name | Type | Description | Notes
7562
7905
  - **Accept**: application/json
7563
7906
 
7564
7907
 
7565
- ## import_collection
7908
+ ## import_campaign_stores
7566
7909
 
7567
- > Import import_collection(application_id, campaign_id, collection_id, opts)
7910
+ > Import import_campaign_stores(application_id, campaign_id, opts)
7568
7911
 
7569
- Import data into existing campaign-level collection
7912
+ Import stores
7570
7913
 
7571
- Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
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.
7572
7915
 
7573
7916
  ### Example
7574
7917
 
@@ -7591,17 +7934,16 @@ end
7591
7934
  api_instance = TalonOne::ManagementApi.new
7592
7935
  application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
7593
7936
  campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
7594
- collection_id = 56 # Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
7595
7937
  opts = {
7596
7938
  up_file: 'up_file_example' # String | The file containing the data that is being imported.
7597
7939
  }
7598
7940
 
7599
7941
  begin
7600
- #Import data into existing campaign-level collection
7601
- result = api_instance.import_collection(application_id, campaign_id, collection_id, opts)
7942
+ #Import stores
7943
+ result = api_instance.import_campaign_stores(application_id, campaign_id, opts)
7602
7944
  p result
7603
7945
  rescue TalonOne::ApiError => e
7604
- puts "Exception when calling ManagementApi->import_collection: #{e}"
7946
+ puts "Exception when calling ManagementApi->import_campaign_stores: #{e}"
7605
7947
  end
7606
7948
  ```
7607
7949
 
@@ -7612,7 +7954,6 @@ Name | Type | Description | Notes
7612
7954
  ------------- | ------------- | ------------- | -------------
7613
7955
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
7614
7956
  **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
7615
- **collection_id** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
7616
7957
  **up_file** | **String**| The file containing the data that is being imported. | [optional]
7617
7958
 
7618
7959
  ### Return type
@@ -7629,13 +7970,13 @@ Name | Type | Description | Notes
7629
7970
  - **Accept**: application/json
7630
7971
 
7631
7972
 
7632
- ## import_coupons
7973
+ ## import_collection
7633
7974
 
7634
- > Import import_coupons(application_id, campaign_id, opts)
7975
+ > Import import_collection(application_id, campaign_id, collection_id, opts)
7635
7976
 
7636
- Import coupons
7977
+ Import data into existing campaign-level collection
7637
7978
 
7638
- Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the customer who receives the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about [coupon reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. 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:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
7979
+ Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
7639
7980
 
7640
7981
  ### Example
7641
7982
 
@@ -7658,17 +7999,17 @@ end
7658
7999
  api_instance = TalonOne::ManagementApi.new
7659
8000
  application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
7660
8001
  campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
8002
+ collection_id = 56 # Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
7661
8003
  opts = {
7662
- skip_duplicates: true, # Boolean | An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`.
7663
8004
  up_file: 'up_file_example' # String | The file containing the data that is being imported.
7664
8005
  }
7665
8006
 
7666
8007
  begin
7667
- #Import coupons
7668
- result = api_instance.import_coupons(application_id, campaign_id, opts)
8008
+ #Import data into existing campaign-level collection
8009
+ result = api_instance.import_collection(application_id, campaign_id, collection_id, opts)
7669
8010
  p result
7670
8011
  rescue TalonOne::ApiError => e
7671
- puts "Exception when calling ManagementApi->import_coupons: #{e}"
8012
+ puts "Exception when calling ManagementApi->import_collection: #{e}"
7672
8013
  end
7673
8014
  ```
7674
8015
 
@@ -7679,7 +8020,7 @@ Name | Type | Description | Notes
7679
8020
  ------------- | ------------- | ------------- | -------------
7680
8021
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
7681
8022
  **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
7682
- **skip_duplicates** | **Boolean**| An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when &#x60;skipDuplicates&#x3D;true&#x60;. | [optional]
8023
+ **collection_id** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
7683
8024
  **up_file** | **String**| The file containing the data that is being imported. | [optional]
7684
8025
 
7685
8026
  ### Return type
@@ -7696,13 +8037,13 @@ Name | Type | Description | Notes
7696
8037
  - **Accept**: application/json
7697
8038
 
7698
8039
 
7699
- ## import_loyalty_cards
8040
+ ## import_coupons
7700
8041
 
7701
- > Import import_loyalty_cards(loyalty_program_id, opts)
8042
+ > Import import_coupons(application_id, campaign_id, opts)
7702
8043
 
7703
- Import loyalty cards
8044
+ Import coupons
7704
8045
 
7705
- Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
8046
+ Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. 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:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
7706
8047
 
7707
8048
  ### Example
7708
8049
 
@@ -7723,17 +8064,19 @@ TalonOne.configure do |config|
7723
8064
  end
7724
8065
 
7725
8066
  api_instance = TalonOne::ManagementApi.new
7726
- 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.
8067
+ application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
8068
+ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
7727
8069
  opts = {
8070
+ skip_duplicates: true, # Boolean | An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`.
7728
8071
  up_file: 'up_file_example' # String | The file containing the data that is being imported.
7729
8072
  }
7730
8073
 
7731
8074
  begin
7732
- #Import loyalty cards
7733
- result = api_instance.import_loyalty_cards(loyalty_program_id, opts)
8075
+ #Import coupons
8076
+ result = api_instance.import_coupons(application_id, campaign_id, opts)
7734
8077
  p result
7735
8078
  rescue TalonOne::ApiError => e
7736
- puts "Exception when calling ManagementApi->import_loyalty_cards: #{e}"
8079
+ puts "Exception when calling ManagementApi->import_coupons: #{e}"
7737
8080
  end
7738
8081
  ```
7739
8082
 
@@ -7742,7 +8085,9 @@ end
7742
8085
 
7743
8086
  Name | Type | Description | Notes
7744
8087
  ------------- | ------------- | ------------- | -------------
7745
- **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. |
8088
+ **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
8089
+ **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
8090
+ **skip_duplicates** | **Boolean**| An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when &#x60;skipDuplicates&#x3D;true&#x60;. | [optional]
7746
8091
  **up_file** | **String**| The file containing the data that is being imported. | [optional]
7747
8092
 
7748
8093
  ### Return type
@@ -7759,13 +8104,13 @@ Name | Type | Description | Notes
7759
8104
  - **Accept**: application/json
7760
8105
 
7761
8106
 
7762
- ## import_loyalty_customers_tiers
8107
+ ## import_loyalty_cards
7763
8108
 
7764
- > Import import_loyalty_customers_tiers(loyalty_program_id, opts)
8109
+ > Import import_loyalty_cards(loyalty_program_id, opts)
7765
8110
 
7766
- Import customers into loyalty tiers
8111
+ Import loyalty cards
7767
8112
 
7768
- 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 ```
8113
+ Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
7769
8114
 
7770
8115
  ### Example
7771
8116
 
@@ -7786,7 +8131,70 @@ TalonOne.configure do |config|
7786
8131
  end
7787
8132
 
7788
8133
  api_instance = TalonOne::ManagementApi.new
7789
- loyalty_program_id = 56 # Integer | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
8134
+ 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.
8135
+ opts = {
8136
+ up_file: 'up_file_example' # String | The file containing the data that is being imported.
8137
+ }
8138
+
8139
+ begin
8140
+ #Import loyalty cards
8141
+ result = api_instance.import_loyalty_cards(loyalty_program_id, opts)
8142
+ p result
8143
+ rescue TalonOne::ApiError => e
8144
+ puts "Exception when calling ManagementApi->import_loyalty_cards: #{e}"
8145
+ end
8146
+ ```
8147
+
8148
+ ### Parameters
8149
+
8150
+
8151
+ Name | Type | Description | Notes
8152
+ ------------- | ------------- | ------------- | -------------
8153
+ **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. |
8154
+ **up_file** | **String**| The file containing the data that is being imported. | [optional]
8155
+
8156
+ ### Return type
8157
+
8158
+ [**Import**](Import.md)
8159
+
8160
+ ### Authorization
8161
+
8162
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
8163
+
8164
+ ### HTTP request headers
8165
+
8166
+ - **Content-Type**: multipart/form-data
8167
+ - **Accept**: application/json
8168
+
8169
+
8170
+ ## import_loyalty_customers_tiers
8171
+
8172
+ > Import import_loyalty_customers_tiers(loyalty_program_id, opts)
8173
+
8174
+ Import customers into loyalty tiers
8175
+
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 ```
8177
+
8178
+ ### Example
8179
+
8180
+ ```ruby
8181
+ # load the gem
8182
+ require 'talon_one'
8183
+ # setup authorization
8184
+ TalonOne.configure do |config|
8185
+ # Configure API key authorization: management_key
8186
+ config.api_key['Authorization'] = 'YOUR API KEY'
8187
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8188
+ #config.api_key_prefix['Authorization'] = 'Bearer'
8189
+
8190
+ # Configure API key authorization: manager_auth
8191
+ config.api_key['Authorization'] = 'YOUR API KEY'
8192
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8193
+ #config.api_key_prefix['Authorization'] = 'Bearer'
8194
+ end
8195
+
8196
+ api_instance = TalonOne::ManagementApi.new
8197
+ loyalty_program_id = 56 # Integer | Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
7790
8198
  opts = {
7791
8199
  up_file: 'up_file_example' # String | The file containing the data that is being imported.
7792
8200
  }
@@ -8013,6 +8421,64 @@ Name | Type | Description | Notes
8013
8421
  - **Accept**: application/json
8014
8422
 
8015
8423
 
8424
+ ## invite_user_external
8425
+
8426
+ > invite_user_external(body)
8427
+
8428
+ Invite user from identity provider
8429
+
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.
8431
+
8432
+ ### Example
8433
+
8434
+ ```ruby
8435
+ # load the gem
8436
+ require 'talon_one'
8437
+ # setup authorization
8438
+ TalonOne.configure do |config|
8439
+ # Configure API key authorization: management_key
8440
+ config.api_key['Authorization'] = 'YOUR API KEY'
8441
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8442
+ #config.api_key_prefix['Authorization'] = 'Bearer'
8443
+
8444
+ # Configure API key authorization: manager_auth
8445
+ config.api_key['Authorization'] = 'YOUR API KEY'
8446
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8447
+ #config.api_key_prefix['Authorization'] = 'Bearer'
8448
+ end
8449
+
8450
+ api_instance = TalonOne::ManagementApi.new
8451
+ body = TalonOne::NewExternalInvitation.new # NewExternalInvitation | body
8452
+
8453
+ begin
8454
+ #Invite user from identity provider
8455
+ api_instance.invite_user_external(body)
8456
+ rescue TalonOne::ApiError => e
8457
+ puts "Exception when calling ManagementApi->invite_user_external: #{e}"
8458
+ end
8459
+ ```
8460
+
8461
+ ### Parameters
8462
+
8463
+
8464
+ Name | Type | Description | Notes
8465
+ ------------- | ------------- | ------------- | -------------
8466
+ **body** | [**NewExternalInvitation**](NewExternalInvitation.md)| body |
8467
+
8468
+ ### Return type
8469
+
8470
+ nil (empty response body)
8471
+
8472
+ ### Authorization
8473
+
8474
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
8475
+
8476
+ ### HTTP request headers
8477
+
8478
+ - **Content-Type**: application/json
8479
+ - **Accept**: Not defined
8480
+
8481
+
8016
8482
  ## list_account_collections
8017
8483
 
8018
8484
  > InlineResponse20017 list_account_collections(opts)
@@ -8151,6 +8617,61 @@ Name | Type | Description | Notes
8151
8617
  - **Accept**: application/json
8152
8618
 
8153
8619
 
8620
+ ## list_all_roles_v2
8621
+
8622
+ > InlineResponse20044 list_all_roles_v2
8623
+
8624
+ List roles
8625
+
8626
+ List all roles.
8627
+
8628
+ ### Example
8629
+
8630
+ ```ruby
8631
+ # load the gem
8632
+ require 'talon_one'
8633
+ # setup authorization
8634
+ TalonOne.configure do |config|
8635
+ # Configure API key authorization: management_key
8636
+ config.api_key['Authorization'] = 'YOUR API KEY'
8637
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8638
+ #config.api_key_prefix['Authorization'] = 'Bearer'
8639
+
8640
+ # Configure API key authorization: manager_auth
8641
+ config.api_key['Authorization'] = 'YOUR API KEY'
8642
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8643
+ #config.api_key_prefix['Authorization'] = 'Bearer'
8644
+ end
8645
+
8646
+ api_instance = TalonOne::ManagementApi.new
8647
+
8648
+ begin
8649
+ #List roles
8650
+ result = api_instance.list_all_roles_v2
8651
+ p result
8652
+ rescue TalonOne::ApiError => e
8653
+ puts "Exception when calling ManagementApi->list_all_roles_v2: #{e}"
8654
+ end
8655
+ ```
8656
+
8657
+ ### Parameters
8658
+
8659
+ This endpoint does not need any parameter.
8660
+
8661
+ ### Return type
8662
+
8663
+ [**InlineResponse20044**](InlineResponse20044.md)
8664
+
8665
+ ### Authorization
8666
+
8667
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
8668
+
8669
+ ### HTTP request headers
8670
+
8671
+ - **Content-Type**: Not defined
8672
+ - **Accept**: application/json
8673
+
8674
+
8154
8675
  ## list_catalog_items
8155
8676
 
8156
8677
  > InlineResponse20035 list_catalog_items(catalog_id, opts)
@@ -8503,6 +9024,60 @@ nil (empty response body)
8503
9024
  - **Accept**: Not defined
8504
9025
 
8505
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
+
8506
9081
  ## post_added_deducted_points_notification
8507
9082
 
8508
9083
  > BaseNotification post_added_deducted_points_notification(loyalty_program_id, body)
@@ -8807,6 +9382,524 @@ Name | Type | Description | Notes
8807
9382
  - **Accept**: application/json
8808
9383
 
8809
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
+
8810
9903
  ## search_coupons_advanced_application_wide_without_total_count
8811
9904
 
8812
9905
  > InlineResponse2009 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
@@ -8849,7 +9942,7 @@ opts = {
8849
9942
  recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
8850
9943
  batch_id: 'batch_id_example', # String | Filter results by batches of coupons
8851
9944
  exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
8852
- 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.
8853
9946
  }
8854
9947
 
8855
9948
  begin
@@ -8880,7 +9973,7 @@ Name | Type | Description | Notes
8880
9973
  **recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field | [optional]
8881
9974
  **batch_id** | **String**| Filter results by batches of coupons | [optional]
8882
9975
  **exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
8883
- **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]
8884
9977
 
8885
9978
  ### Return type
8886
9979
 
@@ -9429,7 +10522,7 @@ Name | Type | Description | Notes
9429
10522
 
9430
10523
  Update coupon
9431
10524
 
9432
- 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>
9433
10526
 
9434
10527
  ### Example
9435
10528
 
@@ -9705,7 +10798,7 @@ TalonOne.configure do |config|
9705
10798
  end
9706
10799
 
9707
10800
  api_instance = TalonOne::ManagementApi.new
9708
- role_id = 56 # Integer | The ID of role.
10801
+ role_id = 56 # Integer | The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
9709
10802
  body = TalonOne::RoleV2Base.new # RoleV2Base | body
9710
10803
 
9711
10804
  begin
@@ -9722,7 +10815,7 @@ end
9722
10815
 
9723
10816
  Name | Type | Description | Notes
9724
10817
  ------------- | ------------- | ------------- | -------------
9725
- **role_id** | **Integer**| The ID of role. |
10818
+ **role_id** | **Integer**| The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. |
9726
10819
  **body** | **RoleV2Base**| body |
9727
10820
 
9728
10821
  ### Return type