talon_one 8.0.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -8
  3. data/docs/Account.md +1 -1
  4. data/docs/AccountAdditionalCost.md +1 -1
  5. data/docs/Achievement.md +2 -2
  6. data/docs/AchievementBase.md +35 -0
  7. data/docs/AchievementProgressWithDefinition.md +45 -0
  8. data/docs/AchievementStatusEntry.md +45 -0
  9. data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
  10. data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
  11. data/docs/AnalyticsSKU.md +23 -0
  12. data/docs/Application.md +1 -1
  13. data/docs/ApplicationCIF.md +1 -1
  14. data/docs/ApplicationCIFExpression.md +1 -1
  15. data/docs/ApplicationCIFReferences.md +19 -0
  16. data/docs/ApplicationCustomer.md +2 -2
  17. data/docs/ApplicationEvent.md +1 -1
  18. data/docs/ApplicationSession.md +1 -1
  19. data/docs/Attribute.md +1 -1
  20. data/docs/Audience.md +1 -1
  21. data/docs/AudienceCustomer.md +2 -2
  22. data/docs/BaseNotificationWebhook.md +1 -1
  23. data/docs/Binding.md +9 -1
  24. data/docs/CampaignCollection.md +1 -1
  25. data/docs/CampaignCollectionWithoutPayload.md +1 -1
  26. data/docs/CampaignDeactivationRequest.md +17 -0
  27. data/docs/CampaignDetail.md +19 -0
  28. data/docs/CampaignGroup.md +1 -1
  29. data/docs/CampaignSet.md +1 -1
  30. data/docs/CampaignStoreBudget.md +1 -1
  31. data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
  32. data/docs/CampaignTemplate.md +4 -2
  33. data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
  34. data/docs/CartItem.md +12 -2
  35. data/docs/Catalog.md +1 -1
  36. data/docs/CatalogItem.md +1 -1
  37. data/docs/Change.md +1 -1
  38. data/docs/Collection.md +1 -1
  39. data/docs/CollectionWithoutPayload.md +1 -1
  40. data/docs/Coupon.md +2 -2
  41. data/docs/CouponCreationJob.md +1 -1
  42. data/docs/CouponDeletionJob.md +1 -1
  43. data/docs/CouponEntity.md +19 -0
  44. data/docs/CreateAchievement.md +1 -1
  45. data/docs/CustomEffect.md +1 -1
  46. data/docs/CustomerProfile.md +2 -2
  47. data/docs/CustomerProfileEntity.md +19 -0
  48. data/docs/CustomerSessionV2.md +1 -1
  49. data/docs/Effect.md +6 -0
  50. data/docs/EffectEntity.md +7 -1
  51. data/docs/Entity.md +1 -1
  52. data/docs/Environment.md +4 -2
  53. data/docs/Event.md +1 -1
  54. data/docs/EventType.md +1 -1
  55. data/docs/Export.md +1 -1
  56. data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +25 -0
  57. data/docs/Giveaway.md +1 -1
  58. data/docs/GiveawaysPool.md +1 -1
  59. data/docs/HiddenConditionsEffects.md +23 -0
  60. data/docs/Import.md +1 -1
  61. data/docs/InlineResponse20048.md +17 -0
  62. data/docs/InlineResponse20049.md +17 -0
  63. data/docs/InlineResponse20050.md +19 -0
  64. data/docs/InlineResponse20051.md +19 -0
  65. data/docs/IntegrationApi.md +6 -4
  66. data/docs/IntegrationCoupon.md +2 -2
  67. data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
  68. data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
  69. data/docs/IntegrationEventV2Request.md +2 -0
  70. data/docs/InventoryCoupon.md +2 -2
  71. data/docs/InventoryReferral.md +1 -1
  72. data/docs/LedgerEntry.md +1 -1
  73. data/docs/LedgerInfo.md +2 -2
  74. data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
  75. data/docs/LoyaltyCard.md +1 -1
  76. data/docs/LoyaltyLedgerEntryFlags.md +17 -0
  77. data/docs/LoyaltyProgramBalance.md +2 -2
  78. data/docs/LoyaltyProgramTransaction.md +3 -1
  79. data/docs/LoyaltyTier.md +1 -1
  80. data/docs/ManagementApi.md +824 -220
  81. data/docs/MessageTest.md +27 -0
  82. data/docs/ModelReturn.md +1 -1
  83. data/docs/MultipleAudiencesItem.md +1 -1
  84. data/docs/NewMessageTest.md +29 -0
  85. data/docs/NewPriceAdjustment.md +27 -0
  86. data/docs/NewPriceType.md +23 -0
  87. data/docs/NewWebhook.md +2 -0
  88. data/docs/Picklist.md +1 -1
  89. data/docs/PriceDetail.md +23 -0
  90. data/docs/PriceType.md +33 -0
  91. data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
  92. data/docs/ProductUnitAnalyticsTotals.md +17 -0
  93. data/docs/Referral.md +1 -1
  94. data/docs/RevisionActivationRequest.md +19 -0
  95. data/docs/Role.md +1 -1
  96. data/docs/RoleV2.md +1 -1
  97. data/docs/Ruleset.md +1 -1
  98. data/docs/SamlConnection.md +1 -1
  99. data/docs/ScimBaseGroup.md +19 -0
  100. data/docs/ScimGroup.md +21 -0
  101. data/docs/ScimGroupMember.md +19 -0
  102. data/docs/ScimGroupsListResponse.md +21 -0
  103. data/docs/SkuUnitAnalytics.md +19 -0
  104. data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
  105. data/docs/Store.md +1 -1
  106. data/docs/StrikethroughLabelingNotification.md +2 -0
  107. data/docs/TemplateDef.md +1 -1
  108. data/docs/UpdateAchievement.md +1 -1
  109. data/docs/User.md +1 -1
  110. data/docs/Webhook.md +3 -1
  111. data/docs/WebhookAuthentication.md +33 -0
  112. data/docs/WebhookAuthenticationBase.md +21 -0
  113. data/docs/WebhookAuthenticationDataBasic.md +19 -0
  114. data/docs/WebhookAuthenticationDataCustom.md +17 -0
  115. data/docs/WebhookAuthenticationWebhookRef.md +21 -0
  116. data/docs/WebhookWithOutgoingIntegrationDetails.md +3 -1
  117. data/lib/talon_one/api/integration_api.rb +9 -6
  118. data/lib/talon_one/api/management_api.rb +1009 -304
  119. data/lib/talon_one/models/account.rb +1 -1
  120. data/lib/talon_one/models/account_additional_cost.rb +1 -1
  121. data/lib/talon_one/models/achievement.rb +4 -4
  122. data/lib/talon_one/models/achievement_base.rb +377 -0
  123. data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
  124. data/lib/talon_one/models/achievement_status_entry.rb +472 -0
  125. data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
  126. data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
  127. data/lib/talon_one/models/analytics_sku.rb +246 -0
  128. data/lib/talon_one/models/application.rb +1 -1
  129. data/lib/talon_one/models/application_cif.rb +1 -1
  130. data/lib/talon_one/models/application_cif_expression.rb +1 -1
  131. data/lib/talon_one/models/application_cif_references.rb +219 -0
  132. data/lib/talon_one/models/application_customer.rb +2 -2
  133. data/lib/talon_one/models/application_event.rb +1 -1
  134. data/lib/talon_one/models/application_session.rb +1 -1
  135. data/lib/talon_one/models/attribute.rb +1 -1
  136. data/lib/talon_one/models/audience.rb +1 -1
  137. data/lib/talon_one/models/audience_customer.rb +2 -2
  138. data/lib/talon_one/models/base_notification.rb +2 -2
  139. data/lib/talon_one/models/base_notification_webhook.rb +1 -1
  140. data/lib/talon_one/models/binding.rb +44 -4
  141. data/lib/talon_one/models/campaign_collection.rb +1 -1
  142. data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
  143. data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
  144. data/lib/talon_one/models/campaign_detail.rb +232 -0
  145. data/lib/talon_one/models/campaign_group.rb +1 -1
  146. data/lib/talon_one/models/campaign_set.rb +1 -1
  147. data/lib/talon_one/models/campaign_store_budget.rb +1 -1
  148. data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
  149. data/lib/talon_one/models/campaign_template.rb +17 -5
  150. data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
  151. data/lib/talon_one/models/cart_item.rb +57 -5
  152. data/lib/talon_one/models/catalog.rb +1 -1
  153. data/lib/talon_one/models/catalog_action.rb +2 -2
  154. data/lib/talon_one/models/catalog_item.rb +1 -1
  155. data/lib/talon_one/models/change.rb +1 -1
  156. data/lib/talon_one/models/collection.rb +1 -1
  157. data/lib/talon_one/models/collection_without_payload.rb +1 -1
  158. data/lib/talon_one/models/coupon.rb +7 -7
  159. data/lib/talon_one/models/coupon_constraints.rb +5 -5
  160. data/lib/talon_one/models/coupon_creation_job.rb +6 -6
  161. data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
  162. data/lib/talon_one/models/coupon_entity.rb +227 -0
  163. data/lib/talon_one/models/create_achievement.rb +3 -3
  164. data/lib/talon_one/models/custom_effect.rb +1 -1
  165. data/lib/talon_one/models/customer_profile.rb +2 -2
  166. data/lib/talon_one/models/customer_profile_entity.rb +227 -0
  167. data/lib/talon_one/models/customer_session_v2.rb +1 -1
  168. data/lib/talon_one/models/delete_user_request.rb +0 -1
  169. data/lib/talon_one/models/effect.rb +31 -1
  170. data/lib/talon_one/models/effect_entity.rb +34 -4
  171. data/lib/talon_one/models/entity.rb +1 -1
  172. data/lib/talon_one/models/environment.rb +17 -5
  173. data/lib/talon_one/models/event.rb +1 -1
  174. data/lib/talon_one/models/event_type.rb +1 -1
  175. data/lib/talon_one/models/export.rb +1 -1
  176. data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +270 -0
  177. data/lib/talon_one/models/giveaway.rb +1 -1
  178. data/lib/talon_one/models/giveaways_pool.rb +1 -1
  179. data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
  180. data/lib/talon_one/models/import.rb +1 -1
  181. data/lib/talon_one/models/inline_response20048.rb +208 -0
  182. data/lib/talon_one/models/inline_response20049.rb +208 -0
  183. data/lib/talon_one/models/inline_response20050.rb +222 -0
  184. data/lib/talon_one/models/inline_response20051.rb +227 -0
  185. data/lib/talon_one/models/integration_coupon.rb +7 -7
  186. data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
  187. data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
  188. data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
  189. data/lib/talon_one/models/inventory_coupon.rb +7 -7
  190. data/lib/talon_one/models/inventory_referral.rb +1 -1
  191. data/lib/talon_one/models/ledger_entry.rb +1 -1
  192. data/lib/talon_one/models/ledger_info.rb +0 -10
  193. data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
  194. data/lib/talon_one/models/loyalty_card.rb +1 -1
  195. data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
  196. data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
  197. data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
  198. data/lib/talon_one/models/loyalty_tier.rb +1 -1
  199. data/lib/talon_one/models/message_test.rb +227 -0
  200. data/lib/talon_one/models/model_return.rb +1 -1
  201. data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
  202. data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
  203. data/lib/talon_one/models/new_coupons.rb +5 -5
  204. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
  205. data/lib/talon_one/models/new_message_test.rb +322 -0
  206. data/lib/talon_one/models/new_price_adjustment.rb +268 -0
  207. data/lib/talon_one/models/new_price_type.rb +270 -0
  208. data/lib/talon_one/models/new_webhook.rb +16 -1
  209. data/lib/talon_one/models/picklist.rb +1 -1
  210. data/lib/talon_one/models/price_detail.rb +237 -0
  211. data/lib/talon_one/models/price_type.rb +347 -0
  212. data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
  213. data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
  214. data/lib/talon_one/models/referral.rb +1 -1
  215. data/lib/talon_one/models/revision_activation_request.rb +224 -0
  216. data/lib/talon_one/models/role.rb +1 -1
  217. data/lib/talon_one/models/role_v2.rb +1 -1
  218. data/lib/talon_one/models/ruleset.rb +1 -1
  219. data/lib/talon_one/models/saml_connection.rb +1 -1
  220. data/lib/talon_one/models/scim_base_group.rb +220 -0
  221. data/lib/talon_one/models/scim_group.rb +235 -0
  222. data/lib/talon_one/models/scim_group_member.rb +218 -0
  223. data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
  224. data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
  225. data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
  226. data/lib/talon_one/models/store.rb +1 -1
  227. data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
  228. data/lib/talon_one/models/template_def.rb +1 -1
  229. data/lib/talon_one/models/update_achievement.rb +3 -3
  230. data/lib/talon_one/models/update_coupon.rb +5 -5
  231. data/lib/talon_one/models/update_coupon_batch.rb +5 -5
  232. data/lib/talon_one/models/user.rb +1 -1
  233. data/lib/talon_one/models/webhook.rb +17 -2
  234. data/lib/talon_one/models/webhook_authentication.rb +365 -0
  235. data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
  236. data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
  237. data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
  238. data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
  239. data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +17 -2
  240. data/lib/talon_one/version.rb +1 -1
  241. data/lib/talon_one.rb +26 -1
  242. data/spec/api/integration_api_spec.rb +4 -3
  243. data/spec/api/management_api_spec.rb +227 -90
  244. data/spec/models/achievement_base_spec.rb +1 -1
  245. data/spec/models/achievement_progress_with_definition_spec.rb +1 -1
  246. data/spec/models/achievement_spec.rb +1 -1
  247. data/spec/models/achievement_status_entry_spec.rb +1 -1
  248. data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
  249. data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -0
  250. data/spec/models/base_notification_spec.rb +1 -1
  251. data/spec/models/binding_spec.rb +24 -0
  252. data/spec/models/campaign_deactivation_request_spec.rb +41 -0
  253. data/spec/models/campaign_template_spec.rb +6 -0
  254. data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
  255. data/spec/models/cart_item_spec.rb +30 -0
  256. data/spec/models/catalog_action_spec.rb +1 -1
  257. data/spec/models/coupon_entity_spec.rb +47 -0
  258. data/spec/models/create_achievement_spec.rb +1 -1
  259. data/spec/models/customer_profile_entity_spec.rb +47 -0
  260. data/spec/models/effect_entity_spec.rb +18 -0
  261. data/spec/models/effect_spec.rb +18 -0
  262. data/spec/models/environment_spec.rb +6 -0
  263. data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +65 -0
  264. data/spec/models/inline_response20048_spec.rb +0 -6
  265. data/spec/models/inline_response20049_spec.rb +0 -6
  266. data/spec/models/inline_response20050_spec.rb +47 -0
  267. data/spec/models/inline_response20051_spec.rb +47 -0
  268. data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
  269. data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
  270. data/spec/models/integration_event_v2_request_spec.rb +6 -0
  271. data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
  272. data/spec/models/loyalty_program_transaction_spec.rb +6 -0
  273. data/spec/models/new_message_test_spec.rb +1 -1
  274. data/spec/models/new_price_adjustment_spec.rb +71 -0
  275. data/spec/models/new_price_type_spec.rb +59 -0
  276. data/spec/models/new_webhook_spec.rb +6 -0
  277. data/spec/models/price_detail_spec.rb +59 -0
  278. data/spec/models/price_type_spec.rb +89 -0
  279. data/spec/models/revision_activation_request_spec.rb +47 -0
  280. data/spec/models/scim_base_group_spec.rb +47 -0
  281. data/spec/models/scim_group_member_spec.rb +47 -0
  282. data/spec/models/scim_group_spec.rb +53 -0
  283. data/spec/models/scim_groups_list_response_spec.rb +53 -0
  284. data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
  285. data/spec/models/update_achievement_spec.rb +1 -1
  286. data/spec/models/webhook_authentication_base_spec.rb +57 -0
  287. data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
  288. data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
  289. data/spec/models/webhook_authentication_spec.rb +93 -0
  290. data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
  291. data/spec/models/webhook_spec.rb +6 -0
  292. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
  293. metadata +661 -527
@@ -21,7 +21,7 @@ module TalonOne
21
21
  end
22
22
  # Enable user by email address
23
23
  # Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
24
- # @param body [DeactivateUserRequest] body
24
+ # @param body [DeleteUserRequest] body
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [nil]
27
27
  def activate_user_by_email(body, opts = {})
@@ -31,7 +31,7 @@ module TalonOne
31
31
 
32
32
  # Enable user by email address
33
33
  # Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
34
- # @param body [DeactivateUserRequest] body
34
+ # @param body [DeleteUserRequest] body
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
37
  def activate_user_by_email_with_http_info(body, opts = {})
@@ -721,6 +721,82 @@ module TalonOne
721
721
  return data, status_code, headers
722
722
  end
723
723
 
724
+ # Create campaign store budget
725
+ # Create a new store budget for a given campaign.
726
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
727
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
728
+ # @param body [NewCampaignStoreBudget] body
729
+ # @param [Hash] opts the optional parameters
730
+ # @return [nil]
731
+ def create_campaign_store_budget(application_id, campaign_id, body, opts = {})
732
+ create_campaign_store_budget_with_http_info(application_id, campaign_id, body, opts)
733
+ nil
734
+ end
735
+
736
+ # Create campaign store budget
737
+ # Create a new store budget for a given campaign.
738
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
739
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
740
+ # @param body [NewCampaignStoreBudget] body
741
+ # @param [Hash] opts the optional parameters
742
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
743
+ def create_campaign_store_budget_with_http_info(application_id, campaign_id, body, opts = {})
744
+ if @api_client.config.debugging
745
+ @api_client.config.logger.debug 'Calling API: ManagementApi.create_campaign_store_budget ...'
746
+ end
747
+ # verify the required parameter 'application_id' is set
748
+ if @api_client.config.client_side_validation && application_id.nil?
749
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_campaign_store_budget"
750
+ end
751
+ # verify the required parameter 'campaign_id' is set
752
+ if @api_client.config.client_side_validation && campaign_id.nil?
753
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_campaign_store_budget"
754
+ end
755
+ # verify the required parameter 'body' is set
756
+ if @api_client.config.client_side_validation && body.nil?
757
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_campaign_store_budget"
758
+ end
759
+ # resource path
760
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
761
+
762
+ # query parameters
763
+ query_params = opts[:query_params] || {}
764
+
765
+ # header parameters
766
+ header_params = opts[:header_params] || {}
767
+ # HTTP header 'Accept' (if needed)
768
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
769
+ # HTTP header 'Content-Type'
770
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
771
+
772
+ # form parameters
773
+ form_params = opts[:form_params] || {}
774
+
775
+ # http body (model)
776
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
777
+
778
+ # return_type
779
+ return_type = opts[:return_type]
780
+
781
+ # auth_names
782
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
783
+
784
+ new_options = opts.merge(
785
+ :header_params => header_params,
786
+ :query_params => query_params,
787
+ :form_params => form_params,
788
+ :body => post_body,
789
+ :auth_names => auth_names,
790
+ :return_type => return_type
791
+ )
792
+
793
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
794
+ if @api_client.config.debugging
795
+ @api_client.config.logger.debug "API called: ManagementApi#create_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
796
+ end
797
+ return data, status_code, headers
798
+ end
799
+
724
800
  # Create campaign-level collection
725
801
  # Create a campaign-level collection in a given campaign.
726
802
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -1435,7 +1511,7 @@ module TalonOne
1435
1511
 
1436
1512
  # Disable user by email address
1437
1513
  # [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
1438
- # @param body [DeactivateUserRequest] body
1514
+ # @param body [DeleteUserRequest] body
1439
1515
  # @param [Hash] opts the optional parameters
1440
1516
  # @return [nil]
1441
1517
  def deactivate_user_by_email(body, opts = {})
@@ -1445,7 +1521,7 @@ module TalonOne
1445
1521
 
1446
1522
  # Disable user by email address
1447
1523
  # [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
1448
- # @param body [DeactivateUserRequest] body
1524
+ # @param body [DeleteUserRequest] body
1449
1525
  # @param [Hash] opts the optional parameters
1450
1526
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1451
1527
  def deactivate_user_by_email_with_http_info(body, opts = {})
@@ -1777,6 +1853,88 @@ module TalonOne
1777
1853
  return data, status_code, headers
1778
1854
  end
1779
1855
 
1856
+ # Delete campaign store budgets
1857
+ # Delete the store budgets for a given campaign.
1858
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
1859
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
1860
+ # @param [Hash] opts the optional parameters
1861
+ # @option opts [String] :action The action that this budget is limiting.
1862
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
1863
+ # @return [nil]
1864
+ def delete_campaign_store_budgets(application_id, campaign_id, opts = {})
1865
+ delete_campaign_store_budgets_with_http_info(application_id, campaign_id, opts)
1866
+ nil
1867
+ end
1868
+
1869
+ # Delete campaign store budgets
1870
+ # Delete the store budgets for a given campaign.
1871
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
1872
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
1873
+ # @param [Hash] opts the optional parameters
1874
+ # @option opts [String] :action The action that this budget is limiting.
1875
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
1876
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1877
+ def delete_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {})
1878
+ if @api_client.config.debugging
1879
+ @api_client.config.logger.debug 'Calling API: ManagementApi.delete_campaign_store_budgets ...'
1880
+ end
1881
+ # verify the required parameter 'application_id' is set
1882
+ if @api_client.config.client_side_validation && application_id.nil?
1883
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_campaign_store_budgets"
1884
+ end
1885
+ # verify the required parameter 'campaign_id' is set
1886
+ if @api_client.config.client_side_validation && campaign_id.nil?
1887
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_campaign_store_budgets"
1888
+ end
1889
+ allowable_values = ["setDiscount"]
1890
+ if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
1891
+ fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
1892
+ end
1893
+ allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
1894
+ if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
1895
+ fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
1896
+ end
1897
+ # resource path
1898
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
1899
+
1900
+ # query parameters
1901
+ query_params = opts[:query_params] || {}
1902
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
1903
+ query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
1904
+
1905
+ # header parameters
1906
+ header_params = opts[:header_params] || {}
1907
+ # HTTP header 'Accept' (if needed)
1908
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1909
+
1910
+ # form parameters
1911
+ form_params = opts[:form_params] || {}
1912
+
1913
+ # http body (model)
1914
+ post_body = opts[:body]
1915
+
1916
+ # return_type
1917
+ return_type = opts[:return_type]
1918
+
1919
+ # auth_names
1920
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
1921
+
1922
+ new_options = opts.merge(
1923
+ :header_params => header_params,
1924
+ :query_params => query_params,
1925
+ :form_params => form_params,
1926
+ :body => post_body,
1927
+ :auth_names => auth_names,
1928
+ :return_type => return_type
1929
+ )
1930
+
1931
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1932
+ if @api_client.config.debugging
1933
+ @api_client.config.logger.debug "API called: ManagementApi#delete_campaign_store_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1934
+ end
1935
+ return data, status_code, headers
1936
+ end
1937
+
1780
1938
  # Delete campaign-level collection
1781
1939
  # Delete a given campaign-level collection.
1782
1940
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -2310,7 +2468,7 @@ module TalonOne
2310
2468
 
2311
2469
  # Delete user by email address
2312
2470
  # [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
2313
- # @param body [DeactivateUserRequest] body
2471
+ # @param body [DeleteUserRequest] body
2314
2472
  # @param [Hash] opts the optional parameters
2315
2473
  # @return [nil]
2316
2474
  def delete_user_by_email(body, opts = {})
@@ -2320,7 +2478,7 @@ module TalonOne
2320
2478
 
2321
2479
  # Delete user by email address
2322
2480
  # [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
2323
- # @param body [DeactivateUserRequest] body
2481
+ # @param body [DeleteUserRequest] body
2324
2482
  # @param [Hash] opts the optional parameters
2325
2483
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2326
2484
  def delete_user_by_email_with_http_info(body, opts = {})
@@ -2690,6 +2848,88 @@ module TalonOne
2690
2848
  return data, status_code, headers
2691
2849
  end
2692
2850
 
2851
+ # Export campaign store budgets
2852
+ # Download a CSV file containing the store budgets for a given 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 columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
2853
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2854
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
2855
+ # @param [Hash] opts the optional parameters
2856
+ # @option opts [String] :action The action that this budget is limiting.
2857
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
2858
+ # @return [String]
2859
+ def export_campaign_store_budgets(application_id, campaign_id, opts = {})
2860
+ data, _status_code, _headers = export_campaign_store_budgets_with_http_info(application_id, campaign_id, opts)
2861
+ data
2862
+ end
2863
+
2864
+ # Export campaign store budgets
2865
+ # Download a CSV file containing the store budgets for a given 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 columns: - &#x60;store_integration_id&#x60;: The identifier of the store. - &#x60;limit&#x60;: The budget limit for the store.
2866
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2867
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
2868
+ # @param [Hash] opts the optional parameters
2869
+ # @option opts [String] :action The action that this budget is limiting.
2870
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
2871
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
2872
+ def export_campaign_store_budgets_with_http_info(application_id, campaign_id, opts = {})
2873
+ if @api_client.config.debugging
2874
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_campaign_store_budgets ...'
2875
+ end
2876
+ # verify the required parameter 'application_id' is set
2877
+ if @api_client.config.client_side_validation && application_id.nil?
2878
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_campaign_store_budgets"
2879
+ end
2880
+ # verify the required parameter 'campaign_id' is set
2881
+ if @api_client.config.client_side_validation && campaign_id.nil?
2882
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_campaign_store_budgets"
2883
+ end
2884
+ allowable_values = ["setDiscount"]
2885
+ if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
2886
+ fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
2887
+ end
2888
+ allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
2889
+ if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
2890
+ fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
2891
+ end
2892
+ # resource path
2893
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
2894
+
2895
+ # query parameters
2896
+ query_params = opts[:query_params] || {}
2897
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
2898
+ query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
2899
+
2900
+ # header parameters
2901
+ header_params = opts[:header_params] || {}
2902
+ # HTTP header 'Accept' (if needed)
2903
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
2904
+
2905
+ # form parameters
2906
+ form_params = opts[:form_params] || {}
2907
+
2908
+ # http body (model)
2909
+ post_body = opts[:body]
2910
+
2911
+ # return_type
2912
+ return_type = opts[:return_type] || 'String'
2913
+
2914
+ # auth_names
2915
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
2916
+
2917
+ new_options = opts.merge(
2918
+ :header_params => header_params,
2919
+ :query_params => query_params,
2920
+ :form_params => form_params,
2921
+ :body => post_body,
2922
+ :auth_names => auth_names,
2923
+ :return_type => return_type
2924
+ )
2925
+
2926
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2927
+ if @api_client.config.debugging
2928
+ @api_client.config.logger.debug "API called: ManagementApi#export_campaign_store_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2929
+ end
2930
+ return data, status_code, headers
2931
+ end
2932
+
2693
2933
  # Export stores
2694
2934
  # 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
2935
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -2837,7 +3077,7 @@ module TalonOne
2837
3077
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2838
3078
  # @param [Hash] opts the optional parameters
2839
3079
  # @option opts [Float] :campaign_id Filter results by campaign ID.
2840
- # @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.
3080
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
2841
3081
  # @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.
2842
3082
  # @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.
2843
3083
  # @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.
@@ -2861,7 +3101,7 @@ module TalonOne
2861
3101
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2862
3102
  # @param [Hash] opts the optional parameters
2863
3103
  # @option opts [Float] :campaign_id Filter results by campaign ID.
2864
- # @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.
3104
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
2865
3105
  # @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.
2866
3106
  # @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.
2867
3107
  # @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.
@@ -2953,7 +3193,7 @@ module TalonOne
2953
3193
  end
2954
3194
 
2955
3195
  # Export customer sessions
2956
- # Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/product/server-infrastructure-and-data-retention#data-retention-policy). **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/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
3196
+ # Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **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/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
2957
3197
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2958
3198
  # @param [Hash] opts the optional parameters
2959
3199
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
@@ -2968,7 +3208,7 @@ module TalonOne
2968
3208
  end
2969
3209
 
2970
3210
  # Export customer sessions
2971
- # Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/product/server-infrastructure-and-data-retention#data-retention-policy). **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/). - &#x60;id&#x60;: The internal ID of the session. - &#x60;firstsession&#x60;: Whether this is a first session. - &#x60;integrationid&#x60;: The integration ID of the session. - &#x60;applicationid&#x60;: The ID of the Application. - &#x60;profileid&#x60;: The internal ID of the customer profile. - &#x60;profileintegrationid&#x60;: The integration ID of the customer profile. - &#x60;created&#x60;: The timestamp when the session was created. - &#x60;state&#x60;: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - &#x60;cartitems&#x60;: The cart items in the session. - &#x60;discounts&#x60;: The discounts in the session. - &#x60;total&#x60;: The total value of cart items and additional costs in the session, before any discounts are applied. - &#x60;attributes&#x60;: The attributes set in the session. - &#x60;closedat&#x60;: Timestamp when the session was closed. - &#x60;cancelledat&#x60;: Timestamp when the session was cancelled. - &#x60;referral&#x60;: The referral code in the session. - &#x60;identifiers&#x60;: The identifiers in the session. - &#x60;additional_costs&#x60;: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - &#x60;updated&#x60;: Timestamp of the last session update. - &#x60;store_integration_id&#x60;: The integration ID of the store. - &#x60;coupons&#x60;: Coupon codes in the session.
3211
+ # Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **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/). - &#x60;id&#x60;: The internal ID of the session. - &#x60;firstsession&#x60;: Whether this is a first session. - &#x60;integrationid&#x60;: The integration ID of the session. - &#x60;applicationid&#x60;: The ID of the Application. - &#x60;profileid&#x60;: The internal ID of the customer profile. - &#x60;profileintegrationid&#x60;: The integration ID of the customer profile. - &#x60;created&#x60;: The timestamp when the session was created. - &#x60;state&#x60;: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - &#x60;cartitems&#x60;: The cart items in the session. - &#x60;discounts&#x60;: The discounts in the session. - &#x60;total&#x60;: The total value of cart items and additional costs in the session, before any discounts are applied. - &#x60;attributes&#x60;: The attributes set in the session. - &#x60;closedat&#x60;: Timestamp when the session was closed. - &#x60;cancelledat&#x60;: Timestamp when the session was cancelled. - &#x60;referral&#x60;: The referral code in the session. - &#x60;identifiers&#x60;: The identifiers in the session. - &#x60;additional_costs&#x60;: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - &#x60;updated&#x60;: Timestamp of the last session update. - &#x60;store_integration_id&#x60;: The integration ID of the store. - &#x60;coupons&#x60;: Coupon codes in the session.
2972
3212
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
2973
3213
  # @param [Hash] opts the optional parameters
2974
3214
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
@@ -3476,6 +3716,8 @@ module TalonOne
3476
3716
  # @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.
3477
3717
  # @param [Hash] opts the optional parameters
3478
3718
  # @option opts [String] :batch_id Filter results by loyalty card batch ID.
3719
+ # @option opts [DateTime] :created_before Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
3720
+ # @option opts [DateTime] :created_after Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
3479
3721
  # @option opts [String] :date_format Determines the format of dates in the export document.
3480
3722
  # @return [String]
3481
3723
  def export_loyalty_cards(loyalty_program_id, opts = {})
@@ -3488,6 +3730,8 @@ module TalonOne
3488
3730
  # @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.
3489
3731
  # @param [Hash] opts the optional parameters
3490
3732
  # @option opts [String] :batch_id Filter results by loyalty card batch ID.
3733
+ # @option opts [DateTime] :created_before Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
3734
+ # @option opts [DateTime] :created_after Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
3491
3735
  # @option opts [String] :date_format Determines the format of dates in the export document.
3492
3736
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
3493
3737
  def export_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
@@ -3508,6 +3752,8 @@ module TalonOne
3508
3752
  # query parameters
3509
3753
  query_params = opts[:query_params] || {}
3510
3754
  query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
3755
+ query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
3756
+ query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
3511
3757
  query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
3512
3758
 
3513
3759
  # header parameters
@@ -3544,7 +3790,7 @@ module TalonOne
3544
3790
  end
3545
3791
 
3546
3792
  # Export customer's transaction logs
3547
- # 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.
3793
+ # 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. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
3548
3794
  # @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.
3549
3795
  # @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.
3550
3796
  # @param loyalty_program_id [String] The identifier for the loyalty program.
@@ -3558,7 +3804,7 @@ module TalonOne
3558
3804
  end
3559
3805
 
3560
3806
  # Export customer&#39;s transaction logs
3561
- # 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.
3807
+ # 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. - &#x60;flags&#x60;: The flags of the transaction, when applicable. The &#x60;createsNegativeBalance&#x60; flag indicates whether the transaction results in a negative balance.
3562
3808
  # @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.
3563
3809
  # @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.
3564
3810
  # @param loyalty_program_id [String] The identifier for the loyalty program.
@@ -3806,7 +4052,7 @@ module TalonOne
3806
4052
  # @option opts [String] :status Filter results by HTTP status codes.
3807
4053
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
3808
4054
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
3809
- # @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.
4055
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
3810
4056
  # @return [InlineResponse20022]
3811
4057
  def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
3812
4058
  data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
@@ -3824,7 +4070,7 @@ module TalonOne
3824
4070
  # @option opts [String] :status Filter results by HTTP status codes.
3825
4071
  # @option opts [Integer] :page_size The number of items in the response.
3826
4072
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
3827
- # @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.
4073
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
3828
4074
  # @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
3829
4075
  def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
3830
4076
  if @api_client.config.debugging
@@ -4232,7 +4478,7 @@ module TalonOne
4232
4478
  # @param [Hash] opts the optional parameters
4233
4479
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4234
4480
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4235
- # @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.
4481
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4236
4482
  # @return [InlineResponse20038]
4237
4483
  def get_additional_costs(opts = {})
4238
4484
  data, _status_code, _headers = get_additional_costs_with_http_info(opts)
@@ -4244,7 +4490,7 @@ module TalonOne
4244
4490
  # @param [Hash] opts the optional parameters
4245
4491
  # @option opts [Integer] :page_size The number of items in the response.
4246
4492
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4247
- # @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.
4493
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4248
4494
  # @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
4249
4495
  def get_additional_costs_with_http_info(opts = {})
4250
4496
  if @api_client.config.debugging
@@ -4499,7 +4745,7 @@ module TalonOne
4499
4745
  # @param [Hash] opts the optional parameters
4500
4746
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4501
4747
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4502
- # @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.
4748
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4503
4749
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4504
4750
  # @return [InlineResponse20035]
4505
4751
  def get_application_customer_friends(application_id, integration_id, opts = {})
@@ -4514,7 +4760,7 @@ module TalonOne
4514
4760
  # @param [Hash] opts the optional parameters
4515
4761
  # @option opts [Integer] :page_size The number of items in the response.
4516
4762
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4517
- # @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.
4763
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4518
4764
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
4519
4765
  # @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
4520
4766
  def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
@@ -4755,7 +5001,7 @@ module TalonOne
4755
5001
  # @param [Hash] opts the optional parameters
4756
5002
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4757
5003
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4758
- # @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.
5004
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4759
5005
  # @return [InlineResponse20031]
4760
5006
  def get_application_event_types(application_id, opts = {})
4761
5007
  data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
@@ -4768,7 +5014,7 @@ module TalonOne
4768
5014
  # @param [Hash] opts the optional parameters
4769
5015
  # @option opts [Integer] :page_size The number of items in the response.
4770
5016
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4771
- # @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.
5017
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4772
5018
  # @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
4773
5019
  def get_application_event_types_with_http_info(application_id, opts = {})
4774
5020
  if @api_client.config.debugging
@@ -4834,7 +5080,7 @@ module TalonOne
4834
5080
  # @param [Hash] opts the optional parameters
4835
5081
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
4836
5082
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4837
- # @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.
5083
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4838
5084
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
4839
5085
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
4840
5086
  # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -4858,7 +5104,7 @@ module TalonOne
4858
5104
  # @param [Hash] opts the optional parameters
4859
5105
  # @option opts [Integer] :page_size The number of items in the response.
4860
5106
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
4861
- # @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.
5107
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
4862
5108
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
4863
5109
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
4864
5110
  # @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -5022,7 +5268,7 @@ module TalonOne
5022
5268
  # @param [Hash] opts the optional parameters
5023
5269
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5024
5270
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5025
- # @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.
5271
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5026
5272
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
5027
5273
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
5028
5274
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -5043,7 +5289,7 @@ module TalonOne
5043
5289
  # @param [Hash] opts the optional parameters
5044
5290
  # @option opts [Integer] :page_size The number of items in the response.
5045
5291
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5046
- # @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.
5292
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5047
5293
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
5048
5294
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
5049
5295
  # @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -5128,7 +5374,7 @@ module TalonOne
5128
5374
  # @param [Hash] opts the optional parameters
5129
5375
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5130
5376
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5131
- # @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.
5377
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5132
5378
  # @return [InlineResponse2007]
5133
5379
  def get_applications(opts = {})
5134
5380
  data, _status_code, _headers = get_applications_with_http_info(opts)
@@ -5140,7 +5386,7 @@ module TalonOne
5140
5386
  # @param [Hash] opts the optional parameters
5141
5387
  # @option opts [Integer] :page_size The number of items in the response.
5142
5388
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5143
- # @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.
5389
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5144
5390
  # @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
5145
5391
  def get_applications_with_http_info(opts = {})
5146
5392
  if @api_client.config.debugging
@@ -5263,7 +5509,7 @@ module TalonOne
5263
5509
  # @param [Hash] opts the optional parameters
5264
5510
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5265
5511
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5266
- # @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.
5512
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5267
5513
  # @option opts [String] :entity Returned attributes will be filtered by supplied entity.
5268
5514
  # @return [InlineResponse20036]
5269
5515
  def get_attributes(opts = {})
@@ -5276,7 +5522,7 @@ module TalonOne
5276
5522
  # @param [Hash] opts the optional parameters
5277
5523
  # @option opts [Integer] :page_size The number of items in the response.
5278
5524
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5279
- # @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.
5525
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5280
5526
  # @option opts [String] :entity Returned attributes will be filtered by supplied entity.
5281
5527
  # @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
5282
5528
  def get_attributes_with_http_info(opts = {})
@@ -5340,7 +5586,7 @@ module TalonOne
5340
5586
  # @param [Hash] opts the optional parameters
5341
5587
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5342
5588
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5343
- # @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.
5589
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5344
5590
  # @option opts [String] :profile_query The filter to select a profile.
5345
5591
  # @return [InlineResponse20034]
5346
5592
  def get_audience_memberships(audience_id, opts = {})
@@ -5354,7 +5600,7 @@ module TalonOne
5354
5600
  # @param [Hash] opts the optional parameters
5355
5601
  # @option opts [Integer] :page_size The number of items in the response.
5356
5602
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5357
- # @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.
5603
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5358
5604
  # @option opts [String] :profile_query The filter to select a profile.
5359
5605
  # @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
5360
5606
  def get_audience_memberships_with_http_info(audience_id, opts = {})
@@ -5421,7 +5667,7 @@ module TalonOne
5421
5667
  # @param [Hash] opts the optional parameters
5422
5668
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5423
5669
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5424
- # @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.
5670
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5425
5671
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
5426
5672
  # @return [InlineResponse20032]
5427
5673
  def get_audiences(opts = {})
@@ -5434,7 +5680,7 @@ module TalonOne
5434
5680
  # @param [Hash] opts the optional parameters
5435
5681
  # @option opts [Integer] :page_size The number of items in the response.
5436
5682
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5437
- # @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.
5683
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5438
5684
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
5439
5685
  # @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
5440
5686
  def get_audiences_with_http_info(opts = {})
@@ -5496,7 +5742,7 @@ module TalonOne
5496
5742
  # Get a list of audience IDs and their member count.
5497
5743
  # @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
5498
5744
  # @param [Hash] opts the optional parameters
5499
- # @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.
5745
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5500
5746
  # @return [InlineResponse20033]
5501
5747
  def get_audiences_analytics(audience_ids, opts = {})
5502
5748
  data, _status_code, _headers = get_audiences_analytics_with_http_info(audience_ids, opts)
@@ -5507,7 +5753,7 @@ module TalonOne
5507
5753
  # Get a list of audience IDs and their member count.
5508
5754
  # @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
5509
5755
  # @param [Hash] opts the optional parameters
5510
- # @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.
5756
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5511
5757
  # @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
5512
5758
  def get_audiences_analytics_with_http_info(audience_ids, opts = {})
5513
5759
  if @api_client.config.debugging
@@ -5722,7 +5968,7 @@ module TalonOne
5722
5968
  # @param [Hash] opts the optional parameters
5723
5969
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5724
5970
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5725
- # @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.
5971
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5726
5972
  # @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.
5727
5973
  # @return [InlineResponse2008]
5728
5974
  def get_campaign_by_attributes(application_id, body, opts = {})
@@ -5737,7 +5983,7 @@ module TalonOne
5737
5983
  # @param [Hash] opts the optional parameters
5738
5984
  # @option opts [Integer] :page_size The number of items in the response.
5739
5985
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5740
- # @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.
5986
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5741
5987
  # @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.
5742
5988
  # @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
5743
5989
  def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
@@ -5876,7 +6122,7 @@ module TalonOne
5876
6122
  # @param [Hash] opts the optional parameters
5877
6123
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5878
6124
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5879
- # @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.
6125
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5880
6126
  # @return [InlineResponse20013]
5881
6127
  def get_campaign_groups(opts = {})
5882
6128
  data, _status_code, _headers = get_campaign_groups_with_http_info(opts)
@@ -5888,7 +6134,7 @@ module TalonOne
5888
6134
  # @param [Hash] opts the optional parameters
5889
6135
  # @option opts [Integer] :page_size The number of items in the response.
5890
6136
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5891
- # @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.
6137
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5892
6138
  # @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
5893
6139
  def get_campaign_groups_with_http_info(opts = {})
5894
6140
  if @api_client.config.debugging
@@ -5949,7 +6195,7 @@ module TalonOne
5949
6195
  # @param [Hash] opts the optional parameters
5950
6196
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
5951
6197
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5952
- # @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.
6198
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5953
6199
  # @option opts [String] :state Filter results by the state of the campaign template.
5954
6200
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
5955
6201
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. 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.
@@ -5965,7 +6211,7 @@ module TalonOne
5965
6211
  # @param [Hash] opts the optional parameters
5966
6212
  # @option opts [Integer] :page_size The number of items in the response.
5967
6213
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
5968
- # @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.
6214
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
5969
6215
  # @option opts [String] :state Filter results by the state of the campaign template.
5970
6216
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
5971
6217
  # @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. 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.
@@ -6039,7 +6285,7 @@ module TalonOne
6039
6285
  # @param [Hash] opts the optional parameters
6040
6286
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6041
6287
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6042
- # @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.
6288
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6043
6289
  # @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.
6044
6290
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
6045
6291
  # @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
@@ -6060,7 +6306,7 @@ module TalonOne
6060
6306
  # @param [Hash] opts the optional parameters
6061
6307
  # @option opts [Integer] :page_size The number of items in the response.
6062
6308
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6063
- # @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.
6309
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6064
6310
  # @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.
6065
6311
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
6066
6312
  # @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
@@ -6145,7 +6391,7 @@ module TalonOne
6145
6391
  # @param [Hash] opts the optional parameters
6146
6392
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6147
6393
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6148
- # @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.
6394
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6149
6395
  # @option opts [Float] :application_id Filter results by Application ID.
6150
6396
  # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
6151
6397
  # @option opts [Integer] :user_id Filter results by user ID.
@@ -6165,7 +6411,7 @@ module TalonOne
6165
6411
  # @param [Hash] opts the optional parameters
6166
6412
  # @option opts [Integer] :page_size The number of items in the response.
6167
6413
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6168
- # @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.
6414
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6169
6415
  # @option opts [Float] :application_id Filter results by Application ID.
6170
6416
  # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
6171
6417
  # @option opts [Integer] :user_id Filter results by user ID.
@@ -6394,7 +6640,7 @@ module TalonOne
6394
6640
  # @param [Hash] opts the optional parameters
6395
6641
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6396
6642
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6397
- # @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.
6643
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6398
6644
  # @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.
6399
6645
  # @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.
6400
6646
  # @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.
@@ -6423,7 +6669,7 @@ module TalonOne
6423
6669
  # @param [Hash] opts the optional parameters
6424
6670
  # @option opts [Integer] :page_size The number of items in the response.
6425
6671
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6426
- # @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.
6672
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6427
6673
  # @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.
6428
6674
  # @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.
6429
6675
  # @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.
@@ -6633,7 +6879,7 @@ module TalonOne
6633
6879
  # @param [Hash] opts the optional parameters
6634
6880
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6635
6881
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6636
- # @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.
6882
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6637
6883
  # @option opts [String] :name Only return reports matching the customer name.
6638
6884
  # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
6639
6885
  # @option opts [String] :campaign_name Only return reports matching the campaign name.
@@ -6652,7 +6898,7 @@ module TalonOne
6652
6898
  # @param [Hash] opts the optional parameters
6653
6899
  # @option opts [Integer] :page_size The number of items in the response.
6654
6900
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6655
- # @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.
6901
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6656
6902
  # @option opts [String] :name Only return reports matching the customer name.
6657
6903
  # @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
6658
6904
  # @option opts [String] :campaign_name Only return reports matching the campaign name.
@@ -6737,7 +6983,7 @@ module TalonOne
6737
6983
  # @param [Hash] opts the optional parameters
6738
6984
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
6739
6985
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6740
- # @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.
6986
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6741
6987
  # @return [CustomerAnalytics]
6742
6988
  def get_customer_analytics(application_id, customer_id, opts = {})
6743
6989
  data, _status_code, _headers = get_customer_analytics_with_http_info(application_id, customer_id, opts)
@@ -6751,7 +6997,7 @@ module TalonOne
6751
6997
  # @param [Hash] opts the optional parameters
6752
6998
  # @option opts [Integer] :page_size The number of items in the response.
6753
6999
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6754
- # @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.
7000
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
6755
7001
  # @return [Array<(CustomerAnalytics, Integer, Hash)>] CustomerAnalytics data, response status code and response headers
6756
7002
  def get_customer_analytics_with_http_info(application_id, customer_id, opts = {})
6757
7003
  if @api_client.config.debugging
@@ -6886,7 +7132,7 @@ module TalonOne
6886
7132
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6887
7133
  # @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
6888
7134
  # @option opts [String] :title Filter results by the &#x60;title&#x60; of an achievement.
6889
- # @return [InlineResponse20049]
7135
+ # @return [InlineResponse20051]
6890
7136
  def get_customer_profile_achievement_progress(application_id, integration_id, opts = {})
6891
7137
  data, _status_code, _headers = get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts)
6892
7138
  data
@@ -6901,7 +7147,7 @@ module TalonOne
6901
7147
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
6902
7148
  # @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
6903
7149
  # @option opts [String] :title Filter results by the &#x60;title&#x60; of an achievement.
6904
- # @return [Array<(InlineResponse20049, Integer, Hash)>] InlineResponse20049 data, response status code and response headers
7150
+ # @return [Array<(InlineResponse20051, Integer, Hash)>] InlineResponse20051 data, response status code and response headers
6905
7151
  def get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts = {})
6906
7152
  if @api_client.config.debugging
6907
7153
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile_achievement_progress ...'
@@ -6944,7 +7190,7 @@ module TalonOne
6944
7190
  post_body = opts[:body]
6945
7191
 
6946
7192
  # return_type
6947
- return_type = opts[:return_type] || 'InlineResponse20049'
7193
+ return_type = opts[:return_type] || 'InlineResponse20051'
6948
7194
 
6949
7195
  # auth_names
6950
7196
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -7205,7 +7451,7 @@ module TalonOne
7205
7451
  # @option opts [Boolean] :include_old_versions Include all versions of every event type. (default to false)
7206
7452
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7207
7453
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7208
- # @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.
7454
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
7209
7455
  # @return [InlineResponse20042]
7210
7456
  def get_event_types(opts = {})
7211
7457
  data, _status_code, _headers = get_event_types_with_http_info(opts)
@@ -7219,7 +7465,7 @@ module TalonOne
7219
7465
  # @option opts [Boolean] :include_old_versions Include all versions of every event type.
7220
7466
  # @option opts [Integer] :page_size The number of items in the response.
7221
7467
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7222
- # @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.
7468
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
7223
7469
  # @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
7224
7470
  def get_event_types_with_http_info(opts = {})
7225
7471
  if @api_client.config.debugging
@@ -7533,7 +7779,7 @@ module TalonOne
7533
7779
  # @param [Hash] opts the optional parameters
7534
7780
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7535
7781
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7536
- # @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.
7782
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
7537
7783
  # @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
7538
7784
  # @option opts [Integer] :profile_id Filter results by customer profile ID.
7539
7785
  # @option opts [String] :batch_id Filter results by loyalty card batch ID.
@@ -7549,7 +7795,7 @@ module TalonOne
7549
7795
  # @param [Hash] opts the optional parameters
7550
7796
  # @option opts [Integer] :page_size The number of items in the response.
7551
7797
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7552
- # @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.
7798
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
7553
7799
  # @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
7554
7800
  # @option opts [Integer] :profile_id Filter results by customer profile ID.
7555
7801
  # @option opts [String] :batch_id Filter results by loyalty card batch ID.
@@ -7963,6 +8209,121 @@ module TalonOne
7963
8209
  return data, status_code, headers
7964
8210
  end
7965
8211
 
8212
+ # List message log entries
8213
+ # Retrieve all message log entries.
8214
+ # @param entity_type [String] The entity type the log is related to.
8215
+ # @param [Hash] opts the optional parameters
8216
+ # @option opts [String] :message_id Filter results by message ID.
8217
+ # @option opts [String] :change_type Filter results by change type.
8218
+ # @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
8219
+ # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8220
+ # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8221
+ # @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
8222
+ # @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
8223
+ # @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to&#x60;true&#x60;, only log entries with &#x60;2xx&#x60; response codes are returned. When set to &#x60;false&#x60;, only log entries with &#x60;4xx&#x60; and &#x60;5xx&#x60; response codes are returned.
8224
+ # @option opts [Float] :application_id Filter results by Application ID.
8225
+ # @option opts [Float] :campaign_id Filter results by campaign ID.
8226
+ # @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
8227
+ # @option opts [Integer] :response_code Filter results by response status code.
8228
+ # @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
8229
+ # @return [MessageLogEntries]
8230
+ def get_message_logs(entity_type, opts = {})
8231
+ data, _status_code, _headers = get_message_logs_with_http_info(entity_type, opts)
8232
+ data
8233
+ end
8234
+
8235
+ # List message log entries
8236
+ # Retrieve all message log entries.
8237
+ # @param entity_type [String] The entity type the log is related to.
8238
+ # @param [Hash] opts the optional parameters
8239
+ # @option opts [String] :message_id Filter results by message ID.
8240
+ # @option opts [String] :change_type Filter results by change type.
8241
+ # @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
8242
+ # @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8243
+ # @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
8244
+ # @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
8245
+ # @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
8246
+ # @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to&#x60;true&#x60;, only log entries with &#x60;2xx&#x60; response codes are returned. When set to &#x60;false&#x60;, only log entries with &#x60;4xx&#x60; and &#x60;5xx&#x60; response codes are returned.
8247
+ # @option opts [Float] :application_id Filter results by Application ID.
8248
+ # @option opts [Float] :campaign_id Filter results by campaign ID.
8249
+ # @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
8250
+ # @option opts [Integer] :response_code Filter results by response status code.
8251
+ # @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
8252
+ # @return [Array<(MessageLogEntries, Integer, Hash)>] MessageLogEntries data, response status code and response headers
8253
+ def get_message_logs_with_http_info(entity_type, opts = {})
8254
+ if @api_client.config.debugging
8255
+ @api_client.config.logger.debug 'Calling API: ManagementApi.get_message_logs ...'
8256
+ end
8257
+ # verify the required parameter 'entity_type' is set
8258
+ if @api_client.config.client_side_validation && entity_type.nil?
8259
+ fail ArgumentError, "Missing the required parameter 'entity_type' when calling ManagementApi.get_message_logs"
8260
+ end
8261
+ # verify enum value
8262
+ allowable_values = ["application", "loyalty_program", "webhook"]
8263
+ if @api_client.config.client_side_validation && !allowable_values.include?(entity_type)
8264
+ fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
8265
+ end
8266
+ allowable_values = ["CampaignEvaluationTreeChanged", "CampaignNotification", "CouponCreated", "CouponUpdated", "CouponDeleted", "AsyncCouponsCreated", "CouponsDeleted", "CouponsUpdated", "CouponCodeExpiring", "StrikethroughPrice", "LoyaltyPointsAdded", "LoyaltyPointsDeducted", "LoyaltyPointsExpiring", "LoyaltyPointsPendingToActive", "LoyaltyAddedDeductedPointsBalances", "LoyaltyCardAddedDeductedPointsBalances", "TierWillDowngrade", "TierUpgrade", "TierDowngrade", "LoyaltyCardPointsAdded", "LoyaltyCardPointsDeducted", "LoyaltyCardPointsExpiring"]
8267
+ if @api_client.config.client_side_validation && opts[:'change_type'] && !allowable_values.include?(opts[:'change_type'])
8268
+ fail ArgumentError, "invalid value for \"change_type\", must be one of #{allowable_values}"
8269
+ end
8270
+ allowable_values = ["15m", "30m", "1h", "4h", "1d", "2d"]
8271
+ if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
8272
+ fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
8273
+ end
8274
+ # resource path
8275
+ local_var_path = '/v1/message_logs'
8276
+
8277
+ # query parameters
8278
+ query_params = opts[:query_params] || {}
8279
+ query_params[:'entityType'] = entity_type
8280
+ query_params[:'messageID'] = opts[:'message_id'] if !opts[:'message_id'].nil?
8281
+ query_params[:'changeType'] = opts[:'change_type'] if !opts[:'change_type'].nil?
8282
+ query_params[:'notificationIDs'] = opts[:'notification_i_ds'] if !opts[:'notification_i_ds'].nil?
8283
+ query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
8284
+ query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
8285
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
8286
+ query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
8287
+ query_params[:'isSuccessful'] = opts[:'is_successful'] if !opts[:'is_successful'].nil?
8288
+ query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
8289
+ query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
8290
+ query_params[:'loyaltyProgramId'] = opts[:'loyalty_program_id'] if !opts[:'loyalty_program_id'].nil?
8291
+ query_params[:'responseCode'] = opts[:'response_code'] if !opts[:'response_code'].nil?
8292
+ query_params[:'webhookIDs'] = opts[:'webhook_i_ds'] if !opts[:'webhook_i_ds'].nil?
8293
+
8294
+ # header parameters
8295
+ header_params = opts[:header_params] || {}
8296
+ # HTTP header 'Accept' (if needed)
8297
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8298
+
8299
+ # form parameters
8300
+ form_params = opts[:form_params] || {}
8301
+
8302
+ # http body (model)
8303
+ post_body = opts[:body]
8304
+
8305
+ # return_type
8306
+ return_type = opts[:return_type] || 'MessageLogEntries'
8307
+
8308
+ # auth_names
8309
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
8310
+
8311
+ new_options = opts.merge(
8312
+ :header_params => header_params,
8313
+ :query_params => query_params,
8314
+ :form_params => form_params,
8315
+ :body => post_body,
8316
+ :auth_names => auth_names,
8317
+ :return_type => return_type
8318
+ )
8319
+
8320
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
8321
+ if @api_client.config.debugging
8322
+ @api_client.config.logger.debug "API called: ManagementApi#get_message_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8323
+ end
8324
+ return data, status_code, headers
8325
+ end
8326
+
7966
8327
  # List referrals
7967
8328
  # List all referrals of the specified campaign.
7968
8329
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
@@ -7970,7 +8331,7 @@ module TalonOne
7970
8331
  # @param [Hash] opts the optional parameters
7971
8332
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
7972
8333
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7973
- # @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.
8334
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
7974
8335
  # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
7975
8336
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
7976
8337
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -7990,7 +8351,7 @@ module TalonOne
7990
8351
  # @param [Hash] opts the optional parameters
7991
8352
  # @option opts [Integer] :page_size The number of items in the response.
7992
8353
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
7993
- # @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.
8354
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
7994
8355
  # @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
7995
8356
  # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
7996
8357
  # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -8217,7 +8578,7 @@ module TalonOne
8217
8578
  # @param [Hash] opts the optional parameters
8218
8579
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8219
8580
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8220
- # @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.
8581
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8221
8582
  # @return [InlineResponse2009]
8222
8583
  def get_rulesets(application_id, campaign_id, opts = {})
8223
8584
  data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts)
@@ -8231,7 +8592,7 @@ module TalonOne
8231
8592
  # @param [Hash] opts the optional parameters
8232
8593
  # @option opts [Integer] :page_size The number of items in the response.
8233
8594
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8234
- # @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.
8595
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8235
8596
  # @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
8236
8597
  def get_rulesets_with_http_info(application_id, campaign_id, opts = {})
8237
8598
  if @api_client.config.debugging
@@ -8430,7 +8791,7 @@ module TalonOne
8430
8791
  # @param [Hash] opts the optional parameters
8431
8792
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8432
8793
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8433
- # @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.
8794
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8434
8795
  # @return [InlineResponse20043]
8435
8796
  def get_users(opts = {})
8436
8797
  data, _status_code, _headers = get_users_with_http_info(opts)
@@ -8442,7 +8803,7 @@ module TalonOne
8442
8803
  # @param [Hash] opts the optional parameters
8443
8804
  # @option opts [Integer] :page_size The number of items in the response.
8444
8805
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8445
- # @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.
8806
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8446
8807
  # @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
8447
8808
  def get_users_with_http_info(opts = {})
8448
8809
  if @api_client.config.debugging
@@ -8565,7 +8926,7 @@ module TalonOne
8565
8926
  # @param [Hash] opts the optional parameters
8566
8927
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8567
8928
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8568
- # @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.
8929
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8569
8930
  # @option opts [String] :integration_request_uuid Filter results by integration request UUID.
8570
8931
  # @option opts [Float] :webhook_id Filter results by webhook id.
8571
8932
  # @option opts [Float] :application_id Filter results by Application ID.
@@ -8583,7 +8944,7 @@ module TalonOne
8583
8944
  # @param [Hash] opts the optional parameters
8584
8945
  # @option opts [Integer] :page_size The number of items in the response.
8585
8946
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8586
- # @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.
8947
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8587
8948
  # @option opts [String] :integration_request_uuid Filter results by integration request UUID.
8588
8949
  # @option opts [Float] :webhook_id Filter results by webhook id.
8589
8950
  # @option opts [Float] :application_id Filter results by Application ID.
@@ -8656,7 +9017,7 @@ module TalonOne
8656
9017
  # @param [Hash] opts the optional parameters
8657
9018
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8658
9019
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8659
- # @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.
9020
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8660
9021
  # @option opts [String] :status Filter results by HTTP status codes.
8661
9022
  # @option opts [Float] :webhook_id Filter results by webhook id.
8662
9023
  # @option opts [Float] :application_id Filter results by Application ID.
@@ -8675,7 +9036,7 @@ module TalonOne
8675
9036
  # @param [Hash] opts the optional parameters
8676
9037
  # @option opts [Integer] :page_size The number of items in the response.
8677
9038
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8678
- # @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.
9039
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8679
9040
  # @option opts [String] :status Filter results by HTTP status codes.
8680
9041
  # @option opts [Float] :webhook_id Filter results by webhook id.
8681
9042
  # @option opts [Float] :application_id Filter results by Application ID.
@@ -8753,7 +9114,7 @@ module TalonOne
8753
9114
  # List all webhooks.
8754
9115
  # @param [Hash] opts the optional parameters
8755
9116
  # @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.
8756
- # @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.
9117
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8757
9118
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
8758
9119
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8759
9120
  # @option opts [String] :creation_type Filter results by creation type.
@@ -8770,7 +9131,7 @@ module TalonOne
8770
9131
  # List all webhooks.
8771
9132
  # @param [Hash] opts the optional parameters
8772
9133
  # @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.
8773
- # @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.
9134
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
8774
9135
  # @option opts [Integer] :page_size The number of items in the response.
8775
9136
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
8776
9137
  # @option opts [String] :creation_type Filter results by creation type.
@@ -9046,42 +9407,56 @@ module TalonOne
9046
9407
  return data, status_code, headers
9047
9408
  end
9048
9409
 
9049
- # Import stores
9050
- # 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.
9410
+ # Import campaign store budgets
9411
+ # Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import **replaces** the previous list of store budgets.
9051
9412
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
9052
9413
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
9053
9414
  # @param [Hash] opts the optional parameters
9415
+ # @option opts [String] :action The action that this budget is limiting.
9416
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
9054
9417
  # @option opts [String] :up_file The file containing the data that is being imported.
9055
9418
  # @return [Import]
9056
- def import_campaign_stores(application_id, campaign_id, opts = {})
9057
- data, _status_code, _headers = import_campaign_stores_with_http_info(application_id, campaign_id, opts)
9419
+ def import_campaign_store_budget(application_id, campaign_id, opts = {})
9420
+ data, _status_code, _headers = import_campaign_store_budget_with_http_info(application_id, campaign_id, opts)
9058
9421
  data
9059
9422
  end
9060
9423
 
9061
- # Import stores
9062
- # 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.
9424
+ # Import campaign store budgets
9425
+ # Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - &#x60;store_integration_id&#x60;: The identifier of the store. - &#x60;limit&#x60;: The budget limit for the store. The import **replaces** the previous list of store budgets.
9063
9426
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
9064
9427
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
9065
9428
  # @param [Hash] opts the optional parameters
9429
+ # @option opts [String] :action The action that this budget is limiting.
9430
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
9066
9431
  # @option opts [String] :up_file The file containing the data that is being imported.
9067
9432
  # @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
9068
- def import_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
9433
+ def import_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {})
9069
9434
  if @api_client.config.debugging
9070
- @api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_stores ...'
9435
+ @api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_store_budget ...'
9071
9436
  end
9072
9437
  # verify the required parameter 'application_id' is set
9073
9438
  if @api_client.config.client_side_validation && application_id.nil?
9074
- fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_stores"
9439
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_store_budget"
9075
9440
  end
9076
9441
  # verify the required parameter 'campaign_id' is set
9077
9442
  if @api_client.config.client_side_validation && campaign_id.nil?
9078
- fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_stores"
9443
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_store_budget"
9444
+ end
9445
+ allowable_values = ["setDiscount"]
9446
+ if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
9447
+ fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
9448
+ end
9449
+ allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
9450
+ if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
9451
+ fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
9079
9452
  end
9080
9453
  # resource path
9081
- 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))
9454
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
9082
9455
 
9083
9456
  # query parameters
9084
9457
  query_params = opts[:query_params] || {}
9458
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
9459
+ query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
9085
9460
 
9086
9461
  # header parameters
9087
9462
  header_params = opts[:header_params] || {}
@@ -9114,12 +9489,85 @@ module TalonOne
9114
9489
 
9115
9490
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9116
9491
  if @api_client.config.debugging
9117
- @api_client.config.logger.debug "API called: ManagementApi#import_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9492
+ @api_client.config.logger.debug "API called: ManagementApi#import_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9118
9493
  end
9119
9494
  return data, status_code, headers
9120
9495
  end
9121
9496
 
9122
- # Import data into existing campaign-level collection
9497
+ # Import stores
9498
+ # 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.
9499
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
9500
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
9501
+ # @param [Hash] opts the optional parameters
9502
+ # @option opts [String] :up_file The file containing the data that is being imported.
9503
+ # @return [Import]
9504
+ def import_campaign_stores(application_id, campaign_id, opts = {})
9505
+ data, _status_code, _headers = import_campaign_stores_with_http_info(application_id, campaign_id, opts)
9506
+ data
9507
+ end
9508
+
9509
+ # Import stores
9510
+ # 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.
9511
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
9512
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
9513
+ # @param [Hash] opts the optional parameters
9514
+ # @option opts [String] :up_file The file containing the data that is being imported.
9515
+ # @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
9516
+ def import_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
9517
+ if @api_client.config.debugging
9518
+ @api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_stores ...'
9519
+ end
9520
+ # verify the required parameter 'application_id' is set
9521
+ if @api_client.config.client_side_validation && application_id.nil?
9522
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_stores"
9523
+ end
9524
+ # verify the required parameter 'campaign_id' is set
9525
+ if @api_client.config.client_side_validation && campaign_id.nil?
9526
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_stores"
9527
+ end
9528
+ # resource path
9529
+ 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))
9530
+
9531
+ # query parameters
9532
+ query_params = opts[:query_params] || {}
9533
+
9534
+ # header parameters
9535
+ header_params = opts[:header_params] || {}
9536
+ # HTTP header 'Accept' (if needed)
9537
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9538
+ # HTTP header 'Content-Type'
9539
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
9540
+
9541
+ # form parameters
9542
+ form_params = opts[:form_params] || {}
9543
+ form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
9544
+
9545
+ # http body (model)
9546
+ post_body = opts[:body]
9547
+
9548
+ # return_type
9549
+ return_type = opts[:return_type] || 'Import'
9550
+
9551
+ # auth_names
9552
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
9553
+
9554
+ new_options = opts.merge(
9555
+ :header_params => header_params,
9556
+ :query_params => query_params,
9557
+ :form_params => form_params,
9558
+ :body => post_body,
9559
+ :auth_names => auth_names,
9560
+ :return_type => return_type
9561
+ )
9562
+
9563
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9564
+ if @api_client.config.debugging
9565
+ @api_client.config.logger.debug "API called: ManagementApi#import_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9566
+ end
9567
+ return data, status_code, headers
9568
+ end
9569
+
9570
+ # Import data into existing campaign-level collection
9123
9571
  # 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.
9124
9572
  # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
9125
9573
  # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
@@ -9412,6 +9860,7 @@ module TalonOne
9412
9860
  # Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
9413
9861
  # @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.
9414
9862
  # @param [Hash] opts the optional parameters
9863
+ # @option opts [Boolean] :notifications_enabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer&#39;s tier or offsets their negative points balance. This parameter is optional and defaults to &#x60;true&#x60;.
9415
9864
  # @option opts [String] :up_file The file containing the data that is being imported.
9416
9865
  # @return [Import]
9417
9866
  def import_loyalty_points(loyalty_program_id, opts = {})
@@ -9423,6 +9872,7 @@ module TalonOne
9423
9872
  # Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - &#x60;customerprofileid&#x60; (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - &#x60;identifier&#x60; (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - &#x60;amount&#x60;: The amount of points to award to the customer profile. - &#x60;startdate&#x60; (optional): The earliest date when the points can be redeemed. The points are &#x60;active&#x60; from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string &#x60;immediate&#x60;. Empty or missing values are considered &#x60;immediate&#x60;. - &#x60;expirydate&#x60; (optional): The latest date when the points can be redeemed. The points are &#x60;expired&#x60; after this date. **Note**: It must be an RFC3339 timestamp string or string &#x60;unlimited&#x60;. Empty or missing values are considered &#x60;unlimited&#x60;. - &#x60;subledgerid&#x60; (optional): The ID of the subledger that should received the points. - &#x60;reason&#x60; (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for &#x60;startdate&#x60;. If &#x60;startdate&#x60; matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for &#x60;startdate&#x60; is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** &#x60;&#x60;&#x60;text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60; **Example for card-based programs:** &#x60;&#x60;&#x60;text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement &#x60;&#x60;&#x60;
9424
9873
  # @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.
9425
9874
  # @param [Hash] opts the optional parameters
9875
+ # @option opts [Boolean] :notifications_enabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer&#39;s tier or offsets their negative points balance. This parameter is optional and defaults to &#x60;true&#x60;.
9426
9876
  # @option opts [String] :up_file The file containing the data that is being imported.
9427
9877
  # @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
9428
9878
  def import_loyalty_points_with_http_info(loyalty_program_id, opts = {})
@@ -9438,6 +9888,7 @@ module TalonOne
9438
9888
 
9439
9889
  # query parameters
9440
9890
  query_params = opts[:query_params] || {}
9891
+ query_params[:'notificationsEnabled'] = opts[:'notifications_enabled'] if !opts[:'notifications_enabled'].nil?
9441
9892
 
9442
9893
  # header parameters
9443
9894
  header_params = opts[:header_params] || {}
@@ -9682,7 +10133,7 @@ module TalonOne
9682
10133
  # @param [Hash] opts the optional parameters
9683
10134
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
9684
10135
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9685
- # @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.
10136
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
9686
10137
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9687
10138
  # @option opts [String] :name Filter by collection name.
9688
10139
  # @return [InlineResponse20020]
@@ -9696,7 +10147,7 @@ module TalonOne
9696
10147
  # @param [Hash] opts the optional parameters
9697
10148
  # @option opts [Integer] :page_size The number of items in the response.
9698
10149
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9699
- # @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.
10150
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
9700
10151
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9701
10152
  # @option opts [String] :name Filter by collection name.
9702
10153
  # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
@@ -9764,7 +10215,7 @@ module TalonOne
9764
10215
  # @option opts [Integer] :page_size The number of items in the response. (default to 50)
9765
10216
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9766
10217
  # @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no &#x60;title&#x60; is provided, all the achievements from the campaign are returned.
9767
- # @return [InlineResponse20048]
10218
+ # @return [InlineResponse20050]
9768
10219
  def list_achievements(application_id, campaign_id, opts = {})
9769
10220
  data, _status_code, _headers = list_achievements_with_http_info(application_id, campaign_id, opts)
9770
10221
  data
@@ -9778,7 +10229,7 @@ module TalonOne
9778
10229
  # @option opts [Integer] :page_size The number of items in the response.
9779
10230
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9780
10231
  # @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no &#x60;title&#x60; is provided, all the achievements from the campaign are returned.
9781
- # @return [Array<(InlineResponse20048, Integer, Hash)>] InlineResponse20048 data, response status code and response headers
10232
+ # @return [Array<(InlineResponse20050, Integer, Hash)>] InlineResponse20050 data, response status code and response headers
9782
10233
  def list_achievements_with_http_info(application_id, campaign_id, opts = {})
9783
10234
  if @api_client.config.debugging
9784
10235
  @api_client.config.logger.debug 'Calling API: ManagementApi.list_achievements ...'
@@ -9820,7 +10271,7 @@ module TalonOne
9820
10271
  post_body = opts[:body]
9821
10272
 
9822
10273
  # return_type
9823
- return_type = opts[:return_type] || 'InlineResponse20048'
10274
+ return_type = opts[:return_type] || 'InlineResponse20050'
9824
10275
 
9825
10276
  # auth_names
9826
10277
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -9897,6 +10348,88 @@ module TalonOne
9897
10348
  return data, status_code, headers
9898
10349
  end
9899
10350
 
10351
+ # List campaign store budget limits
10352
+ # Return the store budget limits for a given campaign.
10353
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
10354
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
10355
+ # @param [Hash] opts the optional parameters
10356
+ # @option opts [String] :action The action that this budget is limiting.
10357
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
10358
+ # @return [InlineResponse20048]
10359
+ def list_campaign_store_budget_limits(application_id, campaign_id, opts = {})
10360
+ data, _status_code, _headers = list_campaign_store_budget_limits_with_http_info(application_id, campaign_id, opts)
10361
+ data
10362
+ end
10363
+
10364
+ # List campaign store budget limits
10365
+ # Return the store budget limits for a given campaign.
10366
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
10367
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
10368
+ # @param [Hash] opts the optional parameters
10369
+ # @option opts [String] :action The action that this budget is limiting.
10370
+ # @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to &#x60;overall&#x60;.
10371
+ # @return [Array<(InlineResponse20048, Integer, Hash)>] InlineResponse20048 data, response status code and response headers
10372
+ def list_campaign_store_budget_limits_with_http_info(application_id, campaign_id, opts = {})
10373
+ if @api_client.config.debugging
10374
+ @api_client.config.logger.debug 'Calling API: ManagementApi.list_campaign_store_budget_limits ...'
10375
+ end
10376
+ # verify the required parameter 'application_id' is set
10377
+ if @api_client.config.client_side_validation && application_id.nil?
10378
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.list_campaign_store_budget_limits"
10379
+ end
10380
+ # verify the required parameter 'campaign_id' is set
10381
+ if @api_client.config.client_side_validation && campaign_id.nil?
10382
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.list_campaign_store_budget_limits"
10383
+ end
10384
+ allowable_values = ["setDiscount"]
10385
+ if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
10386
+ fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
10387
+ end
10388
+ allowable_values = ["overall", "daily", "weekly", "monthly", "yearly"]
10389
+ if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
10390
+ fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
10391
+ end
10392
+ # resource path
10393
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
10394
+
10395
+ # query parameters
10396
+ query_params = opts[:query_params] || {}
10397
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
10398
+ query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
10399
+
10400
+ # header parameters
10401
+ header_params = opts[:header_params] || {}
10402
+ # HTTP header 'Accept' (if needed)
10403
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10404
+
10405
+ # form parameters
10406
+ form_params = opts[:form_params] || {}
10407
+
10408
+ # http body (model)
10409
+ post_body = opts[:body]
10410
+
10411
+ # return_type
10412
+ return_type = opts[:return_type] || 'InlineResponse20048'
10413
+
10414
+ # auth_names
10415
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
10416
+
10417
+ new_options = opts.merge(
10418
+ :header_params => header_params,
10419
+ :query_params => query_params,
10420
+ :form_params => form_params,
10421
+ :body => post_body,
10422
+ :auth_names => auth_names,
10423
+ :return_type => return_type
10424
+ )
10425
+
10426
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10427
+ if @api_client.config.debugging
10428
+ @api_client.config.logger.debug "API called: ManagementApi#list_campaign_store_budget_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10429
+ end
10430
+ return data, status_code, headers
10431
+ end
10432
+
9900
10433
  # List items in a catalog
9901
10434
  # Return a paginated list of cart items in the given catalog.
9902
10435
  # @param catalog_id [Integer] The ID of the catalog. You can find the ID in the Campaign Manager in **Account** &gt; **Tools** &gt; **Cart item catalogs**.
@@ -9946,8 +10479,8 @@ module TalonOne
9946
10479
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
9947
10480
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
9948
10481
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
9949
- query_params[:'sku'] = @api_client.build_collection_param(opts[:'sku'], :csv) if !opts[:'sku'].nil?
9950
- query_params[:'productNames'] = @api_client.build_collection_param(opts[:'product_names'], :csv) if !opts[:'product_names'].nil?
10482
+ query_params[:'sku'] = @api_client.build_collection_param(opts[:'sku'], :multi) if !opts[:'sku'].nil?
10483
+ query_params[:'productNames'] = @api_client.build_collection_param(opts[:'product_names'], :multi) if !opts[:'product_names'].nil?
9951
10484
 
9952
10485
  # header parameters
9953
10486
  header_params = opts[:header_params] || {}
@@ -9989,7 +10522,7 @@ module TalonOne
9989
10522
  # @param [Hash] opts the optional parameters
9990
10523
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
9991
10524
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
9992
- # @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.
10525
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
9993
10526
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
9994
10527
  # @option opts [String] :name Filter by collection name.
9995
10528
  # @return [InlineResponse20020]
@@ -10005,7 +10538,7 @@ module TalonOne
10005
10538
  # @param [Hash] opts the optional parameters
10006
10539
  # @option opts [Integer] :page_size The number of items in the response.
10007
10540
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10008
- # @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.
10541
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
10009
10542
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10010
10543
  # @option opts [String] :name Filter by collection name.
10011
10544
  # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
@@ -10079,7 +10612,7 @@ module TalonOne
10079
10612
  # @param [Hash] opts the optional parameters
10080
10613
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
10081
10614
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10082
- # @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.
10615
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
10083
10616
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10084
10617
  # @option opts [String] :name Filter by collection name.
10085
10618
  # @return [InlineResponse20020]
@@ -10094,7 +10627,7 @@ module TalonOne
10094
10627
  # @param [Hash] opts the optional parameters
10095
10628
  # @option opts [Integer] :page_size The number of items in the response.
10096
10629
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10097
- # @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.
10630
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
10098
10631
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10099
10632
  # @option opts [String] :name Filter by collection name.
10100
10633
  # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
@@ -10164,7 +10697,7 @@ module TalonOne
10164
10697
  # @param [Hash] opts the optional parameters
10165
10698
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
10166
10699
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10167
- # @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.
10700
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
10168
10701
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10169
10702
  # @option opts [Float] :campaign_id Filter results by campaign ID.
10170
10703
  # @option opts [String] :name The name of the store.
@@ -10182,7 +10715,7 @@ module TalonOne
10182
10715
  # @param [Hash] opts the optional parameters
10183
10716
  # @option opts [Integer] :page_size The number of items in the response.
10184
10717
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
10185
- # @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.
10718
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
10186
10719
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When &#x60;true&#x60;: &#x60;hasMore&#x60; is true when there is a next page. &#x60;totalResultSize&#x60; is always zero. - When &#x60;false&#x60;: &#x60;hasMore&#x60; is always false. &#x60;totalResultSize&#x60; contains the total number of results for this query.
10187
10720
  # @option opts [Float] :campaign_id Filter results by campaign ID.
10188
10721
  # @option opts [String] :name The name of the store.
@@ -10252,51 +10785,37 @@ module TalonOne
10252
10785
  return data, status_code, headers
10253
10786
  end
10254
10787
 
10255
- # Activate or deactivate notification
10256
- # Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
10257
- # @param notification_id [Integer] The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
10258
- # @param body [NotificationActivation] body
10788
+ # Validate Okta API ownership
10789
+ # 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.
10259
10790
  # @param [Hash] opts the optional parameters
10260
10791
  # @return [nil]
10261
- def notification_activation(notification_id, body, opts = {})
10262
- notification_activation_with_http_info(notification_id, body, opts)
10792
+ def okta_event_handler_challenge(opts = {})
10793
+ okta_event_handler_challenge_with_http_info(opts)
10263
10794
  nil
10264
10795
  end
10265
10796
 
10266
- # Activate or deactivate notification
10267
- # Activate or deactivate the given notification. When &#x60;enabled&#x60; is false, updates will no longer be sent for the given notification.
10268
- # @param notification_id [Integer] The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
10269
- # @param body [NotificationActivation] body
10797
+ # Validate Okta API ownership
10798
+ # 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.
10270
10799
  # @param [Hash] opts the optional parameters
10271
10800
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
10272
- def notification_activation_with_http_info(notification_id, body, opts = {})
10801
+ def okta_event_handler_challenge_with_http_info(opts = {})
10273
10802
  if @api_client.config.debugging
10274
- @api_client.config.logger.debug 'Calling API: ManagementApi.notification_activation ...'
10275
- end
10276
- # verify the required parameter 'notification_id' is set
10277
- if @api_client.config.client_side_validation && notification_id.nil?
10278
- fail ArgumentError, "Missing the required parameter 'notification_id' when calling ManagementApi.notification_activation"
10279
- end
10280
- # verify the required parameter 'body' is set
10281
- if @api_client.config.client_side_validation && body.nil?
10282
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.notification_activation"
10803
+ @api_client.config.logger.debug 'Calling API: ManagementApi.okta_event_handler_challenge ...'
10283
10804
  end
10284
10805
  # resource path
10285
- local_var_path = '/v1/notifications/{notificationId}/activation'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s))
10806
+ local_var_path = '/v1/provisioning/okta'
10286
10807
 
10287
10808
  # query parameters
10288
10809
  query_params = opts[:query_params] || {}
10289
10810
 
10290
10811
  # header parameters
10291
10812
  header_params = opts[:header_params] || {}
10292
- # HTTP header 'Content-Type'
10293
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10294
10813
 
10295
10814
  # form parameters
10296
10815
  form_params = opts[:form_params] || {}
10297
10816
 
10298
10817
  # http body (model)
10299
- post_body = opts[:body] || @api_client.object_to_http_body(body)
10818
+ post_body = opts[:body]
10300
10819
 
10301
10820
  # return_type
10302
10821
  return_type = opts[:return_type]
@@ -10313,44 +10832,66 @@ module TalonOne
10313
10832
  :return_type => return_type
10314
10833
  )
10315
10834
 
10316
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
10835
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10317
10836
  if @api_client.config.debugging
10318
- @api_client.config.logger.debug "API called: ManagementApi#notification_activation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10837
+ @api_client.config.logger.debug "API called: ManagementApi#okta_event_handler_challenge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10319
10838
  end
10320
10839
  return data, status_code, headers
10321
10840
  end
10322
10841
 
10323
- # Validate Okta API ownership
10324
- # 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.
10842
+ # Deduct points from customer profile
10843
+ # Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
10844
+ # @param loyalty_program_id [String] The identifier for the loyalty program.
10845
+ # @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
10846
+ # @param body [DeductLoyaltyPoints] body
10325
10847
  # @param [Hash] opts the optional parameters
10326
10848
  # @return [nil]
10327
- def okta_event_handler_challenge(opts = {})
10328
- okta_event_handler_challenge_with_http_info(opts)
10849
+ def remove_loyalty_points(loyalty_program_id, integration_id, body, opts = {})
10850
+ remove_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts)
10329
10851
  nil
10330
10852
  end
10331
10853
 
10332
- # Validate Okta API ownership
10333
- # 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.
10854
+ # Deduct points from customer profile
10855
+ # Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
10856
+ # @param loyalty_program_id [String] The identifier for the loyalty program.
10857
+ # @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
10858
+ # @param body [DeductLoyaltyPoints] body
10334
10859
  # @param [Hash] opts the optional parameters
10335
10860
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
10336
- def okta_event_handler_challenge_with_http_info(opts = {})
10861
+ def remove_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts = {})
10337
10862
  if @api_client.config.debugging
10338
- @api_client.config.logger.debug 'Calling API: ManagementApi.okta_event_handler_challenge ...'
10863
+ @api_client.config.logger.debug 'Calling API: ManagementApi.remove_loyalty_points ...'
10864
+ end
10865
+ # verify the required parameter 'loyalty_program_id' is set
10866
+ if @api_client.config.client_side_validation && loyalty_program_id.nil?
10867
+ fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.remove_loyalty_points"
10868
+ end
10869
+ # verify the required parameter 'integration_id' is set
10870
+ if @api_client.config.client_side_validation && integration_id.nil?
10871
+ fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.remove_loyalty_points"
10872
+ end
10873
+ # verify the required parameter 'body' is set
10874
+ if @api_client.config.client_side_validation && body.nil?
10875
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.remove_loyalty_points"
10339
10876
  end
10340
10877
  # resource path
10341
- local_var_path = '/v1/provisioning/okta'
10878
+ local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))
10342
10879
 
10343
10880
  # query parameters
10344
10881
  query_params = opts[:query_params] || {}
10345
10882
 
10346
10883
  # header parameters
10347
10884
  header_params = opts[:header_params] || {}
10885
+ # HTTP header 'Accept' (if needed)
10886
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10887
+ # HTTP header 'Content-Type'
10888
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10348
10889
 
10349
10890
  # form parameters
10350
10891
  form_params = opts[:form_params] || {}
10351
10892
 
10352
10893
  # http body (model)
10353
- post_body = opts[:body]
10894
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
10354
10895
 
10355
10896
  # return_type
10356
10897
  return_type = opts[:return_type]
@@ -10367,44 +10908,38 @@ module TalonOne
10367
10908
  :return_type => return_type
10368
10909
  )
10369
10910
 
10370
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10911
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
10371
10912
  if @api_client.config.debugging
10372
- @api_client.config.logger.debug "API called: ManagementApi#okta_event_handler_challenge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10913
+ @api_client.config.logger.debug "API called: ManagementApi#remove_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10373
10914
  end
10374
10915
  return data, status_code, headers
10375
10916
  end
10376
10917
 
10377
- # Create notification about added or deducted loyalty points
10378
- # 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 [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
10379
- # @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.
10380
- # @param body [NewBaseNotification] body
10918
+ # Reset password
10919
+ # Consumes the supplied password reset token and updates the password for the associated account.
10920
+ # @param body [NewPassword] body
10381
10921
  # @param [Hash] opts the optional parameters
10382
- # @return [BaseNotification]
10383
- def post_added_deducted_points_notification(loyalty_program_id, body, opts = {})
10384
- data, _status_code, _headers = post_added_deducted_points_notification_with_http_info(loyalty_program_id, body, opts)
10922
+ # @return [NewPassword]
10923
+ def reset_password(body, opts = {})
10924
+ data, _status_code, _headers = reset_password_with_http_info(body, opts)
10385
10925
  data
10386
10926
  end
10387
10927
 
10388
- # Create notification about added or deducted loyalty points
10389
- # 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 [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
10390
- # @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.
10391
- # @param body [NewBaseNotification] body
10928
+ # Reset password
10929
+ # Consumes the supplied password reset token and updates the password for the associated account.
10930
+ # @param body [NewPassword] body
10392
10931
  # @param [Hash] opts the optional parameters
10393
- # @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
10394
- def post_added_deducted_points_notification_with_http_info(loyalty_program_id, body, opts = {})
10932
+ # @return [Array<(NewPassword, Integer, Hash)>] NewPassword data, response status code and response headers
10933
+ def reset_password_with_http_info(body, opts = {})
10395
10934
  if @api_client.config.debugging
10396
- @api_client.config.logger.debug 'Calling API: ManagementApi.post_added_deducted_points_notification ...'
10397
- end
10398
- # verify the required parameter 'loyalty_program_id' is set
10399
- if @api_client.config.client_side_validation && loyalty_program_id.nil?
10400
- fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.post_added_deducted_points_notification"
10935
+ @api_client.config.logger.debug 'Calling API: ManagementApi.reset_password ...'
10401
10936
  end
10402
10937
  # verify the required parameter 'body' is set
10403
10938
  if @api_client.config.client_side_validation && body.nil?
10404
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_added_deducted_points_notification"
10939
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.reset_password"
10405
10940
  end
10406
10941
  # resource path
10407
- local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
10942
+ local_var_path = '/v1/reset_password'
10408
10943
 
10409
10944
  # query parameters
10410
10945
  query_params = opts[:query_params] || {}
@@ -10423,7 +10958,7 @@ module TalonOne
10423
10958
  post_body = opts[:body] || @api_client.object_to_http_body(body)
10424
10959
 
10425
10960
  # return_type
10426
- return_type = opts[:return_type] || 'BaseNotification'
10961
+ return_type = opts[:return_type] || 'NewPassword'
10427
10962
 
10428
10963
  # auth_names
10429
10964
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10439,42 +10974,36 @@ module TalonOne
10439
10974
 
10440
10975
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10441
10976
  if @api_client.config.debugging
10442
- @api_client.config.logger.debug "API called: ManagementApi#post_added_deducted_points_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10977
+ @api_client.config.logger.debug "API called: ManagementApi#reset_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10443
10978
  end
10444
10979
  return data, status_code, headers
10445
10980
  end
10446
10981
 
10447
- # Create strikethrough notification
10448
- # Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
10449
- # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
10450
- # @param body [NewBaseNotification] body
10982
+ # Create SCIM group
10983
+ # Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
10984
+ # @param body [ScimBaseGroup] body
10451
10985
  # @param [Hash] opts the optional parameters
10452
- # @return [BaseNotification]
10453
- def post_catalogs_strikethrough_notification(application_id, body, opts = {})
10454
- data, _status_code, _headers = post_catalogs_strikethrough_notification_with_http_info(application_id, body, opts)
10986
+ # @return [ScimGroup]
10987
+ def scim_create_group(body, opts = {})
10988
+ data, _status_code, _headers = scim_create_group_with_http_info(body, opts)
10455
10989
  data
10456
10990
  end
10457
10991
 
10458
- # Create strikethrough notification
10459
- # Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
10460
- # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
10461
- # @param body [NewBaseNotification] body
10992
+ # Create SCIM group
10993
+ # Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
10994
+ # @param body [ScimBaseGroup] body
10462
10995
  # @param [Hash] opts the optional parameters
10463
- # @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
10464
- def post_catalogs_strikethrough_notification_with_http_info(application_id, body, opts = {})
10996
+ # @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
10997
+ def scim_create_group_with_http_info(body, opts = {})
10465
10998
  if @api_client.config.debugging
10466
- @api_client.config.logger.debug 'Calling API: ManagementApi.post_catalogs_strikethrough_notification ...'
10467
- end
10468
- # verify the required parameter 'application_id' is set
10469
- if @api_client.config.client_side_validation && application_id.nil?
10470
- fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.post_catalogs_strikethrough_notification"
10999
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_group ...'
10471
11000
  end
10472
11001
  # verify the required parameter 'body' is set
10473
11002
  if @api_client.config.client_side_validation && body.nil?
10474
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_catalogs_strikethrough_notification"
11003
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_group"
10475
11004
  end
10476
11005
  # resource path
10477
- local_var_path = '/v1/applications/{applicationId}/catalogs/notifications/strikethrough'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))
11006
+ local_var_path = '/v1/provisioning/scim/Groups'
10478
11007
 
10479
11008
  # query parameters
10480
11009
  query_params = opts[:query_params] || {}
@@ -10493,7 +11022,7 @@ module TalonOne
10493
11022
  post_body = opts[:body] || @api_client.object_to_http_body(body)
10494
11023
 
10495
11024
  # return_type
10496
- return_type = opts[:return_type] || 'BaseNotification'
11025
+ return_type = opts[:return_type] || 'ScimGroup'
10497
11026
 
10498
11027
  # auth_names
10499
11028
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10509,42 +11038,36 @@ module TalonOne
10509
11038
 
10510
11039
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10511
11040
  if @api_client.config.debugging
10512
- @api_client.config.logger.debug "API called: ManagementApi#post_catalogs_strikethrough_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11041
+ @api_client.config.logger.debug "API called: ManagementApi#scim_create_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10513
11042
  end
10514
11043
  return data, status_code, headers
10515
11044
  end
10516
11045
 
10517
- # Create notification about pending loyalty points
10518
- # Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
10519
- # @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.
10520
- # @param body [NewBaseNotification] body
11046
+ # Create SCIM user
11047
+ # Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
11048
+ # @param body [ScimNewUser] body
10521
11049
  # @param [Hash] opts the optional parameters
10522
- # @return [BaseNotification]
10523
- def post_pending_points_notification(loyalty_program_id, body, opts = {})
10524
- data, _status_code, _headers = post_pending_points_notification_with_http_info(loyalty_program_id, body, opts)
11050
+ # @return [ScimUser]
11051
+ def scim_create_user(body, opts = {})
11052
+ data, _status_code, _headers = scim_create_user_with_http_info(body, opts)
10525
11053
  data
10526
11054
  end
10527
11055
 
10528
- # Create notification about pending loyalty points
10529
- # Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
10530
- # @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.
10531
- # @param body [NewBaseNotification] body
11056
+ # Create SCIM user
11057
+ # Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
11058
+ # @param body [ScimNewUser] body
10532
11059
  # @param [Hash] opts the optional parameters
10533
- # @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
10534
- def post_pending_points_notification_with_http_info(loyalty_program_id, body, opts = {})
11060
+ # @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
11061
+ def scim_create_user_with_http_info(body, opts = {})
10535
11062
  if @api_client.config.debugging
10536
- @api_client.config.logger.debug 'Calling API: ManagementApi.post_pending_points_notification ...'
10537
- end
10538
- # verify the required parameter 'loyalty_program_id' is set
10539
- if @api_client.config.client_side_validation && loyalty_program_id.nil?
10540
- fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.post_pending_points_notification"
11063
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_user ...'
10541
11064
  end
10542
11065
  # verify the required parameter 'body' is set
10543
11066
  if @api_client.config.client_side_validation && body.nil?
10544
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_pending_points_notification"
11067
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_user"
10545
11068
  end
10546
11069
  # resource path
10547
- local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
11070
+ local_var_path = '/v1/provisioning/scim/Users'
10548
11071
 
10549
11072
  # query parameters
10550
11073
  query_params = opts[:query_params] || {}
@@ -10563,7 +11086,7 @@ module TalonOne
10563
11086
  post_body = opts[:body] || @api_client.object_to_http_body(body)
10564
11087
 
10565
11088
  # return_type
10566
- return_type = opts[:return_type] || 'BaseNotification'
11089
+ return_type = opts[:return_type] || 'ScimUser'
10567
11090
 
10568
11091
  # auth_names
10569
11092
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10579,64 +11102,48 @@ module TalonOne
10579
11102
 
10580
11103
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10581
11104
  if @api_client.config.debugging
10582
- @api_client.config.logger.debug "API called: ManagementApi#post_pending_points_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11105
+ @api_client.config.logger.debug "API called: ManagementApi#scim_create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10583
11106
  end
10584
11107
  return data, status_code, headers
10585
11108
  end
10586
11109
 
10587
- # Deduct points from customer profile
10588
- # Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
10589
- # @param loyalty_program_id [String] The identifier for the loyalty program.
10590
- # @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
10591
- # @param body [DeductLoyaltyPoints] body
11110
+ # Delete SCIM group
11111
+ # Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11112
+ # @param group_id [Integer] The ID of the group.
10592
11113
  # @param [Hash] opts the optional parameters
10593
11114
  # @return [nil]
10594
- def remove_loyalty_points(loyalty_program_id, integration_id, body, opts = {})
10595
- remove_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts)
11115
+ def scim_delete_group(group_id, opts = {})
11116
+ scim_delete_group_with_http_info(group_id, opts)
10596
11117
  nil
10597
11118
  end
10598
11119
 
10599
- # Deduct points from customer profile
10600
- # Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the &#x60;integrationId&#x60; of the profile from a &#x60;sessionId&#x60;, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
10601
- # @param loyalty_program_id [String] The identifier for the loyalty program.
10602
- # @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
10603
- # @param body [DeductLoyaltyPoints] body
11120
+ # Delete SCIM group
11121
+ # Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11122
+ # @param group_id [Integer] The ID of the group.
10604
11123
  # @param [Hash] opts the optional parameters
10605
11124
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
10606
- def remove_loyalty_points_with_http_info(loyalty_program_id, integration_id, body, opts = {})
11125
+ def scim_delete_group_with_http_info(group_id, opts = {})
10607
11126
  if @api_client.config.debugging
10608
- @api_client.config.logger.debug 'Calling API: ManagementApi.remove_loyalty_points ...'
10609
- end
10610
- # verify the required parameter 'loyalty_program_id' is set
10611
- if @api_client.config.client_side_validation && loyalty_program_id.nil?
10612
- fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.remove_loyalty_points"
10613
- end
10614
- # verify the required parameter 'integration_id' is set
10615
- if @api_client.config.client_side_validation && integration_id.nil?
10616
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.remove_loyalty_points"
11127
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_group ...'
10617
11128
  end
10618
- # verify the required parameter 'body' is set
10619
- if @api_client.config.client_side_validation && body.nil?
10620
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.remove_loyalty_points"
11129
+ # verify the required parameter 'group_id' is set
11130
+ if @api_client.config.client_side_validation && group_id.nil?
11131
+ fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_delete_group"
10621
11132
  end
10622
11133
  # resource path
10623
- local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))
11134
+ local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
10624
11135
 
10625
11136
  # query parameters
10626
11137
  query_params = opts[:query_params] || {}
10627
11138
 
10628
11139
  # header parameters
10629
11140
  header_params = opts[:header_params] || {}
10630
- # HTTP header 'Accept' (if needed)
10631
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10632
- # HTTP header 'Content-Type'
10633
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10634
11141
 
10635
11142
  # form parameters
10636
11143
  form_params = opts[:form_params] || {}
10637
11144
 
10638
11145
  # http body (model)
10639
- post_body = opts[:body] || @api_client.object_to_http_body(body)
11146
+ post_body = opts[:body]
10640
11147
 
10641
11148
  # return_type
10642
11149
  return_type = opts[:return_type]
@@ -10653,57 +11160,53 @@ module TalonOne
10653
11160
  :return_type => return_type
10654
11161
  )
10655
11162
 
10656
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
11163
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
10657
11164
  if @api_client.config.debugging
10658
- @api_client.config.logger.debug "API called: ManagementApi#remove_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11165
+ @api_client.config.logger.debug "API called: ManagementApi#scim_delete_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10659
11166
  end
10660
11167
  return data, status_code, headers
10661
11168
  end
10662
11169
 
10663
- # Reset password
10664
- # Consumes the supplied password reset token and updates the password for the associated account.
10665
- # @param body [NewPassword] body
11170
+ # Delete SCIM user
11171
+ # Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
11172
+ # @param user_id [Integer] The ID of the user.
10666
11173
  # @param [Hash] opts the optional parameters
10667
- # @return [NewPassword]
10668
- def reset_password(body, opts = {})
10669
- data, _status_code, _headers = reset_password_with_http_info(body, opts)
10670
- data
11174
+ # @return [nil]
11175
+ def scim_delete_user(user_id, opts = {})
11176
+ scim_delete_user_with_http_info(user_id, opts)
11177
+ nil
10671
11178
  end
10672
11179
 
10673
- # Reset password
10674
- # Consumes the supplied password reset token and updates the password for the associated account.
10675
- # @param body [NewPassword] body
11180
+ # Delete SCIM user
11181
+ # Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
11182
+ # @param user_id [Integer] The ID of the user.
10676
11183
  # @param [Hash] opts the optional parameters
10677
- # @return [Array<(NewPassword, Integer, Hash)>] NewPassword data, response status code and response headers
10678
- def reset_password_with_http_info(body, opts = {})
11184
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
11185
+ def scim_delete_user_with_http_info(user_id, opts = {})
10679
11186
  if @api_client.config.debugging
10680
- @api_client.config.logger.debug 'Calling API: ManagementApi.reset_password ...'
11187
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_user ...'
10681
11188
  end
10682
- # verify the required parameter 'body' is set
10683
- if @api_client.config.client_side_validation && body.nil?
10684
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.reset_password"
11189
+ # verify the required parameter 'user_id' is set
11190
+ if @api_client.config.client_side_validation && user_id.nil?
11191
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_delete_user"
10685
11192
  end
10686
11193
  # resource path
10687
- local_var_path = '/v1/reset_password'
11194
+ local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
10688
11195
 
10689
11196
  # query parameters
10690
11197
  query_params = opts[:query_params] || {}
10691
11198
 
10692
11199
  # header parameters
10693
11200
  header_params = opts[:header_params] || {}
10694
- # HTTP header 'Accept' (if needed)
10695
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10696
- # HTTP header 'Content-Type'
10697
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10698
11201
 
10699
11202
  # form parameters
10700
11203
  form_params = opts[:form_params] || {}
10701
11204
 
10702
11205
  # http body (model)
10703
- post_body = opts[:body] || @api_client.object_to_http_body(body)
11206
+ post_body = opts[:body]
10704
11207
 
10705
11208
  # return_type
10706
- return_type = opts[:return_type] || 'NewPassword'
11209
+ return_type = opts[:return_type]
10707
11210
 
10708
11211
  # auth_names
10709
11212
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10717,38 +11220,38 @@ module TalonOne
10717
11220
  :return_type => return_type
10718
11221
  )
10719
11222
 
10720
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11223
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
10721
11224
  if @api_client.config.debugging
10722
- @api_client.config.logger.debug "API called: ManagementApi#reset_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11225
+ @api_client.config.logger.debug "API called: ManagementApi#scim_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10723
11226
  end
10724
11227
  return data, status_code, headers
10725
11228
  end
10726
11229
 
10727
- # Create SCIM user
10728
- # Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
10729
- # @param body [ScimNewUser] body
11230
+ # Get SCIM group
11231
+ # Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11232
+ # @param group_id [Integer] The ID of the group.
10730
11233
  # @param [Hash] opts the optional parameters
10731
- # @return [ScimUser]
10732
- def scim_create_user(body, opts = {})
10733
- data, _status_code, _headers = scim_create_user_with_http_info(body, opts)
11234
+ # @return [ScimGroup]
11235
+ def scim_get_group(group_id, opts = {})
11236
+ data, _status_code, _headers = scim_get_group_with_http_info(group_id, opts)
10734
11237
  data
10735
11238
  end
10736
11239
 
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
11240
+ # Get SCIM group
11241
+ # Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11242
+ # @param group_id [Integer] The ID of the group.
10740
11243
  # @param [Hash] opts the optional parameters
10741
- # @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
10742
- def scim_create_user_with_http_info(body, opts = {})
11244
+ # @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
11245
+ def scim_get_group_with_http_info(group_id, opts = {})
10743
11246
  if @api_client.config.debugging
10744
- @api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_user ...'
11247
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_group ...'
10745
11248
  end
10746
- # verify the required parameter 'body' is set
10747
- if @api_client.config.client_side_validation && body.nil?
10748
- fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_user"
11249
+ # verify the required parameter 'group_id' is set
11250
+ if @api_client.config.client_side_validation && group_id.nil?
11251
+ fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_get_group"
10749
11252
  end
10750
11253
  # resource path
10751
- local_var_path = '/v1/provisioning/scim/Users'
11254
+ local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
10752
11255
 
10753
11256
  # query parameters
10754
11257
  query_params = opts[:query_params] || {}
@@ -10757,17 +11260,15 @@ module TalonOne
10757
11260
  header_params = opts[:header_params] || {}
10758
11261
  # HTTP header 'Accept' (if needed)
10759
11262
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10760
- # HTTP header 'Content-Type'
10761
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10762
11263
 
10763
11264
  # form parameters
10764
11265
  form_params = opts[:form_params] || {}
10765
11266
 
10766
11267
  # http body (model)
10767
- post_body = opts[:body] || @api_client.object_to_http_body(body)
11268
+ post_body = opts[:body]
10768
11269
 
10769
11270
  # return_type
10770
- return_type = opts[:return_type] || 'ScimUser'
11271
+ return_type = opts[:return_type] || 'ScimGroup'
10771
11272
 
10772
11273
  # auth_names
10773
11274
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10781,44 +11282,40 @@ module TalonOne
10781
11282
  :return_type => return_type
10782
11283
  )
10783
11284
 
10784
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11285
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10785
11286
  if @api_client.config.debugging
10786
- @api_client.config.logger.debug "API called: ManagementApi#scim_create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11287
+ @api_client.config.logger.debug "API called: ManagementApi#scim_get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10787
11288
  end
10788
11289
  return data, status_code, headers
10789
11290
  end
10790
11291
 
10791
- # Delete SCIM user
10792
- # Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
10793
- # @param user_id [Integer] The ID of the user.
11292
+ # List SCIM groups
11293
+ # Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
10794
11294
  # @param [Hash] opts the optional parameters
10795
- # @return [nil]
10796
- def scim_delete_user(user_id, opts = {})
10797
- scim_delete_user_with_http_info(user_id, opts)
10798
- nil
11295
+ # @return [ScimGroupsListResponse]
11296
+ def scim_get_groups(opts = {})
11297
+ data, _status_code, _headers = scim_get_groups_with_http_info(opts)
11298
+ data
10799
11299
  end
10800
11300
 
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.
11301
+ # List SCIM groups
11302
+ # Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
10804
11303
  # @param [Hash] opts the optional parameters
10805
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
10806
- def scim_delete_user_with_http_info(user_id, opts = {})
11304
+ # @return [Array<(ScimGroupsListResponse, Integer, Hash)>] ScimGroupsListResponse data, response status code and response headers
11305
+ def scim_get_groups_with_http_info(opts = {})
10807
11306
  if @api_client.config.debugging
10808
- @api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_user ...'
10809
- end
10810
- # verify the required parameter 'user_id' is set
10811
- if @api_client.config.client_side_validation && user_id.nil?
10812
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_delete_user"
11307
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_groups ...'
10813
11308
  end
10814
11309
  # resource path
10815
- local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
11310
+ local_var_path = '/v1/provisioning/scim/Groups'
10816
11311
 
10817
11312
  # query parameters
10818
11313
  query_params = opts[:query_params] || {}
10819
11314
 
10820
11315
  # header parameters
10821
11316
  header_params = opts[:header_params] || {}
11317
+ # HTTP header 'Accept' (if needed)
11318
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10822
11319
 
10823
11320
  # form parameters
10824
11321
  form_params = opts[:form_params] || {}
@@ -10827,7 +11324,7 @@ module TalonOne
10827
11324
  post_body = opts[:body]
10828
11325
 
10829
11326
  # return_type
10830
- return_type = opts[:return_type]
11327
+ return_type = opts[:return_type] || 'ScimGroupsListResponse'
10831
11328
 
10832
11329
  # auth_names
10833
11330
  auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
@@ -10841,9 +11338,9 @@ module TalonOne
10841
11338
  :return_type => return_type
10842
11339
  )
10843
11340
 
10844
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
11341
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10845
11342
  if @api_client.config.debugging
10846
- @api_client.config.logger.debug "API called: ManagementApi#scim_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11343
+ @api_client.config.logger.debug "API called: ManagementApi#scim_get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10847
11344
  end
10848
11345
  return data, status_code, headers
10849
11346
  end
@@ -11134,6 +11631,76 @@ module TalonOne
11134
11631
  return data, status_code, headers
11135
11632
  end
11136
11633
 
11634
+ # Update SCIM group attributes
11635
+ # Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11636
+ # @param group_id [Integer] The ID of the group.
11637
+ # @param body [ScimPatchRequest] body
11638
+ # @param [Hash] opts the optional parameters
11639
+ # @return [ScimGroup]
11640
+ def scim_patch_group(group_id, body, opts = {})
11641
+ data, _status_code, _headers = scim_patch_group_with_http_info(group_id, body, opts)
11642
+ data
11643
+ end
11644
+
11645
+ # Update SCIM group attributes
11646
+ # Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11647
+ # @param group_id [Integer] The ID of the group.
11648
+ # @param body [ScimPatchRequest] body
11649
+ # @param [Hash] opts the optional parameters
11650
+ # @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
11651
+ def scim_patch_group_with_http_info(group_id, body, opts = {})
11652
+ if @api_client.config.debugging
11653
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_patch_group ...'
11654
+ end
11655
+ # verify the required parameter 'group_id' is set
11656
+ if @api_client.config.client_side_validation && group_id.nil?
11657
+ fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_patch_group"
11658
+ end
11659
+ # verify the required parameter 'body' is set
11660
+ if @api_client.config.client_side_validation && body.nil?
11661
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_patch_group"
11662
+ end
11663
+ # resource path
11664
+ local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
11665
+
11666
+ # query parameters
11667
+ query_params = opts[:query_params] || {}
11668
+
11669
+ # header parameters
11670
+ header_params = opts[:header_params] || {}
11671
+ # HTTP header 'Accept' (if needed)
11672
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11673
+ # HTTP header 'Content-Type'
11674
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
11675
+
11676
+ # form parameters
11677
+ form_params = opts[:form_params] || {}
11678
+
11679
+ # http body (model)
11680
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
11681
+
11682
+ # return_type
11683
+ return_type = opts[:return_type] || 'ScimGroup'
11684
+
11685
+ # auth_names
11686
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
11687
+
11688
+ new_options = opts.merge(
11689
+ :header_params => header_params,
11690
+ :query_params => query_params,
11691
+ :form_params => form_params,
11692
+ :body => post_body,
11693
+ :auth_names => auth_names,
11694
+ :return_type => return_type
11695
+ )
11696
+
11697
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
11698
+ if @api_client.config.debugging
11699
+ @api_client.config.logger.debug "API called: ManagementApi#scim_patch_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11700
+ end
11701
+ return data, status_code, headers
11702
+ end
11703
+
11137
11704
  # Update SCIM user attributes
11138
11705
  # 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.
11139
11706
  # @param user_id [Integer] The ID of the user.
@@ -11204,6 +11771,76 @@ module TalonOne
11204
11771
  return data, status_code, headers
11205
11772
  end
11206
11773
 
11774
+ # Update SCIM group
11775
+ # Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11776
+ # @param group_id [Integer] The ID of the group.
11777
+ # @param body [ScimBaseGroup] body
11778
+ # @param [Hash] opts the optional parameters
11779
+ # @return [ScimGroup]
11780
+ def scim_replace_group_attributes(group_id, body, opts = {})
11781
+ data, _status_code, _headers = scim_replace_group_attributes_with_http_info(group_id, body, opts)
11782
+ data
11783
+ end
11784
+
11785
+ # Update SCIM group
11786
+ # Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a &#x60;Group&#x60; corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and &#x60;members&#x60; are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
11787
+ # @param group_id [Integer] The ID of the group.
11788
+ # @param body [ScimBaseGroup] body
11789
+ # @param [Hash] opts the optional parameters
11790
+ # @return [Array<(ScimGroup, Integer, Hash)>] ScimGroup data, response status code and response headers
11791
+ def scim_replace_group_attributes_with_http_info(group_id, body, opts = {})
11792
+ if @api_client.config.debugging
11793
+ @api_client.config.logger.debug 'Calling API: ManagementApi.scim_replace_group_attributes ...'
11794
+ end
11795
+ # verify the required parameter 'group_id' is set
11796
+ if @api_client.config.client_side_validation && group_id.nil?
11797
+ fail ArgumentError, "Missing the required parameter 'group_id' when calling ManagementApi.scim_replace_group_attributes"
11798
+ end
11799
+ # verify the required parameter 'body' is set
11800
+ if @api_client.config.client_side_validation && body.nil?
11801
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_replace_group_attributes"
11802
+ end
11803
+ # resource path
11804
+ local_var_path = '/v1/provisioning/scim/Groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
11805
+
11806
+ # query parameters
11807
+ query_params = opts[:query_params] || {}
11808
+
11809
+ # header parameters
11810
+ header_params = opts[:header_params] || {}
11811
+ # HTTP header 'Accept' (if needed)
11812
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11813
+ # HTTP header 'Content-Type'
11814
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
11815
+
11816
+ # form parameters
11817
+ form_params = opts[:form_params] || {}
11818
+
11819
+ # http body (model)
11820
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
11821
+
11822
+ # return_type
11823
+ return_type = opts[:return_type] || 'ScimGroup'
11824
+
11825
+ # auth_names
11826
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
11827
+
11828
+ new_options = opts.merge(
11829
+ :header_params => header_params,
11830
+ :query_params => query_params,
11831
+ :form_params => form_params,
11832
+ :body => post_body,
11833
+ :auth_names => auth_names,
11834
+ :return_type => return_type
11835
+ )
11836
+
11837
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
11838
+ if @api_client.config.debugging
11839
+ @api_client.config.logger.debug "API called: ManagementApi#scim_replace_group_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11840
+ end
11841
+ return data, status_code, headers
11842
+ end
11843
+
11207
11844
  # Update SCIM user
11208
11845
  # 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.
11209
11846
  # @param user_id [Integer] The ID of the user.
@@ -11281,7 +11918,7 @@ module TalonOne
11281
11918
  # @param [Hash] opts the optional parameters
11282
11919
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
11283
11920
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11284
- # @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.
11921
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
11285
11922
  # @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.
11286
11923
  # @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.
11287
11924
  # @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.
@@ -11305,7 +11942,7 @@ module TalonOne
11305
11942
  # @param [Hash] opts the optional parameters
11306
11943
  # @option opts [Integer] :page_size The number of items in the response.
11307
11944
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11308
- # @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.
11945
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
11309
11946
  # @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.
11310
11947
  # @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.
11311
11948
  # @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.
@@ -11411,7 +12048,7 @@ module TalonOne
11411
12048
  # @param [Hash] opts the optional parameters
11412
12049
  # @option opts [Integer] :page_size The number of items in the response. (default to 1000)
11413
12050
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11414
- # @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.
12051
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
11415
12052
  # @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.
11416
12053
  # @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.
11417
12054
  # @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.
@@ -11435,7 +12072,7 @@ module TalonOne
11435
12072
  # @param [Hash] opts the optional parameters
11436
12073
  # @option opts [Integer] :page_size The number of items in the response.
11437
12074
  # @option opts [Integer] :skip The number of items to skip when paging through large result sets.
11438
- # @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.
12075
+ # @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:** You may not be able to use all fields for sorting. This is due to performance limitations.
11439
12076
  # @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.
11440
12077
  # @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.
11441
12078
  # @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.
@@ -11531,6 +12168,74 @@ module TalonOne
11531
12168
  return data, status_code, headers
11532
12169
  end
11533
12170
 
12171
+ # Get summary of campaign store budgets
12172
+ # Fetch a summary of all store budget information for a given campaign.
12173
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
12174
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
12175
+ # @param [Hash] opts the optional parameters
12176
+ # @return [InlineResponse20049]
12177
+ def summarize_campaign_store_budget(application_id, campaign_id, opts = {})
12178
+ data, _status_code, _headers = summarize_campaign_store_budget_with_http_info(application_id, campaign_id, opts)
12179
+ data
12180
+ end
12181
+
12182
+ # Get summary of campaign store budgets
12183
+ # Fetch a summary of all store budget information for a given campaign.
12184
+ # @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
12185
+ # @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
12186
+ # @param [Hash] opts the optional parameters
12187
+ # @return [Array<(InlineResponse20049, Integer, Hash)>] InlineResponse20049 data, response status code and response headers
12188
+ def summarize_campaign_store_budget_with_http_info(application_id, campaign_id, opts = {})
12189
+ if @api_client.config.debugging
12190
+ @api_client.config.logger.debug 'Calling API: ManagementApi.summarize_campaign_store_budget ...'
12191
+ end
12192
+ # verify the required parameter 'application_id' is set
12193
+ if @api_client.config.client_side_validation && application_id.nil?
12194
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.summarize_campaign_store_budget"
12195
+ end
12196
+ # verify the required parameter 'campaign_id' is set
12197
+ if @api_client.config.client_side_validation && campaign_id.nil?
12198
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.summarize_campaign_store_budget"
12199
+ end
12200
+ # resource path
12201
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
12202
+
12203
+ # query parameters
12204
+ query_params = opts[:query_params] || {}
12205
+
12206
+ # header parameters
12207
+ header_params = opts[:header_params] || {}
12208
+ # HTTP header 'Accept' (if needed)
12209
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12210
+
12211
+ # form parameters
12212
+ form_params = opts[:form_params] || {}
12213
+
12214
+ # http body (model)
12215
+ post_body = opts[:body]
12216
+
12217
+ # return_type
12218
+ return_type = opts[:return_type] || 'InlineResponse20049'
12219
+
12220
+ # auth_names
12221
+ auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
12222
+
12223
+ new_options = opts.merge(
12224
+ :header_params => header_params,
12225
+ :query_params => query_params,
12226
+ :form_params => form_params,
12227
+ :body => post_body,
12228
+ :auth_names => auth_names,
12229
+ :return_type => return_type
12230
+ )
12231
+
12232
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
12233
+ if @api_client.config.debugging
12234
+ @api_client.config.logger.debug "API called: ManagementApi#summarize_campaign_store_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12235
+ end
12236
+ return data, status_code, headers
12237
+ end
12238
+
11534
12239
  # Transfer card data
11535
12240
  # Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
11536
12241
  # @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.