talon_one 2.2.0 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (134) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +22 -12
  3. data/docs/AddLoyaltyPointsEffectProps.md +3 -1
  4. data/docs/Application.md +2 -0
  5. data/docs/ApplicationEvent.md +3 -1
  6. data/docs/Binding.md +2 -0
  7. data/docs/Campaign.md +11 -1
  8. data/docs/CartItem.md +1 -3
  9. data/docs/Change.md +2 -0
  10. data/docs/CustomerProfileIntegrationRequestV2.md +3 -1
  11. data/docs/DeductLoyaltyPointsEffectProps.md +3 -1
  12. data/docs/Effect.md +2 -0
  13. data/docs/EffectEntity.md +3 -1
  14. data/docs/Import.md +1 -1
  15. data/docs/InlineResponse20020.md +2 -2
  16. data/docs/InlineResponse20021.md +1 -1
  17. data/docs/InlineResponse20022.md +1 -1
  18. data/docs/InlineResponse20023.md +1 -1
  19. data/docs/InlineResponse20024.md +1 -1
  20. data/docs/InlineResponse20025.md +1 -1
  21. data/docs/InlineResponse20026.md +1 -1
  22. data/docs/InlineResponse20027.md +2 -4
  23. data/docs/InlineResponse20028.md +4 -2
  24. data/docs/InlineResponse20029.md +1 -1
  25. data/docs/IntegrationApi.md +27 -27
  26. data/docs/IntegrationRequest.md +1 -1
  27. data/docs/IntegrationStateV2.md +2 -0
  28. data/docs/LoyaltyProgramBalance.md +10 -2
  29. data/docs/LoyaltyProgramLedgers.md +3 -1
  30. data/docs/LoyaltySubLedger.md +1 -1
  31. data/docs/ManagementApi.md +623 -169
  32. data/docs/NewApplication.md +2 -0
  33. data/docs/NewCoupons.md +5 -5
  34. data/docs/NewCouponsForMultipleRecipients.md +31 -0
  35. data/docs/ProfileAudiencesChanges.md +19 -0
  36. data/docs/RejectCouponEffectProps.md +7 -1
  37. data/docs/RejectReferralEffectProps.md +7 -1
  38. data/docs/RollbackAddedLoyaltyPointsEffectProps.md +25 -0
  39. data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +29 -0
  40. data/docs/RollbackReferralEffectProps.md +17 -0
  41. data/docs/RuleFailureReason.md +39 -0
  42. data/docs/UpdateApplication.md +2 -0
  43. data/lib/talon_one.rb +6 -3
  44. data/lib/talon_one/api/integration_api.rb +30 -30
  45. data/lib/talon_one/api/management_api.rb +816 -242
  46. data/lib/talon_one/models/add_loyalty_points_effect_props.rb +19 -4
  47. data/lib/talon_one/models/application.rb +23 -1
  48. data/lib/talon_one/models/application_api_key.rb +2 -2
  49. data/lib/talon_one/models/application_event.rb +16 -4
  50. data/lib/talon_one/models/binding.rb +11 -1
  51. data/lib/talon_one/models/campaign.rb +52 -2
  52. data/lib/talon_one/models/cart_item.rb +4 -13
  53. data/lib/talon_one/models/change.rb +11 -1
  54. data/lib/talon_one/models/code_generator_settings.rb +9 -0
  55. data/lib/talon_one/models/create_application_api_key.rb +2 -2
  56. data/lib/talon_one/models/customer_profile_integration_request_v2.rb +11 -2
  57. data/lib/talon_one/models/customer_session.rb +38 -0
  58. data/lib/talon_one/models/customer_session_v2.rb +15 -0
  59. data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +19 -4
  60. data/lib/talon_one/models/effect.rb +11 -1
  61. data/lib/talon_one/models/effect_entity.rb +14 -4
  62. data/lib/talon_one/models/import.rb +1 -35
  63. data/lib/talon_one/models/inline_response20020.rb +1 -6
  64. data/lib/talon_one/models/inline_response20021.rb +1 -1
  65. data/lib/talon_one/models/inline_response20022.rb +1 -1
  66. data/lib/talon_one/models/inline_response20023.rb +1 -1
  67. data/lib/talon_one/models/inline_response20024.rb +1 -1
  68. data/lib/talon_one/models/inline_response20025.rb +1 -1
  69. data/lib/talon_one/models/inline_response20026.rb +1 -1
  70. data/lib/talon_one/models/inline_response20027.rb +7 -11
  71. data/lib/talon_one/models/inline_response20028.rb +11 -7
  72. data/lib/talon_one/models/inline_response20029.rb +1 -1
  73. data/lib/talon_one/models/integration_request.rb +1 -1
  74. data/lib/talon_one/models/integration_state_v2.rb +12 -1
  75. data/lib/talon_one/models/limit_config.rb +0 -12
  76. data/lib/talon_one/models/loyalty_points.rb +28 -0
  77. data/lib/talon_one/models/loyalty_program_balance.rb +65 -4
  78. data/lib/talon_one/models/loyalty_program_ledgers.rb +16 -1
  79. data/lib/talon_one/models/loyalty_sub_ledger.rb +1 -1
  80. data/lib/talon_one/models/new_application.rb +23 -1
  81. data/lib/talon_one/models/new_application_api_key.rb +2 -2
  82. data/lib/talon_one/models/new_coupons.rb +36 -41
  83. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +368 -0
  84. data/lib/talon_one/models/new_customer_session.rb +30 -0
  85. data/lib/talon_one/models/new_customer_session_v2.rb +15 -0
  86. data/lib/talon_one/models/{new_import.rb → profile_audiences_changes.rb} +32 -48
  87. data/lib/talon_one/models/reject_coupon_effect_props.rb +34 -4
  88. data/lib/talon_one/models/reject_referral_effect_props.rb +34 -4
  89. data/lib/talon_one/models/{cart_item_adjustment.rb → rollback_added_loyalty_points_effect_props.rb} +63 -61
  90. data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +293 -0
  91. data/lib/talon_one/models/{import_coupons.rb → rollback_referral_effect_props.rb} +15 -13
  92. data/lib/talon_one/models/rule_failure_reason.rb +343 -0
  93. data/lib/talon_one/models/update_application.rb +23 -1
  94. data/lib/talon_one/version.rb +1 -1
  95. data/spec/api/integration_api_spec.rb +15 -15
  96. data/spec/api/management_api_spec.rb +183 -68
  97. data/spec/models/add_loyalty_points_effect_props_spec.rb +6 -0
  98. data/spec/models/application_api_key_spec.rb +1 -1
  99. data/spec/models/application_event_spec.rb +6 -0
  100. data/spec/models/application_spec.rb +10 -0
  101. data/spec/models/binding_spec.rb +6 -0
  102. data/spec/models/campaign_spec.rb +30 -0
  103. data/spec/models/cart_item_spec.rb +0 -6
  104. data/spec/models/change_spec.rb +6 -0
  105. data/spec/models/create_application_api_key_spec.rb +1 -1
  106. data/spec/models/customer_profile_integration_request_v2_spec.rb +7 -1
  107. data/spec/models/deduct_loyalty_points_effect_props_spec.rb +6 -0
  108. data/spec/models/effect_entity_spec.rb +6 -0
  109. data/spec/models/effect_spec.rb +6 -0
  110. data/spec/models/import_spec.rb +0 -4
  111. data/spec/models/inline_response20027_spec.rb +0 -6
  112. data/spec/models/inline_response20028_spec.rb +6 -0
  113. data/spec/models/integration_request_spec.rb +1 -1
  114. data/spec/models/integration_state_v2_spec.rb +6 -0
  115. data/spec/models/limit_config_spec.rb +0 -4
  116. data/spec/models/loyalty_program_balance_spec.rb +24 -0
  117. data/spec/models/loyalty_program_ledgers_spec.rb +6 -0
  118. data/spec/models/new_application_api_key_spec.rb +1 -1
  119. data/spec/models/new_application_spec.rb +10 -0
  120. data/spec/models/new_coupons_for_multiple_recipients_spec.rb +83 -0
  121. data/spec/models/new_coupons_spec.rb +6 -6
  122. data/spec/models/{cart_item_adjustment_spec.rb → profile_audiences_changes_spec.rb} +8 -14
  123. data/spec/models/reject_coupon_effect_props_spec.rb +18 -0
  124. data/spec/models/reject_referral_effect_props_spec.rb +18 -0
  125. data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +65 -0
  126. data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +77 -0
  127. data/spec/models/{import_coupons_spec.rb → rollback_referral_effect_props_spec.rb} +7 -7
  128. data/spec/models/rule_failure_reason_spec.rb +107 -0
  129. data/spec/models/update_application_spec.rb +10 -0
  130. metadata +26 -14
  131. data/docs/CartItemAdjustment.md +0 -21
  132. data/docs/ImportCoupons.md +0 -17
  133. data/docs/NewImport.md +0 -17
  134. data/spec/models/new_import_spec.rb +0 -45
@@ -442,6 +442,85 @@ module TalonOne
442
442
  return data, status_code, headers
443
443
  end
444
444
 
445
+ # Create Coupons for Multiple Recipients
446
+ # Create coupons according to some pattern for up to 1000 recipients.
447
+ # @param application_id [Integer]
448
+ # @param campaign_id [Integer]
449
+ # @param body [NewCouponsForMultipleRecipients]
450
+ # @param [Hash] opts the optional parameters
451
+ # @option opts [String] :silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
452
+ # @return [InlineResponse2004]
453
+ def create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {})
454
+ data, _status_code, _headers = create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts)
455
+ data
456
+ end
457
+
458
+ # Create Coupons for Multiple Recipients
459
+ # Create coupons according to some pattern for up to 1000 recipients.
460
+ # @param application_id [Integer]
461
+ # @param campaign_id [Integer]
462
+ # @param body [NewCouponsForMultipleRecipients]
463
+ # @param [Hash] opts the optional parameters
464
+ # @option opts [String] :silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
465
+ # @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
466
+ def create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {})
467
+ if @api_client.config.debugging
468
+ @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_for_multiple_recipients ...'
469
+ end
470
+ # verify the required parameter 'application_id' is set
471
+ if @api_client.config.client_side_validation && application_id.nil?
472
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons_for_multiple_recipients"
473
+ end
474
+ # verify the required parameter 'campaign_id' is set
475
+ if @api_client.config.client_side_validation && campaign_id.nil?
476
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons_for_multiple_recipients"
477
+ end
478
+ # verify the required parameter 'body' is set
479
+ if @api_client.config.client_side_validation && body.nil?
480
+ fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons_for_multiple_recipients"
481
+ end
482
+ # resource path
483
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
484
+
485
+ # query parameters
486
+ query_params = opts[:query_params] || {}
487
+ query_params[:'silent'] = opts[:'silent'] if !opts[:'silent'].nil?
488
+
489
+ # header parameters
490
+ header_params = opts[:header_params] || {}
491
+ # HTTP header 'Accept' (if needed)
492
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
493
+ # HTTP header 'Content-Type'
494
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
495
+
496
+ # form parameters
497
+ form_params = opts[:form_params] || {}
498
+
499
+ # http body (model)
500
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
501
+
502
+ # return_type
503
+ return_type = opts[:return_type] || 'InlineResponse2004'
504
+
505
+ # auth_names
506
+ auth_names = opts[:auth_names] || ['manager_auth']
507
+
508
+ new_options = opts.merge(
509
+ :header_params => header_params,
510
+ :query_params => query_params,
511
+ :form_params => form_params,
512
+ :body => post_body,
513
+ :auth_names => auth_names,
514
+ :return_type => return_type
515
+ )
516
+
517
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
518
+ if @api_client.config.debugging
519
+ @api_client.config.logger.debug "API called: ManagementApi#create_coupons_for_multiple_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
520
+ end
521
+ return data, status_code, headers
522
+ end
523
+
445
524
  # Request a password reset
446
525
  # Sends an email with a password recovery link to the email of an existing account.
447
526
  # @param body [NewPasswordEmail]
@@ -781,12 +860,12 @@ module TalonOne
781
860
  # @param campaign_id [Integer]
782
861
  # @param [Hash] opts the optional parameters
783
862
  # @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.
784
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
785
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
786
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
787
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
788
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
789
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
863
+ # @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 timezone. Talon.One will convert to UTC internally.
864
+ # @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 timezone. Talon.One will convert to UTC internally.
865
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
866
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
867
+ # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
868
+ # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
790
869
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
791
870
  # @option opts [String] :batch_id Filter results by batches of coupons
792
871
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
@@ -804,12 +883,12 @@ module TalonOne
804
883
  # @param campaign_id [Integer]
805
884
  # @param [Hash] opts the optional parameters
806
885
  # @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.
807
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
808
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
809
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
810
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
811
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
812
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
886
+ # @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 timezone. Talon.One will convert to UTC internally.
887
+ # @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 timezone. Talon.One will convert to UTC internally.
888
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
889
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
890
+ # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
891
+ # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
813
892
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
814
893
  # @option opts [String] :batch_id Filter results by batches of coupons
815
894
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
@@ -866,7 +945,479 @@ module TalonOne
866
945
  post_body = opts[:body]
867
946
 
868
947
  # return_type
869
- return_type = opts[:return_type]
948
+ return_type = opts[:return_type]
949
+
950
+ # auth_names
951
+ auth_names = opts[:auth_names] || ['manager_auth']
952
+
953
+ new_options = opts.merge(
954
+ :header_params => header_params,
955
+ :query_params => query_params,
956
+ :form_params => form_params,
957
+ :body => post_body,
958
+ :auth_names => auth_names,
959
+ :return_type => return_type
960
+ )
961
+
962
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
963
+ if @api_client.config.debugging
964
+ @api_client.config.logger.debug "API called: ManagementApi#delete_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
965
+ end
966
+ return data, status_code, headers
967
+ end
968
+
969
+ # Delete one Referral
970
+ # @param application_id [Integer]
971
+ # @param campaign_id [Integer]
972
+ # @param referral_id [String] The ID of the referral code to delete
973
+ # @param [Hash] opts the optional parameters
974
+ # @return [nil]
975
+ def delete_referral(application_id, campaign_id, referral_id, opts = {})
976
+ delete_referral_with_http_info(application_id, campaign_id, referral_id, opts)
977
+ nil
978
+ end
979
+
980
+ # Delete one Referral
981
+ # @param application_id [Integer]
982
+ # @param campaign_id [Integer]
983
+ # @param referral_id [String] The ID of the referral code to delete
984
+ # @param [Hash] opts the optional parameters
985
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
986
+ def delete_referral_with_http_info(application_id, campaign_id, referral_id, opts = {})
987
+ if @api_client.config.debugging
988
+ @api_client.config.logger.debug 'Calling API: ManagementApi.delete_referral ...'
989
+ end
990
+ # verify the required parameter 'application_id' is set
991
+ if @api_client.config.client_side_validation && application_id.nil?
992
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_referral"
993
+ end
994
+ # verify the required parameter 'campaign_id' is set
995
+ if @api_client.config.client_side_validation && campaign_id.nil?
996
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_referral"
997
+ end
998
+ # verify the required parameter 'referral_id' is set
999
+ if @api_client.config.client_side_validation && referral_id.nil?
1000
+ fail ArgumentError, "Missing the required parameter 'referral_id' when calling ManagementApi.delete_referral"
1001
+ end
1002
+ # resource path
1003
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'referralId' + '}', CGI.escape(referral_id.to_s))
1004
+
1005
+ # query parameters
1006
+ query_params = opts[:query_params] || {}
1007
+
1008
+ # header parameters
1009
+ header_params = opts[:header_params] || {}
1010
+
1011
+ # form parameters
1012
+ form_params = opts[:form_params] || {}
1013
+
1014
+ # http body (model)
1015
+ post_body = opts[:body]
1016
+
1017
+ # return_type
1018
+ return_type = opts[:return_type]
1019
+
1020
+ # auth_names
1021
+ auth_names = opts[:auth_names] || ['manager_auth']
1022
+
1023
+ new_options = opts.merge(
1024
+ :header_params => header_params,
1025
+ :query_params => query_params,
1026
+ :form_params => form_params,
1027
+ :body => post_body,
1028
+ :auth_names => auth_names,
1029
+ :return_type => return_type
1030
+ )
1031
+
1032
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1033
+ if @api_client.config.debugging
1034
+ @api_client.config.logger.debug "API called: ManagementApi#delete_referral\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1035
+ end
1036
+ return data, status_code, headers
1037
+ end
1038
+
1039
+ # Delete a Ruleset
1040
+ # @param application_id [Integer]
1041
+ # @param campaign_id [Integer]
1042
+ # @param ruleset_id [Integer]
1043
+ # @param [Hash] opts the optional parameters
1044
+ # @return [nil]
1045
+ def delete_ruleset(application_id, campaign_id, ruleset_id, opts = {})
1046
+ delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts)
1047
+ nil
1048
+ end
1049
+
1050
+ # Delete a Ruleset
1051
+ # @param application_id [Integer]
1052
+ # @param campaign_id [Integer]
1053
+ # @param ruleset_id [Integer]
1054
+ # @param [Hash] opts the optional parameters
1055
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1056
+ def delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {})
1057
+ if @api_client.config.debugging
1058
+ @api_client.config.logger.debug 'Calling API: ManagementApi.delete_ruleset ...'
1059
+ end
1060
+ # verify the required parameter 'application_id' is set
1061
+ if @api_client.config.client_side_validation && application_id.nil?
1062
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_ruleset"
1063
+ end
1064
+ # verify the required parameter 'campaign_id' is set
1065
+ if @api_client.config.client_side_validation && campaign_id.nil?
1066
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_ruleset"
1067
+ end
1068
+ # verify the required parameter 'ruleset_id' is set
1069
+ if @api_client.config.client_side_validation && ruleset_id.nil?
1070
+ fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling ManagementApi.delete_ruleset"
1071
+ end
1072
+ # resource path
1073
+ local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'rulesetId' + '}', CGI.escape(ruleset_id.to_s))
1074
+
1075
+ # query parameters
1076
+ query_params = opts[:query_params] || {}
1077
+
1078
+ # header parameters
1079
+ header_params = opts[:header_params] || {}
1080
+
1081
+ # form parameters
1082
+ form_params = opts[:form_params] || {}
1083
+
1084
+ # http body (model)
1085
+ post_body = opts[:body]
1086
+
1087
+ # return_type
1088
+ return_type = opts[:return_type]
1089
+
1090
+ # auth_names
1091
+ auth_names = opts[:auth_names] || ['manager_auth']
1092
+
1093
+ new_options = opts.merge(
1094
+ :header_params => header_params,
1095
+ :query_params => query_params,
1096
+ :form_params => form_params,
1097
+ :body => post_body,
1098
+ :auth_names => auth_names,
1099
+ :return_type => return_type
1100
+ )
1101
+
1102
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1103
+ if @api_client.config.debugging
1104
+ @api_client.config.logger.debug "API called: ManagementApi#delete_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1105
+ end
1106
+ return data, status_code, headers
1107
+ end
1108
+
1109
+ # Destroy a Session
1110
+ # @param [Hash] opts the optional parameters
1111
+ # @return [nil]
1112
+ def destroy_session(opts = {})
1113
+ destroy_session_with_http_info(opts)
1114
+ nil
1115
+ end
1116
+
1117
+ # Destroy a Session
1118
+ # @param [Hash] opts the optional parameters
1119
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1120
+ def destroy_session_with_http_info(opts = {})
1121
+ if @api_client.config.debugging
1122
+ @api_client.config.logger.debug 'Calling API: ManagementApi.destroy_session ...'
1123
+ end
1124
+ # resource path
1125
+ local_var_path = '/v1/sessions'
1126
+
1127
+ # query parameters
1128
+ query_params = opts[:query_params] || {}
1129
+
1130
+ # header parameters
1131
+ header_params = opts[:header_params] || {}
1132
+
1133
+ # form parameters
1134
+ form_params = opts[:form_params] || {}
1135
+
1136
+ # http body (model)
1137
+ post_body = opts[:body]
1138
+
1139
+ # return_type
1140
+ return_type = opts[:return_type]
1141
+
1142
+ # auth_names
1143
+ auth_names = opts[:auth_names] || ['manager_auth']
1144
+
1145
+ new_options = opts.merge(
1146
+ :header_params => header_params,
1147
+ :query_params => query_params,
1148
+ :form_params => form_params,
1149
+ :body => post_body,
1150
+ :auth_names => auth_names,
1151
+ :return_type => return_type
1152
+ )
1153
+
1154
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1155
+ if @api_client.config.debugging
1156
+ @api_client.config.logger.debug "API called: ManagementApi#destroy_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1157
+ end
1158
+ return data, status_code, headers
1159
+ end
1160
+
1161
+ # Export Coupons to a CSV file
1162
+ # Download a file with the coupons that match the given attributes.
1163
+ # @param application_id [Integer]
1164
+ # @param [Hash] opts the optional parameters
1165
+ # @option opts [Float] :campaign_id Filter results by campaign.
1166
+ # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
1167
+ # @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.
1168
+ # @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 timezone. Talon.One will convert to UTC internally.
1169
+ # @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 timezone. Talon.One will convert to UTC internally.
1170
+ # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
1171
+ # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
1172
+ # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
1173
+ # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
1174
+ # @option opts [String] :batch_id Filter results by batches of coupons
1175
+ # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
1176
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1177
+ # @option opts [String] :campaign_state Filter results by the state of the campaign.
1178
+ # @return [String]
1179
+ def export_coupons(application_id, opts = {})
1180
+ data, _status_code, _headers = export_coupons_with_http_info(application_id, opts)
1181
+ data
1182
+ end
1183
+
1184
+ # Export Coupons to a CSV file
1185
+ # Download a file with the coupons that match the given attributes.
1186
+ # @param application_id [Integer]
1187
+ # @param [Hash] opts the optional parameters
1188
+ # @option opts [Float] :campaign_id Filter results by campaign.
1189
+ # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
1190
+ # @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.
1191
+ # @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 timezone. Talon.One will convert to UTC internally.
1192
+ # @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 timezone. Talon.One will convert to UTC internally.
1193
+ # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
1194
+ # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
1195
+ # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
1196
+ # @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon&#39;s RecipientIntegrationId field
1197
+ # @option opts [String] :batch_id Filter results by batches of coupons
1198
+ # @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
1199
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1200
+ # @option opts [String] :campaign_state Filter results by the state of the campaign.
1201
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1202
+ def export_coupons_with_http_info(application_id, opts = {})
1203
+ if @api_client.config.debugging
1204
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_coupons ...'
1205
+ end
1206
+ # verify the required parameter 'application_id' is set
1207
+ if @api_client.config.client_side_validation && application_id.nil?
1208
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_coupons"
1209
+ end
1210
+ allowable_values = ["expired", "validNow", "validFuture"]
1211
+ if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
1212
+ fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
1213
+ end
1214
+ allowable_values = ["true", "false"]
1215
+ if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
1216
+ fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
1217
+ end
1218
+ allowable_values = ["excel", "ISO8601"]
1219
+ if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
1220
+ fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
1221
+ end
1222
+ allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"]
1223
+ if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
1224
+ fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
1225
+ end
1226
+ # resource path
1227
+ local_var_path = '/v1/applications/{applicationId}/export_coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))
1228
+
1229
+ # query parameters
1230
+ query_params = opts[:query_params] || {}
1231
+ query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
1232
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1233
+ query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
1234
+ query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
1235
+ query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
1236
+ query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
1237
+ query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
1238
+ query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
1239
+ query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
1240
+ query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
1241
+ query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
1242
+ query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
1243
+ query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil?
1244
+
1245
+ # header parameters
1246
+ header_params = opts[:header_params] || {}
1247
+ # HTTP header 'Accept' (if needed)
1248
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
1249
+
1250
+ # form parameters
1251
+ form_params = opts[:form_params] || {}
1252
+
1253
+ # http body (model)
1254
+ post_body = opts[:body]
1255
+
1256
+ # return_type
1257
+ return_type = opts[:return_type] || 'String'
1258
+
1259
+ # auth_names
1260
+ auth_names = opts[:auth_names] || ['manager_auth']
1261
+
1262
+ new_options = opts.merge(
1263
+ :header_params => header_params,
1264
+ :query_params => query_params,
1265
+ :form_params => form_params,
1266
+ :body => post_body,
1267
+ :auth_names => auth_names,
1268
+ :return_type => return_type
1269
+ )
1270
+
1271
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1272
+ if @api_client.config.debugging
1273
+ @api_client.config.logger.debug "API called: ManagementApi#export_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1274
+ end
1275
+ return data, status_code, headers
1276
+ end
1277
+
1278
+ # Export Customer Sessions to a CSV file
1279
+ # Download a file with the customer sessions that match the request.
1280
+ # @param application_id [Integer]
1281
+ # @param [Hash] opts the optional parameters
1282
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
1283
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
1284
+ # @option opts [String] :profile_integration_id Only return sessions for the customer that matches this customer integration ID.
1285
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1286
+ # @option opts [String] :customer_session_state Filter results by state.
1287
+ # @return [String]
1288
+ def export_customer_sessions(application_id, opts = {})
1289
+ data, _status_code, _headers = export_customer_sessions_with_http_info(application_id, opts)
1290
+ data
1291
+ end
1292
+
1293
+ # Export Customer Sessions to a CSV file
1294
+ # Download a file with the customer sessions that match the request.
1295
+ # @param application_id [Integer]
1296
+ # @param [Hash] opts the optional parameters
1297
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
1298
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
1299
+ # @option opts [String] :profile_integration_id Only return sessions for the customer that matches this customer integration ID.
1300
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1301
+ # @option opts [String] :customer_session_state Filter results by state.
1302
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1303
+ def export_customer_sessions_with_http_info(application_id, opts = {})
1304
+ if @api_client.config.debugging
1305
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_customer_sessions ...'
1306
+ end
1307
+ # verify the required parameter 'application_id' is set
1308
+ if @api_client.config.client_side_validation && application_id.nil?
1309
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_customer_sessions"
1310
+ end
1311
+ allowable_values = ["excel", "ISO8601"]
1312
+ if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
1313
+ fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
1314
+ end
1315
+ allowable_values = ["open", "closed", "cancelled"]
1316
+ if @api_client.config.client_side_validation && opts[:'customer_session_state'] && !allowable_values.include?(opts[:'customer_session_state'])
1317
+ fail ArgumentError, "invalid value for \"customer_session_state\", must be one of #{allowable_values}"
1318
+ end
1319
+ # resource path
1320
+ local_var_path = '/v1/applications/{applicationId}/export_customer_sessions'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))
1321
+
1322
+ # query parameters
1323
+ query_params = opts[:query_params] || {}
1324
+ query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
1325
+ query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
1326
+ query_params[:'profileIntegrationId'] = opts[:'profile_integration_id'] if !opts[:'profile_integration_id'].nil?
1327
+ query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
1328
+ query_params[:'customerSessionState'] = opts[:'customer_session_state'] if !opts[:'customer_session_state'].nil?
1329
+
1330
+ # header parameters
1331
+ header_params = opts[:header_params] || {}
1332
+ # HTTP header 'Accept' (if needed)
1333
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
1334
+
1335
+ # form parameters
1336
+ form_params = opts[:form_params] || {}
1337
+
1338
+ # http body (model)
1339
+ post_body = opts[:body]
1340
+
1341
+ # return_type
1342
+ return_type = opts[:return_type] || 'String'
1343
+
1344
+ # auth_names
1345
+ auth_names = opts[:auth_names] || ['manager_auth']
1346
+
1347
+ new_options = opts.merge(
1348
+ :header_params => header_params,
1349
+ :query_params => query_params,
1350
+ :form_params => form_params,
1351
+ :body => post_body,
1352
+ :auth_names => auth_names,
1353
+ :return_type => return_type
1354
+ )
1355
+
1356
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1357
+ if @api_client.config.debugging
1358
+ @api_client.config.logger.debug "API called: ManagementApi#export_customer_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1359
+ end
1360
+ return data, status_code, headers
1361
+ end
1362
+
1363
+ # Export triggered Effects to a CSV file
1364
+ # Download a file with the triggered effects that match the given attributes.
1365
+ # @param application_id [Integer]
1366
+ # @param [Hash] opts the optional parameters
1367
+ # @option opts [Float] :campaign_id Filter results by campaign.
1368
+ # @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 timezone. Talon.One will convert to UTC internally.
1369
+ # @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 timezone. Talon.One will convert to UTC internally.
1370
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1371
+ # @return [String]
1372
+ def export_effects(application_id, opts = {})
1373
+ data, _status_code, _headers = export_effects_with_http_info(application_id, opts)
1374
+ data
1375
+ end
1376
+
1377
+ # Export triggered Effects to a CSV file
1378
+ # Download a file with the triggered effects that match the given attributes.
1379
+ # @param application_id [Integer]
1380
+ # @param [Hash] opts the optional parameters
1381
+ # @option opts [Float] :campaign_id Filter results by campaign.
1382
+ # @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 timezone. Talon.One will convert to UTC internally.
1383
+ # @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 timezone. Talon.One will convert to UTC internally.
1384
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1385
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1386
+ def export_effects_with_http_info(application_id, opts = {})
1387
+ if @api_client.config.debugging
1388
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_effects ...'
1389
+ end
1390
+ # verify the required parameter 'application_id' is set
1391
+ if @api_client.config.client_side_validation && application_id.nil?
1392
+ fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_effects"
1393
+ end
1394
+ allowable_values = ["excel", "ISO8601"]
1395
+ if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
1396
+ fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
1397
+ end
1398
+ # resource path
1399
+ local_var_path = '/v1/applications/{applicationId}/export_effects'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))
1400
+
1401
+ # query parameters
1402
+ query_params = opts[:query_params] || {}
1403
+ query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
1404
+ query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
1405
+ query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
1406
+ query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
1407
+
1408
+ # header parameters
1409
+ header_params = opts[:header_params] || {}
1410
+ # HTTP header 'Accept' (if needed)
1411
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
1412
+
1413
+ # form parameters
1414
+ form_params = opts[:form_params] || {}
1415
+
1416
+ # http body (model)
1417
+ post_body = opts[:body]
1418
+
1419
+ # return_type
1420
+ return_type = opts[:return_type] || 'String'
870
1421
 
871
1422
  # auth_names
872
1423
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -880,54 +1431,46 @@ module TalonOne
880
1431
  :return_type => return_type
881
1432
  )
882
1433
 
883
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1434
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
884
1435
  if @api_client.config.debugging
885
- @api_client.config.logger.debug "API called: ManagementApi#delete_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1436
+ @api_client.config.logger.debug "API called: ManagementApi#export_effects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
886
1437
  end
887
1438
  return data, status_code, headers
888
1439
  end
889
1440
 
890
- # Delete one Referral
891
- # @param application_id [Integer]
892
- # @param campaign_id [Integer]
893
- # @param referral_id [String] The ID of the referral code to delete
1441
+ # Export customer loyalty balance to a CSV file
1442
+ # Download a file with the balance of each customer in the loyalty program
1443
+ # @param program_id [String]
894
1444
  # @param [Hash] opts the optional parameters
895
- # @return [nil]
896
- def delete_referral(application_id, campaign_id, referral_id, opts = {})
897
- delete_referral_with_http_info(application_id, campaign_id, referral_id, opts)
898
- nil
1445
+ # @return [String]
1446
+ def export_loyalty_balance(program_id, opts = {})
1447
+ data, _status_code, _headers = export_loyalty_balance_with_http_info(program_id, opts)
1448
+ data
899
1449
  end
900
1450
 
901
- # Delete one Referral
902
- # @param application_id [Integer]
903
- # @param campaign_id [Integer]
904
- # @param referral_id [String] The ID of the referral code to delete
1451
+ # Export customer loyalty balance to a CSV file
1452
+ # Download a file with the balance of each customer in the loyalty program
1453
+ # @param program_id [String]
905
1454
  # @param [Hash] opts the optional parameters
906
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
907
- def delete_referral_with_http_info(application_id, campaign_id, referral_id, opts = {})
1455
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1456
+ def export_loyalty_balance_with_http_info(program_id, opts = {})
908
1457
  if @api_client.config.debugging
909
- @api_client.config.logger.debug 'Calling API: ManagementApi.delete_referral ...'
910
- end
911
- # verify the required parameter 'application_id' is set
912
- if @api_client.config.client_side_validation && application_id.nil?
913
- fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_referral"
914
- end
915
- # verify the required parameter 'campaign_id' is set
916
- if @api_client.config.client_side_validation && campaign_id.nil?
917
- fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_referral"
1458
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_balance ...'
918
1459
  end
919
- # verify the required parameter 'referral_id' is set
920
- if @api_client.config.client_side_validation && referral_id.nil?
921
- fail ArgumentError, "Missing the required parameter 'referral_id' when calling ManagementApi.delete_referral"
1460
+ # verify the required parameter 'program_id' is set
1461
+ if @api_client.config.client_side_validation && program_id.nil?
1462
+ fail ArgumentError, "Missing the required parameter 'program_id' when calling ManagementApi.export_loyalty_balance"
922
1463
  end
923
1464
  # resource path
924
- local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'referralId' + '}', CGI.escape(referral_id.to_s))
1465
+ local_var_path = '/v1/loyalty_programs/{programID}/export_customer_balance'.sub('{' + 'programID' + '}', CGI.escape(program_id.to_s))
925
1466
 
926
1467
  # query parameters
927
1468
  query_params = opts[:query_params] || {}
928
1469
 
929
1470
  # header parameters
930
1471
  header_params = opts[:header_params] || {}
1472
+ # HTTP header 'Accept' (if needed)
1473
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
931
1474
 
932
1475
  # form parameters
933
1476
  form_params = opts[:form_params] || {}
@@ -936,7 +1479,7 @@ module TalonOne
936
1479
  post_body = opts[:body]
937
1480
 
938
1481
  # return_type
939
- return_type = opts[:return_type]
1482
+ return_type = opts[:return_type] || 'String'
940
1483
 
941
1484
  # auth_names
942
1485
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -950,54 +1493,73 @@ module TalonOne
950
1493
  :return_type => return_type
951
1494
  )
952
1495
 
953
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1496
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
954
1497
  if @api_client.config.debugging
955
- @api_client.config.logger.debug "API called: ManagementApi#delete_referral\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1498
+ @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
956
1499
  end
957
1500
  return data, status_code, headers
958
1501
  end
959
1502
 
960
- # Delete a Ruleset
961
- # @param application_id [Integer]
962
- # @param campaign_id [Integer]
963
- # @param ruleset_id [Integer]
1503
+ # Export a customer's loyalty ledger log to a CSV file
1504
+ # Download a file with a customer's ledger log in the loyalty program
1505
+ # @param range_start [DateTime] Only return results from after this timestamp, must be an RFC3339 timestamp string
1506
+ # @param range_end [DateTime] Only return results from before this timestamp, must be an RFC3339 timestamp string
1507
+ # @param program_id [String]
1508
+ # @param integration_id [String]
964
1509
  # @param [Hash] opts the optional parameters
965
- # @return [nil]
966
- def delete_ruleset(application_id, campaign_id, ruleset_id, opts = {})
967
- delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts)
968
- nil
1510
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1511
+ # @return [String]
1512
+ def export_loyalty_ledger(range_start, range_end, program_id, integration_id, opts = {})
1513
+ data, _status_code, _headers = export_loyalty_ledger_with_http_info(range_start, range_end, program_id, integration_id, opts)
1514
+ data
969
1515
  end
970
1516
 
971
- # Delete a Ruleset
972
- # @param application_id [Integer]
973
- # @param campaign_id [Integer]
974
- # @param ruleset_id [Integer]
1517
+ # Export a customer&#39;s loyalty ledger log to a CSV file
1518
+ # Download a file with a customer&#39;s ledger log in the loyalty program
1519
+ # @param range_start [DateTime] Only return results from after this timestamp, must be an RFC3339 timestamp string
1520
+ # @param range_end [DateTime] Only return results from before this timestamp, must be an RFC3339 timestamp string
1521
+ # @param program_id [String]
1522
+ # @param integration_id [String]
975
1523
  # @param [Hash] opts the optional parameters
976
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
977
- def delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {})
1524
+ # @option opts [String] :date_format Determines the format of dates in the export document.
1525
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1526
+ def export_loyalty_ledger_with_http_info(range_start, range_end, program_id, integration_id, opts = {})
978
1527
  if @api_client.config.debugging
979
- @api_client.config.logger.debug 'Calling API: ManagementApi.delete_ruleset ...'
1528
+ @api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_ledger ...'
980
1529
  end
981
- # verify the required parameter 'application_id' is set
982
- if @api_client.config.client_side_validation && application_id.nil?
983
- fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_ruleset"
1530
+ # verify the required parameter 'range_start' is set
1531
+ if @api_client.config.client_side_validation && range_start.nil?
1532
+ fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.export_loyalty_ledger"
984
1533
  end
985
- # verify the required parameter 'campaign_id' is set
986
- if @api_client.config.client_side_validation && campaign_id.nil?
987
- fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_ruleset"
1534
+ # verify the required parameter 'range_end' is set
1535
+ if @api_client.config.client_side_validation && range_end.nil?
1536
+ fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.export_loyalty_ledger"
988
1537
  end
989
- # verify the required parameter 'ruleset_id' is set
990
- if @api_client.config.client_side_validation && ruleset_id.nil?
991
- fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling ManagementApi.delete_ruleset"
1538
+ # verify the required parameter 'program_id' is set
1539
+ if @api_client.config.client_side_validation && program_id.nil?
1540
+ fail ArgumentError, "Missing the required parameter 'program_id' when calling ManagementApi.export_loyalty_ledger"
1541
+ end
1542
+ # verify the required parameter 'integration_id' is set
1543
+ if @api_client.config.client_side_validation && integration_id.nil?
1544
+ fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.export_loyalty_ledger"
1545
+ end
1546
+ allowable_values = ["excel", "ISO8601"]
1547
+ if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
1548
+ fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
992
1549
  end
993
1550
  # resource path
994
- local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'rulesetId' + '}', CGI.escape(ruleset_id.to_s))
1551
+ local_var_path = '/v1/loyalty_programs/{programID}/profile/{integrationID}/export_log'.sub('{' + 'programID' + '}', CGI.escape(program_id.to_s)).sub('{' + 'integrationID' + '}', CGI.escape(integration_id.to_s))
995
1552
 
996
1553
  # query parameters
997
1554
  query_params = opts[:query_params] || {}
1555
+ query_params[:'rangeStart'] = range_start
1556
+ query_params[:'rangeEnd'] = range_end
1557
+ query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
998
1558
 
999
1559
  # header parameters
1000
1560
  header_params = opts[:header_params] || {}
1561
+ # HTTP header 'Accept' (if needed)
1562
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
1001
1563
 
1002
1564
  # form parameters
1003
1565
  form_params = opts[:form_params] || {}
@@ -1006,7 +1568,7 @@ module TalonOne
1006
1568
  post_body = opts[:body]
1007
1569
 
1008
1570
  # return_type
1009
- return_type = opts[:return_type]
1571
+ return_type = opts[:return_type] || 'String'
1010
1572
 
1011
1573
  # auth_names
1012
1574
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -1020,9 +1582,9 @@ module TalonOne
1020
1582
  :return_type => return_type
1021
1583
  )
1022
1584
 
1023
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1585
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1024
1586
  if @api_client.config.debugging
1025
- @api_client.config.logger.debug "API called: ManagementApi#delete_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1587
+ @api_client.config.logger.debug "API called: ManagementApi#export_loyalty_ledger\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1026
1588
  end
1027
1589
  return data, status_code, headers
1028
1590
  end
@@ -1419,7 +1981,7 @@ module TalonOne
1419
1981
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1420
1982
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1421
1983
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
1422
- # @return [InlineResponse20021]
1984
+ # @return [InlineResponse20022]
1423
1985
  def get_additional_costs(opts = {})
1424
1986
  data, _status_code, _headers = get_additional_costs_with_http_info(opts)
1425
1987
  data
@@ -1431,7 +1993,7 @@ module TalonOne
1431
1993
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1432
1994
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
1433
1995
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
1434
- # @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
1996
+ # @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
1435
1997
  def get_additional_costs_with_http_info(opts = {})
1436
1998
  if @api_client.config.debugging
1437
1999
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
@@ -1457,7 +2019,7 @@ module TalonOne
1457
2019
  post_body = opts[:body]
1458
2020
 
1459
2021
  # return_type
1460
- return_type = opts[:return_type] || 'InlineResponse20021'
2022
+ return_type = opts[:return_type] || 'InlineResponse20022'
1461
2023
 
1462
2024
  # auth_names
1463
2025
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -1574,7 +2136,7 @@ module TalonOne
1574
2136
  return data, status_code, headers
1575
2137
  end
1576
2138
 
1577
- # Get all roles.
2139
+ # Get all roles
1578
2140
  # @param [Hash] opts the optional parameters
1579
2141
  # @return [InlineResponse20030]
1580
2142
  def get_all_roles(opts = {})
@@ -1582,7 +2144,7 @@ module TalonOne
1582
2144
  data
1583
2145
  end
1584
2146
 
1585
- # Get all roles.
2147
+ # Get all roles
1586
2148
  # @param [Hash] opts the optional parameters
1587
2149
  # @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
1588
2150
  def get_all_roles_with_http_info(opts = {})
@@ -2031,8 +2593,8 @@ module TalonOne
2031
2593
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2032
2594
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2033
2595
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
2034
- # @option opts [DateTime] :created_before Only return events created before this date
2035
- # @option opts [DateTime] :created_after Only return events created after this date
2596
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2597
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
2036
2598
  # @option opts [String] :session Session integration ID filter for events. Must be exact match.
2037
2599
  # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
2038
2600
  # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
@@ -2055,8 +2617,8 @@ module TalonOne
2055
2617
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2056
2618
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2057
2619
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
2058
- # @option opts [DateTime] :created_before Only return events created before this date
2059
- # @option opts [DateTime] :created_after Only return events created after this date
2620
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2621
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
2060
2622
  # @option opts [String] :session Session integration ID filter for events. Must be exact match.
2061
2623
  # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
2062
2624
  # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
@@ -2143,8 +2705,8 @@ module TalonOne
2143
2705
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2144
2706
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2145
2707
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
2146
- # @option opts [DateTime] :created_before Only return events created before this date
2147
- # @option opts [DateTime] :created_after Only return events created after this date
2708
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2709
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
2148
2710
  # @option opts [String] :session Session integration ID filter for events. Must be exact match.
2149
2711
  # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
2150
2712
  # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
@@ -2167,8 +2729,8 @@ module TalonOne
2167
2729
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2168
2730
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2169
2731
  # @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
2170
- # @option opts [DateTime] :created_before Only return events created before this date
2171
- # @option opts [DateTime] :created_after Only return events created after this date
2732
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2733
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
2172
2734
  # @option opts [String] :session Session integration ID filter for events. Must be exact match.
2173
2735
  # @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
2174
2736
  # @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
@@ -2321,8 +2883,8 @@ module TalonOne
2321
2883
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2322
2884
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
2323
2885
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
2324
- # @option opts [DateTime] :created_before Only return events created before this date
2325
- # @option opts [DateTime] :created_after Only return events created after this date
2886
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2887
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
2326
2888
  # @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
2327
2889
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
2328
2890
  # @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
@@ -2340,8 +2902,8 @@ module TalonOne
2340
2902
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2341
2903
  # @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
2342
2904
  # @option opts [String] :state Filter by sessions with this state. Must be exact match.
2343
- # @option opts [DateTime] :created_before Only return events created before this date
2344
- # @option opts [DateTime] :created_after Only return events created after this date
2905
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
2906
+ # @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
2345
2907
  # @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
2346
2908
  # @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
2347
2909
  # @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
@@ -2540,7 +3102,7 @@ module TalonOne
2540
3102
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
2541
3103
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2542
3104
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2543
- # @return [InlineResponse20020]
3105
+ # @return [InlineResponse20021]
2544
3106
  def get_attributes(opts = {})
2545
3107
  data, _status_code, _headers = get_attributes_with_http_info(opts)
2546
3108
  data
@@ -2552,7 +3114,7 @@ module TalonOne
2552
3114
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
2553
3115
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2554
3116
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2555
- # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
3117
+ # @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
2556
3118
  def get_attributes_with_http_info(opts = {})
2557
3119
  if @api_client.config.debugging
2558
3120
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
@@ -2578,7 +3140,7 @@ module TalonOne
2578
3140
  post_body = opts[:body]
2579
3141
 
2580
3142
  # return_type
2581
- return_type = opts[:return_type] || 'InlineResponse20020'
3143
+ return_type = opts[:return_type] || 'InlineResponse20021'
2582
3144
 
2583
3145
  # auth_names
2584
3146
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -2599,6 +3161,74 @@ module TalonOne
2599
3161
  return data, status_code, headers
2600
3162
  end
2601
3163
 
3164
+ # Get all audiences
3165
+ # Get All audiences created in the account.
3166
+ # @param [Hash] opts the optional parameters
3167
+ # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
3168
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3169
+ # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3170
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
3171
+ # @return [InlineResponse20020]
3172
+ def get_audiences(opts = {})
3173
+ data, _status_code, _headers = get_audiences_with_http_info(opts)
3174
+ data
3175
+ end
3176
+
3177
+ # Get all audiences
3178
+ # Get All audiences created in the account.
3179
+ # @param [Hash] opts the optional parameters
3180
+ # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
3181
+ # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3182
+ # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3183
+ # @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
3184
+ # @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
3185
+ def get_audiences_with_http_info(opts = {})
3186
+ if @api_client.config.debugging
3187
+ @api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
3188
+ end
3189
+ # resource path
3190
+ local_var_path = '/v1/audiences'
3191
+
3192
+ # query parameters
3193
+ query_params = opts[:query_params] || {}
3194
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
3195
+ query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
3196
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
3197
+ query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
3198
+
3199
+ # header parameters
3200
+ header_params = opts[:header_params] || {}
3201
+ # HTTP header 'Accept' (if needed)
3202
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3203
+
3204
+ # form parameters
3205
+ form_params = opts[:form_params] || {}
3206
+
3207
+ # http body (model)
3208
+ post_body = opts[:body]
3209
+
3210
+ # return_type
3211
+ return_type = opts[:return_type] || 'InlineResponse20020'
3212
+
3213
+ # auth_names
3214
+ auth_names = opts[:auth_names] || ['manager_auth']
3215
+
3216
+ new_options = opts.merge(
3217
+ :header_params => header_params,
3218
+ :query_params => query_params,
3219
+ :form_params => form_params,
3220
+ :body => post_body,
3221
+ :auth_names => auth_names,
3222
+ :return_type => return_type
3223
+ )
3224
+
3225
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3226
+ if @api_client.config.debugging
3227
+ @api_client.config.logger.debug "API called: ManagementApi#get_audiences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3228
+ end
3229
+ return data, status_code, headers
3230
+ end
3231
+
2602
3232
  # Get a Campaign
2603
3233
  # @param application_id [Integer]
2604
3234
  # @param campaign_id [Integer]
@@ -2847,8 +3477,8 @@ module TalonOne
2847
3477
  # @option opts [String] :campaign_state Filter results by the state of the campaign.
2848
3478
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
2849
3479
  # @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
2850
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
2851
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
3480
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3481
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
2852
3482
  # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
2853
3483
  # @return [InlineResponse2002]
2854
3484
  def get_campaigns(application_id, opts = {})
@@ -2865,8 +3495,8 @@ module TalonOne
2865
3495
  # @option opts [String] :campaign_state Filter results by the state of the campaign.
2866
3496
  # @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
2867
3497
  # @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
2868
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
2869
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
3498
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3499
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
2870
3500
  # @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
2871
3501
  # @return [Array<(InlineResponse2002, Integer, Hash)>] InlineResponse2002 data, response status code and response headers
2872
3502
  def get_campaigns_with_http_info(application_id, opts = {})
@@ -2936,11 +3566,13 @@ module TalonOne
2936
3566
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2937
3567
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2938
3568
  # @option opts [Integer] :application_id
2939
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
2940
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
3569
+ # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
3570
+ # @option opts [Integer] :user_id
3571
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3572
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
2941
3573
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
2942
3574
  # @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
2943
- # @return [InlineResponse20027]
3575
+ # @return [InlineResponse20028]
2944
3576
  def get_changes(opts = {})
2945
3577
  data, _status_code, _headers = get_changes_with_http_info(opts)
2946
3578
  data
@@ -2953,11 +3585,13 @@ module TalonOne
2953
3585
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
2954
3586
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
2955
3587
  # @option opts [Integer] :application_id
2956
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
2957
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
3588
+ # @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
3589
+ # @option opts [Integer] :user_id
3590
+ # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3591
+ # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
2958
3592
  # @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
2959
3593
  # @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
2960
- # @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
3594
+ # @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
2961
3595
  def get_changes_with_http_info(opts = {})
2962
3596
  if @api_client.config.debugging
2963
3597
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
@@ -2971,6 +3605,8 @@ module TalonOne
2971
3605
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
2972
3606
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2973
3607
  query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
3608
+ query_params[:'entityPath'] = opts[:'entity_path'] if !opts[:'entity_path'].nil?
3609
+ query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
2974
3610
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
2975
3611
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
2976
3612
  query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil?
@@ -2988,7 +3624,7 @@ module TalonOne
2988
3624
  post_body = opts[:body]
2989
3625
 
2990
3626
  # return_type
2991
- return_type = opts[:return_type] || 'InlineResponse20027'
3627
+ return_type = opts[:return_type] || 'InlineResponse20028'
2992
3628
 
2993
3629
  # auth_names
2994
3630
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -3017,12 +3653,12 @@ module TalonOne
3017
3653
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3018
3654
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3019
3655
  # @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.
3020
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3021
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3022
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3023
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3024
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3025
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3656
+ # @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 timezone. Talon.One will convert to UTC internally.
3657
+ # @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 timezone. Talon.One will convert to UTC internally.
3658
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3659
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3660
+ # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3661
+ # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3026
3662
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3027
3663
  # @option opts [String] :batch_id Filter results by batches of coupons
3028
3664
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
@@ -3043,12 +3679,12 @@ module TalonOne
3043
3679
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3044
3680
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3045
3681
  # @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.
3046
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3047
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3048
- # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3049
- # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3050
- # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3051
- # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3682
+ # @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 timezone. Talon.One will convert to UTC internally.
3683
+ # @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 timezone. Talon.One will convert to UTC internally.
3684
+ # @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3685
+ # @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3686
+ # @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3687
+ # @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally.
3052
3688
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3053
3689
  # @option opts [String] :batch_id Filter results by batches of coupons
3054
3690
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
@@ -3141,8 +3777,8 @@ module TalonOne
3141
3777
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3142
3778
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3143
3779
  # @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.
3144
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3145
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3780
+ # @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 timezone. Talon.One will convert to UTC internally.
3781
+ # @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 timezone. Talon.One will convert to UTC internally.
3146
3782
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3147
3783
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
3148
3784
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -3165,8 +3801,8 @@ module TalonOne
3165
3801
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3166
3802
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3167
3803
  # @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.
3168
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3169
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3804
+ # @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 timezone. Talon.One will convert to UTC internally.
3805
+ # @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 timezone. Talon.One will convert to UTC internally.
3170
3806
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3171
3807
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
3172
3808
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -3260,8 +3896,8 @@ module TalonOne
3260
3896
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3261
3897
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3262
3898
  # @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.
3263
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3264
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3899
+ # @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 timezone. Talon.One will convert to UTC internally.
3900
+ # @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 timezone. Talon.One will convert to UTC internally.
3265
3901
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3266
3902
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
3267
3903
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -3284,8 +3920,8 @@ module TalonOne
3284
3920
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3285
3921
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3286
3922
  # @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.
3287
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3288
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3923
+ # @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 timezone. Talon.One will convert to UTC internally.
3924
+ # @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 timezone. Talon.One will convert to UTC internally.
3289
3925
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3290
3926
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
3291
3927
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -3380,8 +4016,8 @@ module TalonOne
3380
4016
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3381
4017
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3382
4018
  # @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.
3383
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3384
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
4019
+ # @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 timezone. Talon.One will convert to UTC internally.
4020
+ # @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 timezone. Talon.One will convert to UTC internally.
3385
4021
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3386
4022
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
3387
4023
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -3402,8 +4038,8 @@ module TalonOne
3402
4038
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
3403
4039
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
3404
4040
  # @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.
3405
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
3406
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
4041
+ # @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 timezone. Talon.One will convert to UTC internally.
4042
+ # @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 timezone. Talon.One will convert to UTC internally.
3407
4043
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
3408
4044
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
3409
4045
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -4040,7 +4676,7 @@ module TalonOne
4040
4676
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
4041
4677
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4042
4678
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4043
- # @return [InlineResponse20025]
4679
+ # @return [InlineResponse20026]
4044
4680
  def get_event_types(opts = {})
4045
4681
  data, _status_code, _headers = get_event_types_with_http_info(opts)
4046
4682
  data
@@ -4055,7 +4691,7 @@ module TalonOne
4055
4691
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
4056
4692
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4057
4693
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4058
- # @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
4694
+ # @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
4059
4695
  def get_event_types_with_http_info(opts = {})
4060
4696
  if @api_client.config.debugging
4061
4697
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
@@ -4084,7 +4720,7 @@ module TalonOne
4084
4720
  post_body = opts[:body]
4085
4721
 
4086
4722
  # return_type
4087
- return_type = opts[:return_type] || 'InlineResponse20025'
4723
+ return_type = opts[:return_type] || 'InlineResponse20026'
4088
4724
 
4089
4725
  # auth_names
4090
4726
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -4113,7 +4749,7 @@ module TalonOne
4113
4749
  # @option opts [Integer] :application_id
4114
4750
  # @option opts [Integer] :campaign_id
4115
4751
  # @option opts [String] :entity The name of the entity type that was exported.
4116
- # @return [InlineResponse20028]
4752
+ # @return [InlineResponse20029]
4117
4753
  def get_exports(opts = {})
4118
4754
  data, _status_code, _headers = get_exports_with_http_info(opts)
4119
4755
  data
@@ -4127,7 +4763,7 @@ module TalonOne
4127
4763
  # @option opts [Integer] :application_id
4128
4764
  # @option opts [Integer] :campaign_id
4129
4765
  # @option opts [String] :entity The name of the entity type that was exported.
4130
- # @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
4766
+ # @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
4131
4767
  def get_exports_with_http_info(opts = {})
4132
4768
  if @api_client.config.debugging
4133
4769
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
@@ -4158,68 +4794,6 @@ module TalonOne
4158
4794
  # http body (model)
4159
4795
  post_body = opts[:body]
4160
4796
 
4161
- # return_type
4162
- return_type = opts[:return_type] || 'InlineResponse20028'
4163
-
4164
- # auth_names
4165
- auth_names = opts[:auth_names] || ['manager_auth']
4166
-
4167
- new_options = opts.merge(
4168
- :header_params => header_params,
4169
- :query_params => query_params,
4170
- :form_params => form_params,
4171
- :body => post_body,
4172
- :auth_names => auth_names,
4173
- :return_type => return_type
4174
- )
4175
-
4176
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4177
- if @api_client.config.debugging
4178
- @api_client.config.logger.debug "API called: ManagementApi#get_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4179
- end
4180
- return data, status_code, headers
4181
- end
4182
-
4183
- # Get Imports
4184
- # Get a list of all past imports
4185
- # @param [Hash] opts the optional parameters
4186
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
4187
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4188
- # @return [InlineResponse20029]
4189
- def get_imports(opts = {})
4190
- data, _status_code, _headers = get_imports_with_http_info(opts)
4191
- data
4192
- end
4193
-
4194
- # Get Imports
4195
- # Get a list of all past imports
4196
- # @param [Hash] opts the optional parameters
4197
- # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
4198
- # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4199
- # @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
4200
- def get_imports_with_http_info(opts = {})
4201
- if @api_client.config.debugging
4202
- @api_client.config.logger.debug 'Calling API: ManagementApi.get_imports ...'
4203
- end
4204
- # resource path
4205
- local_var_path = '/v1/imports'
4206
-
4207
- # query parameters
4208
- query_params = opts[:query_params] || {}
4209
- query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
4210
- query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
4211
-
4212
- # header parameters
4213
- header_params = opts[:header_params] || {}
4214
- # HTTP header 'Accept' (if needed)
4215
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4216
-
4217
- # form parameters
4218
- form_params = opts[:form_params] || {}
4219
-
4220
- # http body (model)
4221
- post_body = opts[:body]
4222
-
4223
4797
  # return_type
4224
4798
  return_type = opts[:return_type] || 'InlineResponse20029'
4225
4799
 
@@ -4237,7 +4811,7 @@ module TalonOne
4237
4811
 
4238
4812
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4239
4813
  if @api_client.config.debugging
4240
- @api_client.config.logger.debug "API called: ManagementApi#get_imports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4814
+ @api_client.config.logger.debug "API called: ManagementApi#get_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4241
4815
  end
4242
4816
  return data, status_code, headers
4243
4817
  end
@@ -4492,8 +5066,8 @@ module TalonOne
4492
5066
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4493
5067
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4494
5068
  # @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.
4495
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
4496
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
5069
+ # @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 timezone. Talon.One will convert to UTC internally.
5070
+ # @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 timezone. Talon.One will convert to UTC internally.
4497
5071
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
4498
5072
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
4499
5073
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field
@@ -4511,8 +5085,8 @@ module TalonOne
4511
5085
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4512
5086
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4513
5087
  # @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.
4514
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
4515
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
5088
+ # @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 timezone. Talon.One will convert to UTC internally.
5089
+ # @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 timezone. Talon.One will convert to UTC internally.
4516
5090
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
4517
5091
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
4518
5092
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field
@@ -4593,8 +5167,8 @@ module TalonOne
4593
5167
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4594
5168
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4595
5169
  # @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.
4596
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
4597
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
5170
+ # @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 timezone. Talon.One will convert to UTC internally.
5171
+ # @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 timezone. Talon.One will convert to UTC internally.
4598
5172
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
4599
5173
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
4600
5174
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field
@@ -4612,8 +5186,8 @@ module TalonOne
4612
5186
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4613
5187
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4614
5188
  # @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.
4615
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
4616
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
5189
+ # @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 timezone. Talon.One will convert to UTC internally.
5190
+ # @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 timezone. Talon.One will convert to UTC internally.
4617
5191
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
4618
5192
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only referrals where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only referrals where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
4619
5193
  # @option opts [String] :advocate Filter results by match with a profile id specified in the referral&#39;s AdvocateProfileIntegrationId field
@@ -4686,7 +5260,7 @@ module TalonOne
4686
5260
  return data, status_code, headers
4687
5261
  end
4688
5262
 
4689
- # Get information for the specified role.
5263
+ # Get information for the specified role
4690
5264
  # @param role_id [Integer]
4691
5265
  # @param [Hash] opts the optional parameters
4692
5266
  # @return [Role]
@@ -4695,7 +5269,7 @@ module TalonOne
4695
5269
  data
4696
5270
  end
4697
5271
 
4698
- # Get information for the specified role.
5272
+ # Get information for the specified role
4699
5273
  # @param role_id [Integer]
4700
5274
  # @param [Hash] opts the optional parameters
4701
5275
  # @return [Array<(Role, Integer, Hash)>] Role data, response status code and response headers
@@ -4961,7 +5535,7 @@ module TalonOne
4961
5535
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
4962
5536
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4963
5537
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4964
- # @return [InlineResponse20026]
5538
+ # @return [InlineResponse20027]
4965
5539
  def get_users(opts = {})
4966
5540
  data, _status_code, _headers = get_users_with_http_info(opts)
4967
5541
  data
@@ -4973,7 +5547,7 @@ module TalonOne
4973
5547
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
4974
5548
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
4975
5549
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
4976
- # @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
5550
+ # @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
4977
5551
  def get_users_with_http_info(opts = {})
4978
5552
  if @api_client.config.debugging
4979
5553
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
@@ -4999,7 +5573,7 @@ module TalonOne
4999
5573
  post_body = opts[:body]
5000
5574
 
5001
5575
  # return_type
5002
- return_type = opts[:return_type] || 'InlineResponse20026'
5576
+ return_type = opts[:return_type] || 'InlineResponse20027'
5003
5577
 
5004
5578
  # auth_names
5005
5579
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -5092,9 +5666,9 @@ module TalonOne
5092
5666
  # @option opts [Float] :webhook_id Filter results by Webhook.
5093
5667
  # @option opts [Float] :application_id
5094
5668
  # @option opts [Float] :campaign_id Filter results by campaign.
5095
- # @option opts [DateTime] :created_before Only return events created before this date.
5096
- # @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.
5097
- # @return [InlineResponse20023]
5669
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
5670
+ # @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 timezone. Talon.One will convert to UTC internally.
5671
+ # @return [InlineResponse20024]
5098
5672
  def get_webhook_activation_logs(opts = {})
5099
5673
  data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
5100
5674
  data
@@ -5110,9 +5684,9 @@ module TalonOne
5110
5684
  # @option opts [Float] :webhook_id Filter results by Webhook.
5111
5685
  # @option opts [Float] :application_id
5112
5686
  # @option opts [Float] :campaign_id Filter results by campaign.
5113
- # @option opts [DateTime] :created_before Only return events created before this date.
5114
- # @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.
5115
- # @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
5687
+ # @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
5688
+ # @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 timezone. Talon.One will convert to UTC internally.
5689
+ # @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
5116
5690
  def get_webhook_activation_logs_with_http_info(opts = {})
5117
5691
  if @api_client.config.debugging
5118
5692
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
@@ -5144,7 +5718,7 @@ module TalonOne
5144
5718
  post_body = opts[:body]
5145
5719
 
5146
5720
  # return_type
5147
- return_type = opts[:return_type] || 'InlineResponse20023'
5721
+ return_type = opts[:return_type] || 'InlineResponse20024'
5148
5722
 
5149
5723
  # auth_names
5150
5724
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -5175,9 +5749,9 @@ module TalonOne
5175
5749
  # @option opts [Float] :application_id
5176
5750
  # @option opts [Float] :campaign_id Filter results by campaign.
5177
5751
  # @option opts [String] :request_uuid Filter results by request UUID.
5178
- # @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.
5179
- # @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.
5180
- # @return [InlineResponse20024]
5752
+ # @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 timezone. Talon.One will convert to UTC internally.
5753
+ # @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 timezone. Talon.One will convert to UTC internally.
5754
+ # @return [InlineResponse20025]
5181
5755
  def get_webhook_logs(opts = {})
5182
5756
  data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
5183
5757
  data
@@ -5193,9 +5767,9 @@ module TalonOne
5193
5767
  # @option opts [Float] :application_id
5194
5768
  # @option opts [Float] :campaign_id Filter results by campaign.
5195
5769
  # @option opts [String] :request_uuid Filter results by request UUID.
5196
- # @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.
5197
- # @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.
5198
- # @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
5770
+ # @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 timezone. Talon.One will convert to UTC internally.
5771
+ # @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 timezone. Talon.One will convert to UTC internally.
5772
+ # @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
5199
5773
  def get_webhook_logs_with_http_info(opts = {})
5200
5774
  if @api_client.config.debugging
5201
5775
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
@@ -5232,7 +5806,7 @@ module TalonOne
5232
5806
  post_body = opts[:body]
5233
5807
 
5234
5808
  # return_type
5235
- return_type = opts[:return_type] || 'InlineResponse20024'
5809
+ return_type = opts[:return_type] || 'InlineResponse20025'
5236
5810
 
5237
5811
  # auth_names
5238
5812
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -5259,7 +5833,7 @@ module TalonOne
5259
5833
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5260
5834
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
5261
5835
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5262
- # @return [InlineResponse20022]
5836
+ # @return [InlineResponse20023]
5263
5837
  def get_webhooks(opts = {})
5264
5838
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
5265
5839
  data
@@ -5271,7 +5845,7 @@ module TalonOne
5271
5845
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5272
5846
  # @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
5273
5847
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5274
- # @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
5848
+ # @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
5275
5849
  def get_webhooks_with_http_info(opts = {})
5276
5850
  if @api_client.config.debugging
5277
5851
  @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
@@ -5298,7 +5872,7 @@ module TalonOne
5298
5872
  post_body = opts[:body]
5299
5873
 
5300
5874
  # return_type
5301
- return_type = opts[:return_type] || 'InlineResponse20022'
5875
+ return_type = opts[:return_type] || 'InlineResponse20023'
5302
5876
 
5303
5877
  # auth_names
5304
5878
  auth_names = opts[:auth_names] || ['manager_auth']
@@ -5465,8 +6039,8 @@ module TalonOne
5465
6039
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5466
6040
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5467
6041
  # @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.
5468
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5469
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6042
+ # @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 timezone. Talon.One will convert to UTC internally.
6043
+ # @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 timezone. Talon.One will convert to UTC internally.
5470
6044
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5471
6045
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5472
6046
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -5489,8 +6063,8 @@ module TalonOne
5489
6063
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5490
6064
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5491
6065
  # @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.
5492
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5493
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6066
+ # @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 timezone. Talon.One will convert to UTC internally.
6067
+ # @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 timezone. Talon.One will convert to UTC internally.
5494
6068
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5495
6069
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5496
6070
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -5584,8 +6158,8 @@ module TalonOne
5584
6158
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5585
6159
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5586
6160
  # @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.
5587
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5588
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6161
+ # @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 timezone. Talon.One will convert to UTC internally.
6162
+ # @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 timezone. Talon.One will convert to UTC internally.
5589
6163
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5590
6164
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5591
6165
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -5608,8 +6182,8 @@ module TalonOne
5608
6182
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5609
6183
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5610
6184
  # @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.
5611
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5612
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6185
+ # @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 timezone. Talon.One will convert to UTC internally.
6186
+ # @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 timezone. Talon.One will convert to UTC internally.
5613
6187
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5614
6188
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5615
6189
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -5705,8 +6279,8 @@ module TalonOne
5705
6279
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5706
6280
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5707
6281
  # @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.
5708
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5709
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6282
+ # @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 timezone. Talon.One will convert to UTC internally.
6283
+ # @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 timezone. Talon.One will convert to UTC internally.
5710
6284
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5711
6285
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5712
6286
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -5729,8 +6303,8 @@ module TalonOne
5729
6303
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5730
6304
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5731
6305
  # @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.
5732
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5733
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6306
+ # @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 timezone. Talon.One will convert to UTC internally.
6307
+ # @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 timezone. Talon.One will convert to UTC internally.
5734
6308
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5735
6309
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5736
6310
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -5827,8 +6401,8 @@ module TalonOne
5827
6401
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5828
6402
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5829
6403
  # @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.
5830
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5831
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6404
+ # @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 timezone. Talon.One will convert to UTC internally.
6405
+ # @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 timezone. Talon.One will convert to UTC internally.
5832
6406
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5833
6407
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5834
6408
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
@@ -5851,8 +6425,8 @@ module TalonOne
5851
6425
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
5852
6426
  # @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with &#x60;-&#x60; to sort in descending order.
5853
6427
  # @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.
5854
- # @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
5855
- # @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
6428
+ # @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 timezone. Talon.One will convert to UTC internally.
6429
+ # @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 timezone. Talon.One will convert to UTC internally.
5856
6430
  # @option opts [String] :valid Either \&quot;expired\&quot;, \&quot;validNow\&quot;, or \&quot;validFuture\&quot;. The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
5857
6431
  # @option opts [String] :usable Either \&quot;true\&quot; or \&quot;false\&quot;. If \&quot;true\&quot;, only coupons where &#x60;usageCounter &lt; usageLimit&#x60; will be returned, \&quot;false\&quot; will return only coupons where &#x60;usageCounter &gt;&#x3D; usageLimit&#x60;.
5858
6432
  # @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.