talon_one 5.0.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (327) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +77 -17
  3. data/docs/AchievementProgress.md +2 -0
  4. data/docs/AdditionalCampaignProperties.md +3 -1
  5. data/docs/AnalyticsDataPoint.md +19 -0
  6. data/docs/AnalyticsDataPointWithTrend.md +19 -0
  7. data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +21 -0
  8. data/docs/AnalyticsDataPointWithTrendAndUplift.md +21 -0
  9. data/docs/Application.md +4 -0
  10. data/docs/ApplicationAnalyticsDataPoint.md +6 -6
  11. data/docs/ApplicationCIF.md +33 -0
  12. data/docs/ApplicationCIFExpression.md +27 -0
  13. data/docs/ApplicationCampaignAnalytics.md +13 -19
  14. data/docs/ApplicationCampaignStats.md +1 -3
  15. data/docs/AsyncCouponDeletionJobResponse.md +17 -0
  16. data/docs/BaseLoyaltyProgram.md +8 -4
  17. data/docs/BaseNotification.md +1 -1
  18. data/docs/BaseNotificationEntity.md +1 -1
  19. data/docs/Campaign.md +15 -1
  20. data/docs/CampaignCollectionEditedNotification.md +21 -0
  21. data/docs/CampaignNotificationPolicy.md +3 -1
  22. data/docs/CampaignStateChangedNotification.md +2 -2
  23. data/docs/CampaignStoreBudget.md +25 -0
  24. data/docs/CampaignVersions.md +27 -0
  25. data/docs/CardAddedDeductedPointsNotificationPolicy.md +19 -0
  26. data/docs/CartItem.md +1 -1
  27. data/docs/CodeGeneratorSettings.md +1 -1
  28. data/docs/Coupon.md +1 -1
  29. data/docs/CouponConstraints.md +1 -1
  30. data/docs/CouponCreationJob.md +1 -1
  31. data/docs/CouponDeletionFilters.md +43 -0
  32. data/docs/CouponDeletionJob.md +39 -0
  33. data/docs/CustomerSessionV2.md +2 -2
  34. data/docs/Effect.md +8 -0
  35. data/docs/EffectEntity.md +9 -1
  36. data/docs/Environment.md +3 -1
  37. data/docs/Event.md +1 -1
  38. data/docs/GenerateCampaignDescription.md +19 -0
  39. data/docs/GenerateCampaignTags.md +17 -0
  40. data/docs/GenerateItemFilterDescription.md +17 -0
  41. data/docs/GenerateLoyaltyCard.md +19 -0
  42. data/docs/GenerateRuleTitle.md +19 -0
  43. data/docs/GenerateRuleTitleRule.md +19 -0
  44. data/docs/IncreaseAchievementProgressEffectProps.md +1 -1
  45. data/docs/IntegrationApi.md +67 -6
  46. data/docs/IntegrationCoupon.md +1 -1
  47. data/docs/InventoryCoupon.md +1 -1
  48. data/docs/InventoryReferral.md +1 -1
  49. data/docs/LoyaltyBalanceWithTier.md +31 -0
  50. data/docs/LoyaltyBalancesWithTiers.md +19 -0
  51. data/docs/LoyaltyCard.md +6 -2
  52. data/docs/LoyaltyCardBatch.md +21 -0
  53. data/docs/LoyaltyCardBatchResponse.md +19 -0
  54. data/docs/LoyaltyProgram.md +14 -6
  55. data/docs/ManagementApi.md +1044 -69
  56. data/docs/MessageLogResponse.md +3 -3
  57. data/docs/NewAppWideCouponDeletionJob.md +19 -0
  58. data/docs/NewApplication.md +3 -1
  59. data/docs/NewApplicationCIF.md +27 -0
  60. data/docs/NewApplicationCIFExpression.md +21 -0
  61. data/docs/NewBaseNotification.md +1 -1
  62. data/docs/NewCouponCreationJob.md +1 -1
  63. data/docs/NewCouponDeletionJob.md +17 -0
  64. data/docs/NewCoupons.md +1 -1
  65. data/docs/NewCouponsForMultipleRecipients.md +1 -1
  66. data/docs/NewCustomerSessionV2.md +2 -2
  67. data/docs/NewLoyaltyProgram.md +8 -4
  68. data/docs/NewOutgoingIntegrationWebhook.md +2 -0
  69. data/docs/NewReferral.md +1 -1
  70. data/docs/NewReferralsForMultipleAdvocates.md +1 -1
  71. data/docs/NewRevisionVersion.md +37 -0
  72. data/docs/NewWebhook.md +2 -0
  73. data/docs/OktaEvent.md +19 -0
  74. data/docs/OktaEventPayload.md +17 -0
  75. data/docs/OktaEventPayloadData.md +17 -0
  76. data/docs/OktaEventTarget.md +21 -0
  77. data/docs/ProjectedTier.md +21 -0
  78. data/docs/Referral.md +1 -1
  79. data/docs/ReferralConstraints.md +1 -1
  80. data/docs/RejectCouponEffectProps.md +3 -1
  81. data/docs/RejectReferralEffectProps.md +3 -1
  82. data/docs/Revision.md +35 -0
  83. data/docs/RevisionActivation.md +17 -0
  84. data/docs/RevisionVersion.md +53 -0
  85. data/docs/RollbackIncreasedAchievementProgressEffectProps.md +27 -0
  86. data/docs/RuleFailureReason.md +5 -1
  87. data/docs/SSOConfig.md +3 -1
  88. data/docs/ScimBaseUser.md +23 -0
  89. data/docs/ScimBaseUserName.md +17 -0
  90. data/docs/ScimNewUser.md +23 -0
  91. data/docs/ScimPatchOperation.md +21 -0
  92. data/docs/ScimPatchRequest.md +19 -0
  93. data/docs/ScimResource.md +21 -0
  94. data/docs/ScimResourceTypesListResponse.md +17 -0
  95. data/docs/ScimSchemaResource.md +23 -0
  96. data/docs/ScimSchemasListResponse.md +21 -0
  97. data/docs/ScimServiceProviderConfigResponse.md +27 -0
  98. data/docs/ScimServiceProviderConfigResponseBulk.md +21 -0
  99. data/docs/ScimServiceProviderConfigResponseChangePassword.md +17 -0
  100. data/docs/ScimServiceProviderConfigResponseFilter.md +19 -0
  101. data/docs/ScimServiceProviderConfigResponsePatch.md +17 -0
  102. data/docs/ScimUser.md +25 -0
  103. data/docs/ScimUsersListResponse.md +21 -0
  104. data/docs/Tier.md +3 -1
  105. data/docs/TransferLoyaltyCard.md +3 -1
  106. data/docs/UpdateApplication.md +5 -1
  107. data/docs/UpdateApplicationCIF.md +23 -0
  108. data/docs/UpdateCampaign.md +1 -1
  109. data/docs/UpdateCoupon.md +1 -1
  110. data/docs/UpdateCouponBatch.md +1 -1
  111. data/docs/UpdateLoyaltyCard.md +4 -2
  112. data/docs/UpdateLoyaltyProgram.md +8 -4
  113. data/docs/UpdateReferral.md +1 -1
  114. data/docs/UpdateReferralBatch.md +1 -1
  115. data/docs/User.md +3 -1
  116. data/docs/Webhook.md +2 -0
  117. data/docs/WebhookWithOutgoingIntegrationDetails.md +2 -0
  118. data/lib/talon_one/api/integration_api.rb +83 -7
  119. data/lib/talon_one/api/management_api.rb +1127 -78
  120. data/lib/talon_one/models/achievement_progress.rb +16 -1
  121. data/lib/talon_one/models/additional_campaign_properties.rb +21 -6
  122. data/lib/talon_one/models/analytics_data_point.rb +225 -0
  123. data/lib/talon_one/models/analytics_data_point_with_trend.rb +225 -0
  124. data/lib/talon_one/models/analytics_data_point_with_trend_and_influenced_rate.rb +239 -0
  125. data/lib/talon_one/models/analytics_data_point_with_trend_and_uplift.rb +239 -0
  126. data/lib/talon_one/models/application.rb +21 -1
  127. data/lib/talon_one/models/application_analytics_data_point.rb +14 -4
  128. data/lib/talon_one/models/application_campaign_analytics.rb +39 -41
  129. data/lib/talon_one/models/application_campaign_stats.rb +1 -16
  130. data/lib/talon_one/models/application_cif.rb +308 -0
  131. data/lib/talon_one/models/application_cif_expression.rb +275 -0
  132. data/lib/talon_one/models/async_coupon_deletion_job_response.rb +213 -0
  133. data/lib/talon_one/models/attribute.rb +2 -2
  134. data/lib/talon_one/models/base_loyalty_program.rb +44 -25
  135. data/lib/talon_one/models/base_notification.rb +3 -2
  136. data/lib/talon_one/models/base_notification_entity.rb +1 -0
  137. data/lib/talon_one/models/campaign.rb +83 -6
  138. data/lib/talon_one/models/campaign_collection_edited_notification.rb +235 -0
  139. data/lib/talon_one/models/campaign_notification_policy.rb +16 -4
  140. data/lib/talon_one/models/campaign_state_changed_notification.rb +2 -2
  141. data/lib/talon_one/models/campaign_store_budget.rb +275 -0
  142. data/lib/talon_one/models/campaign_versions.rb +259 -0
  143. data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb +269 -0
  144. data/lib/talon_one/models/cart_item.rb +1 -1
  145. data/lib/talon_one/models/code_generator_settings.rb +1 -1
  146. data/lib/talon_one/models/coupon.rb +1 -1
  147. data/lib/talon_one/models/coupon_constraints.rb +1 -1
  148. data/lib/talon_one/models/coupon_creation_job.rb +1 -1
  149. data/lib/talon_one/models/coupon_deletion_filters.rb +375 -0
  150. data/lib/talon_one/models/coupon_deletion_job.rb +370 -0
  151. data/lib/talon_one/models/customer_session_v2.rb +2 -2
  152. data/lib/talon_one/models/effect.rb +41 -1
  153. data/lib/talon_one/models/effect_entity.rb +44 -4
  154. data/lib/talon_one/models/environment.rb +16 -4
  155. data/lib/talon_one/models/event.rb +0 -5
  156. data/lib/talon_one/models/generate_campaign_description.rb +227 -0
  157. data/lib/talon_one/models/generate_campaign_tags.rb +212 -0
  158. data/lib/talon_one/models/generate_item_filter_description.rb +214 -0
  159. data/lib/talon_one/models/generate_loyalty_card.rb +256 -0
  160. data/lib/talon_one/models/generate_rule_title.rb +226 -0
  161. data/lib/talon_one/models/generate_rule_title_rule.rb +221 -0
  162. data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +1 -1
  163. data/lib/talon_one/models/integration_coupon.rb +1 -1
  164. data/lib/talon_one/models/inventory_coupon.rb +1 -1
  165. data/lib/talon_one/models/inventory_referral.rb +1 -1
  166. data/lib/talon_one/models/loyalty_balance_with_tier.rb +276 -0
  167. data/lib/talon_one/models/loyalty_balances_with_tiers.rb +219 -0
  168. data/lib/talon_one/models/loyalty_card.rb +25 -5
  169. data/lib/talon_one/models/loyalty_card_batch.rb +304 -0
  170. data/lib/talon_one/models/loyalty_card_batch_response.rb +227 -0
  171. data/lib/talon_one/models/loyalty_program.rb +70 -29
  172. data/lib/talon_one/models/message_log_response.rb +3 -22
  173. data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb +227 -0
  174. data/lib/talon_one/models/new_application.rb +14 -4
  175. data/lib/talon_one/models/new_application_cif.rb +262 -0
  176. data/lib/talon_one/models/new_application_cif_expression.rb +229 -0
  177. data/lib/talon_one/models/new_attribute.rb +2 -2
  178. data/lib/talon_one/models/new_base_notification.rb +1 -0
  179. data/lib/talon_one/models/new_coupon_creation_job.rb +1 -1
  180. data/lib/talon_one/models/new_coupon_deletion_job.rb +211 -0
  181. data/lib/talon_one/models/new_coupons.rb +1 -1
  182. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +1 -1
  183. data/lib/talon_one/models/new_customer_session_v2.rb +2 -2
  184. data/lib/talon_one/models/new_loyalty_program.rb +44 -25
  185. data/lib/talon_one/models/new_notification_test.rb +2 -2
  186. data/lib/talon_one/models/new_outgoing_integration_webhook.rb +11 -1
  187. data/lib/talon_one/models/new_referral.rb +1 -1
  188. data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +1 -1
  189. data/lib/talon_one/models/new_revision_version.rb +352 -0
  190. data/lib/talon_one/models/new_webhook.rb +11 -1
  191. data/lib/talon_one/models/okta_event.rb +229 -0
  192. data/lib/talon_one/models/okta_event_payload.rb +212 -0
  193. data/lib/talon_one/models/okta_event_payload_data.rb +214 -0
  194. data/lib/talon_one/models/okta_event_target.rb +243 -0
  195. data/lib/talon_one/models/projected_tier.rb +232 -0
  196. data/lib/talon_one/models/referral.rb +1 -1
  197. data/lib/talon_one/models/referral_constraints.rb +1 -1
  198. data/lib/talon_one/models/reject_coupon_effect_props.rb +14 -4
  199. data/lib/talon_one/models/reject_referral_effect_props.rb +14 -4
  200. data/lib/talon_one/models/revision.rb +319 -0
  201. data/lib/talon_one/models/revision_activation.rb +206 -0
  202. data/lib/talon_one/models/revision_version.rb +466 -0
  203. data/lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb +288 -0
  204. data/lib/talon_one/models/rule_failure_reason.rb +24 -4
  205. data/lib/talon_one/models/scim_base_user.rb +237 -0
  206. data/lib/talon_one/models/scim_base_user_name.rb +208 -0
  207. data/lib/talon_one/models/scim_new_user.rb +237 -0
  208. data/lib/talon_one/models/scim_patch_operation.rb +267 -0
  209. data/lib/talon_one/models/scim_patch_request.rb +226 -0
  210. data/lib/talon_one/models/scim_resource.rb +228 -0
  211. data/lib/talon_one/models/scim_resource_types_list_response.rb +214 -0
  212. data/lib/talon_one/models/scim_schema_resource.rb +239 -0
  213. data/lib/talon_one/models/scim_schemas_list_response.rb +236 -0
  214. data/lib/talon_one/models/scim_service_provider_config_response.rb +256 -0
  215. data/lib/talon_one/models/scim_service_provider_config_response_bulk.rb +228 -0
  216. data/lib/talon_one/models/scim_service_provider_config_response_change_password.rb +208 -0
  217. data/lib/talon_one/models/scim_service_provider_config_response_filter.rb +218 -0
  218. data/lib/talon_one/models/scim_service_provider_config_response_patch.rb +208 -0
  219. data/lib/talon_one/models/scim_user.rb +252 -0
  220. data/lib/talon_one/models/scim_users_list_response.rb +236 -0
  221. data/lib/talon_one/models/sso_config.rb +14 -4
  222. data/lib/talon_one/models/tier.rb +12 -2
  223. data/lib/talon_one/models/transfer_loyalty_card.rb +14 -4
  224. data/lib/talon_one/models/update_application.rb +24 -4
  225. data/lib/talon_one/models/update_application_cif.rb +237 -0
  226. data/lib/talon_one/models/update_campaign.rb +1 -1
  227. data/lib/talon_one/models/update_coupon.rb +1 -1
  228. data/lib/talon_one/models/update_coupon_batch.rb +1 -1
  229. data/lib/talon_one/models/update_loyalty_card.rb +15 -5
  230. data/lib/talon_one/models/update_loyalty_program.rb +44 -25
  231. data/lib/talon_one/models/update_referral.rb +1 -1
  232. data/lib/talon_one/models/update_referral_batch.rb +1 -1
  233. data/lib/talon_one/models/user.rb +14 -4
  234. data/lib/talon_one/models/webhook.rb +11 -1
  235. data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +11 -1
  236. data/lib/talon_one/version.rb +1 -1
  237. data/lib/talon_one.rb +54 -11
  238. data/spec/api/integration_api_spec.rb +18 -3
  239. data/spec/api/management_api_spec.rb +227 -23
  240. data/spec/models/achievement_progress_spec.rb +6 -0
  241. data/spec/models/additional_campaign_properties_spec.rb +7 -1
  242. data/spec/models/analytics_data_point_spec.rb +47 -0
  243. data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +53 -0
  244. data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +53 -0
  245. data/spec/models/analytics_data_point_with_trend_spec.rb +47 -0
  246. data/spec/models/application_campaign_analytics_spec.rb +1 -19
  247. data/spec/models/application_campaign_stats_spec.rb +0 -6
  248. data/spec/models/application_cif_expression_spec.rb +71 -0
  249. data/spec/models/application_cif_spec.rb +89 -0
  250. data/spec/models/application_spec.rb +12 -0
  251. data/spec/models/async_coupon_deletion_job_response_spec.rb +41 -0
  252. data/spec/models/attribute_spec.rb +1 -1
  253. data/spec/models/base_loyalty_program_spec.rb +18 -6
  254. data/spec/models/base_notification_spec.rb +1 -1
  255. data/spec/models/campaign_collection_edited_notification_spec.rb +53 -0
  256. data/spec/models/campaign_notification_policy_spec.rb +6 -0
  257. data/spec/models/campaign_spec.rb +43 -1
  258. data/spec/models/campaign_store_budget_spec.rb +65 -0
  259. data/spec/models/campaign_versions_spec.rb +71 -0
  260. data/spec/models/card_added_deducted_points_notification_policy_spec.rb +51 -0
  261. data/spec/models/coupon_deletion_filters_spec.rb +123 -0
  262. data/spec/models/coupon_deletion_job_spec.rb +107 -0
  263. data/spec/models/effect_entity_spec.rb +24 -0
  264. data/spec/models/effect_spec.rb +24 -0
  265. data/spec/models/environment_spec.rb +6 -0
  266. data/spec/models/generate_campaign_description_spec.rb +47 -0
  267. data/spec/models/generate_campaign_tags_spec.rb +41 -0
  268. data/spec/models/generate_item_filter_description_spec.rb +41 -0
  269. data/spec/models/generate_loyalty_card_spec.rb +51 -0
  270. data/spec/models/generate_rule_title_rule_spec.rb +47 -0
  271. data/spec/models/generate_rule_title_spec.rb +47 -0
  272. data/spec/models/loyalty_balance_with_tier_spec.rb +83 -0
  273. data/spec/models/loyalty_balances_with_tiers_spec.rb +47 -0
  274. data/spec/models/loyalty_card_batch_response_spec.rb +47 -0
  275. data/spec/models/loyalty_card_batch_spec.rb +57 -0
  276. data/spec/models/loyalty_card_spec.rb +12 -0
  277. data/spec/models/loyalty_program_spec.rb +30 -6
  278. data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +47 -0
  279. data/spec/models/new_application_cif_expression_spec.rb +53 -0
  280. data/spec/models/new_application_cif_spec.rb +71 -0
  281. data/spec/models/new_application_spec.rb +6 -0
  282. data/spec/models/new_attribute_spec.rb +1 -1
  283. data/spec/models/new_coupon_deletion_job_spec.rb +41 -0
  284. data/spec/models/new_loyalty_program_spec.rb +18 -6
  285. data/spec/models/new_notification_test_spec.rb +1 -1
  286. data/spec/models/new_outgoing_integration_webhook_spec.rb +6 -0
  287. data/spec/models/new_revision_version_spec.rb +105 -0
  288. data/spec/models/new_webhook_spec.rb +6 -0
  289. data/spec/models/okta_event_payload_data_spec.rb +41 -0
  290. data/spec/models/okta_event_payload_spec.rb +41 -0
  291. data/spec/models/okta_event_spec.rb +47 -0
  292. data/spec/models/okta_event_target_spec.rb +53 -0
  293. data/spec/models/projected_tier_spec.rb +53 -0
  294. data/spec/models/reject_coupon_effect_props_spec.rb +6 -0
  295. data/spec/models/reject_referral_effect_props_spec.rb +6 -0
  296. data/spec/models/revision_activation_spec.rb +41 -0
  297. data/spec/models/revision_spec.rb +95 -0
  298. data/spec/models/revision_version_spec.rb +153 -0
  299. data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +71 -0
  300. data/spec/models/rule_failure_reason_spec.rb +12 -0
  301. data/spec/models/scim_base_user_name_spec.rb +41 -0
  302. data/spec/models/scim_base_user_spec.rb +59 -0
  303. data/spec/models/scim_new_user_spec.rb +59 -0
  304. data/spec/models/scim_patch_operation_spec.rb +57 -0
  305. data/spec/models/scim_patch_request_spec.rb +47 -0
  306. data/spec/models/scim_resource_spec.rb +53 -0
  307. data/spec/models/scim_resource_types_list_response_spec.rb +41 -0
  308. data/spec/models/scim_schema_resource_spec.rb +59 -0
  309. data/spec/models/scim_schemas_list_response_spec.rb +53 -0
  310. data/spec/models/scim_service_provider_config_response_bulk_spec.rb +53 -0
  311. data/spec/models/scim_service_provider_config_response_change_password_spec.rb +41 -0
  312. data/spec/models/scim_service_provider_config_response_filter_spec.rb +47 -0
  313. data/spec/models/scim_service_provider_config_response_patch_spec.rb +41 -0
  314. data/spec/models/scim_service_provider_config_response_spec.rb +71 -0
  315. data/spec/models/scim_user_spec.rb +65 -0
  316. data/spec/models/scim_users_list_response_spec.rb +53 -0
  317. data/spec/models/sso_config_spec.rb +6 -0
  318. data/spec/models/tier_spec.rb +6 -0
  319. data/spec/models/transfer_loyalty_card_spec.rb +6 -0
  320. data/spec/models/update_application_cif_spec.rb +59 -0
  321. data/spec/models/update_application_spec.rb +12 -0
  322. data/spec/models/update_loyalty_card_spec.rb +6 -0
  323. data/spec/models/update_loyalty_program_spec.rb +18 -6
  324. data/spec/models/user_spec.rb +6 -0
  325. data/spec/models/webhook_spec.rb +6 -0
  326. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
  327. metadata +219 -3
@@ -19,8 +19,8 @@ module TalonOne
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Activate user by email address
23
- # Activate a deactivated user by their email address.
22
+ # Enable user by email address
23
+ # Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
24
24
  # @param body [ActivateUserRequest] body
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [nil]
@@ -29,8 +29,8 @@ module TalonOne
29
29
  nil
30
30
  end
31
31
 
32
- # Activate user by email address
33
- # Activate a deactivated user by their email address.
32
+ # Enable user by email address
33
+ # Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
34
34
  # @param body [ActivateUserRequest] body
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -581,6 +581,76 @@ module TalonOne
581
581
  return data, status_code, headers
582
582
  end
583
583
 
584
+ # Create loyalty cards
585
+ # 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.
586
+ # @param 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.
587
+ # @param body [LoyaltyCardBatch] body
588
+ # @param [Hash] opts the optional parameters
589
+ # @return [LoyaltyCardBatchResponse]
590
+ def create_batch_loyalty_cards(loyalty_program_id, body, opts = {})
591
+ data, _status_code, _headers = create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, opts)
592
+ data
593
+ end
594
+
595
+ # Create loyalty cards
596
+ # 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 &#x60;400&#x60; status code.
597
+ # @param 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.
598
+ # @param body [LoyaltyCardBatch] body
599
+ # @param [Hash] opts the optional parameters
600
+ # @return [Array<(LoyaltyCardBatchResponse, Integer, Hash)>] LoyaltyCardBatchResponse data, response status code and response headers
601
+ def create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, opts = {})
602
+ if @api_client.config.debugging
603
+ @api_client.config.logger.debug 'Calling API: ManagementApi.create_batch_loyalty_cards ...'
604
+ end
605
+ # verify the required parameter 'loyalty_program_id' is set
606
+ if @api_client.config.client_side_validation && loyalty_program_id.nil?
607
+ fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.create_batch_loyalty_cards"
608
+ end
609
+ # verify the required parameter 'body' is set
610
+ if @api_client.config.client_side_validation && body.nil?
611
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_batch_loyalty_cards"
612
+ end
613
+ # resource path
614
+ local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/batch'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
615
+
616
+ # query parameters
617
+ query_params = opts[:query_params] || {}
618
+
619
+ # header parameters
620
+ header_params = opts[:header_params] || {}
621
+ # HTTP header 'Accept' (if needed)
622
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
623
+ # HTTP header 'Content-Type'
624
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
625
+
626
+ # form parameters
627
+ form_params = opts[:form_params] || {}
628
+
629
+ # http body (model)
630
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
631
+
632
+ # return_type
633
+ return_type = opts[:return_type] || 'LoyaltyCardBatchResponse'
634
+
635
+ # auth_names
636
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
637
+
638
+ new_options = opts.merge(
639
+ :header_params => header_params,
640
+ :query_params => query_params,
641
+ :form_params => form_params,
642
+ :body => post_body,
643
+ :auth_names => auth_names,
644
+ :return_type => return_type
645
+ )
646
+
647
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
648
+ if @api_client.config.debugging
649
+ @api_client.config.logger.debug "API called: ManagementApi#create_batch_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
650
+ end
651
+ return data, status_code, headers
652
+ end
653
+
584
654
  # Create campaign from campaign template
585
655
  # Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing [campaign collections](https://docs.talon.one/docs/product/campaigns/managing-collections), the corresponding collections for the new campaign are created automatically.
586
656
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -882,6 +952,82 @@ module TalonOne
882
952
  return data, status_code, headers
883
953
  end
884
954
 
955
+ # Creates a coupon deletion job
956
+ # This endpoint handles creating a job to delete coupons asynchronously.
957
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
958
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
959
+ # @param body [NewCouponDeletionJob] body
960
+ # @param [Hash] opts the optional parameters
961
+ # @return [AsyncCouponDeletionJobResponse]
962
+ def create_coupons_deletion_job(application_id, campaign_id, body, opts = {})
963
+ data, _status_code, _headers = create_coupons_deletion_job_with_http_info(application_id, campaign_id, body, opts)
964
+ data
965
+ end
966
+
967
+ # Creates a coupon deletion job
968
+ # This endpoint handles creating a job to delete coupons asynchronously.
969
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
970
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
971
+ # @param body [NewCouponDeletionJob] body
972
+ # @param [Hash] opts the optional parameters
973
+ # @return [Array<(AsyncCouponDeletionJobResponse, Integer, Hash)>] AsyncCouponDeletionJobResponse data, response status code and response headers
974
+ def create_coupons_deletion_job_with_http_info(application_id, campaign_id, body, opts = {})
975
+ if @api_client.config.debugging
976
+ @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_deletion_job ...'
977
+ end
978
+ # verify the required parameter 'application_id' is set
979
+ if @api_client.config.client_side_validation && application_id.nil?
980
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons_deletion_job"
981
+ end
982
+ # verify the required parameter 'campaign_id' is set
983
+ if @api_client.config.client_side_validation && campaign_id.nil?
984
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons_deletion_job"
985
+ end
986
+ # verify the required parameter 'body' is set
987
+ if @api_client.config.client_side_validation && body.nil?
988
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons_deletion_job"
989
+ end
990
+ # resource path
991
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
992
+
993
+ # query parameters
994
+ query_params = opts[:query_params] || {}
995
+
996
+ # header parameters
997
+ header_params = opts[:header_params] || {}
998
+ # HTTP header 'Accept' (if needed)
999
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1000
+ # HTTP header 'Content-Type'
1001
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1002
+
1003
+ # form parameters
1004
+ form_params = opts[:form_params] || {}
1005
+
1006
+ # http body (model)
1007
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
1008
+
1009
+ # return_type
1010
+ return_type = opts[:return_type] || 'AsyncCouponDeletionJobResponse'
1011
+
1012
+ # auth_names
1013
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
1014
+
1015
+ new_options = opts.merge(
1016
+ :header_params => header_params,
1017
+ :query_params => query_params,
1018
+ :form_params => form_params,
1019
+ :body => post_body,
1020
+ :auth_names => auth_names,
1021
+ :return_type => return_type
1022
+ )
1023
+
1024
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1025
+ if @api_client.config.debugging
1026
+ @api_client.config.logger.debug "API called: ManagementApi#create_coupons_deletion_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1027
+ end
1028
+ return data, status_code, headers
1029
+ end
1030
+
885
1031
  # Create coupons for multiple recipients
886
1032
  # Create coupons according to some pattern for up to 1000 recipients.
887
1033
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -1287,8 +1433,8 @@ module TalonOne
1287
1433
  return data, status_code, headers
1288
1434
  end
1289
1435
 
1290
- # Deactivate user by email address
1291
- # Deactivate a specific user by their email address.
1436
+ # Disable user by email address
1437
+ # [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
1292
1438
  # @param body [DeactivateUserRequest] body
1293
1439
  # @param [Hash] opts the optional parameters
1294
1440
  # @return [nil]
@@ -1297,8 +1443,8 @@ module TalonOne
1297
1443
  nil
1298
1444
  end
1299
1445
 
1300
- # Deactivate user by email address
1301
- # Deactivate a specific user by their email address.
1446
+ # Disable user by email address
1447
+ # [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
1302
1448
  # @param body [DeactivateUserRequest] body
1303
1449
  # @param [Hash] opts the optional parameters
1304
1450
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1785,10 +1931,10 @@ module TalonOne
1785
1931
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1786
1932
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1787
1933
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1788
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1789
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1790
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1791
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1934
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1935
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1936
+ # @option opts [DateTime] :expires_after 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.
1937
+ # @option opts [DateTime] :expires_before 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.
1792
1938
  # @option opts [String] :valid - &#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.
1793
1939
  # @option opts [String] :batch_id Filter results by batches of coupons
1794
1940
  # @option opts [String] :usable - &#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.
@@ -1809,10 +1955,10 @@ module TalonOne
1809
1955
  # @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
1810
1956
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1811
1957
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1812
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1813
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1814
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1815
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1958
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1959
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
1960
+ # @option opts [DateTime] :expires_after 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.
1961
+ # @option opts [DateTime] :expires_before 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.
1816
1962
  # @option opts [String] :valid - &#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.
1817
1963
  # @option opts [String] :batch_id Filter results by batches of coupons
1818
1964
  # @option opts [String] :usable - &#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.
@@ -2163,7 +2309,7 @@ module TalonOne
2163
2309
  end
2164
2310
 
2165
2311
  # Delete user by email address
2166
- # Delete a specific user by their email address.
2312
+ # [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
2167
2313
  # @param body [DeleteUserRequest] body
2168
2314
  # @param [Hash] opts the optional parameters
2169
2315
  # @return [nil]
@@ -2173,7 +2319,7 @@ module TalonOne
2173
2319
  end
2174
2320
 
2175
2321
  # Delete user by email address
2176
- # Delete a specific user by their email address.
2322
+ # [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
2177
2323
  # @param body [DeleteUserRequest] body
2178
2324
  # @param [Hash] opts the optional parameters
2179
2325
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -2278,6 +2424,74 @@ module TalonOne
2278
2424
  return data, status_code, headers
2279
2425
  end
2280
2426
 
2427
+ # Disconnect stores
2428
+ # Disconnect the stores linked to a specific campaign.
2429
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2430
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
2431
+ # @param [Hash] opts the optional parameters
2432
+ # @return [nil]
2433
+ def disconnect_campaign_stores(application_id, campaign_id, opts = {})
2434
+ disconnect_campaign_stores_with_http_info(application_id, campaign_id, opts)
2435
+ nil
2436
+ end
2437
+
2438
+ # Disconnect stores
2439
+ # Disconnect the stores linked to a specific campaign.
2440
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2441
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
2442
+ # @param [Hash] opts the optional parameters
2443
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2444
+ def disconnect_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
2445
+ if @api_client.config.debugging
2446
+ @api_client.config.logger.debug 'Calling API: ManagementApi.disconnect_campaign_stores ...'
2447
+ end
2448
+ # verify the required parameter 'application_id' is set
2449
+ if @api_client.config.client_side_validation && application_id.nil?
2450
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.disconnect_campaign_stores"
2451
+ end
2452
+ # verify the required parameter 'campaign_id' is set
2453
+ if @api_client.config.client_side_validation && campaign_id.nil?
2454
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.disconnect_campaign_stores"
2455
+ end
2456
+ # resource path
2457
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
2458
+
2459
+ # query parameters
2460
+ query_params = opts[:query_params] || {}
2461
+
2462
+ # header parameters
2463
+ header_params = opts[:header_params] || {}
2464
+ # HTTP header 'Accept' (if needed)
2465
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2466
+
2467
+ # form parameters
2468
+ form_params = opts[:form_params] || {}
2469
+
2470
+ # http body (model)
2471
+ post_body = opts[:body]
2472
+
2473
+ # return_type
2474
+ return_type = opts[:return_type]
2475
+
2476
+ # auth_names
2477
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
2478
+
2479
+ new_options = opts.merge(
2480
+ :header_params => header_params,
2481
+ :query_params => query_params,
2482
+ :form_params => form_params,
2483
+ :body => post_body,
2484
+ :auth_names => auth_names,
2485
+ :return_type => return_type
2486
+ )
2487
+
2488
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
2489
+ if @api_client.config.debugging
2490
+ @api_client.config.logger.debug "API called: ManagementApi#disconnect_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2491
+ end
2492
+ return data, status_code, headers
2493
+ end
2494
+
2281
2495
  # Export account-level collection's items
2282
2496
  # Download a CSV file containing items from a given account-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/).
2283
2497
  # @param collection_id [Integer] The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
@@ -2476,6 +2690,74 @@ module TalonOne
2476
2690
  return data, status_code, headers
2477
2691
  end
2478
2692
 
2693
+ # Export stores
2694
+ # 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.
2695
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2696
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
2697
+ # @param [Hash] opts the optional parameters
2698
+ # @return [String]
2699
+ def export_campaign_stores(application_id, campaign_id, opts = {})
2700
+ data, _status_code, _headers = export_campaign_stores_with_http_info(application_id, campaign_id, opts)
2701
+ data
2702
+ end
2703
+
2704
+ # Export stores
2705
+ # 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: - &#x60;store_integration_id&#x60;: The identifier of the store.
2706
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2707
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
2708
+ # @param [Hash] opts the optional parameters
2709
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
2710
+ def export_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
2711
+ if @api_client.config.debugging
2712
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_campaign_stores ...'
2713
+ end
2714
+ # verify the required parameter 'application_id' is set
2715
+ if @api_client.config.client_side_validation && application_id.nil?
2716
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_campaign_stores"
2717
+ end
2718
+ # verify the required parameter 'campaign_id' is set
2719
+ if @api_client.config.client_side_validation && campaign_id.nil?
2720
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_campaign_stores"
2721
+ end
2722
+ # resource path
2723
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
2724
+
2725
+ # query parameters
2726
+ query_params = opts[:query_params] || {}
2727
+
2728
+ # header parameters
2729
+ header_params = opts[:header_params] || {}
2730
+ # HTTP header 'Accept' (if needed)
2731
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
2732
+
2733
+ # form parameters
2734
+ form_params = opts[:form_params] || {}
2735
+
2736
+ # http body (model)
2737
+ post_body = opts[:body]
2738
+
2739
+ # return_type
2740
+ return_type = opts[:return_type] || 'String'
2741
+
2742
+ # auth_names
2743
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
2744
+
2745
+ new_options = opts.merge(
2746
+ :header_params => header_params,
2747
+ :query_params => query_params,
2748
+ :form_params => form_params,
2749
+ :body => post_body,
2750
+ :auth_names => auth_names,
2751
+ :return_type => return_type
2752
+ )
2753
+
2754
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2755
+ if @api_client.config.debugging
2756
+ @api_client.config.logger.debug "API called: ManagementApi#export_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2757
+ end
2758
+ return data, status_code, headers
2759
+ end
2760
+
2479
2761
  # Export campaign-level collection's items
2480
2762
  # 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/).
2481
2763
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -2566,7 +2848,7 @@ module TalonOne
2566
2848
  # @option opts [String] :batch_id Filter results by batches of coupons
2567
2849
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
2568
2850
  # @option opts [String] :date_format Determines the format of dates in the export document.
2569
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
2851
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
2570
2852
  # @option opts [Boolean] :values_only Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data. (default to false)
2571
2853
  # @return [String]
2572
2854
  def export_coupons(application_id, opts = {})
@@ -2590,7 +2872,7 @@ module TalonOne
2590
2872
  # @option opts [String] :batch_id Filter results by batches of coupons
2591
2873
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
2592
2874
  # @option opts [String] :date_format Determines the format of dates in the export document.
2593
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
2875
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
2594
2876
  # @option opts [Boolean] :values_only Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data.
2595
2877
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
2596
2878
  def export_coupons_with_http_info(application_id, opts = {})
@@ -2613,7 +2895,7 @@ module TalonOne
2613
2895
  if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
2614
2896
  fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
2615
2897
  end
2616
- allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"]
2898
+ allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
2617
2899
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
2618
2900
  fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
2619
2901
  end
@@ -2756,7 +3038,7 @@ module TalonOne
2756
3038
  end
2757
3039
 
2758
3040
  # Export customers' tier data
2759
- # 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.
3041
+ # 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.
2760
3042
  # @param loyalty_program_id [String] The identifier for the loyalty program.
2761
3043
  # @param [Hash] opts the optional parameters
2762
3044
  # @option opts [Array<String>] :subledger_ids An array of subledgers IDs to filter the export by.
@@ -2768,7 +3050,7 @@ module TalonOne
2768
3050
  end
2769
3051
 
2770
3052
  # Export customers&#39; tier data
2771
- # Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - &#x60;programid&#x60;: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - &#x60;subledgerid&#x60;: 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. - &#x60;customerprofileid&#x60;: The ID used to integrate customer profiles with the loyalty program. - &#x60;tiername&#x60;: The name of the tier. - &#x60;startdate&#x60;: The tier start date in RFC3339. - &#x60;expirydate&#x60;: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - &#x60;subledgerId&#x60; (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - &#x60;tierName&#x60; (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported.
3053
+ # Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - &#x60;programid&#x60;: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - &#x60;subledgerid&#x60;: 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. - &#x60;customerprofileid&#x60;: The ID used to integrate customer profiles with the loyalty program. - &#x60;tiername&#x60;: The name of the tier. - &#x60;startdate&#x60;: The tier start date in RFC3339. - &#x60;expirydate&#x60;: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - &#x60;subledgerIds&#x60; (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. - &#x60;tierNames&#x60; (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.
2772
3054
  # @param loyalty_program_id [String] The identifier for the loyalty program.
2773
3055
  # @param [Hash] opts the optional parameters
2774
3056
  # @option opts [Array<String>] :subledger_ids An array of subledgers IDs to filter the export by.
@@ -2828,8 +3110,8 @@ module TalonOne
2828
3110
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2829
3111
  # @param [Hash] opts the optional parameters
2830
3112
  # @option opts [Float] :campaign_id Filter results by campaign.
2831
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
2832
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
3113
+ # @option opts [DateTime] :created_before 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.
3114
+ # @option opts [DateTime] :created_after 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.
2833
3115
  # @option opts [String] :date_format Determines the format of dates in the export document.
2834
3116
  # @return [String]
2835
3117
  def export_effects(application_id, opts = {})
@@ -2842,8 +3124,8 @@ module TalonOne
2842
3124
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2843
3125
  # @param [Hash] opts the optional parameters
2844
3126
  # @option opts [Float] :campaign_id Filter results by campaign.
2845
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
2846
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
3127
+ # @option opts [DateTime] :created_before 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.
3128
+ # @option opts [DateTime] :created_after 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.
2847
3129
  # @option opts [String] :date_format Determines the format of dates in the export document.
2848
3130
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
2849
3131
  def export_effects_with_http_info(application_id, opts = {})
@@ -3189,47 +3471,112 @@ module TalonOne
3189
3471
  return data, status_code, headers
3190
3472
  end
3191
3473
 
3192
- # Export customer's transaction logs
3193
- # 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.
3194
- # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3195
- # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3196
- # @param loyalty_program_id [String] The identifier for the loyalty program.
3197
- # @param integration_id [String] The identifier of the profile.
3474
+ # Export loyalty cards
3475
+ # 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.
3476
+ # @param 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.
3198
3477
  # @param [Hash] opts the optional parameters
3199
- # @option opts [String] :date_format Determines the format of dates in the export document.
3478
+ # @option opts [String] :batch_id Filter results by loyalty card batch ID.
3200
3479
  # @return [String]
3201
- def export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts = {})
3202
- data, _status_code, _headers = export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts)
3480
+ def export_loyalty_cards(loyalty_program_id, opts = {})
3481
+ data, _status_code, _headers = export_loyalty_cards_with_http_info(loyalty_program_id, opts)
3203
3482
  data
3204
3483
  end
3205
3484
 
3206
- # Export customer&#39;s transaction logs
3207
- # Download a CSV file containing a customer&#39;s transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - &#x60;customerprofileid&#x60;: The ID of the profile. - &#x60;customersessionid&#x60;: The ID of the customer session. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;rulename&#x60;: The name of the rule. - &#x60;programid&#x60;: The ID of the loyalty program. - &#x60;type&#x60;: The type of the loyalty program. - &#x60;name&#x60;: The name of the loyalty program. - &#x60;subledgerid&#x60;: The ID of the subledger, when applicable. - &#x60;startdate&#x60;: The start date of the program. - &#x60;expirydate&#x60;: The expiration date of the program. - &#x60;id&#x60;: The ID of the transaction. - &#x60;created&#x60;: The timestamp of the creation of the loyalty program. - &#x60;amount&#x60;: The number of points in that transaction. - &#x60;archived&#x60;: Whether the session related to the transaction is archived. - &#x60;campaignid&#x60;: The ID of the campaign.
3208
- # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3209
- # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3210
- # @param loyalty_program_id [String] The identifier for the loyalty program.
3211
- # @param integration_id [String] The identifier of the profile.
3485
+ # Export loyalty cards
3486
+ # 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: - &#x60;identifier&#x60;: The unique identifier of the loyalty card. - &#x60;created&#x60;: The date and time the loyalty card was created. - &#x60;status&#x60;: The status of the loyalty card. - &#x60;userpercardlimit&#x60;: The maximum number of customer profiles that can be linked to the card. - &#x60;customerprofileids&#x60;: Integration IDs of the customer profiles linked to the card. - &#x60;blockreason&#x60;: The reason for transferring and blocking the loyalty card. - &#x60;generated&#x60;: An indicator of whether the loyalty card was generated. - &#x60;batchid&#x60;: The ID of the batch the loyalty card is in.
3487
+ # @param 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.
3212
3488
  # @param [Hash] opts the optional parameters
3213
- # @option opts [String] :date_format Determines the format of dates in the export document.
3489
+ # @option opts [String] :batch_id Filter results by loyalty card batch ID.
3214
3490
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
3215
- def export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts = {})
3491
+ def export_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
3216
3492
  if @api_client.config.debugging
3217
- @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_ledger ...'
3218
- end
3219
- # verify the required parameter 'range_start' is set
3220
- if @api_client.config.client_side_validation && range_start.nil?
3221
- fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.export_loyalty_ledger"
3222
- end
3223
- # verify the required parameter 'range_end' is set
3224
- if @api_client.config.client_side_validation && range_end.nil?
3225
- fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.export_loyalty_ledger"
3493
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_cards ...'
3226
3494
  end
3227
3495
  # verify the required parameter 'loyalty_program_id' is set
3228
3496
  if @api_client.config.client_side_validation && loyalty_program_id.nil?
3229
- fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_ledger"
3497
+ fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_cards"
3230
3498
  end
3231
- # verify the required parameter 'integration_id' is set
3232
- if @api_client.config.client_side_validation && integration_id.nil?
3499
+ # resource path
3500
+ local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/export'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
3501
+
3502
+ # query parameters
3503
+ query_params = opts[:query_params] || {}
3504
+ query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
3505
+
3506
+ # header parameters
3507
+ header_params = opts[:header_params] || {}
3508
+ # HTTP header 'Accept' (if needed)
3509
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
3510
+
3511
+ # form parameters
3512
+ form_params = opts[:form_params] || {}
3513
+
3514
+ # http body (model)
3515
+ post_body = opts[:body]
3516
+
3517
+ # return_type
3518
+ return_type = opts[:return_type] || 'String'
3519
+
3520
+ # auth_names
3521
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
3522
+
3523
+ new_options = opts.merge(
3524
+ :header_params => header_params,
3525
+ :query_params => query_params,
3526
+ :form_params => form_params,
3527
+ :body => post_body,
3528
+ :auth_names => auth_names,
3529
+ :return_type => return_type
3530
+ )
3531
+
3532
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3533
+ if @api_client.config.debugging
3534
+ @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3535
+ end
3536
+ return data, status_code, headers
3537
+ end
3538
+
3539
+ # Export customer's transaction logs
3540
+ # 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.
3541
+ # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3542
+ # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3543
+ # @param loyalty_program_id [String] The identifier for the loyalty program.
3544
+ # @param integration_id [String] The identifier of the profile.
3545
+ # @param [Hash] opts the optional parameters
3546
+ # @option opts [String] :date_format Determines the format of dates in the export document.
3547
+ # @return [String]
3548
+ def export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts = {})
3549
+ data, _status_code, _headers = export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts)
3550
+ data
3551
+ end
3552
+
3553
+ # Export customer&#39;s transaction logs
3554
+ # Download a CSV file containing a customer&#39;s transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - &#x60;customerprofileid&#x60;: The ID of the profile. - &#x60;customersessionid&#x60;: The ID of the customer session. - &#x60;rulesetid&#x60;: The ID of the rule set. - &#x60;rulename&#x60;: The name of the rule. - &#x60;programid&#x60;: The ID of the loyalty program. - &#x60;type&#x60;: The transaction type, such as &#x60;addition&#x60; or &#x60;subtraction&#x60;. - &#x60;name&#x60;: The reason for the transaction. - &#x60;subledgerid&#x60;: The ID of the subledger, when applicable. - &#x60;startdate&#x60;: The start date of the program. - &#x60;expirydate&#x60;: The expiration date of the program. - &#x60;id&#x60;: The ID of the transaction. - &#x60;created&#x60;: The timestamp of the creation of the loyalty program. - &#x60;amount&#x60;: The number of points in that transaction. - &#x60;archived&#x60;: Whether the session related to the transaction is archived. - &#x60;campaignid&#x60;: The ID of the campaign.
3555
+ # @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3556
+ # @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.
3557
+ # @param loyalty_program_id [String] The identifier for the loyalty program.
3558
+ # @param integration_id [String] The identifier of the profile.
3559
+ # @param [Hash] opts the optional parameters
3560
+ # @option opts [String] :date_format Determines the format of dates in the export document.
3561
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
3562
+ def export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts = {})
3563
+ if @api_client.config.debugging
3564
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_ledger ...'
3565
+ end
3566
+ # verify the required parameter 'range_start' is set
3567
+ if @api_client.config.client_side_validation && range_start.nil?
3568
+ fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.export_loyalty_ledger"
3569
+ end
3570
+ # verify the required parameter 'range_end' is set
3571
+ if @api_client.config.client_side_validation && range_end.nil?
3572
+ fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.export_loyalty_ledger"
3573
+ end
3574
+ # verify the required parameter 'loyalty_program_id' is set
3575
+ if @api_client.config.client_side_validation && loyalty_program_id.nil?
3576
+ fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_ledger"
3577
+ end
3578
+ # verify the required parameter 'integration_id' is set
3579
+ if @api_client.config.client_side_validation && integration_id.nil?
3233
3580
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.export_loyalty_ledger"
3234
3581
  end
3235
3582
  allowable_values = ["excel", "ISO8601"]
@@ -5465,7 +5812,7 @@ module TalonOne
5465
5812
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5466
5813
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5467
5814
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5468
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
5815
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
5469
5816
  # @return [InlineResponse2006]
5470
5817
  def get_campaign_by_attributes(application_id, body, opts = {})
5471
5818
  data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts)
@@ -5480,7 +5827,7 @@ module TalonOne
5480
5827
  # @option opts [Integer] :page_size The number of items in the response.
5481
5828
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5482
5829
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5483
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
5830
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
5484
5831
  # @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
5485
5832
  def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
5486
5833
  if @api_client.config.debugging
@@ -5502,7 +5849,7 @@ module TalonOne
5502
5849
  fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_by_attributes, must be greater than or equal to 1.'
5503
5850
  end
5504
5851
 
5505
- allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"]
5852
+ allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
5506
5853
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
5507
5854
  fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
5508
5855
  end
@@ -5725,7 +6072,7 @@ module TalonOne
5725
6072
  fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_templates, must be greater than or equal to 1.'
5726
6073
  end
5727
6074
 
5728
- allowable_values = ["enabled", "disabled", "draft"]
6075
+ allowable_values = ["draft", "enabled", "disabled"]
5729
6076
  if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
5730
6077
  fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
5731
6078
  end
@@ -5782,7 +6129,7 @@ module TalonOne
5782
6129
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5783
6130
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5784
6131
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5785
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
6132
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
5786
6133
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
5787
6134
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values
5788
6135
  # @option opts [DateTime] :created_before 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.
@@ -5803,7 +6150,7 @@ module TalonOne
5803
6150
  # @option opts [Integer] :page_size The number of items in the response.
5804
6151
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5805
6152
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
5806
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
6153
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
5807
6154
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
5808
6155
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \&quot;name\&quot; query parameter, a logical OR will be performed to search both tags and name for the provided values
5809
6156
  # @option opts [DateTime] :created_before 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.
@@ -5828,7 +6175,7 @@ module TalonOne
5828
6175
  fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaigns, must be greater than or equal to 1.'
5829
6176
  end
5830
6177
 
5831
- allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"]
6178
+ allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
5832
6179
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
5833
6180
  fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
5834
6181
  end
@@ -6142,10 +6489,16 @@ module TalonOne
6142
6489
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6143
6490
  # @option opts [String] :valid 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.
6144
6491
  # @option opts [String] :usable 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;.
6492
+ # @option opts [String] :redeemed - &#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.
6145
6493
  # @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
6146
6494
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
6147
6495
  # @option opts [String] :batch_id Filter results by batches of coupons
6148
6496
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
6497
+ # @option opts [DateTime] :expires_before 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.
6498
+ # @option opts [DateTime] :expires_after 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.
6499
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6500
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6501
+ # @option opts [Boolean] :values_only Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data. (default to false)
6149
6502
  # @return [InlineResponse2009]
6150
6503
  def get_coupons_without_total_count(application_id, campaign_id, opts = {})
6151
6504
  data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts)
@@ -6165,10 +6518,16 @@ module TalonOne
6165
6518
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6166
6519
  # @option opts [String] :valid 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.
6167
6520
  # @option opts [String] :usable 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;.
6521
+ # @option opts [String] :redeemed - &#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.
6168
6522
  # @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
6169
6523
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
6170
6524
  # @option opts [String] :batch_id Filter results by batches of coupons
6171
6525
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
6526
+ # @option opts [DateTime] :expires_before 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.
6527
+ # @option opts [DateTime] :expires_after 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.
6528
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6529
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
6530
+ # @option opts [Boolean] :values_only Filter results to only return the coupon codes (&#x60;value&#x60; column) without the associated coupon data.
6172
6531
  # @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
6173
6532
  def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {})
6174
6533
  if @api_client.config.debugging
@@ -6198,6 +6557,10 @@ module TalonOne
6198
6557
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
6199
6558
  fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
6200
6559
  end
6560
+ allowable_values = ["true", "false"]
6561
+ if @api_client.config.client_side_validation && opts[:'redeemed'] && !allowable_values.include?(opts[:'redeemed'])
6562
+ fail ArgumentError, "invalid value for \"redeemed\", must be one of #{allowable_values}"
6563
+ end
6201
6564
  # resource path
6202
6565
  local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
6203
6566
 
@@ -6211,10 +6574,16 @@ module TalonOne
6211
6574
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
6212
6575
  query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
6213
6576
  query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
6577
+ query_params[:'redeemed'] = opts[:'redeemed'] if !opts[:'redeemed'].nil?
6214
6578
  query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
6215
6579
  query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
6216
6580
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
6217
6581
  query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
6582
+ query_params[:'expiresBefore'] = opts[:'expires_before'] if !opts[:'expires_before'].nil?
6583
+ query_params[:'expiresAfter'] = opts[:'expires_after'] if !opts[:'expires_after'].nil?
6584
+ query_params[:'startsBefore'] = opts[:'starts_before'] if !opts[:'starts_before'].nil?
6585
+ query_params[:'startsAfter'] = opts[:'starts_after'] if !opts[:'starts_after'].nil?
6586
+ query_params[:'valuesOnly'] = opts[:'values_only'] if !opts[:'values_only'].nil?
6218
6587
 
6219
6588
  # header parameters
6220
6589
  header_params = opts[:header_params] || {}
@@ -7175,8 +7544,9 @@ module TalonOne
7175
7544
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7176
7545
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7177
7546
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
7178
- # @option opts [String] :identifier Optional query parameter to search cards by identifier.
7179
- # @option opts [Integer] :profile_id Filter by the profile ID.
7547
+ # @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
7548
+ # @option opts [Integer] :profile_id Filter results by customer profile ID.
7549
+ # @option opts [String] :batch_id Filter results by loyalty card batch ID.
7180
7550
  # @return [InlineResponse20015]
7181
7551
  def get_loyalty_cards(loyalty_program_id, opts = {})
7182
7552
  data, _status_code, _headers = get_loyalty_cards_with_http_info(loyalty_program_id, opts)
@@ -7190,8 +7560,9 @@ module TalonOne
7190
7560
  # @option opts [Integer] :page_size The number of items in the response.
7191
7561
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7192
7562
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
7193
- # @option opts [String] :identifier Optional query parameter to search cards by identifier.
7194
- # @option opts [Integer] :profile_id Filter by the profile ID.
7563
+ # @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
7564
+ # @option opts [Integer] :profile_id Filter results by customer profile ID.
7565
+ # @option opts [String] :batch_id Filter results by loyalty card batch ID.
7195
7566
  # @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
7196
7567
  def get_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
7197
7568
  if @api_client.config.debugging
@@ -7227,6 +7598,7 @@ module TalonOne
7227
7598
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
7228
7599
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
7229
7600
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
7601
+ query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
7230
7602
 
7231
7603
  # header parameters
7232
7604
  header_params = opts[:header_params] || {}
@@ -8390,7 +8762,7 @@ module TalonOne
8390
8762
  # List webhooks
8391
8763
  # List all webhooks.
8392
8764
  # @param [Hash] opts the optional parameters
8393
- # @option opts [String] :application_ids Filter by one or more Application IDs, separated by a comma.
8765
+ # @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
8394
8766
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8395
8767
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8396
8768
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
@@ -8407,7 +8779,7 @@ module TalonOne
8407
8779
  # List webhooks
8408
8780
  # List all webhooks.
8409
8781
  # @param [Hash] opts the optional parameters
8410
- # @option opts [String] :application_ids Filter by one or more Application IDs, separated by a comma.
8782
+ # @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
8411
8783
  # @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with &#x60;-&#x60;. **Note:** This parameter works only with numeric fields.
8412
8784
  # @option opts [Integer] :page_size The number of items in the response.
8413
8785
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
@@ -8684,6 +9056,79 @@ module TalonOne
8684
9056
  return data, status_code, headers
8685
9057
  end
8686
9058
 
9059
+ # Import stores
9060
+ # 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.
9061
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
9062
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
9063
+ # @param [Hash] opts the optional parameters
9064
+ # @option opts [String] :up_file The file containing the data that is being imported.
9065
+ # @return [Import]
9066
+ def import_campaign_stores(application_id, campaign_id, opts = {})
9067
+ data, _status_code, _headers = import_campaign_stores_with_http_info(application_id, campaign_id, opts)
9068
+ data
9069
+ end
9070
+
9071
+ # Import stores
9072
+ # 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: - &#x60;store_integration_id&#x60;: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
9073
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
9074
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
9075
+ # @param [Hash] opts the optional parameters
9076
+ # @option opts [String] :up_file The file containing the data that is being imported.
9077
+ # @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
9078
+ def import_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
9079
+ if @api_client.config.debugging
9080
+ @api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_stores ...'
9081
+ end
9082
+ # verify the required parameter 'application_id' is set
9083
+ if @api_client.config.client_side_validation && application_id.nil?
9084
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_stores"
9085
+ end
9086
+ # verify the required parameter 'campaign_id' is set
9087
+ if @api_client.config.client_side_validation && campaign_id.nil?
9088
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_stores"
9089
+ end
9090
+ # resource path
9091
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/import'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
9092
+
9093
+ # query parameters
9094
+ query_params = opts[:query_params] || {}
9095
+
9096
+ # header parameters
9097
+ header_params = opts[:header_params] || {}
9098
+ # HTTP header 'Accept' (if needed)
9099
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9100
+ # HTTP header 'Content-Type'
9101
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
9102
+
9103
+ # form parameters
9104
+ form_params = opts[:form_params] || {}
9105
+ form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
9106
+
9107
+ # http body (model)
9108
+ post_body = opts[:body]
9109
+
9110
+ # return_type
9111
+ return_type = opts[:return_type] || 'Import'
9112
+
9113
+ # auth_names
9114
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
9115
+
9116
+ new_options = opts.merge(
9117
+ :header_params => header_params,
9118
+ :query_params => query_params,
9119
+ :form_params => form_params,
9120
+ :body => post_body,
9121
+ :auth_names => auth_names,
9122
+ :return_type => return_type
9123
+ )
9124
+
9125
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9126
+ if @api_client.config.debugging
9127
+ @api_client.config.logger.debug "API called: ManagementApi#import_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9128
+ end
9129
+ return data, status_code, headers
9130
+ end
9131
+
8687
9132
  # Import data into existing campaign-level collection
8688
9133
  # 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.
8689
9134
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -8907,7 +9352,7 @@ module TalonOne
8907
9352
  end
8908
9353
 
8909
9354
  # Import customers into loyalty tiers
8910
- # 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 ```
9355
+ # 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 ```
8911
9356
  # @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
8912
9357
  # @param [Hash] opts the optional parameters
8913
9358
  # @option opts [String] :up_file The file containing the data that is being imported.
@@ -8918,7 +9363,7 @@ module TalonOne
8918
9363
  end
8919
9364
 
8920
9365
  # Import customers into loyalty tiers
8921
- # 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: - &#x60;subledgerid&#x60; (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - &#x60;customerprofileid&#x60;: The integration ID of the customer profile to whom the tier should be assigned. - &#x60;tiername&#x60;: The name of an existing tier to assign to the customer. - &#x60;expirydate&#x60;: The expiration date of the tier. It should be a future date. About customer assignment to a tier: - If the customer isn&#39;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&#39;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&#39;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:** &#x60;&#x60;&#x60;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 &#x60;&#x60;&#x60;
9366
+ # 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: - &#x60;subledgerid&#x60; (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - &#x60;customerprofileid&#x60;: The integration ID of the customer profile to whom the tier should be assigned. - &#x60;tiername&#x60;: The name of an existing tier to assign to the customer. - &#x60;expirydate&#x60;: 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&#39;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&#39;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&#39;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:** &#x60;&#x60;&#x60;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 &#x60;&#x60;&#x60;
8922
9367
  # @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
8923
9368
  # @param [Hash] opts the optional parameters
8924
9369
  # @option opts [String] :up_file The file containing the data that is being imported.
@@ -9181,7 +9626,7 @@ module TalonOne
9181
9626
  end
9182
9627
 
9183
9628
  # Invite user from identity provider
9184
- # Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
9629
+ # [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.
9185
9630
  # @param body [NewExternalInvitation] body
9186
9631
  # @param [Hash] opts the optional parameters
9187
9632
  # @return [nil]
@@ -9191,7 +9636,7 @@ module TalonOne
9191
9636
  end
9192
9637
 
9193
9638
  # Invite user from identity provider
9194
- # Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
9639
+ # [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.
9195
9640
  # @param body [NewExternalInvitation] body
9196
9641
  # @param [Hash] opts the optional parameters
9197
9642
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -9885,6 +10330,60 @@ module TalonOne
9885
10330
  return data, status_code, headers
9886
10331
  end
9887
10332
 
10333
+ # Validate Okta API ownership
10334
+ # 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.
10335
+ # @param [Hash] opts the optional parameters
10336
+ # @return [nil]
10337
+ def okta_event_handler_challenge(opts = {})
10338
+ okta_event_handler_challenge_with_http_info(opts)
10339
+ nil
10340
+ end
10341
+
10342
+ # Validate Okta API ownership
10343
+ # 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.
10344
+ # @param [Hash] opts the optional parameters
10345
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
10346
+ def okta_event_handler_challenge_with_http_info(opts = {})
10347
+ if @api_client.config.debugging
10348
+ @api_client.config.logger.debug 'Calling API: ManagementApi.okta_event_handler_challenge ...'
10349
+ end
10350
+ # resource path
10351
+ local_var_path = '/v1/provisioning/okta'
10352
+
10353
+ # query parameters
10354
+ query_params = opts[:query_params] || {}
10355
+
10356
+ # header parameters
10357
+ header_params = opts[:header_params] || {}
10358
+
10359
+ # form parameters
10360
+ form_params = opts[:form_params] || {}
10361
+
10362
+ # http body (model)
10363
+ post_body = opts[:body]
10364
+
10365
+ # return_type
10366
+ return_type = opts[:return_type]
10367
+
10368
+ # auth_names
10369
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10370
+
10371
+ new_options = opts.merge(
10372
+ :header_params => header_params,
10373
+ :query_params => query_params,
10374
+ :form_params => form_params,
10375
+ :body => post_body,
10376
+ :auth_names => auth_names,
10377
+ :return_type => return_type
10378
+ )
10379
+
10380
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10381
+ if @api_client.config.debugging
10382
+ @api_client.config.logger.debug "API called: ManagementApi#okta_event_handler_challenge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10383
+ end
10384
+ return data, status_code, headers
10385
+ end
10386
+
9888
10387
  # Create notification about added or deducted loyalty points
9889
10388
  # Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
9890
10389
  # @param loyalty_program_id [Integer] Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
@@ -10235,6 +10734,556 @@ module TalonOne
10235
10734
  return data, status_code, headers
10236
10735
  end
10237
10736
 
10737
+ # Create SCIM user
10738
+ # Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
10739
+ # @param body [ScimNewUser] body
10740
+ # @param [Hash] opts the optional parameters
10741
+ # @return [ScimUser]
10742
+ def scim_create_user(body, opts = {})
10743
+ data, _status_code, _headers = scim_create_user_with_http_info(body, opts)
10744
+ data
10745
+ end
10746
+
10747
+ # Create SCIM user
10748
+ # Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
10749
+ # @param body [ScimNewUser] body
10750
+ # @param [Hash] opts the optional parameters
10751
+ # @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
10752
+ def scim_create_user_with_http_info(body, opts = {})
10753
+ if @api_client.config.debugging
10754
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_user ...'
10755
+ end
10756
+ # verify the required parameter 'body' is set
10757
+ if @api_client.config.client_side_validation && body.nil?
10758
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_user"
10759
+ end
10760
+ # resource path
10761
+ local_var_path = '/v1/provisioning/scim/Users'
10762
+
10763
+ # query parameters
10764
+ query_params = opts[:query_params] || {}
10765
+
10766
+ # header parameters
10767
+ header_params = opts[:header_params] || {}
10768
+ # HTTP header 'Accept' (if needed)
10769
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10770
+ # HTTP header 'Content-Type'
10771
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10772
+
10773
+ # form parameters
10774
+ form_params = opts[:form_params] || {}
10775
+
10776
+ # http body (model)
10777
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
10778
+
10779
+ # return_type
10780
+ return_type = opts[:return_type] || 'ScimUser'
10781
+
10782
+ # auth_names
10783
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10784
+
10785
+ new_options = opts.merge(
10786
+ :header_params => header_params,
10787
+ :query_params => query_params,
10788
+ :form_params => form_params,
10789
+ :body => post_body,
10790
+ :auth_names => auth_names,
10791
+ :return_type => return_type
10792
+ )
10793
+
10794
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10795
+ if @api_client.config.debugging
10796
+ @api_client.config.logger.debug "API called: ManagementApi#scim_create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10797
+ end
10798
+ return data, status_code, headers
10799
+ end
10800
+
10801
+ # Delete SCIM user
10802
+ # Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
10803
+ # @param user_id [Integer] The ID of the user.
10804
+ # @param [Hash] opts the optional parameters
10805
+ # @return [nil]
10806
+ def scim_delete_user(user_id, opts = {})
10807
+ scim_delete_user_with_http_info(user_id, opts)
10808
+ nil
10809
+ end
10810
+
10811
+ # Delete SCIM user
10812
+ # Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
10813
+ # @param user_id [Integer] The ID of the user.
10814
+ # @param [Hash] opts the optional parameters
10815
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
10816
+ def scim_delete_user_with_http_info(user_id, opts = {})
10817
+ if @api_client.config.debugging
10818
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_user ...'
10819
+ end
10820
+ # verify the required parameter 'user_id' is set
10821
+ if @api_client.config.client_side_validation && user_id.nil?
10822
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_delete_user"
10823
+ end
10824
+ # resource path
10825
+ local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
10826
+
10827
+ # query parameters
10828
+ query_params = opts[:query_params] || {}
10829
+
10830
+ # header parameters
10831
+ header_params = opts[:header_params] || {}
10832
+
10833
+ # form parameters
10834
+ form_params = opts[:form_params] || {}
10835
+
10836
+ # http body (model)
10837
+ post_body = opts[:body]
10838
+
10839
+ # return_type
10840
+ return_type = opts[:return_type]
10841
+
10842
+ # auth_names
10843
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10844
+
10845
+ new_options = opts.merge(
10846
+ :header_params => header_params,
10847
+ :query_params => query_params,
10848
+ :form_params => form_params,
10849
+ :body => post_body,
10850
+ :auth_names => auth_names,
10851
+ :return_type => return_type
10852
+ )
10853
+
10854
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
10855
+ if @api_client.config.debugging
10856
+ @api_client.config.logger.debug "API called: ManagementApi#scim_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10857
+ end
10858
+ return data, status_code, headers
10859
+ end
10860
+
10861
+ # List supported SCIM resource types
10862
+ # 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.
10863
+ # @param [Hash] opts the optional parameters
10864
+ # @return [ScimResourceTypesListResponse]
10865
+ def scim_get_resource_types(opts = {})
10866
+ data, _status_code, _headers = scim_get_resource_types_with_http_info(opts)
10867
+ data
10868
+ end
10869
+
10870
+ # List supported SCIM resource types
10871
+ # 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.
10872
+ # @param [Hash] opts the optional parameters
10873
+ # @return [Array<(ScimResourceTypesListResponse, Integer, Hash)>] ScimResourceTypesListResponse data, response status code and response headers
10874
+ def scim_get_resource_types_with_http_info(opts = {})
10875
+ if @api_client.config.debugging
10876
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_resource_types ...'
10877
+ end
10878
+ # resource path
10879
+ local_var_path = '/v1/provisioning/scim/ResourceTypes'
10880
+
10881
+ # query parameters
10882
+ query_params = opts[:query_params] || {}
10883
+
10884
+ # header parameters
10885
+ header_params = opts[:header_params] || {}
10886
+ # HTTP header 'Accept' (if needed)
10887
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10888
+
10889
+ # form parameters
10890
+ form_params = opts[:form_params] || {}
10891
+
10892
+ # http body (model)
10893
+ post_body = opts[:body]
10894
+
10895
+ # return_type
10896
+ return_type = opts[:return_type] || 'ScimResourceTypesListResponse'
10897
+
10898
+ # auth_names
10899
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10900
+
10901
+ new_options = opts.merge(
10902
+ :header_params => header_params,
10903
+ :query_params => query_params,
10904
+ :form_params => form_params,
10905
+ :body => post_body,
10906
+ :auth_names => auth_names,
10907
+ :return_type => return_type
10908
+ )
10909
+
10910
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10911
+ if @api_client.config.debugging
10912
+ @api_client.config.logger.debug "API called: ManagementApi#scim_get_resource_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10913
+ end
10914
+ return data, status_code, headers
10915
+ end
10916
+
10917
+ # List supported SCIM schemas
10918
+ # 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.
10919
+ # @param [Hash] opts the optional parameters
10920
+ # @return [ScimSchemasListResponse]
10921
+ def scim_get_schemas(opts = {})
10922
+ data, _status_code, _headers = scim_get_schemas_with_http_info(opts)
10923
+ data
10924
+ end
10925
+
10926
+ # List supported SCIM schemas
10927
+ # 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.
10928
+ # @param [Hash] opts the optional parameters
10929
+ # @return [Array<(ScimSchemasListResponse, Integer, Hash)>] ScimSchemasListResponse data, response status code and response headers
10930
+ def scim_get_schemas_with_http_info(opts = {})
10931
+ if @api_client.config.debugging
10932
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_schemas ...'
10933
+ end
10934
+ # resource path
10935
+ local_var_path = '/v1/provisioning/scim/Schemas'
10936
+
10937
+ # query parameters
10938
+ query_params = opts[:query_params] || {}
10939
+
10940
+ # header parameters
10941
+ header_params = opts[:header_params] || {}
10942
+ # HTTP header 'Accept' (if needed)
10943
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10944
+
10945
+ # form parameters
10946
+ form_params = opts[:form_params] || {}
10947
+
10948
+ # http body (model)
10949
+ post_body = opts[:body]
10950
+
10951
+ # return_type
10952
+ return_type = opts[:return_type] || 'ScimSchemasListResponse'
10953
+
10954
+ # auth_names
10955
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10956
+
10957
+ new_options = opts.merge(
10958
+ :header_params => header_params,
10959
+ :query_params => query_params,
10960
+ :form_params => form_params,
10961
+ :body => post_body,
10962
+ :auth_names => auth_names,
10963
+ :return_type => return_type
10964
+ )
10965
+
10966
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10967
+ if @api_client.config.debugging
10968
+ @api_client.config.logger.debug "API called: ManagementApi#scim_get_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10969
+ end
10970
+ return data, status_code, headers
10971
+ end
10972
+
10973
+ # Get SCIM service provider configuration
10974
+ # 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.
10975
+ # @param [Hash] opts the optional parameters
10976
+ # @return [ScimServiceProviderConfigResponse]
10977
+ def scim_get_service_provider_config(opts = {})
10978
+ data, _status_code, _headers = scim_get_service_provider_config_with_http_info(opts)
10979
+ data
10980
+ end
10981
+
10982
+ # Get SCIM service provider configuration
10983
+ # 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.
10984
+ # @param [Hash] opts the optional parameters
10985
+ # @return [Array<(ScimServiceProviderConfigResponse, Integer, Hash)>] ScimServiceProviderConfigResponse data, response status code and response headers
10986
+ def scim_get_service_provider_config_with_http_info(opts = {})
10987
+ if @api_client.config.debugging
10988
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_service_provider_config ...'
10989
+ end
10990
+ # resource path
10991
+ local_var_path = '/v1/provisioning/scim/ServiceProviderConfig'
10992
+
10993
+ # query parameters
10994
+ query_params = opts[:query_params] || {}
10995
+
10996
+ # header parameters
10997
+ header_params = opts[:header_params] || {}
10998
+ # HTTP header 'Accept' (if needed)
10999
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11000
+
11001
+ # form parameters
11002
+ form_params = opts[:form_params] || {}
11003
+
11004
+ # http body (model)
11005
+ post_body = opts[:body]
11006
+
11007
+ # return_type
11008
+ return_type = opts[:return_type] || 'ScimServiceProviderConfigResponse'
11009
+
11010
+ # auth_names
11011
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
11012
+
11013
+ new_options = opts.merge(
11014
+ :header_params => header_params,
11015
+ :query_params => query_params,
11016
+ :form_params => form_params,
11017
+ :body => post_body,
11018
+ :auth_names => auth_names,
11019
+ :return_type => return_type
11020
+ )
11021
+
11022
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
11023
+ if @api_client.config.debugging
11024
+ @api_client.config.logger.debug "API called: ManagementApi#scim_get_service_provider_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11025
+ end
11026
+ return data, status_code, headers
11027
+ end
11028
+
11029
+ # Get SCIM user
11030
+ # Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
11031
+ # @param user_id [Integer] The ID of the user.
11032
+ # @param [Hash] opts the optional parameters
11033
+ # @return [ScimUser]
11034
+ def scim_get_user(user_id, opts = {})
11035
+ data, _status_code, _headers = scim_get_user_with_http_info(user_id, opts)
11036
+ data
11037
+ end
11038
+
11039
+ # Get SCIM user
11040
+ # Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
11041
+ # @param user_id [Integer] The ID of the user.
11042
+ # @param [Hash] opts the optional parameters
11043
+ # @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
11044
+ def scim_get_user_with_http_info(user_id, opts = {})
11045
+ if @api_client.config.debugging
11046
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_user ...'
11047
+ end
11048
+ # verify the required parameter 'user_id' is set
11049
+ if @api_client.config.client_side_validation && user_id.nil?
11050
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_get_user"
11051
+ end
11052
+ # resource path
11053
+ local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
11054
+
11055
+ # query parameters
11056
+ query_params = opts[:query_params] || {}
11057
+
11058
+ # header parameters
11059
+ header_params = opts[:header_params] || {}
11060
+ # HTTP header 'Accept' (if needed)
11061
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11062
+
11063
+ # form parameters
11064
+ form_params = opts[:form_params] || {}
11065
+
11066
+ # http body (model)
11067
+ post_body = opts[:body]
11068
+
11069
+ # return_type
11070
+ return_type = opts[:return_type] || 'ScimUser'
11071
+
11072
+ # auth_names
11073
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
11074
+
11075
+ new_options = opts.merge(
11076
+ :header_params => header_params,
11077
+ :query_params => query_params,
11078
+ :form_params => form_params,
11079
+ :body => post_body,
11080
+ :auth_names => auth_names,
11081
+ :return_type => return_type
11082
+ )
11083
+
11084
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
11085
+ if @api_client.config.debugging
11086
+ @api_client.config.logger.debug "API called: ManagementApi#scim_get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11087
+ end
11088
+ return data, status_code, headers
11089
+ end
11090
+
11091
+ # List SCIM users
11092
+ # Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
11093
+ # @param [Hash] opts the optional parameters
11094
+ # @return [ScimUsersListResponse]
11095
+ def scim_get_users(opts = {})
11096
+ data, _status_code, _headers = scim_get_users_with_http_info(opts)
11097
+ data
11098
+ end
11099
+
11100
+ # List SCIM users
11101
+ # Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
11102
+ # @param [Hash] opts the optional parameters
11103
+ # @return [Array<(ScimUsersListResponse, Integer, Hash)>] ScimUsersListResponse data, response status code and response headers
11104
+ def scim_get_users_with_http_info(opts = {})
11105
+ if @api_client.config.debugging
11106
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_users ...'
11107
+ end
11108
+ # resource path
11109
+ local_var_path = '/v1/provisioning/scim/Users'
11110
+
11111
+ # query parameters
11112
+ query_params = opts[:query_params] || {}
11113
+
11114
+ # header parameters
11115
+ header_params = opts[:header_params] || {}
11116
+ # HTTP header 'Accept' (if needed)
11117
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11118
+
11119
+ # form parameters
11120
+ form_params = opts[:form_params] || {}
11121
+
11122
+ # http body (model)
11123
+ post_body = opts[:body]
11124
+
11125
+ # return_type
11126
+ return_type = opts[:return_type] || 'ScimUsersListResponse'
11127
+
11128
+ # auth_names
11129
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
11130
+
11131
+ new_options = opts.merge(
11132
+ :header_params => header_params,
11133
+ :query_params => query_params,
11134
+ :form_params => form_params,
11135
+ :body => post_body,
11136
+ :auth_names => auth_names,
11137
+ :return_type => return_type
11138
+ )
11139
+
11140
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
11141
+ if @api_client.config.debugging
11142
+ @api_client.config.logger.debug "API called: ManagementApi#scim_get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11143
+ end
11144
+ return data, status_code, headers
11145
+ end
11146
+
11147
+ # Update SCIM user attributes
11148
+ # 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.
11149
+ # @param user_id [Integer] The ID of the user.
11150
+ # @param body [ScimPatchRequest] body
11151
+ # @param [Hash] opts the optional parameters
11152
+ # @return [ScimUser]
11153
+ def scim_patch_user(user_id, body, opts = {})
11154
+ data, _status_code, _headers = scim_patch_user_with_http_info(user_id, body, opts)
11155
+ data
11156
+ end
11157
+
11158
+ # Update SCIM user attributes
11159
+ # 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.
11160
+ # @param user_id [Integer] The ID of the user.
11161
+ # @param body [ScimPatchRequest] body
11162
+ # @param [Hash] opts the optional parameters
11163
+ # @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
11164
+ def scim_patch_user_with_http_info(user_id, body, opts = {})
11165
+ if @api_client.config.debugging
11166
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_patch_user ...'
11167
+ end
11168
+ # verify the required parameter 'user_id' is set
11169
+ if @api_client.config.client_side_validation && user_id.nil?
11170
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_patch_user"
11171
+ end
11172
+ # verify the required parameter 'body' is set
11173
+ if @api_client.config.client_side_validation && body.nil?
11174
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_patch_user"
11175
+ end
11176
+ # resource path
11177
+ local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
11178
+
11179
+ # query parameters
11180
+ query_params = opts[:query_params] || {}
11181
+
11182
+ # header parameters
11183
+ header_params = opts[:header_params] || {}
11184
+ # HTTP header 'Accept' (if needed)
11185
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11186
+ # HTTP header 'Content-Type'
11187
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
11188
+
11189
+ # form parameters
11190
+ form_params = opts[:form_params] || {}
11191
+
11192
+ # http body (model)
11193
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
11194
+
11195
+ # return_type
11196
+ return_type = opts[:return_type] || 'ScimUser'
11197
+
11198
+ # auth_names
11199
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
11200
+
11201
+ new_options = opts.merge(
11202
+ :header_params => header_params,
11203
+ :query_params => query_params,
11204
+ :form_params => form_params,
11205
+ :body => post_body,
11206
+ :auth_names => auth_names,
11207
+ :return_type => return_type
11208
+ )
11209
+
11210
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
11211
+ if @api_client.config.debugging
11212
+ @api_client.config.logger.debug "API called: ManagementApi#scim_patch_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11213
+ end
11214
+ return data, status_code, headers
11215
+ end
11216
+
11217
+ # Update SCIM user
11218
+ # 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.
11219
+ # @param user_id [Integer] The ID of the user.
11220
+ # @param body [ScimNewUser] body
11221
+ # @param [Hash] opts the optional parameters
11222
+ # @return [ScimUser]
11223
+ def scim_replace_user_attributes(user_id, body, opts = {})
11224
+ data, _status_code, _headers = scim_replace_user_attributes_with_http_info(user_id, body, opts)
11225
+ data
11226
+ end
11227
+
11228
+ # Update SCIM user
11229
+ # 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.
11230
+ # @param user_id [Integer] The ID of the user.
11231
+ # @param body [ScimNewUser] body
11232
+ # @param [Hash] opts the optional parameters
11233
+ # @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
11234
+ def scim_replace_user_attributes_with_http_info(user_id, body, opts = {})
11235
+ if @api_client.config.debugging
11236
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_replace_user_attributes ...'
11237
+ end
11238
+ # verify the required parameter 'user_id' is set
11239
+ if @api_client.config.client_side_validation && user_id.nil?
11240
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_replace_user_attributes"
11241
+ end
11242
+ # verify the required parameter 'body' is set
11243
+ if @api_client.config.client_side_validation && body.nil?
11244
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_replace_user_attributes"
11245
+ end
11246
+ # resource path
11247
+ local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
11248
+
11249
+ # query parameters
11250
+ query_params = opts[:query_params] || {}
11251
+
11252
+ # header parameters
11253
+ header_params = opts[:header_params] || {}
11254
+ # HTTP header 'Accept' (if needed)
11255
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11256
+ # HTTP header 'Content-Type'
11257
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
11258
+
11259
+ # form parameters
11260
+ form_params = opts[:form_params] || {}
11261
+
11262
+ # http body (model)
11263
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
11264
+
11265
+ # return_type
11266
+ return_type = opts[:return_type] || 'ScimUser'
11267
+
11268
+ # auth_names
11269
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
11270
+
11271
+ new_options = opts.merge(
11272
+ :header_params => header_params,
11273
+ :query_params => query_params,
11274
+ :form_params => form_params,
11275
+ :body => post_body,
11276
+ :auth_names => auth_names,
11277
+ :return_type => return_type
11278
+ )
11279
+
11280
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
11281
+ if @api_client.config.debugging
11282
+ @api_client.config.logger.debug "API called: ManagementApi#scim_replace_user_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11283
+ end
11284
+ return data, status_code, headers
11285
+ end
11286
+
10238
11287
  # List coupons that match the given attributes (without total count)
10239
11288
  # List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
10240
11289
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -10252,7 +11301,7 @@ module TalonOne
10252
11301
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
10253
11302
  # @option opts [String] :batch_id Filter results by batches of coupons
10254
11303
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
10255
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
11304
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
10256
11305
  # @return [InlineResponse2009]
10257
11306
  def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
10258
11307
  data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
@@ -10276,7 +11325,7 @@ module TalonOne
10276
11325
  # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
10277
11326
  # @option opts [String] :batch_id Filter results by batches of coupons
10278
11327
  # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
10279
- # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived. - &#x60;draft&#x60;: Campaigns that are drafts.
11328
+ # @option opts [String] :campaign_state Filter results by the state of the campaign. - &#x60;enabled&#x60;: Campaigns that are scheduled, running (activated), or expired. - &#x60;running&#x60;: Campaigns that are running (activated). - &#x60;disabled&#x60;: Campaigns that are disabled. - &#x60;expired&#x60;: Campaigns that are expired. - &#x60;archived&#x60;: Campaigns that are archived.
10280
11329
  # @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
10281
11330
  def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
10282
11331
  if @api_client.config.debugging
@@ -10306,7 +11355,7 @@ module TalonOne
10306
11355
  if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
10307
11356
  fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
10308
11357
  end
10309
- allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"]
11358
+ allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
10310
11359
  if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
10311
11360
  fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
10312
11361
  end
@@ -11023,7 +12072,7 @@ module TalonOne
11023
12072
  end
11024
12073
 
11025
12074
  # Update coupon
11026
- # 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>
12075
+ # 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>
11027
12076
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
11028
12077
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
11029
12078
  # @param coupon_id [String] The internal ID of the coupon code. You can find this value in the &#x60;id&#x60; property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.
@@ -11036,7 +12085,7 @@ module TalonOne
11036
12085
  end
11037
12086
 
11038
12087
  # Update coupon
11039
- # Update the specified coupon. &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt; &lt;p class&#x3D;\&quot;title\&quot;&gt;Important&lt;/p&gt; &lt;p&gt;With this PUT endpoint only, any property you do not explicitly set in your request will be set to &lt;code&gt;null&lt;/code&gt;.&lt;/p&gt; &lt;/div&gt;
12088
+ # Update the specified coupon. &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt; &lt;p class&#x3D;\&quot;title\&quot;&gt;Important&lt;/p&gt; &lt;p&gt;With this &lt;code&gt;PUT&lt;/code&gt; endpoint alone, if you do not explicitly set a value for the &lt;code&gt;startDate&lt;/code&gt;, &lt;code&gt;expiryDate&lt;/code&gt;, and &lt;code&gt;recipientIntegrationId&lt;/code&gt; properties in your request, it is automatically set to &lt;code&gt;null&lt;/code&gt;.&lt;/p&gt; &lt;/div&gt;
11040
12089
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
11041
12090
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
11042
12091
  # @param coupon_id [String] The internal ID of the coupon code. You can find this value in the &#x60;id&#x60; property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.