talon_one 1.3.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -6
- data/docs/AccountAnalytics.md +1 -0
- data/docs/AccountLimits.md +1 -0
- data/docs/Application.md +1 -0
- data/docs/AttributesMandatory.md +9 -0
- data/docs/AttributesSettings.md +8 -0
- data/docs/BaseSamlConnection.md +15 -0
- data/docs/CampaignAnalytics.md +9 -3
- data/docs/CampaignCopy.md +4 -0
- data/docs/Change.md +2 -2
- data/docs/CustomerInventory.md +9 -0
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +2 -3
- data/docs/InlineResponse20026.md +3 -2
- data/docs/InlineResponse20027.md +1 -1
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +9 -0
- data/docs/IntegrationApi.md +66 -0
- data/docs/ManagementApi.md +162 -101
- data/docs/NewApplication.md +1 -0
- data/docs/NewSamlConnection.md +3 -2
- data/docs/SamlConnection.md +4 -5
- data/docs/SamlConnectionMetadata.md +11 -0
- data/docs/UpdateApplication.md +1 -0
- data/lib/talon_one.rb +6 -0
- data/lib/talon_one/api/integration_api.rb +60 -0
- data/lib/talon_one/api/management_api.rb +177 -119
- data/lib/talon_one/models/account_analytics.rb +19 -4
- data/lib/talon_one/models/account_limits.rb +11 -1
- data/lib/talon_one/models/application.rb +10 -1
- data/lib/talon_one/models/attributes_mandatory.rb +199 -0
- data/lib/talon_one/models/attributes_settings.rb +184 -0
- data/lib/talon_one/models/base_saml_connection.rb +336 -0
- data/lib/talon_one/models/campaign_analytics.rb +94 -4
- data/lib/talon_one/models/campaign_copy.rb +46 -4
- data/lib/talon_one/models/change.rb +2 -2
- data/lib/talon_one/models/customer_inventory.rb +194 -0
- data/lib/talon_one/models/inline_response_200_20.rb +1 -1
- data/lib/talon_one/models/inline_response_200_21.rb +1 -1
- data/lib/talon_one/models/inline_response_200_22.rb +1 -1
- data/lib/talon_one/models/inline_response_200_23.rb +1 -1
- data/lib/talon_one/models/inline_response_200_24.rb +1 -1
- data/lib/talon_one/models/inline_response_200_25.rb +7 -11
- data/lib/talon_one/models/inline_response_200_26.rb +11 -7
- data/lib/talon_one/models/inline_response_200_27.rb +1 -1
- data/lib/talon_one/models/inline_response_200_28.rb +1 -1
- data/lib/talon_one/models/inline_response_200_29.rb +204 -0
- data/lib/talon_one/models/new_application.rb +10 -1
- data/lib/talon_one/models/new_saml_connection.rb +58 -43
- data/lib/talon_one/models/saml_connection.rb +45 -78
- data/lib/talon_one/models/saml_connection_metadata.rb +271 -0
- data/lib/talon_one/models/update_application.rb +13 -4
- data/lib/talon_one/version.rb +1 -1
- data/spec/api/integration_api_spec.rb +14 -0
- data/spec/api/management_api_spec.rb +50 -36
- data/spec/models/account_analytics_spec.rb +6 -0
- data/spec/models/account_limits_spec.rb +6 -0
- data/spec/models/application_spec.rb +6 -0
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -0
- data/spec/models/base_saml_connection_spec.rb +83 -0
- data/spec/models/campaign_analytics_spec.rb +36 -0
- data/spec/models/campaign_copy_spec.rb +24 -0
- data/spec/models/customer_inventory_spec.rb +47 -0
- data/spec/models/inline_response_200_25_spec.rb +0 -6
- data/spec/models/inline_response_200_26_spec.rb +6 -0
- data/spec/models/inline_response_200_29_spec.rb +47 -0
- data/spec/models/new_application_spec.rb +6 -0
- data/spec/models/new_saml_connection_spec.rb +13 -7
- data/spec/models/saml_connection_metadata_spec.rb +59 -0
- data/spec/models/saml_connection_spec.rb +9 -15
- data/spec/models/update_application_spec.rb +6 -0
- data/talon_one-1.3.0.gem +0 -0
- metadata +27 -2
data/docs/NewApplication.md
CHANGED
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional]
|
11
11
|
**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional]
|
12
12
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
|
13
|
+
**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
|
13
14
|
**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | [optional]
|
14
15
|
|
15
16
|
|
data/docs/NewSamlConnection.md
CHANGED
@@ -3,13 +3,14 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**x509certificate** | **String** | X.509 Certificate. |
|
7
|
+
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
6
8
|
**name** | **String** | ID of the SAML service. |
|
7
9
|
**enabled** | **BOOLEAN** | Determines if this SAML connection active. |
|
8
10
|
**issuer** | **String** | Identity Provider Entity ID. |
|
9
11
|
**sign_on_url** | **String** | Single Sign-On URL. |
|
10
12
|
**sign_out_url** | **String** | Single Sign-Out URL. | [optional]
|
11
13
|
**metadata_url** | **String** | Metadata URL. | [optional]
|
12
|
-
**
|
13
|
-
**audience** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. | [optional]
|
14
|
+
**audience_uri** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. | [optional]
|
14
15
|
|
15
16
|
|
data/docs/SamlConnection.md
CHANGED
@@ -3,17 +3,16 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**id** | **Integer** | |
|
7
|
-
**created** | **DateTime** | Unix timestamp indicating when the session was first created. |
|
8
|
-
**account_id** | **Integer** | The ID of the account that owns this SAML Service. |
|
9
6
|
**assertion_consumer_service_url** | **String** | The location where the SAML assertion is sent with a HTTP POST. |
|
7
|
+
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
8
|
**name** | **String** | ID of the SAML service. |
|
11
9
|
**enabled** | **BOOLEAN** | Determines if this SAML connection active. |
|
12
10
|
**issuer** | **String** | Identity Provider Entity ID. |
|
13
11
|
**sign_on_url** | **String** | Single Sign-On URL. |
|
14
12
|
**sign_out_url** | **String** | Single Sign-Out URL. | [optional]
|
15
13
|
**metadata_url** | **String** | Metadata URL. | [optional]
|
16
|
-
**
|
17
|
-
**
|
14
|
+
**audience_uri** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. |
|
15
|
+
**id** | **Integer** | Unique ID for this entity. |
|
16
|
+
**created** | **DateTime** | The exact moment this entity was created. |
|
18
17
|
|
19
18
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# TalonOne::SamlConnectionMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | ID of the SAML service. |
|
7
|
+
**enabled** | **BOOLEAN** | Determines if this SAML connection active. |
|
8
|
+
**account_id** | **Float** | |
|
9
|
+
**metadata_document** | **String** | Identity Provider metadata XML document. |
|
10
|
+
|
11
|
+
|
data/docs/UpdateApplication.md
CHANGED
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
|
|
10
10
|
**case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional]
|
11
11
|
**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional]
|
12
12
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
|
13
|
+
**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
|
13
14
|
|
14
15
|
|
data/lib/talon_one.rb
CHANGED
@@ -35,6 +35,9 @@ require 'talon_one/models/application_session'
|
|
35
35
|
require 'talon_one/models/application_session_entity'
|
36
36
|
require 'talon_one/models/attribute'
|
37
37
|
require 'talon_one/models/attribute_query'
|
38
|
+
require 'talon_one/models/attributes_mandatory'
|
39
|
+
require 'talon_one/models/attributes_settings'
|
40
|
+
require 'talon_one/models/base_saml_connection'
|
38
41
|
require 'talon_one/models/binding'
|
39
42
|
require 'talon_one/models/campaign'
|
40
43
|
require 'talon_one/models/campaign_analytics'
|
@@ -58,6 +61,7 @@ require 'talon_one/models/coupon_value'
|
|
58
61
|
require 'talon_one/models/create_application_api_key'
|
59
62
|
require 'talon_one/models/customer_activity_report'
|
60
63
|
require 'talon_one/models/customer_analytics'
|
64
|
+
require 'talon_one/models/customer_inventory'
|
61
65
|
require 'talon_one/models/customer_profile'
|
62
66
|
require 'talon_one/models/customer_profile_search_query'
|
63
67
|
require 'talon_one/models/customer_session'
|
@@ -98,6 +102,7 @@ require 'talon_one/models/inline_response_200_25'
|
|
98
102
|
require 'talon_one/models/inline_response_200_26'
|
99
103
|
require 'talon_one/models/inline_response_200_27'
|
100
104
|
require 'talon_one/models/inline_response_200_28'
|
105
|
+
require 'talon_one/models/inline_response_200_29'
|
101
106
|
require 'talon_one/models/inline_response_200_3'
|
102
107
|
require 'talon_one/models/inline_response_200_4'
|
103
108
|
require 'talon_one/models/inline_response_200_5'
|
@@ -163,6 +168,7 @@ require 'talon_one/models/role_membership'
|
|
163
168
|
require 'talon_one/models/rule'
|
164
169
|
require 'talon_one/models/ruleset'
|
165
170
|
require 'talon_one/models/saml_connection'
|
171
|
+
require 'talon_one/models/saml_connection_metadata'
|
166
172
|
require 'talon_one/models/session'
|
167
173
|
require 'talon_one/models/slot_def'
|
168
174
|
require 'talon_one/models/template_arg_def'
|
@@ -245,6 +245,66 @@ module TalonOne
|
|
245
245
|
end
|
246
246
|
return data, status_code, headers
|
247
247
|
end
|
248
|
+
# Get an inventory of all data associated with a specific customer profile.
|
249
|
+
# Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information and referral codes. In the future, this will be expanded with coupon codes and loyalty points.
|
250
|
+
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
251
|
+
# @param [Hash] opts the optional parameters
|
252
|
+
# @option opts [Object] :profile optional flag to decide if you would like customer profile information in the response
|
253
|
+
# @option opts [Object] :referrals optional flag to decide if you would like referral information in the response
|
254
|
+
# @return [CustomerInventory]
|
255
|
+
def get_customer_inventory(integration_id, opts = {})
|
256
|
+
data, _status_code, _headers = get_customer_inventory_with_http_info(integration_id, opts)
|
257
|
+
data
|
258
|
+
end
|
259
|
+
|
260
|
+
# Get an inventory of all data associated with a specific customer profile.
|
261
|
+
# Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information and referral codes. In the future, this will be expanded with coupon codes and loyalty points.
|
262
|
+
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
263
|
+
# @param [Hash] opts the optional parameters
|
264
|
+
# @option opts [Object] :profile optional flag to decide if you would like customer profile information in the response
|
265
|
+
# @option opts [Object] :referrals optional flag to decide if you would like referral information in the response
|
266
|
+
# @return [Array<(CustomerInventory, Fixnum, Hash)>] CustomerInventory data, response status code and response headers
|
267
|
+
def get_customer_inventory_with_http_info(integration_id, opts = {})
|
268
|
+
if @api_client.config.debugging
|
269
|
+
@api_client.config.logger.debug 'Calling API: IntegrationApi.get_customer_inventory ...'
|
270
|
+
end
|
271
|
+
# verify the required parameter 'integration_id' is set
|
272
|
+
if @api_client.config.client_side_validation && integration_id.nil?
|
273
|
+
fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationApi.get_customer_inventory"
|
274
|
+
end
|
275
|
+
# resource path
|
276
|
+
local_var_path = '/v1/customer_profiles/{integrationId}/inventory'.sub('{' + 'integrationId' + '}', integration_id.to_s)
|
277
|
+
|
278
|
+
# query parameters
|
279
|
+
query_params = {}
|
280
|
+
query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil?
|
281
|
+
query_params[:'referrals'] = opts[:'referrals'] if !opts[:'referrals'].nil?
|
282
|
+
|
283
|
+
# header parameters
|
284
|
+
header_params = {}
|
285
|
+
# HTTP header 'Accept' (if needed)
|
286
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
287
|
+
# HTTP header 'Content-Type'
|
288
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
289
|
+
|
290
|
+
# form parameters
|
291
|
+
form_params = {}
|
292
|
+
|
293
|
+
# http body (model)
|
294
|
+
post_body = nil
|
295
|
+
auth_names = ['api_key_v1', 'integration_auth']
|
296
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
297
|
+
:header_params => header_params,
|
298
|
+
:query_params => query_params,
|
299
|
+
:form_params => form_params,
|
300
|
+
:body => post_body,
|
301
|
+
:auth_names => auth_names,
|
302
|
+
:return_type => 'CustomerInventory')
|
303
|
+
if @api_client.config.debugging
|
304
|
+
@api_client.config.logger.debug "API called: IntegrationApi#get_customer_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
305
|
+
end
|
306
|
+
return data, status_code, headers
|
307
|
+
end
|
248
308
|
# Get all valid reserved coupons
|
249
309
|
# Returns all coupons this user is subscribed to that are valid and usable
|
250
310
|
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
@@ -150,6 +150,60 @@ module TalonOne
|
|
150
150
|
end
|
151
151
|
return data, status_code, headers
|
152
152
|
end
|
153
|
+
# Define a new custom attribute
|
154
|
+
# Defines a new _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating / updating these objects, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
|
155
|
+
# @param body
|
156
|
+
# @param [Hash] opts the optional parameters
|
157
|
+
# @return [Attribute]
|
158
|
+
def create_attribute(body, opts = {})
|
159
|
+
data, _status_code, _headers = create_attribute_with_http_info(body, opts)
|
160
|
+
data
|
161
|
+
end
|
162
|
+
|
163
|
+
# Define a new custom attribute
|
164
|
+
# Defines a new _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating / updating these objects, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
|
165
|
+
# @param body
|
166
|
+
# @param [Hash] opts the optional parameters
|
167
|
+
# @return [Array<(Attribute, Fixnum, Hash)>] Attribute data, response status code and response headers
|
168
|
+
def create_attribute_with_http_info(body, opts = {})
|
169
|
+
if @api_client.config.debugging
|
170
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.create_attribute ...'
|
171
|
+
end
|
172
|
+
# verify the required parameter 'body' is set
|
173
|
+
if @api_client.config.client_side_validation && body.nil?
|
174
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_attribute"
|
175
|
+
end
|
176
|
+
# resource path
|
177
|
+
local_var_path = '/v1/attributes'
|
178
|
+
|
179
|
+
# query parameters
|
180
|
+
query_params = {}
|
181
|
+
|
182
|
+
# header parameters
|
183
|
+
header_params = {}
|
184
|
+
# HTTP header 'Accept' (if needed)
|
185
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
186
|
+
# HTTP header 'Content-Type'
|
187
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
188
|
+
|
189
|
+
# form parameters
|
190
|
+
form_params = {}
|
191
|
+
|
192
|
+
# http body (model)
|
193
|
+
post_body = @api_client.object_to_http_body(body)
|
194
|
+
auth_names = ['manager_auth']
|
195
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
196
|
+
:header_params => header_params,
|
197
|
+
:query_params => query_params,
|
198
|
+
:form_params => form_params,
|
199
|
+
:body => post_body,
|
200
|
+
:auth_names => auth_names,
|
201
|
+
:return_type => 'Attribute')
|
202
|
+
if @api_client.config.debugging
|
203
|
+
@api_client.config.logger.debug "API called: ManagementApi#create_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
204
|
+
end
|
205
|
+
return data, status_code, headers
|
206
|
+
end
|
153
207
|
# Create a Campaign
|
154
208
|
#
|
155
209
|
# @param application_id
|
@@ -211,7 +265,7 @@ module TalonOne
|
|
211
265
|
return data, status_code, headers
|
212
266
|
end
|
213
267
|
# Create Coupons
|
214
|
-
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000
|
268
|
+
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
|
215
269
|
# @param application_id
|
216
270
|
# @param campaign_id
|
217
271
|
# @param body
|
@@ -224,7 +278,7 @@ module TalonOne
|
|
224
278
|
end
|
225
279
|
|
226
280
|
# Create Coupons
|
227
|
-
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000
|
281
|
+
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
|
228
282
|
# @param application_id
|
229
283
|
# @param campaign_id
|
230
284
|
# @param body
|
@@ -817,8 +871,8 @@ module TalonOne
|
|
817
871
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
818
872
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
819
873
|
# @param [Hash] opts the optional parameters
|
820
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
821
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
874
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
875
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
822
876
|
# @option opts [String] :status Filter results by HTTP status codes.
|
823
877
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
824
878
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -835,8 +889,8 @@ module TalonOne
|
|
835
889
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
836
890
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
837
891
|
# @param [Hash] opts the optional parameters
|
838
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
839
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
892
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
893
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
840
894
|
# @option opts [String] :status Filter results by HTTP status codes.
|
841
895
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
842
896
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -909,8 +963,8 @@ module TalonOne
|
|
909
963
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
910
964
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
911
965
|
# @param [Hash] opts the optional parameters
|
912
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
913
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
966
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
967
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
914
968
|
# @option opts [String] :status Filter results by HTTP status codes.
|
915
969
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
916
970
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -927,8 +981,8 @@ module TalonOne
|
|
927
981
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
928
982
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
929
983
|
# @param [Hash] opts the optional parameters
|
930
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
931
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
984
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
985
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
932
986
|
# @option opts [String] :status Filter results by HTTP status codes.
|
933
987
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
934
988
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1103,67 +1157,13 @@ module TalonOne
|
|
1103
1157
|
end
|
1104
1158
|
return data, status_code, headers
|
1105
1159
|
end
|
1106
|
-
# Get Account Limits
|
1107
|
-
# Returns a list of all account limits set
|
1108
|
-
# @param account_id
|
1109
|
-
# @param [Hash] opts the optional parameters
|
1110
|
-
# @return [AccountLimits]
|
1111
|
-
def get_account_limits(account_id, opts = {})
|
1112
|
-
data, _status_code, _headers = get_account_limits_with_http_info(account_id, opts)
|
1113
|
-
data
|
1114
|
-
end
|
1115
|
-
|
1116
|
-
# Get Account Limits
|
1117
|
-
# Returns a list of all account limits set
|
1118
|
-
# @param account_id
|
1119
|
-
# @param [Hash] opts the optional parameters
|
1120
|
-
# @return [Array<(AccountLimits, Fixnum, Hash)>] AccountLimits data, response status code and response headers
|
1121
|
-
def get_account_limits_with_http_info(account_id, opts = {})
|
1122
|
-
if @api_client.config.debugging
|
1123
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.get_account_limits ...'
|
1124
|
-
end
|
1125
|
-
# verify the required parameter 'account_id' is set
|
1126
|
-
if @api_client.config.client_side_validation && account_id.nil?
|
1127
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling ManagementApi.get_account_limits"
|
1128
|
-
end
|
1129
|
-
# resource path
|
1130
|
-
local_var_path = '/v1/accounts/{accountId}/limits'.sub('{' + 'accountId' + '}', account_id.to_s)
|
1131
|
-
|
1132
|
-
# query parameters
|
1133
|
-
query_params = {}
|
1134
|
-
|
1135
|
-
# header parameters
|
1136
|
-
header_params = {}
|
1137
|
-
# HTTP header 'Accept' (if needed)
|
1138
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1139
|
-
# HTTP header 'Content-Type'
|
1140
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1141
|
-
|
1142
|
-
# form parameters
|
1143
|
-
form_params = {}
|
1144
|
-
|
1145
|
-
# http body (model)
|
1146
|
-
post_body = nil
|
1147
|
-
auth_names = ['manager_auth']
|
1148
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1149
|
-
:header_params => header_params,
|
1150
|
-
:query_params => query_params,
|
1151
|
-
:form_params => form_params,
|
1152
|
-
:body => post_body,
|
1153
|
-
:auth_names => auth_names,
|
1154
|
-
:return_type => 'AccountLimits')
|
1155
|
-
if @api_client.config.debugging
|
1156
|
-
@api_client.config.logger.debug "API called: ManagementApi#get_account_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1157
|
-
end
|
1158
|
-
return data, status_code, headers
|
1159
|
-
end
|
1160
1160
|
# Get all access logs
|
1161
1161
|
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
1162
1162
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
1163
1163
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
1164
1164
|
# @param [Hash] opts the optional parameters
|
1165
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
1166
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
1165
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
1166
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
1167
1167
|
# @option opts [String] :status Filter results by HTTP status codes.
|
1168
1168
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1169
1169
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1179,8 +1179,8 @@ module TalonOne
|
|
1179
1179
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
1180
1180
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
1181
1181
|
# @param [Hash] opts the optional parameters
|
1182
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
1183
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
1182
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
1183
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
1184
1184
|
# @option opts [String] :status Filter results by HTTP status codes.
|
1185
1185
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1186
1186
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1245,7 +1245,7 @@ module TalonOne
|
|
1245
1245
|
end
|
1246
1246
|
# Get all roles.
|
1247
1247
|
# @param [Hash] opts the optional parameters
|
1248
|
-
# @return [
|
1248
|
+
# @return [InlineResponse20029]
|
1249
1249
|
def get_all_roles(opts = {})
|
1250
1250
|
data, _status_code, _headers = get_all_roles_with_http_info(opts)
|
1251
1251
|
data
|
@@ -1253,7 +1253,7 @@ module TalonOne
|
|
1253
1253
|
|
1254
1254
|
# Get all roles.
|
1255
1255
|
# @param [Hash] opts the optional parameters
|
1256
|
-
# @return [Array<(
|
1256
|
+
# @return [Array<(InlineResponse20029, Fixnum, Hash)>] InlineResponse20029 data, response status code and response headers
|
1257
1257
|
def get_all_roles_with_http_info(opts = {})
|
1258
1258
|
if @api_client.config.debugging
|
1259
1259
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_all_roles ...'
|
@@ -1283,7 +1283,7 @@ module TalonOne
|
|
1283
1283
|
:form_params => form_params,
|
1284
1284
|
:body => post_body,
|
1285
1285
|
:auth_names => auth_names,
|
1286
|
-
:return_type => '
|
1286
|
+
:return_type => 'InlineResponse20029')
|
1287
1287
|
if @api_client.config.debugging
|
1288
1288
|
@api_client.config.logger.debug "API called: ManagementApi#get_all_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1289
1289
|
end
|
@@ -1512,7 +1512,7 @@ module TalonOne
|
|
1512
1512
|
return data, status_code, headers
|
1513
1513
|
end
|
1514
1514
|
# Get a list of the customer profiles that match the given attributes
|
1515
|
-
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
1515
|
+
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
1516
1516
|
# @param body
|
1517
1517
|
# @param [Hash] opts the optional parameters
|
1518
1518
|
# @return [InlineResponse20013]
|
@@ -1522,7 +1522,7 @@ module TalonOne
|
|
1522
1522
|
end
|
1523
1523
|
|
1524
1524
|
# Get a list of the customer profiles that match the given attributes
|
1525
|
-
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
1525
|
+
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
1526
1526
|
# @param body
|
1527
1527
|
# @param [Hash] opts the optional parameters
|
1528
1528
|
# @return [Array<(InlineResponse20013, Fixnum, Hash)>] InlineResponse20013 data, response status code and response headers
|
@@ -2082,6 +2082,63 @@ module TalonOne
|
|
2082
2082
|
end
|
2083
2083
|
return data, status_code, headers
|
2084
2084
|
end
|
2085
|
+
# List custom attributes
|
2086
|
+
# Returns all the defined custom attributes for the account.
|
2087
|
+
# @param [Hash] opts the optional parameters
|
2088
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2089
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2090
|
+
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
2091
|
+
# @return [InlineResponse20020]
|
2092
|
+
def get_attributes(opts = {})
|
2093
|
+
data, _status_code, _headers = get_attributes_with_http_info(opts)
|
2094
|
+
data
|
2095
|
+
end
|
2096
|
+
|
2097
|
+
# List custom attributes
|
2098
|
+
# Returns all the defined custom attributes for the account.
|
2099
|
+
# @param [Hash] opts the optional parameters
|
2100
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2101
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
2102
|
+
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
2103
|
+
# @return [Array<(InlineResponse20020, Fixnum, Hash)>] InlineResponse20020 data, response status code and response headers
|
2104
|
+
def get_attributes_with_http_info(opts = {})
|
2105
|
+
if @api_client.config.debugging
|
2106
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
|
2107
|
+
end
|
2108
|
+
# resource path
|
2109
|
+
local_var_path = '/v1/attributes'
|
2110
|
+
|
2111
|
+
# query parameters
|
2112
|
+
query_params = {}
|
2113
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
2114
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
2115
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2116
|
+
|
2117
|
+
# header parameters
|
2118
|
+
header_params = {}
|
2119
|
+
# HTTP header 'Accept' (if needed)
|
2120
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2121
|
+
# HTTP header 'Content-Type'
|
2122
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2123
|
+
|
2124
|
+
# form parameters
|
2125
|
+
form_params = {}
|
2126
|
+
|
2127
|
+
# http body (model)
|
2128
|
+
post_body = nil
|
2129
|
+
auth_names = ['manager_auth']
|
2130
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2131
|
+
:header_params => header_params,
|
2132
|
+
:query_params => query_params,
|
2133
|
+
:form_params => form_params,
|
2134
|
+
:body => post_body,
|
2135
|
+
:auth_names => auth_names,
|
2136
|
+
:return_type => 'InlineResponse20020')
|
2137
|
+
if @api_client.config.debugging
|
2138
|
+
@api_client.config.logger.debug "API called: ManagementApi#get_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2139
|
+
end
|
2140
|
+
return data, status_code, headers
|
2141
|
+
end
|
2085
2142
|
# Get a Campaign
|
2086
2143
|
#
|
2087
2144
|
# @param application_id
|
@@ -2443,7 +2500,7 @@ module TalonOne
|
|
2443
2500
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
2444
2501
|
# @option opts [BOOLEAN] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
|
2445
2502
|
# @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.
|
2446
|
-
# @return [
|
2503
|
+
# @return [InlineResponse20026]
|
2447
2504
|
def get_changes(opts = {})
|
2448
2505
|
data, _status_code, _headers = get_changes_with_http_info(opts)
|
2449
2506
|
data
|
@@ -2460,7 +2517,7 @@ module TalonOne
|
|
2460
2517
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
2461
2518
|
# @option opts [BOOLEAN] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
|
2462
2519
|
# @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.
|
2463
|
-
# @return [Array<(
|
2520
|
+
# @return [Array<(InlineResponse20026, Fixnum, Hash)>] InlineResponse20026 data, response status code and response headers
|
2464
2521
|
def get_changes_with_http_info(opts = {})
|
2465
2522
|
if @api_client.config.debugging
|
2466
2523
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
|
@@ -2498,7 +2555,7 @@ module TalonOne
|
|
2498
2555
|
:form_params => form_params,
|
2499
2556
|
:body => post_body,
|
2500
2557
|
:auth_names => auth_names,
|
2501
|
-
:return_type => '
|
2558
|
+
:return_type => 'InlineResponse20026')
|
2502
2559
|
if @api_client.config.debugging
|
2503
2560
|
@api_client.config.logger.debug "API called: ManagementApi#get_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2504
2561
|
end
|
@@ -3378,7 +3435,7 @@ module TalonOne
|
|
3378
3435
|
return data, status_code, headers
|
3379
3436
|
end
|
3380
3437
|
# Get a list of the customer profiles that match the given attributes
|
3381
|
-
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
3438
|
+
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
3382
3439
|
# @param body
|
3383
3440
|
# @param [Hash] opts the optional parameters
|
3384
3441
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -3390,7 +3447,7 @@ module TalonOne
|
|
3390
3447
|
end
|
3391
3448
|
|
3392
3449
|
# Get a list of the customer profiles that match the given attributes
|
3393
|
-
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
3450
|
+
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
3394
3451
|
# @param body
|
3395
3452
|
# @param [Hash] opts the optional parameters
|
3396
3453
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -3446,7 +3503,7 @@ module TalonOne
|
|
3446
3503
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3447
3504
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3448
3505
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
3449
|
-
# @return [
|
3506
|
+
# @return [InlineResponse20024]
|
3450
3507
|
def get_event_types(opts = {})
|
3451
3508
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
3452
3509
|
data
|
@@ -3461,7 +3518,7 @@ module TalonOne
|
|
3461
3518
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3462
3519
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3463
3520
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
3464
|
-
# @return [Array<(
|
3521
|
+
# @return [Array<(InlineResponse20024, Fixnum, Hash)>] InlineResponse20024 data, response status code and response headers
|
3465
3522
|
def get_event_types_with_http_info(opts = {})
|
3466
3523
|
if @api_client.config.debugging
|
3467
3524
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
|
@@ -3497,7 +3554,7 @@ module TalonOne
|
|
3497
3554
|
:form_params => form_params,
|
3498
3555
|
:body => post_body,
|
3499
3556
|
:auth_names => auth_names,
|
3500
|
-
:return_type => '
|
3557
|
+
:return_type => 'InlineResponse20024')
|
3501
3558
|
if @api_client.config.debugging
|
3502
3559
|
@api_client.config.logger.debug "API called: ManagementApi#get_event_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3503
3560
|
end
|
@@ -3511,7 +3568,7 @@ module TalonOne
|
|
3511
3568
|
# @option opts [Integer] :application_id
|
3512
3569
|
# @option opts [Integer] :campaign_id
|
3513
3570
|
# @option opts [String] :entity The name of the entity type that was exported.
|
3514
|
-
# @return [
|
3571
|
+
# @return [InlineResponse20027]
|
3515
3572
|
def get_exports(opts = {})
|
3516
3573
|
data, _status_code, _headers = get_exports_with_http_info(opts)
|
3517
3574
|
data
|
@@ -3525,7 +3582,7 @@ module TalonOne
|
|
3525
3582
|
# @option opts [Integer] :application_id
|
3526
3583
|
# @option opts [Integer] :campaign_id
|
3527
3584
|
# @option opts [String] :entity The name of the entity type that was exported.
|
3528
|
-
# @return [Array<(
|
3585
|
+
# @return [Array<(InlineResponse20027, Fixnum, Hash)>] InlineResponse20027 data, response status code and response headers
|
3529
3586
|
def get_exports_with_http_info(opts = {})
|
3530
3587
|
if @api_client.config.debugging
|
3531
3588
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
|
@@ -3563,7 +3620,7 @@ module TalonOne
|
|
3563
3620
|
:form_params => form_params,
|
3564
3621
|
:body => post_body,
|
3565
3622
|
:auth_names => auth_names,
|
3566
|
-
:return_type => '
|
3623
|
+
:return_type => 'InlineResponse20027')
|
3567
3624
|
if @api_client.config.debugging
|
3568
3625
|
@api_client.config.logger.debug "API called: ManagementApi#get_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3569
3626
|
end
|
@@ -3574,7 +3631,7 @@ module TalonOne
|
|
3574
3631
|
# @param [Hash] opts the optional parameters
|
3575
3632
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3576
3633
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3577
|
-
# @return [
|
3634
|
+
# @return [InlineResponse20028]
|
3578
3635
|
def get_imports(opts = {})
|
3579
3636
|
data, _status_code, _headers = get_imports_with_http_info(opts)
|
3580
3637
|
data
|
@@ -3585,7 +3642,7 @@ module TalonOne
|
|
3585
3642
|
# @param [Hash] opts the optional parameters
|
3586
3643
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
3587
3644
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
3588
|
-
# @return [Array<(
|
3645
|
+
# @return [Array<(InlineResponse20028, Fixnum, Hash)>] InlineResponse20028 data, response status code and response headers
|
3589
3646
|
def get_imports_with_http_info(opts = {})
|
3590
3647
|
if @api_client.config.debugging
|
3591
3648
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_imports ...'
|
@@ -3617,7 +3674,7 @@ module TalonOne
|
|
3617
3674
|
:form_params => form_params,
|
3618
3675
|
:body => post_body,
|
3619
3676
|
:auth_names => auth_names,
|
3620
|
-
:return_type => '
|
3677
|
+
:return_type => 'InlineResponse20028')
|
3621
3678
|
if @api_client.config.debugging
|
3622
3679
|
@api_client.config.logger.debug "API called: ManagementApi#get_imports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3623
3680
|
end
|
@@ -4218,7 +4275,7 @@ module TalonOne
|
|
4218
4275
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4219
4276
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4220
4277
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
4221
|
-
# @return [
|
4278
|
+
# @return [InlineResponse20025]
|
4222
4279
|
def get_users(opts = {})
|
4223
4280
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
4224
4281
|
data
|
@@ -4230,7 +4287,7 @@ module TalonOne
|
|
4230
4287
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4231
4288
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4232
4289
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
4233
|
-
# @return [Array<(
|
4290
|
+
# @return [Array<(InlineResponse20025, Fixnum, Hash)>] InlineResponse20025 data, response status code and response headers
|
4234
4291
|
def get_users_with_http_info(opts = {})
|
4235
4292
|
if @api_client.config.debugging
|
4236
4293
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
|
@@ -4263,7 +4320,7 @@ module TalonOne
|
|
4263
4320
|
:form_params => form_params,
|
4264
4321
|
:body => post_body,
|
4265
4322
|
:auth_names => auth_names,
|
4266
|
-
:return_type => '
|
4323
|
+
:return_type => 'InlineResponse20025')
|
4267
4324
|
if @api_client.config.debugging
|
4268
4325
|
@api_client.config.logger.debug "API called: ManagementApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4269
4326
|
end
|
@@ -4335,7 +4392,7 @@ module TalonOne
|
|
4335
4392
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
4336
4393
|
# @option opts [DateTime] :created_before Only return events created before this date.
|
4337
4394
|
# @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.
|
4338
|
-
# @return [
|
4395
|
+
# @return [InlineResponse20022]
|
4339
4396
|
def get_webhook_activation_logs(opts = {})
|
4340
4397
|
data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
|
4341
4398
|
data
|
@@ -4353,7 +4410,7 @@ module TalonOne
|
|
4353
4410
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
4354
4411
|
# @option opts [DateTime] :created_before Only return events created before this date.
|
4355
4412
|
# @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.
|
4356
|
-
# @return [Array<(
|
4413
|
+
# @return [Array<(InlineResponse20022, Fixnum, Hash)>] InlineResponse20022 data, response status code and response headers
|
4357
4414
|
def get_webhook_activation_logs_with_http_info(opts = {})
|
4358
4415
|
if @api_client.config.debugging
|
4359
4416
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
|
@@ -4392,7 +4449,7 @@ module TalonOne
|
|
4392
4449
|
:form_params => form_params,
|
4393
4450
|
:body => post_body,
|
4394
4451
|
:auth_names => auth_names,
|
4395
|
-
:return_type => '
|
4452
|
+
:return_type => 'InlineResponse20022')
|
4396
4453
|
if @api_client.config.debugging
|
4397
4454
|
@api_client.config.logger.debug "API called: ManagementApi#get_webhook_activation_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4398
4455
|
end
|
@@ -4411,7 +4468,7 @@ module TalonOne
|
|
4411
4468
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
4412
4469
|
# @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.
|
4413
4470
|
# @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.
|
4414
|
-
# @return [
|
4471
|
+
# @return [InlineResponse20023]
|
4415
4472
|
def get_webhook_logs(opts = {})
|
4416
4473
|
data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
|
4417
4474
|
data
|
@@ -4430,7 +4487,7 @@ module TalonOne
|
|
4430
4487
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
4431
4488
|
# @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.
|
4432
4489
|
# @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.
|
4433
|
-
# @return [Array<(
|
4490
|
+
# @return [Array<(InlineResponse20023, Fixnum, Hash)>] InlineResponse20023 data, response status code and response headers
|
4434
4491
|
def get_webhook_logs_with_http_info(opts = {})
|
4435
4492
|
if @api_client.config.debugging
|
4436
4493
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
|
@@ -4473,7 +4530,7 @@ module TalonOne
|
|
4473
4530
|
:form_params => form_params,
|
4474
4531
|
:body => post_body,
|
4475
4532
|
:auth_names => auth_names,
|
4476
|
-
:return_type => '
|
4533
|
+
:return_type => 'InlineResponse20023')
|
4477
4534
|
if @api_client.config.debugging
|
4478
4535
|
@api_client.config.logger.debug "API called: ManagementApi#get_webhook_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4479
4536
|
end
|
@@ -4486,7 +4543,7 @@ module TalonOne
|
|
4486
4543
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
4487
4544
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4488
4545
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4489
|
-
# @return [
|
4546
|
+
# @return [InlineResponse20021]
|
4490
4547
|
def get_webhooks(opts = {})
|
4491
4548
|
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
4492
4549
|
data
|
@@ -4499,7 +4556,7 @@ module TalonOne
|
|
4499
4556
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
4500
4557
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
4501
4558
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
4502
|
-
# @return [Array<(
|
4559
|
+
# @return [Array<(InlineResponse20021, Fixnum, Hash)>] InlineResponse20021 data, response status code and response headers
|
4503
4560
|
def get_webhooks_with_http_info(opts = {})
|
4504
4561
|
if @api_client.config.debugging
|
4505
4562
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
@@ -4533,7 +4590,7 @@ module TalonOne
|
|
4533
4590
|
:form_params => form_params,
|
4534
4591
|
:body => post_body,
|
4535
4592
|
:auth_names => auth_names,
|
4536
|
-
:return_type => '
|
4593
|
+
:return_type => 'InlineResponse20021')
|
4537
4594
|
if @api_client.config.debugging
|
4538
4595
|
@api_client.config.logger.debug "API called: ManagementApi#get_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4539
4596
|
end
|
@@ -5137,37 +5194,37 @@ module TalonOne
|
|
5137
5194
|
end
|
5138
5195
|
return data, status_code, headers
|
5139
5196
|
end
|
5140
|
-
#
|
5141
|
-
#
|
5142
|
-
# @param
|
5197
|
+
# Update a custom attribute
|
5198
|
+
# Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
|
5199
|
+
# @param attribute_id
|
5143
5200
|
# @param body
|
5144
5201
|
# @param [Hash] opts the optional parameters
|
5145
|
-
# @return [
|
5146
|
-
def
|
5147
|
-
|
5148
|
-
|
5202
|
+
# @return [Attribute]
|
5203
|
+
def update_attribute(attribute_id, body, opts = {})
|
5204
|
+
data, _status_code, _headers = update_attribute_with_http_info(attribute_id, body, opts)
|
5205
|
+
data
|
5149
5206
|
end
|
5150
5207
|
|
5151
|
-
#
|
5152
|
-
#
|
5153
|
-
# @param
|
5208
|
+
# Update a custom attribute
|
5209
|
+
# Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
|
5210
|
+
# @param attribute_id
|
5154
5211
|
# @param body
|
5155
5212
|
# @param [Hash] opts the optional parameters
|
5156
|
-
# @return [Array<(
|
5157
|
-
def
|
5213
|
+
# @return [Array<(Attribute, Fixnum, Hash)>] Attribute data, response status code and response headers
|
5214
|
+
def update_attribute_with_http_info(attribute_id, body, opts = {})
|
5158
5215
|
if @api_client.config.debugging
|
5159
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.
|
5216
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.update_attribute ...'
|
5160
5217
|
end
|
5161
|
-
# verify the required parameter '
|
5162
|
-
if @api_client.config.client_side_validation &&
|
5163
|
-
fail ArgumentError, "Missing the required parameter '
|
5218
|
+
# verify the required parameter 'attribute_id' is set
|
5219
|
+
if @api_client.config.client_side_validation && attribute_id.nil?
|
5220
|
+
fail ArgumentError, "Missing the required parameter 'attribute_id' when calling ManagementApi.update_attribute"
|
5164
5221
|
end
|
5165
5222
|
# verify the required parameter 'body' is set
|
5166
5223
|
if @api_client.config.client_side_validation && body.nil?
|
5167
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.
|
5224
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_attribute"
|
5168
5225
|
end
|
5169
5226
|
# resource path
|
5170
|
-
local_var_path = '/v1/
|
5227
|
+
local_var_path = '/v1/attributes/{attributeId}'.sub('{' + 'attributeId' + '}', attribute_id.to_s)
|
5171
5228
|
|
5172
5229
|
# query parameters
|
5173
5230
|
query_params = {}
|
@@ -5190,9 +5247,10 @@ module TalonOne
|
|
5190
5247
|
:query_params => query_params,
|
5191
5248
|
:form_params => form_params,
|
5192
5249
|
:body => post_body,
|
5193
|
-
:auth_names => auth_names
|
5250
|
+
:auth_names => auth_names,
|
5251
|
+
:return_type => 'Attribute')
|
5194
5252
|
if @api_client.config.debugging
|
5195
|
-
@api_client.config.logger.debug "API called: ManagementApi#
|
5253
|
+
@api_client.config.logger.debug "API called: ManagementApi#update_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5196
5254
|
end
|
5197
5255
|
return data, status_code, headers
|
5198
5256
|
end
|