talon_one 3.0.0 → 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -4
- data/docs/AddLoyaltyPoints.md +2 -2
- data/docs/CustomEffect.md +1 -1
- data/docs/InlineResponse2001.md +1 -1
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +2 -2
- data/docs/InlineResponse20014.md +3 -5
- data/docs/InlineResponse20015.md +4 -2
- data/docs/InlineResponse20016.md +2 -4
- data/docs/InlineResponse20017.md +4 -2
- data/docs/InlineResponse20018.md +2 -2
- data/docs/InlineResponse20019.md +1 -1
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse20020.md +2 -4
- data/docs/InlineResponse20021.md +3 -3
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +3 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +2 -2
- data/docs/InlineResponse20026.md +2 -2
- data/docs/InlineResponse20027.md +3 -3
- data/docs/InlineResponse20028.md +3 -5
- data/docs/InlineResponse20029.md +1 -1
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse20030.md +5 -3
- data/docs/InlineResponse20031.md +1 -1
- data/docs/InlineResponse20032.md +1 -1
- data/docs/InlineResponse20033.md +1 -1
- data/docs/InlineResponse20034.md +1 -1
- data/docs/InlineResponse20035.md +1 -1
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +2 -4
- data/docs/InlineResponse20038.md +4 -2
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/InlineResponse20040.md +19 -0
- data/docs/InlineResponse2005.md +1 -1
- data/docs/InlineResponse2006.md +1 -1
- data/docs/InlineResponse2007.md +2 -2
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +1 -1
- data/docs/IntegrationApi.md +26 -26
- data/docs/ManagementApi.md +141 -141
- data/docs/MultiApplicationEntity.md +1 -1
- data/docs/NewCustomEffect.md +1 -1
- data/docs/NewOutgoingIntegrationWebhook.md +19 -0
- data/docs/NewWebhook.md +3 -3
- data/docs/OutgoingIntegrationConfiguration.md +3 -1
- data/docs/OutgoingIntegrationWebhookTemplate.md +3 -1
- data/docs/ReopenSessionResponse.md +17 -0
- data/docs/StrikethroughCustomEffectPerItemProps.md +21 -0
- data/docs/UpdateCustomEffect.md +1 -1
- data/docs/Webhook.md +3 -3
- data/lib/talon_one/api/integration_api.rb +48 -48
- data/lib/talon_one/api/management_api.rb +234 -234
- data/lib/talon_one/models/add_loyalty_points.rb +2 -2
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/inline_response2001.rb +1 -1
- data/lib/talon_one/models/inline_response20010.rb +11 -11
- data/lib/talon_one/models/inline_response20011.rb +11 -11
- data/lib/talon_one/models/inline_response20012.rb +1 -1
- data/lib/talon_one/models/inline_response20013.rb +1 -3
- data/lib/talon_one/models/inline_response20014.rb +9 -11
- data/lib/talon_one/models/inline_response20015.rb +11 -7
- data/lib/talon_one/models/inline_response20016.rb +7 -11
- data/lib/talon_one/models/inline_response20017.rb +11 -7
- data/lib/talon_one/models/inline_response20018.rb +10 -10
- data/lib/talon_one/models/inline_response20019.rb +1 -1
- data/lib/talon_one/models/inline_response2002.rb +11 -11
- data/lib/talon_one/models/inline_response20020.rb +7 -11
- data/lib/talon_one/models/inline_response20021.rb +10 -10
- data/lib/talon_one/models/inline_response20022.rb +1 -1
- data/lib/talon_one/models/inline_response20023.rb +10 -6
- data/lib/talon_one/models/inline_response20024.rb +1 -1
- data/lib/talon_one/models/inline_response20025.rb +6 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -6
- data/lib/talon_one/models/inline_response20027.rb +11 -11
- data/lib/talon_one/models/inline_response20028.rb +7 -11
- data/lib/talon_one/models/inline_response20029.rb +1 -1
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +11 -7
- data/lib/talon_one/models/inline_response20031.rb +1 -1
- data/lib/talon_one/models/inline_response20032.rb +1 -1
- data/lib/talon_one/models/inline_response20033.rb +1 -1
- data/lib/talon_one/models/inline_response20034.rb +1 -1
- data/lib/talon_one/models/inline_response20035.rb +1 -1
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +7 -11
- data/lib/talon_one/models/inline_response20038.rb +11 -7
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +227 -0
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +1 -1
- data/lib/talon_one/models/inline_response2007.rb +10 -10
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +1 -1
- data/lib/talon_one/models/multi_application_entity.rb +1 -1
- data/lib/talon_one/models/new_custom_effect.rb +1 -1
- data/lib/talon_one/models/new_outgoing_integration_webhook.rb +229 -0
- data/lib/talon_one/models/new_webhook.rb +3 -3
- data/lib/talon_one/models/outgoing_integration_configuration.rb +16 -1
- data/lib/talon_one/models/outgoing_integration_webhook_template.rb +53 -4
- data/lib/talon_one/models/reopen_session_response.rb +215 -0
- data/lib/talon_one/models/strikethrough_custom_effect_per_item_props.rb +243 -0
- data/lib/talon_one/models/update_custom_effect.rb +1 -1
- data/lib/talon_one/models/webhook.rb +3 -3
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +4 -0
- data/spec/api/integration_api_spec.rb +9 -9
- data/spec/api/management_api_spec.rb +59 -59
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +1 -1
- data/spec/models/inline_response20014_spec.rb +0 -6
- data/spec/models/inline_response20015_spec.rb +6 -0
- data/spec/models/inline_response20016_spec.rb +0 -6
- data/spec/models/inline_response20017_spec.rb +6 -0
- data/spec/models/inline_response20018_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +0 -6
- data/spec/models/inline_response20021_spec.rb +2 -2
- data/spec/models/inline_response20023_spec.rb +6 -0
- data/spec/models/inline_response20027_spec.rb +1 -1
- data/spec/models/inline_response20028_spec.rb +0 -6
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20030_spec.rb +6 -0
- data/spec/models/inline_response20037_spec.rb +0 -6
- data/spec/models/inline_response20038_spec.rb +6 -0
- data/spec/models/inline_response20040_spec.rb +47 -0
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/new_outgoing_integration_webhook_spec.rb +47 -0
- data/spec/models/outgoing_integration_configuration_spec.rb +6 -0
- data/spec/models/outgoing_integration_webhook_template_spec.rb +10 -0
- data/spec/models/reopen_session_response_spec.rb +41 -0
- data/spec/models/strikethrough_custom_effect_per_item_props_spec.rb +53 -0
- metadata +18 -2
@@ -19,26 +19,26 @@ module TalonOne
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Add points to card
|
22
|
+
# Add points to card
|
23
23
|
# Add points to the given loyalty card in the specified card-based loyalty program.
|
24
24
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
25
|
-
# @param
|
25
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
26
26
|
# @param body [AddLoyaltyPoints] body
|
27
27
|
# @param [Hash] opts the optional parameters
|
28
28
|
# @return [nil]
|
29
|
-
def add_loyalty_card_points(loyalty_program_id,
|
30
|
-
add_loyalty_card_points_with_http_info(loyalty_program_id,
|
29
|
+
def add_loyalty_card_points(loyalty_program_id, loyalty_card_id, body, opts = {})
|
30
|
+
add_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
|
31
31
|
nil
|
32
32
|
end
|
33
33
|
|
34
|
-
# Add points to card
|
34
|
+
# Add points to card
|
35
35
|
# Add points to the given loyalty card in the specified card-based loyalty program.
|
36
36
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
37
|
-
# @param
|
37
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
38
38
|
# @param body [AddLoyaltyPoints] body
|
39
39
|
# @param [Hash] opts the optional parameters
|
40
40
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
41
|
-
def add_loyalty_card_points_with_http_info(loyalty_program_id,
|
41
|
+
def add_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
|
42
42
|
if @api_client.config.debugging
|
43
43
|
@api_client.config.logger.debug 'Calling API: ManagementApi.add_loyalty_card_points ...'
|
44
44
|
end
|
@@ -46,12 +46,12 @@ module TalonOne
|
|
46
46
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
47
47
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.add_loyalty_card_points"
|
48
48
|
end
|
49
|
-
# verify the required parameter '
|
50
|
-
if @api_client.config.client_side_validation &&
|
51
|
-
fail ArgumentError, "Missing the required parameter '
|
49
|
+
# verify the required parameter 'loyalty_card_id' is set
|
50
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
51
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.add_loyalty_card_points"
|
52
52
|
end
|
53
|
-
if @api_client.config.client_side_validation &&
|
54
|
-
fail ArgumentError, 'invalid value for "
|
53
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
54
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.add_loyalty_card_points, the character length must be smaller than or equal to 108.'
|
55
55
|
end
|
56
56
|
|
57
57
|
# verify the required parameter 'body' is set
|
@@ -59,7 +59,7 @@ module TalonOne
|
|
59
59
|
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.add_loyalty_card_points"
|
60
60
|
end
|
61
61
|
# resource path
|
62
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
62
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
63
63
|
|
64
64
|
# query parameters
|
65
65
|
query_params = opts[:query_params] || {}
|
@@ -181,7 +181,7 @@ module TalonOne
|
|
181
181
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
182
182
|
# @param body [CampaignCopy] body
|
183
183
|
# @param [Hash] opts the optional parameters
|
184
|
-
# @return [
|
184
|
+
# @return [InlineResponse2004]
|
185
185
|
def copy_campaign_to_applications(application_id, campaign_id, body, opts = {})
|
186
186
|
data, _status_code, _headers = copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts)
|
187
187
|
data
|
@@ -193,7 +193,7 @@ module TalonOne
|
|
193
193
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
194
194
|
# @param body [CampaignCopy] body
|
195
195
|
# @param [Hash] opts the optional parameters
|
196
|
-
# @return [Array<(
|
196
|
+
# @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
|
197
197
|
def copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {})
|
198
198
|
if @api_client.config.debugging
|
199
199
|
@api_client.config.logger.debug 'Calling API: ManagementApi.copy_campaign_to_applications ...'
|
@@ -230,7 +230,7 @@ module TalonOne
|
|
230
230
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
231
231
|
|
232
232
|
# return_type
|
233
|
-
return_type = opts[:return_type] || '
|
233
|
+
return_type = opts[:return_type] || 'InlineResponse2004'
|
234
234
|
|
235
235
|
# auth_names
|
236
236
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -596,7 +596,7 @@ module TalonOne
|
|
596
596
|
# @param body [NewCoupons] body
|
597
597
|
# @param [Hash] opts the optional parameters
|
598
598
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (default to 'yes')
|
599
|
-
# @return [
|
599
|
+
# @return [InlineResponse2007]
|
600
600
|
def create_coupons(application_id, campaign_id, body, opts = {})
|
601
601
|
data, _status_code, _headers = create_coupons_with_http_info(application_id, campaign_id, body, opts)
|
602
602
|
data
|
@@ -609,7 +609,7 @@ module TalonOne
|
|
609
609
|
# @param body [NewCoupons] body
|
610
610
|
# @param [Hash] opts the optional parameters
|
611
611
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
612
|
-
# @return [Array<(
|
612
|
+
# @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
|
613
613
|
def create_coupons_with_http_info(application_id, campaign_id, body, opts = {})
|
614
614
|
if @api_client.config.debugging
|
615
615
|
@api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons ...'
|
@@ -647,7 +647,7 @@ module TalonOne
|
|
647
647
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
648
648
|
|
649
649
|
# return_type
|
650
|
-
return_type = opts[:return_type] || '
|
650
|
+
return_type = opts[:return_type] || 'InlineResponse2007'
|
651
651
|
|
652
652
|
# auth_names
|
653
653
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -751,7 +751,7 @@ module TalonOne
|
|
751
751
|
# @param body [NewCouponsForMultipleRecipients] body
|
752
752
|
# @param [Hash] opts the optional parameters
|
753
753
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (default to 'yes')
|
754
|
-
# @return [
|
754
|
+
# @return [InlineResponse2007]
|
755
755
|
def create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {})
|
756
756
|
data, _status_code, _headers = create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts)
|
757
757
|
data
|
@@ -764,7 +764,7 @@ module TalonOne
|
|
764
764
|
# @param body [NewCouponsForMultipleRecipients] body
|
765
765
|
# @param [Hash] opts the optional parameters
|
766
766
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
767
|
-
# @return [Array<(
|
767
|
+
# @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
|
768
768
|
def create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {})
|
769
769
|
if @api_client.config.debugging
|
770
770
|
@api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_for_multiple_recipients ...'
|
@@ -802,7 +802,7 @@ module TalonOne
|
|
802
802
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
803
803
|
|
804
804
|
# return_type
|
805
|
-
return_type = opts[:return_type] || '
|
805
|
+
return_type = opts[:return_type] || 'InlineResponse2007'
|
806
806
|
|
807
807
|
# auth_names
|
808
808
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -1021,26 +1021,26 @@ module TalonOne
|
|
1021
1021
|
return data, status_code, headers
|
1022
1022
|
end
|
1023
1023
|
|
1024
|
-
# Deduct points from card
|
1024
|
+
# Deduct points from card
|
1025
1025
|
# Deduct points from the given loyalty card in the specified card-based loyalty program.
|
1026
1026
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
1027
|
-
# @param
|
1027
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
1028
1028
|
# @param body [DeductLoyaltyPoints] body
|
1029
1029
|
# @param [Hash] opts the optional parameters
|
1030
1030
|
# @return [nil]
|
1031
|
-
def deduct_loyalty_card_points(loyalty_program_id,
|
1032
|
-
deduct_loyalty_card_points_with_http_info(loyalty_program_id,
|
1031
|
+
def deduct_loyalty_card_points(loyalty_program_id, loyalty_card_id, body, opts = {})
|
1032
|
+
deduct_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
|
1033
1033
|
nil
|
1034
1034
|
end
|
1035
1035
|
|
1036
|
-
# Deduct points from card
|
1036
|
+
# Deduct points from card
|
1037
1037
|
# Deduct points from the given loyalty card in the specified card-based loyalty program.
|
1038
1038
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
1039
|
-
# @param
|
1039
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
1040
1040
|
# @param body [DeductLoyaltyPoints] body
|
1041
1041
|
# @param [Hash] opts the optional parameters
|
1042
1042
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1043
|
-
def deduct_loyalty_card_points_with_http_info(loyalty_program_id,
|
1043
|
+
def deduct_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
|
1044
1044
|
if @api_client.config.debugging
|
1045
1045
|
@api_client.config.logger.debug 'Calling API: ManagementApi.deduct_loyalty_card_points ...'
|
1046
1046
|
end
|
@@ -1048,12 +1048,12 @@ module TalonOne
|
|
1048
1048
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
1049
1049
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.deduct_loyalty_card_points"
|
1050
1050
|
end
|
1051
|
-
# verify the required parameter '
|
1052
|
-
if @api_client.config.client_side_validation &&
|
1053
|
-
fail ArgumentError, "Missing the required parameter '
|
1051
|
+
# verify the required parameter 'loyalty_card_id' is set
|
1052
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
1053
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.deduct_loyalty_card_points"
|
1054
1054
|
end
|
1055
|
-
if @api_client.config.client_side_validation &&
|
1056
|
-
fail ArgumentError, 'invalid value for "
|
1055
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
1056
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.deduct_loyalty_card_points, the character length must be smaller than or equal to 108.'
|
1057
1057
|
end
|
1058
1058
|
|
1059
1059
|
# verify the required parameter 'body' is set
|
@@ -1061,7 +1061,7 @@ module TalonOne
|
|
1061
1061
|
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.deduct_loyalty_card_points"
|
1062
1062
|
end
|
1063
1063
|
# resource path
|
1064
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
1064
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
1065
1065
|
|
1066
1066
|
# query parameters
|
1067
1067
|
query_params = opts[:query_params] || {}
|
@@ -1491,21 +1491,21 @@ module TalonOne
|
|
1491
1491
|
# Delete loyalty card
|
1492
1492
|
# Delete the given loyalty card.
|
1493
1493
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
1494
|
-
# @param
|
1494
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
1495
1495
|
# @param [Hash] opts the optional parameters
|
1496
1496
|
# @return [nil]
|
1497
|
-
def delete_loyalty_card(loyalty_program_id,
|
1498
|
-
delete_loyalty_card_with_http_info(loyalty_program_id,
|
1497
|
+
def delete_loyalty_card(loyalty_program_id, loyalty_card_id, opts = {})
|
1498
|
+
delete_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
1499
1499
|
nil
|
1500
1500
|
end
|
1501
1501
|
|
1502
1502
|
# Delete loyalty card
|
1503
1503
|
# Delete the given loyalty card.
|
1504
1504
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
1505
|
-
# @param
|
1505
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
1506
1506
|
# @param [Hash] opts the optional parameters
|
1507
1507
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1508
|
-
def delete_loyalty_card_with_http_info(loyalty_program_id,
|
1508
|
+
def delete_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
1509
1509
|
if @api_client.config.debugging
|
1510
1510
|
@api_client.config.logger.debug 'Calling API: ManagementApi.delete_loyalty_card ...'
|
1511
1511
|
end
|
@@ -1513,16 +1513,16 @@ module TalonOne
|
|
1513
1513
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
1514
1514
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.delete_loyalty_card"
|
1515
1515
|
end
|
1516
|
-
# verify the required parameter '
|
1517
|
-
if @api_client.config.client_side_validation &&
|
1518
|
-
fail ArgumentError, "Missing the required parameter '
|
1516
|
+
# verify the required parameter 'loyalty_card_id' is set
|
1517
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
1518
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.delete_loyalty_card"
|
1519
1519
|
end
|
1520
|
-
if @api_client.config.client_side_validation &&
|
1521
|
-
fail ArgumentError, 'invalid value for "
|
1520
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
1521
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.delete_loyalty_card, the character length must be smaller than or equal to 108.'
|
1522
1522
|
end
|
1523
1523
|
|
1524
1524
|
# resource path
|
1525
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
1525
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
1526
1526
|
|
1527
1527
|
# query parameters
|
1528
1528
|
query_params = opts[:query_params] || {}
|
@@ -2298,7 +2298,7 @@ module TalonOne
|
|
2298
2298
|
return data, status_code, headers
|
2299
2299
|
end
|
2300
2300
|
|
2301
|
-
# Export
|
2301
|
+
# Export all card transaction logs
|
2302
2302
|
# Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
|
2303
2303
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2304
2304
|
# @param [Hash] opts the optional parameters
|
@@ -2309,7 +2309,7 @@ module TalonOne
|
|
2309
2309
|
data
|
2310
2310
|
end
|
2311
2311
|
|
2312
|
-
# Export
|
2312
|
+
# Export all card transaction logs
|
2313
2313
|
# Download a CSV file containing the balances of all cards in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
|
2314
2314
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2315
2315
|
# @param [Hash] opts the optional parameters
|
@@ -2363,30 +2363,30 @@ module TalonOne
|
|
2363
2363
|
return data, status_code, headers
|
2364
2364
|
end
|
2365
2365
|
|
2366
|
-
# Export
|
2366
|
+
# Export card's ledger log
|
2367
2367
|
# Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
|
2368
2368
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2369
|
-
# @param
|
2369
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
2370
2370
|
# @param range_start [DateTime] Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
2371
2371
|
# @param range_end [DateTime] Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
2372
2372
|
# @param [Hash] opts the optional parameters
|
2373
2373
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
2374
2374
|
# @return [String]
|
2375
|
-
def export_loyalty_card_ledger(loyalty_program_id,
|
2376
|
-
data, _status_code, _headers = export_loyalty_card_ledger_with_http_info(loyalty_program_id,
|
2375
|
+
def export_loyalty_card_ledger(loyalty_program_id, loyalty_card_id, range_start, range_end, opts = {})
|
2376
|
+
data, _status_code, _headers = export_loyalty_card_ledger_with_http_info(loyalty_program_id, loyalty_card_id, range_start, range_end, opts)
|
2377
2377
|
data
|
2378
2378
|
end
|
2379
2379
|
|
2380
|
-
# Export
|
2380
|
+
# Export card's ledger log
|
2381
2381
|
# Download a CSV file containing a loyalty card ledger log of the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/).
|
2382
2382
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2383
|
-
# @param
|
2383
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
2384
2384
|
# @param range_start [DateTime] Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
2385
2385
|
# @param range_end [DateTime] Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
2386
2386
|
# @param [Hash] opts the optional parameters
|
2387
2387
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
2388
2388
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
2389
|
-
def export_loyalty_card_ledger_with_http_info(loyalty_program_id,
|
2389
|
+
def export_loyalty_card_ledger_with_http_info(loyalty_program_id, loyalty_card_id, range_start, range_end, opts = {})
|
2390
2390
|
if @api_client.config.debugging
|
2391
2391
|
@api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_card_ledger ...'
|
2392
2392
|
end
|
@@ -2394,12 +2394,12 @@ module TalonOne
|
|
2394
2394
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
2395
2395
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_card_ledger"
|
2396
2396
|
end
|
2397
|
-
# verify the required parameter '
|
2398
|
-
if @api_client.config.client_side_validation &&
|
2399
|
-
fail ArgumentError, "Missing the required parameter '
|
2397
|
+
# verify the required parameter 'loyalty_card_id' is set
|
2398
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
2399
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.export_loyalty_card_ledger"
|
2400
2400
|
end
|
2401
|
-
if @api_client.config.client_side_validation &&
|
2402
|
-
fail ArgumentError, 'invalid value for "
|
2401
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
2402
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.export_loyalty_card_ledger, the character length must be smaller than or equal to 108.'
|
2403
2403
|
end
|
2404
2404
|
|
2405
2405
|
# verify the required parameter 'range_start' is set
|
@@ -2415,7 +2415,7 @@ module TalonOne
|
|
2415
2415
|
fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
|
2416
2416
|
end
|
2417
2417
|
# resource path
|
2418
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
2418
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
2419
2419
|
|
2420
2420
|
# query parameters
|
2421
2421
|
query_params = opts[:query_params] || {}
|
@@ -2652,7 +2652,7 @@ module TalonOne
|
|
2652
2652
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
2653
2653
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2654
2654
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
2655
|
-
# @return [
|
2655
|
+
# @return [InlineResponse20018]
|
2656
2656
|
def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
|
2657
2657
|
data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
|
2658
2658
|
data
|
@@ -2670,7 +2670,7 @@ module TalonOne
|
|
2670
2670
|
# @option opts [Integer] :page_size The number of items in this response.
|
2671
2671
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2672
2672
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
2673
|
-
# @return [Array<(
|
2673
|
+
# @return [Array<(InlineResponse20018, Integer, Hash)>] InlineResponse20018 data, response status code and response headers
|
2674
2674
|
def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
|
2675
2675
|
if @api_client.config.debugging
|
2676
2676
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs_without_total_count ...'
|
@@ -2729,7 +2729,7 @@ module TalonOne
|
|
2729
2729
|
post_body = opts[:body]
|
2730
2730
|
|
2731
2731
|
# return_type
|
2732
|
-
return_type = opts[:return_type] || '
|
2732
|
+
return_type = opts[:return_type] || 'InlineResponse20018'
|
2733
2733
|
|
2734
2734
|
# auth_names
|
2735
2735
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3004,7 +3004,7 @@ module TalonOne
|
|
3004
3004
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
3005
3005
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3006
3006
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3007
|
-
# @return [
|
3007
|
+
# @return [InlineResponse20032]
|
3008
3008
|
def get_additional_costs(opts = {})
|
3009
3009
|
data, _status_code, _headers = get_additional_costs_with_http_info(opts)
|
3010
3010
|
data
|
@@ -3016,7 +3016,7 @@ module TalonOne
|
|
3016
3016
|
# @option opts [Integer] :page_size The number of items in this response.
|
3017
3017
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3018
3018
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3019
|
-
# @return [Array<(
|
3019
|
+
# @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
|
3020
3020
|
def get_additional_costs_with_http_info(opts = {})
|
3021
3021
|
if @api_client.config.debugging
|
3022
3022
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
|
@@ -3050,7 +3050,7 @@ module TalonOne
|
|
3050
3050
|
post_body = opts[:body]
|
3051
3051
|
|
3052
3052
|
# return_type
|
3053
|
-
return_type = opts[:return_type] || '
|
3053
|
+
return_type = opts[:return_type] || 'InlineResponse20032'
|
3054
3054
|
|
3055
3055
|
# auth_names
|
3056
3056
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3082,7 +3082,7 @@ module TalonOne
|
|
3082
3082
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
3083
3083
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3084
3084
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3085
|
-
# @return [
|
3085
|
+
# @return [InlineResponse20019]
|
3086
3086
|
def get_all_access_logs(range_start, range_end, opts = {})
|
3087
3087
|
data, _status_code, _headers = get_all_access_logs_with_http_info(range_start, range_end, opts)
|
3088
3088
|
data
|
@@ -3099,7 +3099,7 @@ module TalonOne
|
|
3099
3099
|
# @option opts [Integer] :page_size The number of items in this response.
|
3100
3100
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3101
3101
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3102
|
-
# @return [Array<(
|
3102
|
+
# @return [Array<(InlineResponse20019, Integer, Hash)>] InlineResponse20019 data, response status code and response headers
|
3103
3103
|
def get_all_access_logs_with_http_info(range_start, range_end, opts = {})
|
3104
3104
|
if @api_client.config.debugging
|
3105
3105
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_all_access_logs ...'
|
@@ -3154,7 +3154,7 @@ module TalonOne
|
|
3154
3154
|
post_body = opts[:body]
|
3155
3155
|
|
3156
3156
|
# return_type
|
3157
|
-
return_type = opts[:return_type] || '
|
3157
|
+
return_type = opts[:return_type] || 'InlineResponse20019'
|
3158
3158
|
|
3159
3159
|
# auth_names
|
3160
3160
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3178,7 +3178,7 @@ module TalonOne
|
|
3178
3178
|
# List roles
|
3179
3179
|
# List all roles.
|
3180
3180
|
# @param [Hash] opts the optional parameters
|
3181
|
-
# @return [
|
3181
|
+
# @return [InlineResponse20040]
|
3182
3182
|
def get_all_roles(opts = {})
|
3183
3183
|
data, _status_code, _headers = get_all_roles_with_http_info(opts)
|
3184
3184
|
data
|
@@ -3187,7 +3187,7 @@ module TalonOne
|
|
3187
3187
|
# List roles
|
3188
3188
|
# List all roles.
|
3189
3189
|
# @param [Hash] opts the optional parameters
|
3190
|
-
# @return [Array<(
|
3190
|
+
# @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
|
3191
3191
|
def get_all_roles_with_http_info(opts = {})
|
3192
3192
|
if @api_client.config.debugging
|
3193
3193
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_all_roles ...'
|
@@ -3210,7 +3210,7 @@ module TalonOne
|
|
3210
3210
|
post_body = opts[:body]
|
3211
3211
|
|
3212
3212
|
# return_type
|
3213
|
-
return_type = opts[:return_type] || '
|
3213
|
+
return_type = opts[:return_type] || 'InlineResponse20040'
|
3214
3214
|
|
3215
3215
|
# auth_names
|
3216
3216
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3432,7 +3432,7 @@ module TalonOne
|
|
3432
3432
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3433
3433
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3434
3434
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
3435
|
-
# @return [
|
3435
|
+
# @return [InlineResponse20030]
|
3436
3436
|
def get_application_customer_friends(application_id, integration_id, opts = {})
|
3437
3437
|
data, _status_code, _headers = get_application_customer_friends_with_http_info(application_id, integration_id, opts)
|
3438
3438
|
data
|
@@ -3447,7 +3447,7 @@ module TalonOne
|
|
3447
3447
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3448
3448
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3449
3449
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
3450
|
-
# @return [Array<(
|
3450
|
+
# @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
|
3451
3451
|
def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
|
3452
3452
|
if @api_client.config.debugging
|
3453
3453
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer_friends ...'
|
@@ -3490,7 +3490,7 @@ module TalonOne
|
|
3490
3490
|
post_body = opts[:body]
|
3491
3491
|
|
3492
3492
|
# return_type
|
3493
|
-
return_type = opts[:return_type] || '
|
3493
|
+
return_type = opts[:return_type] || 'InlineResponse20030'
|
3494
3494
|
|
3495
3495
|
# auth_names
|
3496
3496
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3519,7 +3519,7 @@ module TalonOne
|
|
3519
3519
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
3520
3520
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3521
3521
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
3522
|
-
# @return [
|
3522
|
+
# @return [InlineResponse20021]
|
3523
3523
|
def get_application_customers(application_id, opts = {})
|
3524
3524
|
data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts)
|
3525
3525
|
data
|
@@ -3533,7 +3533,7 @@ module TalonOne
|
|
3533
3533
|
# @option opts [Integer] :page_size The number of items in this response.
|
3534
3534
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3535
3535
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
3536
|
-
# @return [Array<(
|
3536
|
+
# @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
|
3537
3537
|
def get_application_customers_with_http_info(application_id, opts = {})
|
3538
3538
|
if @api_client.config.debugging
|
3539
3539
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...'
|
@@ -3572,7 +3572,7 @@ module TalonOne
|
|
3572
3572
|
post_body = opts[:body]
|
3573
3573
|
|
3574
3574
|
# return_type
|
3575
|
-
return_type = opts[:return_type] || '
|
3575
|
+
return_type = opts[:return_type] || 'InlineResponse20021'
|
3576
3576
|
|
3577
3577
|
# auth_names
|
3578
3578
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3601,7 +3601,7 @@ module TalonOne
|
|
3601
3601
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
3602
3602
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3603
3603
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
3604
|
-
# @return [
|
3604
|
+
# @return [InlineResponse20022]
|
3605
3605
|
def get_application_customers_by_attributes(application_id, body, opts = {})
|
3606
3606
|
data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(application_id, body, opts)
|
3607
3607
|
data
|
@@ -3615,7 +3615,7 @@ module TalonOne
|
|
3615
3615
|
# @option opts [Integer] :page_size The number of items in this response.
|
3616
3616
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3617
3617
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
3618
|
-
# @return [Array<(
|
3618
|
+
# @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
|
3619
3619
|
def get_application_customers_by_attributes_with_http_info(application_id, body, opts = {})
|
3620
3620
|
if @api_client.config.debugging
|
3621
3621
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...'
|
@@ -3659,7 +3659,7 @@ module TalonOne
|
|
3659
3659
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
3660
3660
|
|
3661
3661
|
# return_type
|
3662
|
-
return_type = opts[:return_type] || '
|
3662
|
+
return_type = opts[:return_type] || 'InlineResponse20022'
|
3663
3663
|
|
3664
3664
|
# auth_names
|
3665
3665
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3687,7 +3687,7 @@ module TalonOne
|
|
3687
3687
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
3688
3688
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3689
3689
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3690
|
-
# @return [
|
3690
|
+
# @return [InlineResponse20028]
|
3691
3691
|
def get_application_event_types(application_id, opts = {})
|
3692
3692
|
data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
|
3693
3693
|
data
|
@@ -3700,7 +3700,7 @@ module TalonOne
|
|
3700
3700
|
# @option opts [Integer] :page_size The number of items in this response.
|
3701
3701
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3702
3702
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3703
|
-
# @return [Array<(
|
3703
|
+
# @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
|
3704
3704
|
def get_application_event_types_with_http_info(application_id, opts = {})
|
3705
3705
|
if @api_client.config.debugging
|
3706
3706
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...'
|
@@ -3738,7 +3738,7 @@ module TalonOne
|
|
3738
3738
|
post_body = opts[:body]
|
3739
3739
|
|
3740
3740
|
# return_type
|
3741
|
-
return_type = opts[:return_type] || '
|
3741
|
+
return_type = opts[:return_type] || 'InlineResponse20028'
|
3742
3742
|
|
3743
3743
|
# auth_names
|
3744
3744
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3777,7 +3777,7 @@ module TalonOne
|
|
3777
3777
|
# @option opts [String] :referral_code Referral code
|
3778
3778
|
# @option opts [String] :rule_query Rule name filter for events
|
3779
3779
|
# @option opts [String] :campaign_query Campaign name filter for events
|
3780
|
-
# @return [
|
3780
|
+
# @return [InlineResponse20027]
|
3781
3781
|
def get_application_events_without_total_count(application_id, opts = {})
|
3782
3782
|
data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
|
3783
3783
|
data
|
@@ -3801,7 +3801,7 @@ module TalonOne
|
|
3801
3801
|
# @option opts [String] :referral_code Referral code
|
3802
3802
|
# @option opts [String] :rule_query Rule name filter for events
|
3803
3803
|
# @option opts [String] :campaign_query Campaign name filter for events
|
3804
|
-
# @return [Array<(
|
3804
|
+
# @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
|
3805
3805
|
def get_application_events_without_total_count_with_http_info(application_id, opts = {})
|
3806
3806
|
if @api_client.config.debugging
|
3807
3807
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...'
|
@@ -3858,7 +3858,7 @@ module TalonOne
|
|
3858
3858
|
post_body = opts[:body]
|
3859
3859
|
|
3860
3860
|
# return_type
|
3861
|
-
return_type = opts[:return_type] || '
|
3861
|
+
return_type = opts[:return_type] || 'InlineResponse20027'
|
3862
3862
|
|
3863
3863
|
# auth_names
|
3864
3864
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3961,7 +3961,7 @@ module TalonOne
|
|
3961
3961
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
3962
3962
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
3963
3963
|
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
3964
|
-
# @return [
|
3964
|
+
# @return [InlineResponse20026]
|
3965
3965
|
def get_application_sessions(application_id, opts = {})
|
3966
3966
|
data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts)
|
3967
3967
|
data
|
@@ -3981,7 +3981,7 @@ module TalonOne
|
|
3981
3981
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
3982
3982
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
3983
3983
|
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
3984
|
-
# @return [Array<(
|
3984
|
+
# @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
|
3985
3985
|
def get_application_sessions_with_http_info(application_id, opts = {})
|
3986
3986
|
if @api_client.config.debugging
|
3987
3987
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...'
|
@@ -4030,7 +4030,7 @@ module TalonOne
|
|
4030
4030
|
post_body = opts[:body]
|
4031
4031
|
|
4032
4032
|
# return_type
|
4033
|
-
return_type = opts[:return_type] || '
|
4033
|
+
return_type = opts[:return_type] || 'InlineResponse20026'
|
4034
4034
|
|
4035
4035
|
# auth_names
|
4036
4036
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4057,7 +4057,7 @@ module TalonOne
|
|
4057
4057
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
4058
4058
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4059
4059
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4060
|
-
# @return [
|
4060
|
+
# @return [InlineResponse2003]
|
4061
4061
|
def get_applications(opts = {})
|
4062
4062
|
data, _status_code, _headers = get_applications_with_http_info(opts)
|
4063
4063
|
data
|
@@ -4069,7 +4069,7 @@ module TalonOne
|
|
4069
4069
|
# @option opts [Integer] :page_size The number of items in this response.
|
4070
4070
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4071
4071
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4072
|
-
# @return [Array<(
|
4072
|
+
# @return [Array<(InlineResponse2003, Integer, Hash)>] InlineResponse2003 data, response status code and response headers
|
4073
4073
|
def get_applications_with_http_info(opts = {})
|
4074
4074
|
if @api_client.config.debugging
|
4075
4075
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_applications ...'
|
@@ -4103,7 +4103,7 @@ module TalonOne
|
|
4103
4103
|
post_body = opts[:body]
|
4104
4104
|
|
4105
4105
|
# return_type
|
4106
|
-
return_type = opts[:return_type] || '
|
4106
|
+
return_type = opts[:return_type] || 'InlineResponse2003'
|
4107
4107
|
|
4108
4108
|
# auth_names
|
4109
4109
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4193,7 +4193,7 @@ module TalonOne
|
|
4193
4193
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4194
4194
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4195
4195
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
4196
|
-
# @return [
|
4196
|
+
# @return [InlineResponse20031]
|
4197
4197
|
def get_attributes(opts = {})
|
4198
4198
|
data, _status_code, _headers = get_attributes_with_http_info(opts)
|
4199
4199
|
data
|
@@ -4206,7 +4206,7 @@ module TalonOne
|
|
4206
4206
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4207
4207
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4208
4208
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
4209
|
-
# @return [Array<(
|
4209
|
+
# @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
|
4210
4210
|
def get_attributes_with_http_info(opts = {})
|
4211
4211
|
if @api_client.config.debugging
|
4212
4212
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
|
@@ -4241,7 +4241,7 @@ module TalonOne
|
|
4241
4241
|
post_body = opts[:body]
|
4242
4242
|
|
4243
4243
|
# return_type
|
4244
|
-
return_type = opts[:return_type] || '
|
4244
|
+
return_type = opts[:return_type] || 'InlineResponse20031'
|
4245
4245
|
|
4246
4246
|
# auth_names
|
4247
4247
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4269,7 +4269,7 @@ module TalonOne
|
|
4269
4269
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4270
4270
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4271
4271
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4272
|
-
# @return [
|
4272
|
+
# @return [InlineResponse20029]
|
4273
4273
|
def get_audiences(opts = {})
|
4274
4274
|
data, _status_code, _headers = get_audiences_with_http_info(opts)
|
4275
4275
|
data
|
@@ -4282,7 +4282,7 @@ module TalonOne
|
|
4282
4282
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4283
4283
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4284
4284
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4285
|
-
# @return [Array<(
|
4285
|
+
# @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
|
4286
4286
|
def get_audiences_with_http_info(opts = {})
|
4287
4287
|
if @api_client.config.debugging
|
4288
4288
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
|
@@ -4317,7 +4317,7 @@ module TalonOne
|
|
4317
4317
|
post_body = opts[:body]
|
4318
4318
|
|
4319
4319
|
# return_type
|
4320
|
-
return_type = opts[:return_type] || '
|
4320
|
+
return_type = opts[:return_type] || 'InlineResponse20029'
|
4321
4321
|
|
4322
4322
|
# auth_names
|
4323
4323
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4414,7 +4414,7 @@ module TalonOne
|
|
4414
4414
|
# @param range_end [DateTime] Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
4415
4415
|
# @param [Hash] opts the optional parameters
|
4416
4416
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
4417
|
-
# @return [
|
4417
|
+
# @return [InlineResponse20020]
|
4418
4418
|
def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {})
|
4419
4419
|
data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts)
|
4420
4420
|
data
|
@@ -4428,7 +4428,7 @@ module TalonOne
|
|
4428
4428
|
# @param range_end [DateTime] Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
4429
4429
|
# @param [Hash] opts the optional parameters
|
4430
4430
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
4431
|
-
# @return [Array<(
|
4431
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
4432
4432
|
def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {})
|
4433
4433
|
if @api_client.config.debugging
|
4434
4434
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...'
|
@@ -4474,7 +4474,7 @@ module TalonOne
|
|
4474
4474
|
post_body = opts[:body]
|
4475
4475
|
|
4476
4476
|
# return_type
|
4477
|
-
return_type = opts[:return_type] || '
|
4477
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
4478
4478
|
|
4479
4479
|
# auth_names
|
4480
4480
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4504,7 +4504,7 @@ module TalonOne
|
|
4504
4504
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4505
4505
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4506
4506
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
4507
|
-
# @return [
|
4507
|
+
# @return [InlineResponse2004]
|
4508
4508
|
def get_campaign_by_attributes(application_id, body, opts = {})
|
4509
4509
|
data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts)
|
4510
4510
|
data
|
@@ -4519,7 +4519,7 @@ module TalonOne
|
|
4519
4519
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4520
4520
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4521
4521
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
4522
|
-
# @return [Array<(
|
4522
|
+
# @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
|
4523
4523
|
def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
|
4524
4524
|
if @api_client.config.debugging
|
4525
4525
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_by_attributes ...'
|
@@ -4568,7 +4568,7 @@ module TalonOne
|
|
4568
4568
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
4569
4569
|
|
4570
4570
|
# return_type
|
4571
|
-
return_type = opts[:return_type] || '
|
4571
|
+
return_type = opts[:return_type] || 'InlineResponse2004'
|
4572
4572
|
|
4573
4573
|
# auth_names
|
4574
4574
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4599,7 +4599,7 @@ module TalonOne
|
|
4599
4599
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
4600
4600
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
4601
4601
|
# @option opts [Integer] :user_id Filter results by user ID.
|
4602
|
-
# @return [
|
4602
|
+
# @return [InlineResponse20010]
|
4603
4603
|
def get_campaign_templates(opts = {})
|
4604
4604
|
data, _status_code, _headers = get_campaign_templates_with_http_info(opts)
|
4605
4605
|
data
|
@@ -4615,7 +4615,7 @@ module TalonOne
|
|
4615
4615
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
4616
4616
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
4617
4617
|
# @option opts [Integer] :user_id Filter results by user ID.
|
4618
|
-
# @return [Array<(
|
4618
|
+
# @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
|
4619
4619
|
def get_campaign_templates_with_http_info(opts = {})
|
4620
4620
|
if @api_client.config.debugging
|
4621
4621
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_templates ...'
|
@@ -4657,7 +4657,7 @@ module TalonOne
|
|
4657
4657
|
post_body = opts[:body]
|
4658
4658
|
|
4659
4659
|
# return_type
|
4660
|
-
return_type = opts[:return_type] || '
|
4660
|
+
return_type = opts[:return_type] || 'InlineResponse20010'
|
4661
4661
|
|
4662
4662
|
# auth_names
|
4663
4663
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4692,7 +4692,7 @@ module TalonOne
|
|
4692
4692
|
# @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.
|
4693
4693
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
|
4694
4694
|
# @option opts [Integer] :template_id The ID of the Campaign Template this Campaign was created from.
|
4695
|
-
# @return [
|
4695
|
+
# @return [InlineResponse2004]
|
4696
4696
|
def get_campaigns(application_id, opts = {})
|
4697
4697
|
data, _status_code, _headers = get_campaigns_with_http_info(application_id, opts)
|
4698
4698
|
data
|
@@ -4712,7 +4712,7 @@ module TalonOne
|
|
4712
4712
|
# @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.
|
4713
4713
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
|
4714
4714
|
# @option opts [Integer] :template_id The ID of the Campaign Template this Campaign was created from.
|
4715
|
-
# @return [Array<(
|
4715
|
+
# @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
|
4716
4716
|
def get_campaigns_with_http_info(application_id, opts = {})
|
4717
4717
|
if @api_client.config.debugging
|
4718
4718
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaigns ...'
|
@@ -4761,7 +4761,7 @@ module TalonOne
|
|
4761
4761
|
post_body = opts[:body]
|
4762
4762
|
|
4763
4763
|
# return_type
|
4764
|
-
return_type = opts[:return_type] || '
|
4764
|
+
return_type = opts[:return_type] || 'InlineResponse2004'
|
4765
4765
|
|
4766
4766
|
# auth_names
|
4767
4767
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4796,7 +4796,7 @@ module TalonOne
|
|
4796
4796
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4797
4797
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
4798
4798
|
# @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.
|
4799
|
-
# @return [
|
4799
|
+
# @return [InlineResponse20038]
|
4800
4800
|
def get_changes(opts = {})
|
4801
4801
|
data, _status_code, _headers = get_changes_with_http_info(opts)
|
4802
4802
|
data
|
@@ -4816,7 +4816,7 @@ module TalonOne
|
|
4816
4816
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4817
4817
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
4818
4818
|
# @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.
|
4819
|
-
# @return [Array<(
|
4819
|
+
# @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
|
4820
4820
|
def get_changes_with_http_info(opts = {})
|
4821
4821
|
if @api_client.config.debugging
|
4822
4822
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
|
@@ -4858,7 +4858,7 @@ module TalonOne
|
|
4858
4858
|
post_body = opts[:body]
|
4859
4859
|
|
4860
4860
|
# return_type
|
4861
|
-
return_type = opts[:return_type] || '
|
4861
|
+
return_type = opts[:return_type] || 'InlineResponse20038'
|
4862
4862
|
|
4863
4863
|
# auth_names
|
4864
4864
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4959,7 +4959,7 @@ module TalonOne
|
|
4959
4959
|
# @param [Hash] opts the optional parameters
|
4960
4960
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
4961
4961
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4962
|
-
# @return [
|
4962
|
+
# @return [InlineResponse20016]
|
4963
4963
|
def get_collection_items(collection_id, opts = {})
|
4964
4964
|
data, _status_code, _headers = get_collection_items_with_http_info(collection_id, opts)
|
4965
4965
|
data
|
@@ -4971,7 +4971,7 @@ module TalonOne
|
|
4971
4971
|
# @param [Hash] opts the optional parameters
|
4972
4972
|
# @option opts [Integer] :page_size The number of items in this response.
|
4973
4973
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4974
|
-
# @return [Array<(
|
4974
|
+
# @return [Array<(InlineResponse20016, Integer, Hash)>] InlineResponse20016 data, response status code and response headers
|
4975
4975
|
def get_collection_items_with_http_info(collection_id, opts = {})
|
4976
4976
|
if @api_client.config.debugging
|
4977
4977
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_collection_items ...'
|
@@ -5008,7 +5008,7 @@ module TalonOne
|
|
5008
5008
|
post_body = opts[:body]
|
5009
5009
|
|
5010
5010
|
# return_type
|
5011
|
-
return_type = opts[:return_type] || '
|
5011
|
+
return_type = opts[:return_type] || 'InlineResponse20016'
|
5012
5012
|
|
5013
5013
|
# auth_names
|
5014
5014
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5046,7 +5046,7 @@ module TalonOne
|
|
5046
5046
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
5047
5047
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
5048
5048
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
5049
|
-
# @return [
|
5049
|
+
# @return [InlineResponse2008]
|
5050
5050
|
def get_coupons_without_total_count(application_id, campaign_id, opts = {})
|
5051
5051
|
data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts)
|
5052
5052
|
data
|
@@ -5069,7 +5069,7 @@ module TalonOne
|
|
5069
5069
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
5070
5070
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
5071
5071
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
5072
|
-
# @return [Array<(
|
5072
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
5073
5073
|
def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
5074
5074
|
if @api_client.config.debugging
|
5075
5075
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_without_total_count ...'
|
@@ -5128,7 +5128,7 @@ module TalonOne
|
|
5128
5128
|
post_body = opts[:body]
|
5129
5129
|
|
5130
5130
|
# return_type
|
5131
|
-
return_type = opts[:return_type] || '
|
5131
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
5132
5132
|
|
5133
5133
|
# auth_names
|
5134
5134
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5258,7 +5258,7 @@ module TalonOne
|
|
5258
5258
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
5259
5259
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
5260
5260
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
5261
|
-
# @return [
|
5261
|
+
# @return [InlineResponse20025]
|
5262
5262
|
def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {})
|
5263
5263
|
data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts)
|
5264
5264
|
data
|
@@ -5277,7 +5277,7 @@ module TalonOne
|
|
5277
5277
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
5278
5278
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
5279
5279
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
5280
|
-
# @return [Array<(
|
5280
|
+
# @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
|
5281
5281
|
def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {})
|
5282
5282
|
if @api_client.config.debugging
|
5283
5283
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...'
|
@@ -5329,7 +5329,7 @@ module TalonOne
|
|
5329
5329
|
post_body = opts[:body]
|
5330
5330
|
|
5331
5331
|
# return_type
|
5332
|
-
return_type = opts[:return_type] || '
|
5332
|
+
return_type = opts[:return_type] || 'InlineResponse20025'
|
5333
5333
|
|
5334
5334
|
# auth_names
|
5335
5335
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5503,7 +5503,7 @@ module TalonOne
|
|
5503
5503
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
5504
5504
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5505
5505
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer. (default to false)
|
5506
|
-
# @return [
|
5506
|
+
# @return [InlineResponse20024]
|
5507
5507
|
def get_customer_profiles(opts = {})
|
5508
5508
|
data, _status_code, _headers = get_customer_profiles_with_http_info(opts)
|
5509
5509
|
data
|
@@ -5515,7 +5515,7 @@ module TalonOne
|
|
5515
5515
|
# @option opts [Integer] :page_size The number of items in this response.
|
5516
5516
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5517
5517
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
|
5518
|
-
# @return [Array<(
|
5518
|
+
# @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
|
5519
5519
|
def get_customer_profiles_with_http_info(opts = {})
|
5520
5520
|
if @api_client.config.debugging
|
5521
5521
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...'
|
@@ -5549,7 +5549,7 @@ module TalonOne
|
|
5549
5549
|
post_body = opts[:body]
|
5550
5550
|
|
5551
5551
|
# return_type
|
5552
|
-
return_type = opts[:return_type] || '
|
5552
|
+
return_type = opts[:return_type] || 'InlineResponse20024'
|
5553
5553
|
|
5554
5554
|
# auth_names
|
5555
5555
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5577,7 +5577,7 @@ module TalonOne
|
|
5577
5577
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
5578
5578
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5579
5579
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer. (default to false)
|
5580
|
-
# @return [
|
5580
|
+
# @return [InlineResponse20023]
|
5581
5581
|
def get_customers_by_attributes(body, opts = {})
|
5582
5582
|
data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts)
|
5583
5583
|
data
|
@@ -5590,7 +5590,7 @@ module TalonOne
|
|
5590
5590
|
# @option opts [Integer] :page_size The number of items in this response.
|
5591
5591
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5592
5592
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
|
5593
|
-
# @return [Array<(
|
5593
|
+
# @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
|
5594
5594
|
def get_customers_by_attributes_with_http_info(body, opts = {})
|
5595
5595
|
if @api_client.config.debugging
|
5596
5596
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...'
|
@@ -5630,7 +5630,7 @@ module TalonOne
|
|
5630
5630
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
5631
5631
|
|
5632
5632
|
# return_type
|
5633
|
-
return_type = opts[:return_type] || '
|
5633
|
+
return_type = opts[:return_type] || 'InlineResponse20023'
|
5634
5634
|
|
5635
5635
|
# auth_names
|
5636
5636
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5659,7 +5659,7 @@ module TalonOne
|
|
5659
5659
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
5660
5660
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5661
5661
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5662
|
-
# @return [
|
5662
|
+
# @return [InlineResponse20036]
|
5663
5663
|
def get_event_types(opts = {})
|
5664
5664
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
5665
5665
|
data
|
@@ -5673,7 +5673,7 @@ module TalonOne
|
|
5673
5673
|
# @option opts [Integer] :page_size The number of items in this response.
|
5674
5674
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5675
5675
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5676
|
-
# @return [Array<(
|
5676
|
+
# @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
|
5677
5677
|
def get_event_types_with_http_info(opts = {})
|
5678
5678
|
if @api_client.config.debugging
|
5679
5679
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
|
@@ -5709,7 +5709,7 @@ module TalonOne
|
|
5709
5709
|
post_body = opts[:body]
|
5710
5710
|
|
5711
5711
|
# return_type
|
5712
|
-
return_type = opts[:return_type] || '
|
5712
|
+
return_type = opts[:return_type] || 'InlineResponse20036'
|
5713
5713
|
|
5714
5714
|
# auth_names
|
5715
5715
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5738,7 +5738,7 @@ module TalonOne
|
|
5738
5738
|
# @option opts [Float] :application_id Filter results by Application ID.
|
5739
5739
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
5740
5740
|
# @option opts [String] :entity The name of the entity type that was exported.
|
5741
|
-
# @return [
|
5741
|
+
# @return [InlineResponse20039]
|
5742
5742
|
def get_exports(opts = {})
|
5743
5743
|
data, _status_code, _headers = get_exports_with_http_info(opts)
|
5744
5744
|
data
|
@@ -5752,7 +5752,7 @@ module TalonOne
|
|
5752
5752
|
# @option opts [Float] :application_id Filter results by Application ID.
|
5753
5753
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
5754
5754
|
# @option opts [String] :entity The name of the entity type that was exported.
|
5755
|
-
# @return [Array<(
|
5755
|
+
# @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
|
5756
5756
|
def get_exports_with_http_info(opts = {})
|
5757
5757
|
if @api_client.config.debugging
|
5758
5758
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
|
@@ -5792,7 +5792,7 @@ module TalonOne
|
|
5792
5792
|
post_body = opts[:body]
|
5793
5793
|
|
5794
5794
|
# return_type
|
5795
|
-
return_type = opts[:return_type] || '
|
5795
|
+
return_type = opts[:return_type] || 'InlineResponse20039'
|
5796
5796
|
|
5797
5797
|
# auth_names
|
5798
5798
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5816,21 +5816,21 @@ module TalonOne
|
|
5816
5816
|
# Get loyalty card
|
5817
5817
|
# Get the given loyalty card.
|
5818
5818
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
5819
|
-
# @param
|
5819
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
5820
5820
|
# @param [Hash] opts the optional parameters
|
5821
5821
|
# @return [LoyaltyCard]
|
5822
|
-
def get_loyalty_card(loyalty_program_id,
|
5823
|
-
data, _status_code, _headers = get_loyalty_card_with_http_info(loyalty_program_id,
|
5822
|
+
def get_loyalty_card(loyalty_program_id, loyalty_card_id, opts = {})
|
5823
|
+
data, _status_code, _headers = get_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
5824
5824
|
data
|
5825
5825
|
end
|
5826
5826
|
|
5827
5827
|
# Get loyalty card
|
5828
5828
|
# Get the given loyalty card.
|
5829
5829
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
5830
|
-
# @param
|
5830
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
5831
5831
|
# @param [Hash] opts the optional parameters
|
5832
5832
|
# @return [Array<(LoyaltyCard, Integer, Hash)>] LoyaltyCard data, response status code and response headers
|
5833
|
-
def get_loyalty_card_with_http_info(loyalty_program_id,
|
5833
|
+
def get_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
5834
5834
|
if @api_client.config.debugging
|
5835
5835
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_card ...'
|
5836
5836
|
end
|
@@ -5838,16 +5838,16 @@ module TalonOne
|
|
5838
5838
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
5839
5839
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_card"
|
5840
5840
|
end
|
5841
|
-
# verify the required parameter '
|
5842
|
-
if @api_client.config.client_side_validation &&
|
5843
|
-
fail ArgumentError, "Missing the required parameter '
|
5841
|
+
# verify the required parameter 'loyalty_card_id' is set
|
5842
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
5843
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.get_loyalty_card"
|
5844
5844
|
end
|
5845
|
-
if @api_client.config.client_side_validation &&
|
5846
|
-
fail ArgumentError, 'invalid value for "
|
5845
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
5846
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.get_loyalty_card, the character length must be smaller than or equal to 108.'
|
5847
5847
|
end
|
5848
5848
|
|
5849
5849
|
# resource path
|
5850
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
5850
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
5851
5851
|
|
5852
5852
|
# query parameters
|
5853
5853
|
query_params = opts[:query_params] || {}
|
@@ -5885,34 +5885,34 @@ module TalonOne
|
|
5885
5885
|
return data, status_code, headers
|
5886
5886
|
end
|
5887
5887
|
|
5888
|
-
#
|
5888
|
+
# List card's transactions
|
5889
5889
|
# Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
|
5890
5890
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
5891
|
-
# @param
|
5891
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
5892
5892
|
# @param [Hash] opts the optional parameters
|
5893
5893
|
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
5894
5894
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
5895
5895
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
5896
5896
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5897
5897
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
5898
|
-
# @return [
|
5899
|
-
def get_loyalty_card_transaction_logs(loyalty_program_id,
|
5900
|
-
data, _status_code, _headers = get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id,
|
5898
|
+
# @return [InlineResponse20014]
|
5899
|
+
def get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts = {})
|
5900
|
+
data, _status_code, _headers = get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
5901
5901
|
data
|
5902
5902
|
end
|
5903
5903
|
|
5904
|
-
#
|
5904
|
+
# List card's transactions
|
5905
5905
|
# Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
|
5906
5906
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
5907
|
-
# @param
|
5907
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
5908
5908
|
# @param [Hash] opts the optional parameters
|
5909
5909
|
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
5910
5910
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
5911
5911
|
# @option opts [Integer] :page_size The number of items in this response.
|
5912
5912
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
5913
5913
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
5914
|
-
# @return [Array<(
|
5915
|
-
def get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id,
|
5914
|
+
# @return [Array<(InlineResponse20014, Integer, Hash)>] InlineResponse20014 data, response status code and response headers
|
5915
|
+
def get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
5916
5916
|
if @api_client.config.debugging
|
5917
5917
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_card_transaction_logs ...'
|
5918
5918
|
end
|
@@ -5920,12 +5920,12 @@ module TalonOne
|
|
5920
5920
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
5921
5921
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_loyalty_card_transaction_logs"
|
5922
5922
|
end
|
5923
|
-
# verify the required parameter '
|
5924
|
-
if @api_client.config.client_side_validation &&
|
5925
|
-
fail ArgumentError, "Missing the required parameter '
|
5923
|
+
# verify the required parameter 'loyalty_card_id' is set
|
5924
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
5925
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.get_loyalty_card_transaction_logs"
|
5926
5926
|
end
|
5927
|
-
if @api_client.config.client_side_validation &&
|
5928
|
-
fail ArgumentError, 'invalid value for "
|
5927
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
5928
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.get_loyalty_card_transaction_logs, the character length must be smaller than or equal to 108.'
|
5929
5929
|
end
|
5930
5930
|
|
5931
5931
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
@@ -5937,7 +5937,7 @@ module TalonOne
|
|
5937
5937
|
end
|
5938
5938
|
|
5939
5939
|
# resource path
|
5940
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
5940
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
5941
5941
|
|
5942
5942
|
# query parameters
|
5943
5943
|
query_params = opts[:query_params] || {}
|
@@ -5959,7 +5959,7 @@ module TalonOne
|
|
5959
5959
|
post_body = opts[:body]
|
5960
5960
|
|
5961
5961
|
# return_type
|
5962
|
-
return_type = opts[:return_type] || '
|
5962
|
+
return_type = opts[:return_type] || 'InlineResponse20014'
|
5963
5963
|
|
5964
5964
|
# auth_names
|
5965
5965
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5989,7 +5989,7 @@ module TalonOne
|
|
5989
5989
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5990
5990
|
# @option opts [String] :identifier Optional query parameter to search cards by identifier.
|
5991
5991
|
# @option opts [Integer] :profile_id Filter by the profile ID.
|
5992
|
-
# @return [
|
5992
|
+
# @return [InlineResponse20013]
|
5993
5993
|
def get_loyalty_cards(loyalty_program_id, opts = {})
|
5994
5994
|
data, _status_code, _headers = get_loyalty_cards_with_http_info(loyalty_program_id, opts)
|
5995
5995
|
data
|
@@ -6004,7 +6004,7 @@ module TalonOne
|
|
6004
6004
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
6005
6005
|
# @option opts [String] :identifier Optional query parameter to search cards by identifier.
|
6006
6006
|
# @option opts [Integer] :profile_id Filter by the profile ID.
|
6007
|
-
# @return [Array<(
|
6007
|
+
# @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
|
6008
6008
|
def get_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
|
6009
6009
|
if @api_client.config.debugging
|
6010
6010
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_cards ...'
|
@@ -6052,7 +6052,7 @@ module TalonOne
|
|
6052
6052
|
post_body = opts[:body]
|
6053
6053
|
|
6054
6054
|
# return_type
|
6055
|
-
return_type = opts[:return_type] || '
|
6055
|
+
return_type = opts[:return_type] || 'InlineResponse20013'
|
6056
6056
|
|
6057
6057
|
# auth_names
|
6058
6058
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6213,7 +6213,7 @@ module TalonOne
|
|
6213
6213
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
6214
6214
|
# @option opts [Integer] :page_size The number of items in this response. (default to 50)
|
6215
6215
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
6216
|
-
# @return [
|
6216
|
+
# @return [InlineResponse20012]
|
6217
6217
|
def get_loyalty_program_transactions(loyalty_program_id, opts = {})
|
6218
6218
|
data, _status_code, _headers = get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts)
|
6219
6219
|
data
|
@@ -6229,7 +6229,7 @@ module TalonOne
|
|
6229
6229
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
6230
6230
|
# @option opts [Integer] :page_size The number of items in this response.
|
6231
6231
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
6232
|
-
# @return [Array<(
|
6232
|
+
# @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
|
6233
6233
|
def get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts = {})
|
6234
6234
|
if @api_client.config.debugging
|
6235
6235
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_program_transactions ...'
|
@@ -6278,7 +6278,7 @@ module TalonOne
|
|
6278
6278
|
post_body = opts[:body]
|
6279
6279
|
|
6280
6280
|
# return_type
|
6281
|
-
return_type = opts[:return_type] || '
|
6281
|
+
return_type = opts[:return_type] || 'InlineResponse20012'
|
6282
6282
|
|
6283
6283
|
# auth_names
|
6284
6284
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6302,7 +6302,7 @@ module TalonOne
|
|
6302
6302
|
# List loyalty programs
|
6303
6303
|
# List the loyalty programs of the account.
|
6304
6304
|
# @param [Hash] opts the optional parameters
|
6305
|
-
# @return [
|
6305
|
+
# @return [InlineResponse20011]
|
6306
6306
|
def get_loyalty_programs(opts = {})
|
6307
6307
|
data, _status_code, _headers = get_loyalty_programs_with_http_info(opts)
|
6308
6308
|
data
|
@@ -6311,7 +6311,7 @@ module TalonOne
|
|
6311
6311
|
# List loyalty programs
|
6312
6312
|
# List the loyalty programs of the account.
|
6313
6313
|
# @param [Hash] opts the optional parameters
|
6314
|
-
# @return [Array<(
|
6314
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
6315
6315
|
def get_loyalty_programs_with_http_info(opts = {})
|
6316
6316
|
if @api_client.config.debugging
|
6317
6317
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_programs ...'
|
@@ -6334,7 +6334,7 @@ module TalonOne
|
|
6334
6334
|
post_body = opts[:body]
|
6335
6335
|
|
6336
6336
|
# return_type
|
6337
|
-
return_type = opts[:return_type] || '
|
6337
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
6338
6338
|
|
6339
6339
|
# auth_names
|
6340
6340
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6489,7 +6489,7 @@ module TalonOne
|
|
6489
6489
|
# List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application.
|
6490
6490
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
6491
6491
|
# @param [Hash] opts the optional parameters
|
6492
|
-
# @return [
|
6492
|
+
# @return [InlineResponse2005]
|
6493
6493
|
def get_notification_webhooks(application_id, opts = {})
|
6494
6494
|
data, _status_code, _headers = get_notification_webhooks_with_http_info(application_id, opts)
|
6495
6495
|
data
|
@@ -6499,7 +6499,7 @@ module TalonOne
|
|
6499
6499
|
# List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application.
|
6500
6500
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
6501
6501
|
# @param [Hash] opts the optional parameters
|
6502
|
-
# @return [Array<(
|
6502
|
+
# @return [Array<(InlineResponse2005, Integer, Hash)>] InlineResponse2005 data, response status code and response headers
|
6503
6503
|
def get_notification_webhooks_with_http_info(application_id, opts = {})
|
6504
6504
|
if @api_client.config.debugging
|
6505
6505
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_notification_webhooks ...'
|
@@ -6526,7 +6526,7 @@ module TalonOne
|
|
6526
6526
|
post_body = opts[:body]
|
6527
6527
|
|
6528
6528
|
# return_type
|
6529
|
-
return_type = opts[:return_type] || '
|
6529
|
+
return_type = opts[:return_type] || 'InlineResponse2005'
|
6530
6530
|
|
6531
6531
|
# auth_names
|
6532
6532
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6561,7 +6561,7 @@ module TalonOne
|
|
6561
6561
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
6562
6562
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
6563
6563
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
6564
|
-
# @return [
|
6564
|
+
# @return [InlineResponse2009]
|
6565
6565
|
def get_referrals_without_total_count(application_id, campaign_id, opts = {})
|
6566
6566
|
data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts)
|
6567
6567
|
data
|
@@ -6581,7 +6581,7 @@ module TalonOne
|
|
6581
6581
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
6582
6582
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
6583
6583
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
6584
|
-
# @return [Array<(
|
6584
|
+
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
6585
6585
|
def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
6586
6586
|
if @api_client.config.debugging
|
6587
6587
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals_without_total_count ...'
|
@@ -6637,7 +6637,7 @@ module TalonOne
|
|
6637
6637
|
post_body = opts[:body]
|
6638
6638
|
|
6639
6639
|
# return_type
|
6640
|
-
return_type = opts[:return_type] || '
|
6640
|
+
return_type = opts[:return_type] || 'InlineResponse2009'
|
6641
6641
|
|
6642
6642
|
# auth_names
|
6643
6643
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6802,7 +6802,7 @@ module TalonOne
|
|
6802
6802
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
6803
6803
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
6804
6804
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
6805
|
-
# @return [
|
6805
|
+
# @return [InlineResponse2006]
|
6806
6806
|
def get_rulesets(application_id, campaign_id, opts = {})
|
6807
6807
|
data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts)
|
6808
6808
|
data
|
@@ -6816,7 +6816,7 @@ module TalonOne
|
|
6816
6816
|
# @option opts [Integer] :page_size The number of items in this response.
|
6817
6817
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
6818
6818
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
6819
|
-
# @return [Array<(
|
6819
|
+
# @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
|
6820
6820
|
def get_rulesets_with_http_info(application_id, campaign_id, opts = {})
|
6821
6821
|
if @api_client.config.debugging
|
6822
6822
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_rulesets ...'
|
@@ -6858,7 +6858,7 @@ module TalonOne
|
|
6858
6858
|
post_body = opts[:body]
|
6859
6859
|
|
6860
6860
|
# return_type
|
6861
|
-
return_type = opts[:return_type] || '
|
6861
|
+
return_type = opts[:return_type] || 'InlineResponse2006'
|
6862
6862
|
|
6863
6863
|
# auth_names
|
6864
6864
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6947,7 +6947,7 @@ module TalonOne
|
|
6947
6947
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
6948
6948
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
6949
6949
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
6950
|
-
# @return [
|
6950
|
+
# @return [InlineResponse20037]
|
6951
6951
|
def get_users(opts = {})
|
6952
6952
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
6953
6953
|
data
|
@@ -6959,7 +6959,7 @@ module TalonOne
|
|
6959
6959
|
# @option opts [Integer] :page_size The number of items in this response.
|
6960
6960
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
6961
6961
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
6962
|
-
# @return [Array<(
|
6962
|
+
# @return [Array<(InlineResponse20037, Integer, Hash)>] InlineResponse20037 data, response status code and response headers
|
6963
6963
|
def get_users_with_http_info(opts = {})
|
6964
6964
|
if @api_client.config.debugging
|
6965
6965
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
|
@@ -6993,7 +6993,7 @@ module TalonOne
|
|
6993
6993
|
post_body = opts[:body]
|
6994
6994
|
|
6995
6995
|
# return_type
|
6996
|
-
return_type = opts[:return_type] || '
|
6996
|
+
return_type = opts[:return_type] || 'InlineResponse20037'
|
6997
6997
|
|
6998
6998
|
# auth_names
|
6999
6999
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7088,7 +7088,7 @@ module TalonOne
|
|
7088
7088
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
7089
7089
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
7090
7090
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
7091
|
-
# @return [
|
7091
|
+
# @return [InlineResponse20034]
|
7092
7092
|
def get_webhook_activation_logs(opts = {})
|
7093
7093
|
data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
|
7094
7094
|
data
|
@@ -7106,7 +7106,7 @@ module TalonOne
|
|
7106
7106
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
7107
7107
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
7108
7108
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
7109
|
-
# @return [Array<(
|
7109
|
+
# @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
|
7110
7110
|
def get_webhook_activation_logs_with_http_info(opts = {})
|
7111
7111
|
if @api_client.config.debugging
|
7112
7112
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
|
@@ -7146,7 +7146,7 @@ module TalonOne
|
|
7146
7146
|
post_body = opts[:body]
|
7147
7147
|
|
7148
7148
|
# return_type
|
7149
|
-
return_type = opts[:return_type] || '
|
7149
|
+
return_type = opts[:return_type] || 'InlineResponse20034'
|
7150
7150
|
|
7151
7151
|
# auth_names
|
7152
7152
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7180,7 +7180,7 @@ module TalonOne
|
|
7180
7180
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
7181
7181
|
# @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.
|
7182
7182
|
# @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.
|
7183
|
-
# @return [
|
7183
|
+
# @return [InlineResponse20035]
|
7184
7184
|
def get_webhook_logs(opts = {})
|
7185
7185
|
data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
|
7186
7186
|
data
|
@@ -7199,7 +7199,7 @@ module TalonOne
|
|
7199
7199
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
7200
7200
|
# @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.
|
7201
7201
|
# @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.
|
7202
|
-
# @return [Array<(
|
7202
|
+
# @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
|
7203
7203
|
def get_webhook_logs_with_http_info(opts = {})
|
7204
7204
|
if @api_client.config.debugging
|
7205
7205
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
|
@@ -7244,7 +7244,7 @@ module TalonOne
|
|
7244
7244
|
post_body = opts[:body]
|
7245
7245
|
|
7246
7246
|
# return_type
|
7247
|
-
return_type = opts[:return_type] || '
|
7247
|
+
return_type = opts[:return_type] || 'InlineResponse20035'
|
7248
7248
|
|
7249
7249
|
# auth_names
|
7250
7250
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7272,7 +7272,7 @@ module TalonOne
|
|
7272
7272
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7273
7273
|
# @option opts [Integer] :page_size The number of items in this response. (default to 1000)
|
7274
7274
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
7275
|
-
# @return [
|
7275
|
+
# @return [InlineResponse20033]
|
7276
7276
|
def get_webhooks(opts = {})
|
7277
7277
|
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
7278
7278
|
data
|
@@ -7285,7 +7285,7 @@ module TalonOne
|
|
7285
7285
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7286
7286
|
# @option opts [Integer] :page_size The number of items in this response.
|
7287
7287
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
7288
|
-
# @return [Array<(
|
7288
|
+
# @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
|
7289
7289
|
def get_webhooks_with_http_info(opts = {})
|
7290
7290
|
if @api_client.config.debugging
|
7291
7291
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
@@ -7320,7 +7320,7 @@ module TalonOne
|
|
7320
7320
|
post_body = opts[:body]
|
7321
7321
|
|
7322
7322
|
# return_type
|
7323
|
-
return_type = opts[:return_type] || '
|
7323
|
+
return_type = opts[:return_type] || 'InlineResponse20033'
|
7324
7324
|
|
7325
7325
|
# auth_names
|
7326
7326
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7909,7 +7909,7 @@ module TalonOne
|
|
7909
7909
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7910
7910
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
7911
7911
|
# @option opts [String] :name Filter by the name of the Collection.
|
7912
|
-
# @return [
|
7912
|
+
# @return [InlineResponse20015]
|
7913
7913
|
def list_account_collections(opts = {})
|
7914
7914
|
data, _status_code, _headers = list_account_collections_with_http_info(opts)
|
7915
7915
|
data
|
@@ -7923,7 +7923,7 @@ module TalonOne
|
|
7923
7923
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7924
7924
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
7925
7925
|
# @option opts [String] :name Filter by the name of the Collection.
|
7926
|
-
# @return [Array<(
|
7926
|
+
# @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
|
7927
7927
|
def list_account_collections_with_http_info(opts = {})
|
7928
7928
|
if @api_client.config.debugging
|
7929
7929
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_account_collections ...'
|
@@ -7959,7 +7959,7 @@ module TalonOne
|
|
7959
7959
|
post_body = opts[:body]
|
7960
7960
|
|
7961
7961
|
# return_type
|
7962
|
-
return_type = opts[:return_type] || '
|
7962
|
+
return_type = opts[:return_type] || 'InlineResponse20015'
|
7963
7963
|
|
7964
7964
|
# auth_names
|
7965
7965
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7990,7 +7990,7 @@ module TalonOne
|
|
7990
7990
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7991
7991
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
7992
7992
|
# @option opts [String] :name Filter by the name of the Collection.
|
7993
|
-
# @return [
|
7993
|
+
# @return [InlineResponse20017]
|
7994
7994
|
def list_collections(application_id, campaign_id, opts = {})
|
7995
7995
|
data, _status_code, _headers = list_collections_with_http_info(application_id, campaign_id, opts)
|
7996
7996
|
data
|
@@ -8006,7 +8006,7 @@ module TalonOne
|
|
8006
8006
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8007
8007
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8008
8008
|
# @option opts [String] :name Filter by the name of the Collection.
|
8009
|
-
# @return [Array<(
|
8009
|
+
# @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
|
8010
8010
|
def list_collections_with_http_info(application_id, campaign_id, opts = {})
|
8011
8011
|
if @api_client.config.debugging
|
8012
8012
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_collections ...'
|
@@ -8050,7 +8050,7 @@ module TalonOne
|
|
8050
8050
|
post_body = opts[:body]
|
8051
8051
|
|
8052
8052
|
# return_type
|
8053
|
-
return_type = opts[:return_type] || '
|
8053
|
+
return_type = opts[:return_type] || 'InlineResponse20017'
|
8054
8054
|
|
8055
8055
|
# auth_names
|
8056
8056
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8080,7 +8080,7 @@ module TalonOne
|
|
8080
8080
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8081
8081
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8082
8082
|
# @option opts [String] :name Filter by the name of the Collection.
|
8083
|
-
# @return [
|
8083
|
+
# @return [InlineResponse20017]
|
8084
8084
|
def list_collections_in_application(application_id, opts = {})
|
8085
8085
|
data, _status_code, _headers = list_collections_in_application_with_http_info(application_id, opts)
|
8086
8086
|
data
|
@@ -8095,7 +8095,7 @@ module TalonOne
|
|
8095
8095
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8096
8096
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8097
8097
|
# @option opts [String] :name Filter by the name of the Collection.
|
8098
|
-
# @return [Array<(
|
8098
|
+
# @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
|
8099
8099
|
def list_collections_in_application_with_http_info(application_id, opts = {})
|
8100
8100
|
if @api_client.config.debugging
|
8101
8101
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_collections_in_application ...'
|
@@ -8135,7 +8135,7 @@ module TalonOne
|
|
8135
8135
|
post_body = opts[:body]
|
8136
8136
|
|
8137
8137
|
# return_type
|
8138
|
-
return_type = opts[:return_type] || '
|
8138
|
+
return_type = opts[:return_type] || 'InlineResponse20017'
|
8139
8139
|
|
8140
8140
|
# auth_names
|
8141
8141
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8454,7 +8454,7 @@ module TalonOne
|
|
8454
8454
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
8455
8455
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
8456
8456
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
8457
|
-
# @return [
|
8457
|
+
# @return [InlineResponse2008]
|
8458
8458
|
def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
|
8459
8459
|
data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
|
8460
8460
|
data
|
@@ -8478,7 +8478,7 @@ module TalonOne
|
|
8478
8478
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
8479
8479
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
8480
8480
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
8481
|
-
# @return [Array<(
|
8481
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
8482
8482
|
def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
|
8483
8483
|
if @api_client.config.debugging
|
8484
8484
|
@api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide_without_total_count ...'
|
@@ -8544,7 +8544,7 @@ module TalonOne
|
|
8544
8544
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
8545
8545
|
|
8546
8546
|
# return_type
|
8547
|
-
return_type = opts[:return_type] || '
|
8547
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
8548
8548
|
|
8549
8549
|
# auth_names
|
8550
8550
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8583,7 +8583,7 @@ module TalonOne
|
|
8583
8583
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
8584
8584
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
8585
8585
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
8586
|
-
# @return [
|
8586
|
+
# @return [InlineResponse2008]
|
8587
8587
|
def search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {})
|
8588
8588
|
data, _status_code, _headers = search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts)
|
8589
8589
|
data
|
@@ -8607,7 +8607,7 @@ module TalonOne
|
|
8607
8607
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
8608
8608
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
8609
8609
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
8610
|
-
# @return [Array<(
|
8610
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
8611
8611
|
def search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {})
|
8612
8612
|
if @api_client.config.debugging
|
8613
8613
|
@api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_without_total_count ...'
|
@@ -8672,7 +8672,7 @@ module TalonOne
|
|
8672
8672
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
8673
8673
|
|
8674
8674
|
# return_type
|
8675
|
-
return_type = opts[:return_type] || '
|
8675
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
8676
8676
|
|
8677
8677
|
# auth_names
|
8678
8678
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8693,26 +8693,26 @@ module TalonOne
|
|
8693
8693
|
return data, status_code, headers
|
8694
8694
|
end
|
8695
8695
|
|
8696
|
-
# Transfer
|
8697
|
-
# Transfer card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
8696
|
+
# Transfer card data
|
8697
|
+
# Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
8698
8698
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
8699
|
-
# @param
|
8699
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
8700
8700
|
# @param body [TransferLoyaltyCard] body
|
8701
8701
|
# @param [Hash] opts the optional parameters
|
8702
8702
|
# @return [nil]
|
8703
|
-
def transfer_loyalty_card(loyalty_program_id,
|
8704
|
-
transfer_loyalty_card_with_http_info(loyalty_program_id,
|
8703
|
+
def transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body, opts = {})
|
8704
|
+
transfer_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
|
8705
8705
|
nil
|
8706
8706
|
end
|
8707
8707
|
|
8708
|
-
# Transfer
|
8709
|
-
# Transfer card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
8708
|
+
# Transfer card data
|
8709
|
+
# Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
8710
8710
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
8711
|
-
# @param
|
8711
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
8712
8712
|
# @param body [TransferLoyaltyCard] body
|
8713
8713
|
# @param [Hash] opts the optional parameters
|
8714
8714
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
8715
|
-
def transfer_loyalty_card_with_http_info(loyalty_program_id,
|
8715
|
+
def transfer_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
|
8716
8716
|
if @api_client.config.debugging
|
8717
8717
|
@api_client.config.logger.debug 'Calling API: ManagementApi.transfer_loyalty_card ...'
|
8718
8718
|
end
|
@@ -8720,12 +8720,12 @@ module TalonOne
|
|
8720
8720
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
8721
8721
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.transfer_loyalty_card"
|
8722
8722
|
end
|
8723
|
-
# verify the required parameter '
|
8724
|
-
if @api_client.config.client_side_validation &&
|
8725
|
-
fail ArgumentError, "Missing the required parameter '
|
8723
|
+
# verify the required parameter 'loyalty_card_id' is set
|
8724
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
8725
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.transfer_loyalty_card"
|
8726
8726
|
end
|
8727
|
-
if @api_client.config.client_side_validation &&
|
8728
|
-
fail ArgumentError, 'invalid value for "
|
8727
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
8728
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.transfer_loyalty_card, the character length must be smaller than or equal to 108.'
|
8729
8729
|
end
|
8730
8730
|
|
8731
8731
|
# verify the required parameter 'body' is set
|
@@ -8733,7 +8733,7 @@ module TalonOne
|
|
8733
8733
|
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.transfer_loyalty_card"
|
8734
8734
|
end
|
8735
8735
|
# resource path
|
8736
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
8736
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
8737
8737
|
|
8738
8738
|
# query parameters
|
8739
8739
|
query_params = opts[:query_params] || {}
|
@@ -9300,23 +9300,23 @@ module TalonOne
|
|
9300
9300
|
# Update loyalty card status
|
9301
9301
|
# Update the status of the given loyalty card. A card can be _active_ or _inactive_.
|
9302
9302
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
9303
|
-
# @param
|
9303
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
9304
9304
|
# @param body [UpdateLoyaltyCard] body
|
9305
9305
|
# @param [Hash] opts the optional parameters
|
9306
9306
|
# @return [LoyaltyCard]
|
9307
|
-
def update_loyalty_card(loyalty_program_id,
|
9308
|
-
data, _status_code, _headers = update_loyalty_card_with_http_info(loyalty_program_id,
|
9307
|
+
def update_loyalty_card(loyalty_program_id, loyalty_card_id, body, opts = {})
|
9308
|
+
data, _status_code, _headers = update_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts)
|
9309
9309
|
data
|
9310
9310
|
end
|
9311
9311
|
|
9312
9312
|
# Update loyalty card status
|
9313
9313
|
# Update the status of the given loyalty card. A card can be _active_ or _inactive_.
|
9314
9314
|
# @param loyalty_program_id [Integer] Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
9315
|
-
# @param
|
9315
|
+
# @param loyalty_card_id [String] Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
9316
9316
|
# @param body [UpdateLoyaltyCard] body
|
9317
9317
|
# @param [Hash] opts the optional parameters
|
9318
9318
|
# @return [Array<(LoyaltyCard, Integer, Hash)>] LoyaltyCard data, response status code and response headers
|
9319
|
-
def update_loyalty_card_with_http_info(loyalty_program_id,
|
9319
|
+
def update_loyalty_card_with_http_info(loyalty_program_id, loyalty_card_id, body, opts = {})
|
9320
9320
|
if @api_client.config.debugging
|
9321
9321
|
@api_client.config.logger.debug 'Calling API: ManagementApi.update_loyalty_card ...'
|
9322
9322
|
end
|
@@ -9324,12 +9324,12 @@ module TalonOne
|
|
9324
9324
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
9325
9325
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.update_loyalty_card"
|
9326
9326
|
end
|
9327
|
-
# verify the required parameter '
|
9328
|
-
if @api_client.config.client_side_validation &&
|
9329
|
-
fail ArgumentError, "Missing the required parameter '
|
9327
|
+
# verify the required parameter 'loyalty_card_id' is set
|
9328
|
+
if @api_client.config.client_side_validation && loyalty_card_id.nil?
|
9329
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_card_id' when calling ManagementApi.update_loyalty_card"
|
9330
9330
|
end
|
9331
|
-
if @api_client.config.client_side_validation &&
|
9332
|
-
fail ArgumentError, 'invalid value for "
|
9331
|
+
if @api_client.config.client_side_validation && loyalty_card_id.to_s.length > 108
|
9332
|
+
fail ArgumentError, 'invalid value for "loyalty_card_id" when calling ManagementApi.update_loyalty_card, the character length must be smaller than or equal to 108.'
|
9333
9333
|
end
|
9334
9334
|
|
9335
9335
|
# verify the required parameter 'body' is set
|
@@ -9337,7 +9337,7 @@ module TalonOne
|
|
9337
9337
|
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_loyalty_card"
|
9338
9338
|
end
|
9339
9339
|
# resource path
|
9340
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
9340
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s)).sub('{' + 'loyaltyCardId' + '}', CGI.escape(loyalty_card_id.to_s))
|
9341
9341
|
|
9342
9342
|
# query parameters
|
9343
9343
|
query_params = opts[:query_params] || {}
|